Skip to content

Commit e27be18

Browse files
dlqqqdlqqq
authored
Migrate Jupyternaut settings code (#2)
* migrate all frontend code & plugins * migrate all settings-related API handlers in backend * fix settings styles * fix lint * fix unit tests * skip browser check & e2e tests for now * bump to python 3.10
1 parent 52281e8 commit e27be18

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+7091
-213
lines changed

‎.github/workflows/build.yml‎

Lines changed: 130 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -15,143 +15,142 @@ jobs:
1515
runs-on: ubuntu-latest
1616

1717
steps:
18-
- name: Checkout
19-
uses: actions/checkout@v4
20-
21-
- name: Base Setup
22-
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
23-
24-
- name: Install dependencies
25-
run: python -m pip install -U "jupyterlab>=4.0.0,<5"
26-
27-
- name: Lint the extension
28-
run: |
29-
set -eux
30-
jlpm
31-
jlpm run lint:check
32-
33-
- name: Test the extension
34-
run: |
35-
set -eux
36-
jlpm run test
37-
38-
- name: Build the extension
39-
run: |
40-
set -eux
41-
python -m pip install .[test]
42-
43-
pytest -vv -r ap --cov jupyter_ai_jupyternaut
44-
jupyter server extension list
45-
jupyter server extension list 2>&1 | grep -ie "jupyter_ai_jupyternaut.*OK"
46-
47-
jupyter labextension list
48-
jupyter labextension list 2>&1 | grep -ie "@jupyter-ai/jupyternaut.*OK"
49-
python -m jupyterlab.browser_check
50-
51-
- name: Package the extension
52-
run: |
53-
set -eux
54-
55-
pip install build
56-
python -m build
57-
pip uninstall -y "jupyter_ai_jupyternaut" jupyterlab
58-
59-
- name: Upload extension packages
60-
uses: actions/upload-artifact@v4
61-
with:
62-
name: extension-artifacts
63-
path: dist/jupyter_ai_jupyternaut*
64-
if-no-files-found: error
18+
- name: Checkout
19+
uses: actions/checkout@v4
20+
21+
- name: Base Setup
22+
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
23+
24+
- name: Install dependencies
25+
run: python -m pip install -U "jupyterlab>=4.0.0,<5"
26+
27+
- name: Lint the extension
28+
run: |
29+
set -eux
30+
jlpm
31+
jlpm run lint:check
32+
33+
- name: Test the extension
34+
run: |
35+
set -eux
36+
jlpm run test
37+
38+
- name: Build the extension
39+
run: |
40+
set -eux
41+
python -m pip install .[test]
42+
43+
pytest -vv -r ap --cov jupyter_ai_jupyternaut
44+
jupyter server extension list
45+
jupyter server extension list 2>&1 | grep -ie "jupyter_ai_jupyternaut.*OK"
46+
47+
jupyter labextension list
48+
jupyter labextension list 2>&1 | grep -ie "@jupyter-ai/jupyternaut.*OK"
49+
# python -m jupyterlab.browser_check
50+
- name: Package the extension
51+
run: |
52+
set -eux
53+
54+
pip install build
55+
python -m build
56+
pip uninstall -y "jupyter_ai_jupyternaut" jupyterlab
57+
58+
- name: Upload extension packages
59+
uses: actions/upload-artifact@v4
60+
with:
61+
name: extension-artifacts
62+
path: dist/jupyter_ai_jupyternaut*
63+
if-no-files-found: error
6564

6665
test_isolated:
6766
needs: build
6867
runs-on: ubuntu-latest
6968

7069
steps:
71-
- name: Install Python
72-
uses: actions/setup-python@v5
73-
with:
74-
python-version: '3.9'
75-
architecture: 'x64'
76-
- uses: actions/download-artifact@v4
77-
with:
78-
name: extension-artifacts
79-
- name: Install and Test
80-
run: |
81-
set -eux
82-
# Remove NodeJS, twice to take care of system and locally installed node versions.
83-
sudo rm -rf $(which node)
84-
sudo rm -rf $(which node)
85-
86-
pip install "jupyterlab>=4.0.0,<5" jupyter_ai_jupyternaut*.whl
87-
88-
89-
jupyter server extension list
90-
jupyter server extension list 2>&1 | grep -ie "jupyter_ai_jupyternaut.*OK"
91-
92-
jupyter labextension list
93-
jupyter labextension list 2>&1 | grep -ie "@jupyter-ai/jupyternaut.*OK"
94-
python -m jupyterlab.browser_check --no-browser-test
95-
96-
integration-tests:
97-
name: Integration tests
98-
needs: build
99-
runs-on: ubuntu-latest
100-
101-
env:
102-
PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/pw-browsers
103-
104-
steps:
105-
- name: Checkout
106-
uses: actions/checkout@v4
107-
108-
- name: Base Setup
109-
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
110-
111-
- name: Download extension package
112-
uses: actions/download-artifact@v4
113-
with:
114-
name: extension-artifacts
115-
116-
- name: Install the extension
117-
run: |
118-
set -eux
119-
python -m pip install "jupyterlab>=4.0.0,<5" jupyter_ai_jupyternaut*.whl
120-
121-
- name: Install dependencies
122-
working-directory: ui-tests
123-
env:
124-
YARN_ENABLE_IMMUTABLE_INSTALLS: 0
125-
PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
126-
run: jlpm install
127-
128-
- name: Set up browser cache
129-
uses: actions/cache@v4
130-
with:
131-
path: |
132-
${{ github.workspace }}/pw-browsers
133-
key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }}
134-
135-
- name: Install browser
136-
run: |
137-
set -eux
138-
jlpm playwright install-deps
139-
jlpm playwright install chromium
140-
working-directory: ui-tests
141-
142-
- name: Execute integration tests
143-
working-directory: ui-tests
144-
run: |
145-
jlpm playwright test
146-
147-
- name: Upload Playwright Test report
148-
if: always()
149-
uses: actions/upload-artifact@v4
150-
with:
151-
name: jupyter_ai_jupyternaut-playwright-tests
152-
path: |
153-
ui-tests/test-results
154-
ui-tests/playwright-report
70+
- name: Install Python
71+
uses: actions/setup-python@v5
72+
with:
73+
python-version: '3.10'
74+
architecture: 'x64'
75+
- uses: actions/download-artifact@v4
76+
with:
77+
name: extension-artifacts
78+
- name: Install and Test
79+
run: |
80+
set -eux
81+
# Remove NodeJS, twice to take care of system and locally installed node versions.
82+
sudo rm -rf $(which node)
83+
sudo rm -rf $(which node)
84+
85+
pip install "jupyterlab>=4.0.0,<5" jupyter_ai_jupyternaut*.whl
86+
87+
88+
jupyter server extension list
89+
jupyter server extension list 2>&1 | grep -ie "jupyter_ai_jupyternaut.*OK"
90+
91+
jupyter labextension list
92+
jupyter labextension list 2>&1 | grep -ie "@jupyter-ai/jupyternaut.*OK"
93+
python -m jupyterlab.browser_check --no-browser-test
94+
95+
# integration-tests:
96+
# name: Integration tests
97+
# needs: build
98+
# runs-on: ubuntu-latest
99+
100+
# env:
101+
# PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/pw-browsers
102+
103+
# steps:
104+
# - name: Checkout
105+
# uses: actions/checkout@v4
106+
107+
# - name: Base Setup
108+
# uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
109+
110+
# - name: Download extension package
111+
# uses: actions/download-artifact@v4
112+
# with:
113+
# name: extension-artifacts
114+
115+
# - name: Install the extension
116+
# run: |
117+
# set -eux
118+
# python -m pip install "jupyterlab>=4.0.0,<5" jupyter_ai_jupyternaut*.whl
119+
120+
# - name: Install dependencies
121+
# working-directory: ui-tests
122+
# env:
123+
# YARN_ENABLE_IMMUTABLE_INSTALLS: 0
124+
# PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
125+
# run: jlpm install
126+
127+
# - name: Set up browser cache
128+
# uses: actions/cache@v4
129+
# with:
130+
# path: |
131+
# ${{ github.workspace }}/pw-browsers
132+
# key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }}
133+
134+
# - name: Install browser
135+
# run: |
136+
# set -eux
137+
# jlpm playwright install-deps
138+
# jlpm playwright install chromium
139+
# working-directory: ui-tests
140+
141+
# - name: Execute integration tests
142+
# working-directory: ui-tests
143+
# run: |
144+
# jlpm playwright test
145+
146+
# - name: Upload Playwright Test report
147+
# if: always()
148+
# uses: actions/upload-artifact@v4
149+
# with:
150+
# name: jupyter_ai_jupyternaut-playwright-tests
151+
# path: |
152+
# ui-tests/test-results
153+
# ui-tests/playwright-report
155154

156155
check_links:
157156
name: Check Links

‎conftest.py‎

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,62 @@
1+
from __future__ import annotations
2+
import asyncio
3+
from pathlib import Path
14
import pytest
5+
from traitlets.config import Config, LoggingConfigurable
6+
import logging
7+
from jupyter_server.services.contents.filemanager import AsyncFileContentsManager
8+
from typing import TYPE_CHECKING
9+
10+
if TYPE_CHECKING:
11+
from jupyter_server.serverapp import ServerApp
12+
213

314
pytest_plugins = ("pytest_jupyter.jupyter_server", )
415

516

617
@pytest.fixture
7-
def jp_server_config(jp_server_config):
8-
return {"ServerApp": {"jpserver_extensions": {"jupyter_ai_jupyternaut": True}}}
18+
def jp_server_config(jp_server_config, tmp_path):
19+
return Config({"ServerApp": {"jpserver_extensions": {"jupyter_ai_jupyternaut": True}}, "ContentsManager": {"root_dir": str(tmp_path)}})
20+
21+
22+
class MockJupyternautExtension(LoggingConfigurable):
23+
"""Mock AiExtension class for testing purposes."""
24+
25+
serverapp: ServerApp
26+
27+
def __init__(self, *args, serverapp: ServerApp, **kwargs):
28+
super().__init__(*args, **kwargs)
29+
self.serverapp = serverapp
30+
self._log = None
31+
32+
@property
33+
def log(self) -> logging.Logger:
34+
return self.serverapp.log
35+
36+
@property
37+
def event_loop(self) -> asyncio.AbstractEventLoop:
38+
return self.serverapp.io_loop.asyncio_loop
39+
40+
@property
41+
def contents_manager(self) -> AsyncFileContentsManager:
42+
return self.serverapp.contents_manager
43+
44+
45+
@pytest.fixture
46+
def mock_extension(jp_server_config, jp_configurable_serverapp) -> MockJupyternautExtension:
47+
"""
48+
Returns a mocked `JupyternautExtension` object that can be passed as the
49+
`parent` argument to objects normally initialized by `JupyternautExtension`.
50+
This should be passed to the "manager singletons" like `ConfigManager` and
51+
`EnvSecretsManager`.
52+
53+
See `MockJupyternautExtension` in `conftest.py` for a complete description of the
54+
attributes, properties, and methods available. If something is missing,
55+
please feel free to add to it in your PR.
56+
57+
Returns:
58+
A `MockAiExtension` instance that can be passed as the `parent` argument
59+
to objects normally initialized by `AiExtension`.
60+
"""
61+
serverapp = jp_configurable_serverapp()
62+
return MockJupyternautExtension(config=jp_server_config, serverapp=serverapp)

‎jupyter_ai_jupyternaut/__init__.py‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import warnings
88
warnings.warn("Importing 'jupyter_ai_jupyternaut' outside a proper installation.")
99
__version__ = "dev"
10-
from .handlers import setup_handlers
10+
from .extension_app import JupyternautExtension
1111

1212

1313
def _jupyter_labextension_paths():
@@ -19,18 +19,6 @@ def _jupyter_labextension_paths():
1919

2020
def _jupyter_server_extension_points():
2121
return [{
22-
"module": "jupyter_ai_jupyternaut"
22+
"module": "jupyter_ai_jupyternaut",
23+
"app": JupyternautExtension
2324
}]
24-
25-
26-
def _load_jupyter_server_extension(server_app):
27-
"""Registers the API handler to receive HTTP requests from the frontend extension.
28-
29-
Parameters
30-
----------
31-
server_app: jupyterlab.labapp.LabApp
32-
JupyterLab application instance
33-
"""
34-
setup_handlers(server_app.web_app)
35-
name = "jupyter_ai_jupyternaut"
36-
server_app.log.info(f"Registered {name} server extension")

‎jupyter_ai_jupyternaut/config/__init__.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
from .config_models import *
2+
from .config_manager import ConfigManager
3+
from .config_rest_api import ConfigRestAPI

0 commit comments

Comments
 (0)