fixed subtle bug in extension manager classes—accidently used class attributes instead of instance attributes

Author: Zsailer

jupyter_server/extension/application.py

@@ -322,7 +322,7 @@ def _link_jupyter_server_extension(self, serverapp):
         # Load config from an ExtensionApp's config files.
         self.load_config_file()
         # ServerApp's config might have picked up
-        # CLI config for the ExtensionApp. We call
+        # config for the ExtensionApp. We call
         # update_config to update ExtensionApp's
         # traits with these values found in ServerApp's
         # config.

jupyter_server/extension/manager.py

@@ -21,7 +21,11 @@ class ExtensionPoint(HasTraits):
     point defined by metadata and importable from a Python package.
     """
     metadata = Dict()
-    _app = None
+
+    def __init__(self, *args, **kwargs):
+        # Store extension points that have been linked.
+        self._app = None
+        super().__init__(*args, **kwargs)
 
     @validate('metadata')
     def _valid_metadata(self, proposed):
@@ -43,10 +47,8 @@ def _valid_metadata(self, proposed):
                 "sure the extension is installed?".format(self._module_name)
             )
         # If the metadata includes an ExtensionApp, create an instance.
-        try:
-            self._app = metadata.get("app")()
-        except TypeError:
-            pass
+        if 'app' in metadata:
+            self._app = metadata["app"]()
         return metadata
 
     @property
@@ -129,7 +131,11 @@ class ExtensionPackage(HasTraits):
     """
     name = Unicode(help="Name of the an importable Python package.")
 
-    # Store extension points that have been linked.
+    def __init__(self, *args, **kwargs):
+        # Store extension points that have been linked.
+        self._linked_points = {}
+        super().__init__(*args, **kwargs)
+
     _linked_points = {}
 
     @validate("name")
@@ -185,23 +191,27 @@ class ExtensionManager(LoggingConfigurable):
     Usage:
     m = ExtensionManager(jpserver_extensions=extensions)
     """
-    # The `enabled_extensions` attribute provides a dictionary
-    # with extension (package) names mapped to their ExtensionPackage interface
-    # (see above). This manager simplifies the interaction between the
-    # ServerApp and the extensions being appended.
-    _enabled_extensions = {}
-    # The `_linked_extensions` attribute tracks when each extension
-    # has been successfully linked to a ServerApp. This helps prevent
-    # extensions from being re-linked recursively unintentionally if another
-    # extension attempts to link extensions again.
-    _linked_extensions = {}
+    def __init__(self, *args, **kwargs):
+        # The `enabled_extensions` attribute provides a dictionary
+        # with extension (package) names mapped to their ExtensionPackage interface
+        # (see above). This manager simplifies the interaction between the
+        # ServerApp and the extensions being appended.
+        self._enabled_extensions = {}
+        # The `_linked_extensions` attribute tracks when each extension
+        # has been successfully linked to a ServerApp. This helps prevent
+        # extensions from being re-linked recursively unintentionally if another
+        # extension attempts to link extensions again.
+        self._linked_extensions = {}
+        super().__init__(*args, **kwargs)
 
     @property
     def enabled_extensions(self):
         """Dictionary with extension package names as keys
         and an ExtensionPackage objects as values.
         """
-        return dict(sorted(self._enabled_extensions.items()))
+        # Sort enabled extensions before returning
+        out = sorted(self._enabled_extensions.items())
+        return dict(out)
 
     @property
     def extension_points(self):
@@ -212,7 +222,6 @@ def extension_points(self):
             for name, point in value.extension_points.items()
         }
 
-
     def from_jpserver_extensions(self, jpserver_extensions):
         """Add extensions from 'jpserver_extensions'-like dictionary."""
         for name, enabled in jpserver_extensions.items():

jupyter_server/pytest_plugin.py

@@ -111,16 +111,18 @@ def extension_environ(env_config_path, monkeypatch):
 @pytest.fixture(scope='function')
 def configurable_serverapp(
     environ,
+    server_config,
+    argv,
     http_port,
     tmp_path,
     root_dir,
     io_loop,
-    server_config,
-    **kwargs
 ):
-    def serverapp(
+    ServerApp.clear_instance()
+
+    def _configurable_serverapp(
         config=server_config,
-        argv=[],
+        argv=argv,
         environ=environ,
         http_port=http_port,
         tmp_path=tmp_path,
@@ -144,6 +146,7 @@ def serverapp(
             token=token,
             **kwargs
         )
+
         app.init_signal = lambda: None
         app.log.propagate = True
         app.log.handlers = []
@@ -155,12 +158,11 @@ def serverapp(
         app.start_app()
         return app
 
-    yield serverapp
-    ServerApp.clear_instance()
+    return _configurable_serverapp
 
 
-@pytest.fixture
-def serverapp(configurable_serverapp, server_config, argv):
+@pytest.fixture(scope="function")
+def serverapp(server_config, argv, configurable_serverapp):
     app = configurable_serverapp(config=server_config, argv=argv)
     yield app
     app.remove_server_info_file()

jupyter_server/serverapp.py

@@ -1503,7 +1503,7 @@ def init_server_extensions(self):
         and load its own config.
         """
         # Create an instance of the ExtensionManager.
-        self.extension_manager = ExtensionManager(logger=self.log)
+        self.extension_manager = ExtensionManager(log=self.log)
         self.extension_manager.from_jpserver_extensions(self.jpserver_extensions)
         self.extension_manager.link_all_extensions(self)
 
@@ -1682,6 +1682,7 @@ def initialize(self, argv=None, find_extensions=True, new_httpserver=True):
         self.init_mime_overrides()
         self.init_shutdown_no_activity()
 
+
     def cleanup_kernels(self):
         """Shutdown all kernels.
 

tests/conftest.py

@@ -1 +1 @@
-pytest_plugins = ['pytest_jupyter_server']
+pytest_plugins = ['pytest_jupyter_server']

tests/extension/conftest.py

@@ -1,5 +1,6 @@
 import pytest
 
+
 mock_html = """
 <!DOCTYPE HTML>
 <html>
@@ -23,6 +24,7 @@
 """
 
 
+
 @pytest.fixture
 def mock_template(template_dir):
     index = template_dir.joinpath('index.html')

tests/extension/test_app.py

@@ -1,14 +1,9 @@
 import pytest
 from jupyter_server.serverapp import ServerApp
 
-# Use ServerApps environment because it monkeypatches
-# jupyter_core.paths and provides a config directory
-# that's not cross contaminating the user config directory.
-pytestmark = pytest.mark.usefixtures("environ")
-
 
 @pytest.fixture
-def server_config(request, template_dir):
+def server_config(template_dir):
     config = {
         "ServerApp": {
             "jpserver_extensions": {
@@ -26,15 +21,15 @@ def server_config(request, template_dir):
 
 
 @pytest.fixture
-def mock_extension(serverapp, extension_manager):
+def mock_extension(extension_manager):
     name = "tests.extension.mockextensions"
     pkg = extension_manager.enabled_extensions[name]
     point = pkg.extension_points["mockextension"]
     app = point.app
     return app
 
 
-def test_initialize(serverapp, mock_extension, template_dir):
+def test_initialize(serverapp, template_dir, mock_extension):
     # Check that settings and handlers were added to the mock extension.
     assert isinstance(mock_extension.serverapp, ServerApp)
     assert len(mock_extension.handlers) > 0
@@ -53,7 +48,6 @@ def test_initialize(serverapp, mock_extension, template_dir):
     )
 )
 def test_instance_creation_with_argv(
-    serverapp,
     trait_name,
     trait_value,
     mock_extension,
@@ -62,10 +56,9 @@ def test_instance_creation_with_argv(
 
 
 def test_extensionapp_load_config_file(
-    extension_environ,
     config_file,
-    mock_extension,
     serverapp,
+    mock_extension,
 ):
     # Assert default config_file_paths is the same in the app and extension.
     assert mock_extension.config_file_paths == serverapp.config_file_paths

tests/extension/test_manager.py

@@ -7,6 +7,11 @@
     ExtensionModuleNotFound
 )
 
+# Use ServerApps environment because it monkeypatches
+# jupyter_core.paths and provides a config directory
+# that's not cross contaminating the user config directory.
+pytestmark = pytest.mark.usefixtures("environ")
+
 
 def test_extension_point_api():
     # Import mock extension metadata

tests/extension/test_serverextension.py

@@ -9,6 +9,12 @@
 from jupyter_server.config_manager import BaseJSONConfigManager
 
 
+# Use ServerApps environment because it monkeypatches
+# jupyter_core.paths and provides a config directory
+# that's not cross contaminating the user config directory.
+pytestmark = pytest.mark.usefixtures("environ")
+
+
 def test_help_output():
     check_help_all_output('jupyter_server.extension.serverextension')
     check_help_all_output('jupyter_server.extension.serverextension', ['enable'])

tests/extension/test_utils.py

@@ -2,6 +2,13 @@
 from jupyter_server.extension.utils import validate_extension
 
 
+# Use ServerApps environment because it monkeypatches
+# jupyter_core.paths and provides a config directory
+# that's not cross contaminating the user config directory.
+pytestmark = pytest.mark.usefixtures("environ")
+
+
+
 def test_validate_extension():
     # enabled at sys level
     assert validate_extension('tests.extension.mockextensions.mockext_sys')