Skip to content

Commit 12182e1

Browse files
DonJayamanneDonJayamanne
authored
Merge branch 'main' into don/rear-squid
2 parents c49880f + 9bfda48 commit 12182e1

Some content is hidden

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

43 files changed

+709
-576
lines changed

‎.github/actions/create-venv-for-tests/action.yml‎

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ outputs:
1515
runs:
1616
using: 'composite'
1717
steps:
18+
- name: Install uv
19+
uses: astral-sh/setup-uv@v6
20+
1821
# Used by tests for installation of ipykernel.
1922
# Create a venv & register it as a kernel.
2023
# These tests are slow hence will only run on linux.
@@ -24,27 +27,26 @@ runs:
2427
- name: Create virtual environment without ipykernel
2528
if: inputs.IPyWidgetVersion == '7'
2629
run: |
27-
python -m venv .venvnoreg
28-
29-
python -m venv .venvkernel
30+
uv venv .venvnoreg
31+
uv venv .venvkernel
32+
source .venvnoreg/bin/activate
33+
uv pip install pip
3034
source .venvkernel/bin/activate
3135
python --version
3236
python -c "import sys;print(sys.executable)"
33-
python -m pip install ipykernel
37+
uv pip install pip
38+
uv pip install ipykernel
3439
python -m ipykernel install --user --name .venvkernel --display-name .venvkernel
35-
python -m pip uninstall jedi --yes
36-
python -m pip install jedi==0.17.2
37-
python -m pip install pandas
38-
python -m pip install ipywidgets==7.7.2
40+
uv pip install pandas
41+
uv pip install ipywidgets==7.7.2
3942
40-
python -m venv .venvnokernel
43+
uv venv .venvnokernel
4144
source .venvnokernel/bin/activate
4245
python --version
4346
python -c "import sys;print(sys.executable)"
44-
python -m pip install ipykernel
47+
uv pip install pip
48+
uv pip install ipykernel
4549
python -m ipykernel install --user --name .venvnokernel --display-name .venvnokernel
46-
python -m pip uninstall jedi --yes
47-
python -m pip install jedi==0.17.2
4850
working-directory: src/test/datascience
4951
shell: bash
5052
# Used by tests for installation of ipykernel.
@@ -56,26 +58,25 @@ runs:
5658
- name: Create virtual environment without ipykernel (ipywidgets 8)
5759
if: inputs.IPyWidgetVersion == '8'
5860
run: |
59-
python -m venv .venvnoreg
60-
61-
python -m venv .venvkernel
61+
uv venv .venvnoreg
62+
uv venv .venvkernel
63+
source .venvnoreg/bin/activate
64+
uv pip install pip
6265
source .venvkernel/bin/activate
6366
python --version
6467
python -c "import sys;print(sys.executable)"
65-
python -m pip install ipykernel
68+
uv pip install pip
69+
uv pip install ipykernel
6670
python -m ipykernel install --user --name .venvkernel --display-name .venvkernel
67-
python -m pip uninstall jedi --yes
68-
python -m pip install jedi==0.17.2
69-
python -m pip install pandas
70-
python -m pip install ipywidgets -U
71+
uv pip install pandas
72+
uv pip install ipywidgets -U
7173
72-
python -m venv .venvnokernel
74+
uv venv .venvnokernel
7375
source .venvnokernel/bin/activate
7476
python --version
7577
python -c "import sys;print(sys.executable)"
76-
python -m pip install ipykernel
78+
uv pip install pip
79+
uv pip install ipykernel
7780
python -m ipykernel install --user --name .venvnokernel --display-name .venvnokernel
78-
python -m pip uninstall jedi --yes
79-
python -m pip install jedi==0.17.2
8081
working-directory: src/test/datascience
8182
shell: bash

‎.github/chatmodes/bugfix.chatmode.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
description: Plan to fix a bug
3+
tools: ['codebase', 'editFiles', 'fetch', 'findTestFiles', 'problems', 'runTasks', 'runTests', 'search', 'terminalLastCommand', 'testFailure', 'usages', 'vscodeAPI', 'github', 'get_issue', 'get_issue_comments', 'get_me', 'copilotCodingAgent']
4+
---
5+
# Bug fixing mode instructions
6+
You are an expert (TypeScript and Python) software engineer tasked with fixing a bug in the codebase.
7+
Your goal is to prepare a detailed plan to fix the bug, for this you first need to:
8+
* Understand the context of the bug by reading the issue description and comments.
9+
* Understand the codebase by reading the relevant instruction files.
10+
* Identify the root cause of the bug, and explain this to the user.
11+
12+
Based on your above understanding generate a plan to fix the bug.
13+
Ensure the plan consists of a Markdown document that has the following sections:
14+
15+
* Overview: A brief description of the bug.
16+
* Root Cause: A detailed explanation of the root cause of the bug, including any relevant code snippets or references to the codebase.
17+
* Requirements: A list of requirements to resolve the bug.
18+
* Implementation Steps: A detailed list of steps to implement the bug fix.
19+
20+
Finally prompt the user if they would like to proceed with the implementation of the bug fix.
21+
Remember, do not make any code edits, just generate a plan.
22+
When implementing the fix, ensure to add unit tests to verify the fix.

‎.github/copilot-instructions.md‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ src/ # Source code for the extension
8787
└── test/ # Integration, unit and end-to-end tests
8888
```
8989

90-
### Component Instructions
90+
### Component-Specific Instructions
9191

92-
**IMPORTANT**: Before modifying code in directories below, you **MUST** read the corresponding instruction file(s).
92+
**IMPORTANT**: Before modifying any code in the directories listed below, you **MUST** first read the corresponding instruction file to understand the specific conventions, patterns, and architectural requirements for that component.
9393

9494
Each component has detailed guidelines that cover:
9595
- Architecture patterns and design principles
@@ -99,17 +99,18 @@ Each component has detailed guidelines that cover:
9999
- Error handling approaches
100100
- Component-specific best practices
101101

102-
103-
| Directory | Instruction File | Purpose |
104-
|-----------|------------------|---------|
105-
| `src/platform/**` | `.github/instructions/platform.instructions.md` | Cross-platform abstractions |
106-
| `src/kernels/**` | `.github/instructions/kernel.instructions.md` | Kernel management |
107-
| `src/kernels/jupyter/**` | `.github/instructions/kernel-jupyter.instructions.md` | Jupyter protocol |
108-
| `src/notebooks/**` | `.github/instructions/notebooks.instructions.md` | Notebook controllers |
109-
| `src/interactive-window/**` | `.github/instructions/interactiveWindow.instructions.md` | REPL functionality |
110-
| `src/standalone/**` | `.github/instructions/standalone.instructions.md` | Standalone features |
111-
| `src/notebooks/controllers/ipywidgets/**` | `.github/instructions/ipywidgets.instructions.md` | IPython widgets (interactive Notebook outputs) |
112-
| `src/webviews/extension-side/ipywidgets/**` | `.github/instructions/ipywidgets.instructions.md` | IPython Widget (interactive Notebook outputs) communication |
113-
| `src/webviews/webview-side/ipywidgets/**` | `.github/instructions/ipywidgets.instructions.md` | IPython Widget (interactive Notebook outputs) rendering |
114-
115-
**For AI/Copilot**: Always read the relevant instruction file(s) before modifying code in these directories to ensure adherence to component-specific patterns.
102+
#### Required Reading by Directory
103+
104+
| Directory/Component | Instruction File | When to Read |
105+
|-------------------|------------------|--------------|
106+
| `src/platform/**` | `.github/instructions/platform.instructions.md` | Before working with cross-platform abstractions, utilities, or core services |
107+
| `src/kernels/**` | `.github/instructions/kernel.instructions.md` | Before modifying kernel management, execution, or communication logic |
108+
| `src/kernels/jupyter/**` | `.github/instructions/kernel-jupyter.instructions.md` | Before working with Jupyter protocol implementation or Jupyter-specific features |
109+
| `src/notebooks/**` | `.github/instructions/notebooks.instructions.md` | Before modifying notebook controllers, editing, or management features |
110+
| `src/interactive-window/**` | `.github/instructions/interactiveWindow.instructions.md` | Before working with Python Interactive window (REPL) functionality |
111+
| `src/standalone/**` | `.github/instructions/standalone.instructions.md` | Before modifying standalone mode or isolated execution features |
112+
| `src/notebooks/controllers/ipywidgets/**` | `.github/instructions/ipywidgets.instructions.md` | Before working with IPython widget support |
113+
| `src/webviews/extension-side/ipywidgets/**` | `.github/instructions/ipywidgets.instructions.md` | Before modifying extension-side widget communication |
114+
| `src/webviews/webview-side/ipywidgets/**` | `.github/instructions/ipywidgets.instructions.md` | Before working with frontend widget rendering |
115+
116+
**For AI/Copilot**: Always use the `read_file` tool to read the relevant instruction file(s) before analyzing, modifying, or creating code in these directories. This ensures adherence to component-specific patterns and prevents architectural violations.

‎.github/instructions/typescript.instructions.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,23 @@ const mockInstance = mock<YourType>();
2929
mockInstance.then = undefined; // Ensure 'then' is undefined to prevent hanging
3030
```
3131

32+
## Integration Tests
33+
These tests can be a little slow as VS Code needs to be downloaded and launched.
34+
- Use `npm run test:integration` to run integration tests with local Jupyter Kernels (add `-- -- --grep <pattern>` to filter tests, pay attention to the prefix `-- --`)
35+
- Use `npm run test:integration:web` to run integration tests with Remote Jupyter Kernels and VSCode in browser (`--grep` is not supported)
36+
37+
3238
## Scripts
3339
- Use `npm install` to install dependencies if you changed `package.json`
34-
- Use `npm run test:unittests` for unit tests (add `--grep <pattern>` to filter tests)
40+
- Use `npm run test:unittests` for unit tests (add `-- -- --grep <pattern>` to filter tests, pay attention to the prefix `-- --`)
41+
- Use `npm run test:integration` to run integration tests with local Jupyter Kernels (add `-- -- --grep <pattern>` to filter tests, pay attention to the prefix `-- --`)
42+
- Use `npm run test:integration:web` to run integration tests with Remote Jupyter Kernels and VSCode in browser (`--grep` is not supported)
3543
- Use `npm run lint` to check for linter issues
3644
- Use `npm run format` to check code style
3745
- Use `npm run format-fix` to auto-fix formatting issues
46+
47+
## PreCommit
48+
Always run the following scripts before committing changes:
49+
- `npm run format-fix` to ensure proper code formatting
50+
- `npm run lint` to check for linter issues and attempt to fix before committing.
51+
- `npm run test:unittests` to check for tests failures and attempt to fix before committing.

‎.github/workflows/build-test.yml‎

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ jobs:
146146
run: npm run postinstall
147147

148148
- name: Verify Translation files
149-
run: npm run validateTranslationFiles
149+
run: npx gulp validateTranslationFiles
150150

151151
- name: Run linting on TypeScript code (eslint)
152152
run: npm run lint
@@ -166,8 +166,8 @@ jobs:
166166
python -m black . --check
167167
working-directory: pythonFiles
168168

169-
- name: Run gulp prePublishNonBundle
170-
run: npm run prePublishNonBundle
169+
- name: Compile
170+
run: npm run compile
171171

172172
- name: Check dependencies
173173
run: npm run checkDependencies
@@ -176,7 +176,7 @@ jobs:
176176
run: npx gulp validatePackageLockJson
177177

178178
- name: Validate TELEMETRY files
179-
run: npm run validateTelemetry
179+
run: npx gulp validateTelemetry
180180

181181
- name: Verify usage of new Proposed API
182182
if: github.event_name == 'pull_request'
@@ -249,15 +249,15 @@ jobs:
249249
run: npm run postinstall
250250

251251
- name: Compile if not cached
252-
run: npm run prePublishNonBundle
252+
run: npm run compile
253253
if: steps.out-cache.outputs.cache-hit != 'true'
254254

255255
- name: Run TypeScript unit tests
256256
id: test_unittests
257257
run: npm run test:unittests
258258

259259
- name: Verify there are no unhandled errors
260-
run: npm run verifyUnhandledErrors
260+
run: npx gulp verifyUnhandledErrors
261261

262262
vscodeTests:
263263
name: Tests # These tests run with Python extension & real Jupyter
@@ -592,7 +592,7 @@ jobs:
592592

593593
# This step is slow.
594594
- name: Compile # if not cached
595-
run: npm run prePublishNonBundle
595+
run: npm run compile
596596
# Do not cache for web tests, as the code generated in the compiled code is different for each matrix in web tests
597597
# Rememeber the compiled code contains injected tests, and the injected tests are different for each matrix in the web
598598
# if: steps.out-cache.outputs.cache-hit != 'true' && matrix.jupyterConnection != 'web'
@@ -659,7 +659,7 @@ jobs:
659659
- name: Run Native Notebook with VSCode & Jupyter (ubuntu)
660660
uses: GabrielBB/xvfb-action@b706e4e27b14669b486812790492dc50ca16b465 # v1.7
661661
with:
662-
run: ${{ env.xvfbCommand }} npm run testNativeNotebooksInVSCode
662+
run: ${{ env.xvfbCommand }} npm run test:integration
663663
env:
664664
VSC_JUPYTER_FORCE_LOGGING: 1
665665
VSC_PYTHON_FORCE_LOGGING: 1
@@ -676,13 +676,11 @@ jobs:
676676
- name: Run Notebook Perf Test Without Jupyter
677677
uses: GabrielBB/xvfb-action@b706e4e27b14669b486812790492dc50ca16b465 # v1.7
678678
with:
679-
run: ${{ env.xvfbCommand }} npm run testPerfInVSCode
679+
run: ${{ env.xvfbCommand }} npm run test:performance:notebook
680680
env:
681681
VSC_JUPYTER_FORCE_LOGGING: 1
682682
VSC_PYTHON_FORCE_LOGGING: 1
683683
VSC_JUPYTER_CI_RUN_NON_PYTHON_NB_TEST: 1
684-
VSC_JUPYTER_PERF_TEST: ${{ matrix.matrix == '@notebookPerformance' }}
685-
VSC_JUPYTER_NOTEBOOK_PERF_TEST: ${{ matrix.matrix == '@notebookPerformance' }}
686684
VSC_JUPYTER_CI_TEST_DO_NOT_INSTALL_PYTHON_EXT: ${{ matrix.matrix == '@notebookPerformance' }}
687685
VSC_JUPYTER_REMOTE_NATIVE_TEST: ${{ matrix.jupyterConnection == 'remote' }}
688686
VSC_JUPYTER_NON_RAW_NATIVE_TEST: ${{ matrix.jupyterConnection == 'local' }}
@@ -696,12 +694,11 @@ jobs:
696694
- name: Run Execution Perf Test With Jupyter
697695
uses: GabrielBB/xvfb-action@b706e4e27b14669b486812790492dc50ca16b465 # v1.7
698696
with:
699-
run: ${{ env.xvfbCommand }} npm run testExecPerfInVSCode
697+
run: ${{ env.xvfbCommand }} npm run test:performance:execution
700698
env:
701699
VSC_JUPYTER_FORCE_LOGGING: 1
702700
VSC_PYTHON_FORCE_LOGGING: 1
703701
VSC_JUPYTER_CI_RUN_NON_PYTHON_NB_TEST: 1
704-
VSC_JUPYTER_PERF_TEST: ${{ matrix.matrix == '@executionPerformance' }}
705702
VSC_JUPYTER_REMOTE_NATIVE_TEST: ${{ matrix.jupyterConnection == 'remote' }}
706703
VSC_JUPYTER_NON_RAW_NATIVE_TEST: ${{ matrix.jupyterConnection == 'local' }}
707704
VSC_JUPYTER_CI_RUN_JAVA_NB_TEST: ${{ matrix.python == 'conda' }}
@@ -720,7 +717,7 @@ jobs:
720717
- name: Run Native Notebook with VSCode & Jupyter (web)
721718
uses: GabrielBB/xvfb-action@b706e4e27b14669b486812790492dc50ca16b465 # v1.7
722719
with:
723-
run: npm run testWebExtension
720+
run: npm run test:integration:web
724721
env:
725722
VSC_JUPYTER_FORCE_LOGGING: 1
726723
VSC_PYTHON_FORCE_LOGGING: 1
@@ -735,8 +732,9 @@ jobs:
735732
if: matrix.python != 'noPython' && matrix.os == 'ubuntu-latest' && matrix.jupyterConnection == 'web'
736733

737734
- name: Run Native Notebook with VSCode & Jupyter (windows)
735+
# Running tests on Windows is verys low, hence run only a few of the tests.
738736
run: |
739-
npm run testNativeNotebooksInVSCodeWithoutTestSuffix
737+
npm run test:integration:windows
740738
env:
741739
VSC_JUPYTER_FORCE_LOGGING: 1
742740
VSC_PYTHON_FORCE_LOGGING: 1
@@ -754,7 +752,7 @@ jobs:
754752
- name: Run Native Notebook with VSCode & Jupyter (without Python)
755753
uses: GabrielBB/xvfb-action@b706e4e27b14669b486812790492dc50ca16b465 # v1.7
756754
with:
757-
run: ${{ env.xvfbCommand }} npm run testNativeNotebooksWithoutPythonInVSCode
755+
run: ${{ env.xvfbCommand }} npm run test:integration:nonpython
758756
env:
759757
VSC_JUPYTER_FORCE_LOGGING: 1
760758
VSC_JUPYTER_CI_RUN_NON_PYTHON_NB_TEST: 1
@@ -773,7 +771,7 @@ jobs:
773771

774772
- name: Log test results
775773
if: always()
776-
run: npm run printTestResults
774+
run: npx gulp printTestResults
777775

778776
- name: Upload test result, screenshots files
779777
uses: actions/upload-artifact@v4
@@ -784,7 +782,7 @@ jobs:
784782
retention-days: 60
785783

786784
- name: Verify there are no unhandled errors
787-
run: npm run verifyUnhandledErrors
785+
run: npx gulp verifyUnhandledErrors
788786

789787
smoke-tests:
790788
timeout-minutes: 30
@@ -857,4 +855,4 @@ jobs:
857855
VSC_JUPYTER_CI_TEST_VSC_CHANNEL: 'insiders'
858856
uses: GabrielBB/xvfb-action@b706e4e27b14669b486812790492dc50ca16b465 # v1.7
859857
with:
860-
run: npm run testSmokeLogged
858+
run: npm run test:smoke

‎.github/workflows/copilot-setup-steps.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,14 @@ jobs:
7272
echo "Playwright not found, skipping browser installation"
7373
fi
7474
continue-on-error: true
75+
76+
- name: Install uv
77+
uses: astral-sh/setup-uv@v6
78+
79+
- name: Setup Venv
80+
run: |
81+
uv venv
82+
source .venv/bin/activate
83+
uv pip install pip
84+
uv pip install -r build/venv-test-ipywidgets8-requirements.txt
85+
uv pip install jupyter notebook ipykernel

0 commit comments

Comments
 (0)