Introduction of Java Notebooks and opening JShell support #464

Achal1607 · 2025-09-13T05:50:03Z

This PR introduces support for Java Notebooks with the file extension .ijnb.

Key Features

Interactive Java Notebooks (.ijnb):

Provides an interactive notebook experience for Java developers.
Can be opened in the context of a project, enabling seamless access to project dependencies and configuration.
Supports standard notebook features such as code cells, output rendering, and inline results.

JShell Integration:

Added the ability to open a JShell REPL in the context of a project.
Offers a powerful way to experiment with Java code snippets while leveraging the project's classpath and configuration.

Benefits

Enables rapid prototyping and exploration of Java code.
Simplifies learning and experimenting with Java features.
Provides a consistent developer experience within the VSCode environment.
The notebooks fully integrate with the workspace, ensuring that code execution is aware of the project context.
No external tools or configuration required beyond the existing Java extension setup.

Example Interface Image

sid-srini

Thanks a lot @Achal1607, @shivam71 and @subhash-arabhi for this new and useful feature. It is a lot of good work that you have added @Achal1607. 👍 💯
Please find some suggestions/thoughts on the user-visible text below.

THIRD_PARTY_LICENSES.txt

vscode/src/commands/notebook.ts

vscode/l10n/bundle.l10n.en.json

vscode/package.nls.json

nbcode/notebooks/nbproject/project.properties

nbcode/notebooks/src/org/netbeans/modules/nbcode/java/notebook/CellState.java

nbcode/notebooks/src/org/netbeans/modules/nbcode/java/notebook/NotebookUtils.java

nbcode/notebooks/src/org/netbeans/modules/nbcode/java/notebook/StreamingOutputStream.java

nbcode/notebooks/src/org/netbeans/modules/nbcode/java/project/CommandHandler.java

nbcode/notebooks/src/org/netbeans/modules/nbcode/java/project/ProjectConfigurationUtils.java

nbcode/notebooks/src/org/netbeans/modules/nbcode/java/project/ProjectContext.java

...ebooks/src/org/netbeans/modules/nbcode/java/project/ProjectModulePathConfigurationUtils.java

nbcode/notebooks/test/unit/src/org/netbeans/modules/nbcode/java/notebook/MockNbClient.java

vscode/package.json

patches/java-notebooks.diff

vscode/src/configurations/handlers.ts

patches/java-notebooks.diff

vscode/src/lsp/protocol.ts

vscode/src/notebooks/types.ts

vscode/src/lsp/listeners/requests/handlers.ts

nbcode/notebooks/src/org/netbeans/modules/nbcode/java/notebook/CellState.java

vscode/src/notebooks/kernel.ts

vscode/src/commands/notebook.ts

vscode/esbuild.js

oracle-contributor-agreement · 2025-09-24T14:59:01Z

Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA).
The following contributors of this PR have not signed the OCA:

subhashsubbu636@gmail.com (@subhash-arabhi)

To sign the OCA, please create an Oracle account and sign the OCA in Oracle's Contributor Agreement Application.

When signing the OCA, please provide your GitHub username. After signing the OCA and getting an OCA approval from Oracle, this PR will be automatically updated.

If you are an Oracle employee, please make sure that you are a member of the main Oracle GitHub organization, and your membership in this organization is public.

sid-srini

Thanks a lot. LGTM 👍

- registers support - save outputs - classpath option - code completions in the notebook - recovers from out-of-order cell state changes Note: notebooks module in nbcode

Uses RequestProcessor for async Jshell init and code eval

…g fixes.

- Structure validation using nbformat schema - Updated licenses and copyright - Added proper id to each cell - Added proper execution count - Added validation in serialization step - Added logs Co-authored-by: Achal Talati <achal.talati@oracle.com>

- added input output stream support - added streaming support of cell execution, enhanced output stream - added protocol for listening to cell execution notifications - added streaming support in the frontend for notebooks and improved kernel - added interrupt handler - added cellId to be passed in the cell execution request - added jshell context in the editor context - fixed issue of command truncation - improved code completion provider - fixed some build issues and bugs, e.g. init of configurations

- Corrected execution counter - Introduced mimeTypeHandler and executionSummary and refactored code - Added new commands to localisation english file - Added tests for mimeType and executionSummary of notebook code - New and unexecuted cells will not display success or failure

1. Added mock lsp client helper class 2. Added test for NotebookConfigs class 3. Updated test dependency in project.xml

- Added opening notebooks in context of a project - Also added change project context button in the notebook toolbar - Added few more tests - Added localization in notebooks - Fixed jshell flow and updated open jshell label - Other cleanup and fixes - updated netbeans patch - cleanup of some unused code and added license header to missing files - formatted files and removed unused imports - updated ajv to latest version: 8.17.1 - updated artifactory urls - fixed the execution status issue - removed console.log and replaced with standard extension logger

- Addressed review comments - Fixed some labels - Improvements to NotebookUtils for conversions between line-based positions and string offsets - Avoiding unnecessary string split and joins - Added unit tests - Notebook configurations related changes 1. Made classpath,modulepath and add modules configs as array type on frontend 2. Corresponding changes on backend to process the array 3. Updated notebook configs unit tests - Add enable-preview flag from the project context if not configured - Addressed minor gaps in notebook cell execution - Correctly printing the runtime errors stacktrace - Handling null output stream callback - Performing lineEnding normalization only where required in cell setContent. - Minor performance improvements Co-authored-by: Achal Talati <achal.talati@oracle.com> Co-authored-by: Shivam Madan <shivam.madan@oracle.com> Co-authored-by: Siddharth Srinivasan <siddharth.srinivasan@oracle.com>

Achal1607 added this to the JVSC 25.0.0 milestone Sep 13, 2025

Achal1607 requested a review from sid-srini September 13, 2025 05:50

oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Sep 13, 2025

sid-srini reviewed Sep 18, 2025

View reviewed changes

sid-srini reviewed Sep 19, 2025

View reviewed changes

sid-srini reviewed Sep 20, 2025

View reviewed changes

sid-srini reviewed Sep 23, 2025

View reviewed changes

vscode/esbuild.js Outdated Show resolved Hide resolved

Achal1607 force-pushed the final-java-notebook branch 2 times, most recently from 9f58b53 to 3b5947e Compare September 23, 2025 09:32

oracle-contributor-agreement bot added OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. and removed OCA Verified All contributors have signed the Oracle Contributor Agreement. labels Sep 24, 2025

Achal1607 force-pushed the final-java-notebook branch from 3365aea to 86827fc Compare September 29, 2025 09:33

sid-srini previously approved these changes Sep 29, 2025

View reviewed changes

Achal1607 and others added 10 commits September 30, 2025 15:36

Java notebooks added

6c6c3f2

- registers support - save outputs - classpath option - code completions in the notebook - recovers from out-of-order cell state changes Note: notebooks module in nbcode

Changes to support notebook configurations and handle the async tasks

802a895

Added opening JShell in project context functionality

513179f

Uses RequestProcessor for async Jshell init and code eval

Added notification for initializing java notebook kernel and minor bu…

875b219

…g fixes.

Refactoring notebook frontend code

9b871e8

Added notebook structure validation

6df9add

- Structure validation using nbformat schema - Updated licenses and copyright - Added proper id to each cell - Added proper execution count - Added validation in serialization step - Added logs Co-authored-by: Achal Talati <achal.talati@oracle.com>

Unit tests for notebook module

bba1c43

1. Added mock lsp client helper class 2. Added test for NotebookConfigs class 3. Updated test dependency in project.xml

Achal1607 dismissed sid-srini’s stale review via 8dac55b September 30, 2025 10:16

Achal1607 force-pushed the final-java-notebook branch from 86827fc to 8dac55b Compare September 30, 2025 10:16

sid-srini previously approved these changes Sep 30, 2025

View reviewed changes

Achal1607 dismissed sid-srini’s stale review via 8d8c621 September 30, 2025 11:05

Achal1607 force-pushed the final-java-notebook branch from 8dac55b to 8d8c621 Compare September 30, 2025 11:05

sid-srini previously approved these changes Sep 30, 2025

View reviewed changes

Achal1607 dismissed sid-srini’s stale review via d6197e5 September 30, 2025 12:14

Achal1607 force-pushed the final-java-notebook branch from 8d8c621 to d6197e5 Compare September 30, 2025 12:14

sid-srini previously approved these changes Sep 30, 2025

View reviewed changes

Achal1607 and others added 2 commits September 30, 2025 21:10

Adding notebooks-l10n translation support

160d5f1

Achal1607 dismissed sid-srini’s stale review via 160d5f1 September 30, 2025 15:41

Achal1607 force-pushed the final-java-notebook branch from d6197e5 to 160d5f1 Compare September 30, 2025 15:41

sid-srini approved these changes Sep 30, 2025

View reviewed changes

Introduction of Java Notebooks and opening JShell support #464

Are you sure you want to change the base?

Introduction of Java Notebooks and opening JShell support #464

Conversation

Achal1607 commented Sep 13, 2025

Key Features

Benefits

Example Interface Image

Uh oh!

sid-srini left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oracle-contributor-agreement bot commented Sep 24, 2025

Uh oh!

sid-srini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sid-srini left a comment •

edited

Loading