Remove WeBWorK::Constants and improve the webwork2 app configuration. #1985
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drgrice1
force-pushed
the
course-environment-constants-rework
branch
2 times, most recently
from
df1d695 to
f3d143a
Compare
pstaabp
approved these changes
May 15, 2023
|
This will have implications for the standalone renderer... it will be nice to ditch the WeBWorK::Constants! |
|
Technically since the standalone renderer has its own code for this, it will not need any changes due to this pull request. However, it would be good to make similar changes to the standalone renderer's code. |
drgrice1
force-pushed
the
course-environment-constants-rework
branch
2 times, most recently
from
e907ca6 to
094bef6
Compare
The only constants still defined in the WeBWorK::Constants package were the WEBWORK_DIRECTORY and the PG_DIRECTORY. Furthermore, even those were not used much in the code, and they are even set several times in scripts to "avoid an error message" from not having them defined. The few places that these constants were used now either use WEBWORK_ROOT and PG_ROOT environment variables directory (from which the previous constants were set) or use values from the course environment. The CourseEnvironment constructor grabs webwork_dir and pg_dir from the %WeBWorK::SeedCE hash if those parameters are not passed in, and falls back as a last resort to WEBWORK_ROOT and PG_ROOT environment variables. This makes it so that within the webwork app, you do not need to pass the webwork_dir to construct a CourseEnvironment object. Scripts will either need to set the %WeBWorK::SeedCE webwork_dir and pg_dir values, or pass webwork_dir and pg_dir to the CourseEnvironment constructor in its now optional argument, or just ensure the WEBWORK_ROOT and PG_ROOT environment variables are set. Note the old four argument way of calling the CourseEnvironment constructor that has been marked as deprecated since 2004 is now removed entirely. One upshot of this is that the pg_dir is not needed in site.conf (and so is removed), and this now only needs to be set in one place, namely webwork2.mojolicious.yml. The other constants defined throughout the code that were previously set in WeBWorK::Constants are now set from configuration variables in webwork2.mojolicious.yml when the app initializes. The only such constants are the WeBWorK::Debug constants and one WeBWorK::Hardcopy constant. This means that to enable debug logging, you don't need to modify the code anymore. Just enable it in the webwork2.mojolicious.yml file.
I am tired of seeing matches on things in these directories when grepping for variables that are obsolete, and nothing in these directories works anymore.
drgrice1
force-pushed
the
course-environment-constants-rework
branch
from
094bef6 to
ba6f402
Compare
|
@drdrew42: I realized that I have already done this for the standalone renderer. It is part of openwebwork/renderer#7. |
somiaj
approved these changes
May 16, 2023
drgrice1
added a commit
to drgrice1/webwork2
that referenced
this pull request
May 19, 2023
This was using the old four argument form of the CourseEnvironment constructor. I missed that in openwebwork#1985. To test this rename a course or unarchive a course to a new name. On the current release candidate branch you will get an error. With this pull request it will work. Note that if you test this on the release candidate branch and rename a course, the course directory will be renamed. So you will need to manually rename that back to what it was. The database tables will still be under the old course name. If you attempt to unarchive to a new name, then the course directory will be created with the new name, but the database tables will not be. So you will need to manually delete that new course directory.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The only constants still defined in the WeBWorK::Constants package were the WEBWORK_DIRECTORY and the PG_DIRECTORY. Furthermore, even those were not used much in the code, and they are even set several times in scripts to "avoid an error message" from not having them defined. The few places that these constants were used now either use WEBWORK_ROOT and PG_ROOT environment variables directly (from which the previous constants were set) or use values from the course environment.
The CourseEnvironment constructor grabs webwork_dir and pg_dir from the %WeBWorK::SeedCE hash if those parameters are not passed in, and falls back as a last resort to WEBWORK_ROOT and PG_ROOT environment variables. This makes it so that within the webwork app, you do not need to pass the webwork_dir to construct a CourseEnvironment object.
Scripts will either need to set the %WeBWorK::SeedCE webwork_dir and pg_dir values, or pass webwork_dir and pg_dir to the CourseEnvironment constructor in its now optional argument, or just ensure the WEBWORK_ROOT and PG_ROOT environment variables are set.
Note the old four argument way of calling the CourseEnvironment constructor that has been marked as deprecated since 2004 is now removed entirely.
One upshot of this is that the pg_dir is not needed in site.conf (and so is removed), and this now only needs to be set in one place, namely webwork2.mojolicious.yml.
The other constants defined throughout the code that were previously set in WeBWorK::Constants are now set from configuration variables in webwork2.mojolicious.yml when the app initializes. The only such constants are the WeBWorK::Debug constants and one WeBWorK::Hardcopy constant. This means that to enable debug logging, you don't need to modify the code anymore. Just enable it in the webwork2.mojolicious.yml file.
Note the
clientsandtdirectories were also deleted. I am tired of seeing matches on things in these directories when grepping the code, and nothing in these directories works or is valid for anything anymore.