Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: remove custom startup to fix dev reloading

Browse Source 
The cms/startup.py and lms/startup.py files were created to
allow us to do a lot of custom initialization around things
like the ModuleStore, monkey-patching, adding MIME types to
our process, etc. As far back as 2017, we recognized that
this was a bad thing, marked these modules as "deprecated",
and started removing things or putting them in the standard
Django locations for them (0279181).

In its current state, these startup modules no longer do any
custom work, and just invoke django.startup(). But this is
meant for running Django code in "standalone" usage, e.g. if
you have a script that isn't a management command but needs
some Django functionality.

The "runserver" command used during development normally
launches a child process to serve requests and knows how to
kill and respawn that process when files are modified, so
that changes are reflected. It can also normally handle the
case where there's a SyntaxError in the child process, and
fixing that error will reload the code again.

Something about running django.startup() manually interferes
with this functionality in "runserver". It still reloads the
code in response to changes, but if the code gets into a
broken state for any reason (like a syntax error), the master
process itself dies. That causes the container to restart,
only to die again shortly afterwards in a loop until the
error is fixed. The container restarts will break any shell
you had opened into the container, as well as any IDE
integrations that connected to that container to access the
files and Python instance.

Getting rid of the custom startup code fixes this and moves
us one small step closer to being a more normal Django
project.
This commit is contained in:
David Ormsbee
2025-02-25 18:51:15 -05:00
parent 05890d25b6
commit c4f21b6931
8 changed files with 3 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
cms/conftest.py
View File

@@ -6,10 +6,7 @@ pytest from looking for the conftest.py module in the parent directory when
only running cms tests.
"""
import importlib
import logging
import os
import pytest
@@ -29,13 +26,6 @@ def pytest_configure(config):
else:
logging.info("pytest did not register json_report correctly")
if config.getoption('help'):
return
settings_module = os.environ.get('DJANGO_SETTINGS_MODULE')
startup_module = 'cms.startup' if settings_module.startswith('cms') else 'lms.startup'
startup = importlib.import_module(startup_module)
startup.run()
@pytest.fixture(autouse=True, scope='function')
def _django_clear_site_cache():

20
cms/startup.py
View File

@@ -1,20 +0,0 @@
"""
Module for code that should run during Studio startup (deprecated)
"""
import django
from django.conf import settings
# Force settings to run so that the python path is modified
settings.INSTALLED_APPS # pylint: disable=pointless-statement
def run():
"""
Executed during django startup
NOTE: DO **NOT** add additional code to this method or this file! The Platform Team
is moving all startup code to more standard locations using Django best practices.
"""
django.setup()

3
cms/wsgi.py
View File

@@ -18,9 +18,6 @@ defuse_xml_libs()
import os # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-position
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "cms.envs.aws")
import cms.startup as startup # lint-amnesty, pylint: disable=wrong-import-position
startup.run()
# This application object is used by the development server
# as well as any WSGI server configured to use this file.
from django.core.wsgi import get_wsgi_application # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-position

20
lms/startup.py
View File

@@ -1,20 +0,0 @@
"""
Module for code that should run during LMS startup (deprecated)
"""
import django
from django.conf import settings
# Force settings to run so that the python path is modified
settings.INSTALLED_APPS # pylint: disable=pointless-statement
def run():
"""
Executed during django startup
NOTE: DO **NOT** add additional code to this method or this file! The Platform Team
is moving all startup code to more standard locations using Django best practices.
"""
django.setup()

3
lms/wsgi.py
View File

@@ -15,9 +15,6 @@ defuse_xml_libs()
import os # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-position
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "lms.envs.aws")
import lms.startup as startup # lint-amnesty, pylint: disable=wrong-import-position
startup.run()
# This application object is used by the development server
# as well as any WSGI server configured to use this file.
from django.core.wsgi import get_wsgi_application # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-position

3
lms/wsgi_apache_lms.py
View File

@@ -14,9 +14,6 @@ import os # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-posi
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "lms.envs.aws")
os.environ.setdefault("SERVICE_VARIANT", "lms")
import lms.startup as startup # lint-amnesty, pylint: disable=wrong-import-position
startup.run()
# This application object is used by the development server
# as well as any WSGI server configured to use this file.
from django.core.wsgi import get_wsgi_application # lint-amnesty, pylint: disable=wrong-import-order, wrong-import-position

7
manage.py
View File

@@ -12,7 +12,6 @@ Any arguments not understood by this manage.py will be passed to django-admin.py
"""
# pylint: disable=wrong-import-order, wrong-import-position
from openedx.core.lib.logsettings import log_python_warnings
log_python_warnings()
@@ -20,7 +19,6 @@ log_python_warnings()
from openedx.core.lib.safe_lxml import defuse_xml_libs # isort:skip
defuse_xml_libs()
import importlib
import os
import sys
from argparse import ArgumentParser
@@ -51,7 +49,6 @@ def parse_args():
help_string=lms.format_help(),
settings_base='lms/envs',
default_settings='lms.envs.devstack_docker',
startup='lms.startup',
)
cms = subparsers.add_parser(
@@ -70,7 +67,6 @@ def parse_args():
settings_base='cms/envs',
default_settings='cms.envs.devstack_docker',
service_variant='cms',
startup='cms.startup',
)
edx_args, django_args = parser.parse_known_args()
@@ -99,8 +95,5 @@ if __name__ == "__main__":
# This will trigger django-admin.py to print out its help
django_args.append('--help')
startup = importlib.import_module(edx_args.startup)
startup.run()
from django.core.management import execute_from_command_line
execute_from_command_line([sys.argv[0]] + django_args)

8
openedx/core/djangoapps/monkey_patch/__init__.py
View File

@@ -6,9 +6,8 @@ Here be dragons (and simians!)
* USE WITH CAUTION *
No, but seriously, you probably never really want to make changes here.
This module contains methods to monkey-patch [0] the edx-platform.
Patches are to be applied as early as possible in the callstack
(currently lms/startup.py and cms/startup.py). Consequently, changes
made here will affect the entire platform.
Patches are to be applied as early as possible in the callstack). Consequently,
changes made here will affect the entire platform.
That said, if you've decided you really need to monkey-patch the
platform (and you've convinced enough people that this is best
@@ -25,8 +24,7 @@ solution), kindly follow these guidelines:
- is_patched
- patch
- unpatch
- Add the following code where needed (typically cms/startup.py and
lms/startup.py):
- Add the following code where needed:
```
from openedx.core.djangoapps.monkey_patch import your_module
your_module.patch()