Upgrade Ωedit™ to v2.0.0 by scholarsmate · Pull Request #1668 · apache/daffodil-vscode

scholarsmate · 2026-04-17T19:45:18Z

Closes: #1667

Enhancement Request: Upgrade Ωedit™ to v2.0.0

Summary

updated the data editor to the Ωedit™ 2.x client APIs, including heartbeat and viewport subscription helpers
adjusted server metrics and packaging to the new native runtime fields and @omega-edit/server/out layout
refreshed the Ωedit™ test startup call sites for the 2.x startServer(..., { logConfigFile }) signature

Details

Ωedit™ v2.0.0 changes the client/server package layout and several APIs. This PR aligns the VS Code extension with the migration guide and the new helper APIs so we can validate the upgrade in CI.

keeps the data editor building and packaging against the v2.0.0 release
updates the runtime metrics surfaced in the UI to match the new server fields
ensures the packaged VSIX includes the server binaries from the new out/ directory structure

Review Instructions:

yarn install
yarn compile
yarn test:svelte
yarn vite:pkg
yarn package
Install the .vsix and manual run through of the data editor features in the extension, including:
- opening a data editor and confirming it loads successfully
- confirming the server info shows the new heartbeat messages
- confirming the file type information in the profile view is correct
- confirming the server shuts down after the idle timeout when no editor is open
- confirming search and replace features work as expected with the new client APIs
- confirming the viewport subscription helper correctly updates the visible range in the UI as we scroll
- others as needed to validate the upgrade and new features

Wiki:

I have determined that no documentation updates are needed for these changes

Copilot

Pull request overview

Upgrades the VS Code data editor integration to Ωedit™ v2.0.0, updating client/server APIs, packaging/runtime layout, and the webview↔extension message contract to match the new server/heartbeat/viewport behaviors.

Changes:

Bump Ωedit™ dependencies to 2.0.0 and adapt server start/heartbeat/viewport subscription flows to new helper APIs.
Update webview messaging/metrics fields for the new native runtime heartbeat payload and byte transport format.
Rework packaging so the VSIX includes Ωedit™ runtime bits from the new @omega-edit/server/out layout and syncs the Ωedit™ client runtime into dist/package.

Reviewed changes

Copilot reviewed 22 out of 23 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
yarn.lock	Locks Ωedit™ client/server v2.0.0 and new transitive deps (protobuf-ts, pino updates).
vite.config.mjs	Copies new server `out/` layout and marks `@omega-edit/client` as an external runtime dependency.
src/utils.ts	Changes default data editor log file setting to empty (meaning “use default/app-data path”).
src/tests/suite/utils.test.ts	Aligns expected default config with empty log file setting.
src/tests/suite/omegaEditClientLogger.test.ts	Adds coverage ensuring Ωedit™ client logger can be required/used without explicit setup.
src/tests/suite/dataEditor.test.ts	Updates `startServer` call signature and adds test covering server idle session reaping / shutdown behavior.
src/svelte/src/utilities/message.ts	Adds `webviewReady` command for extension↔webview synchronization.
src/svelte/src/components/dataEditor.svelte	Updates byte payloads to arrays and adjusts viewport refresh decoding for v2 message shape.
src/svelte/src/components/ServerMetrics/ServerMetrics.svelte	Updates heartbeat field names for native runtime metrics and fixes uptime string formatting.
src/svelte/src/components/DataDisplays/CustomByteDisplay/DataLineFeed.svelte	Sends selection bytes as arrays for message serialization compatibility.
src/svelte/src/App.svelte	Sends `webviewReady` on mount and adjusts byte payload handling for apply/viewport refresh.
src/dataEditor/svelteWebviewInitializer.ts	Fixes nonce replacement and restructures HTML loading/injection logic.
src/dataEditor/include/server/heartbeat/index.ts	Replaces manual interval heartbeat polling with v2 heartbeat loop helper.
src/dataEditor/include/server/heartbeat/HeartBeatInfo.ts	Updates heartbeat model fields to v2 native memory metrics.
src/dataEditor/include/server/Sessions.ts	Removes client-driven server stop; adds resilience for “server already stopped” session cleanup.
src/dataEditor/include/server/ServerInfo.ts	Updates runtime metadata fields to v2 (runtime/platform/compiler/build info).
src/dataEditor/dataEditorClient.ts	Major v2 API migration: server lifecycle options, viewport subscription helper, byte serialization helpers, webview resync + ready handshake, logging tweaks.
src/dataEditor/config/Extract.ts	Updates defaults to v2 log/checkpoint path helpers; fixes port keyword substitution to string.
src/dataEditor/config/Config.ts	Adds log file normalization helpers and default log/checkpoint path helpers by port.
package.json	Pins Ωedit™ deps to 2.0.0, updates packaging pipeline, adds postinstall runtime patch hook, updates config defaults and activation event.
build/yarn-scripts.ts	Adds Ωedit™ runtime patching + runtime sync + VSIX packaging helper; changes `.vscodeignore` generation.
build/package/NONOTICE	Adds notice entry for `@protobuf-ts/runtime-rpc`.
build/package/LICENSE	Adds license entries for protobuf-ts runtime and `@pinojs/redact`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 24 out of 25 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 24 out of 25 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- updated the data editor to the Ωedit™ 2.x client APIs, including heartbeat and viewport subscription helpers - adjusted server metrics and packaging to the new native runtime fields and `@omega-edit/server/out` layout - refreshed the Ωedit™ test startup call sites for the 2.x `startServer(..., { logConfigFile })` signature Ωedit™ `v2.0.0` changes the client/server package layout and several APIs. This PR aligns the VS Code extension with the migration guide and the new helper APIs so we can validate the upgrade in CI. - keeps the data editor building and packaging against the RC release - updates the runtime metrics surfaced in the UI to match the new server fields - ensures the packaged VSIX includes the server binaries from the new `out/` directory structure - `yarn install` - `yarn compile` - `yarn test:svelte` - `yarn vite:pkg` - `yarn package` - Manual run through of the data editor features in the extension, including: - opening a data editor and confirming it loads successfully - confirming the server info shows the new heartbeat messages - confirming the file type information in the profile view is correct - confirming the server shuts down after the idle timeout when no editor is open - confirming search and replace features work as expected with the new client APIs - confirming the viewport subscription helper correctly updates the visible range in the UI as we scroll - others _as needed_ to validate the upgrade and new features - [x] I have determined that no documentation updates are needed for these changes Closes: apache#1667

Copilot

Pull request overview

Copilot reviewed 24 out of 25 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

stricklandrbls · 2026-04-23T00:59:01Z

Getting the following output in the VSCode debugger output when pressing the Profile button. This was after deleting a single byte.

rejected promise not handled within 1 second: Error: profileSession error: 2 UNKNOWN: Profile function failed with error code: -1
extensionHostProcess.js:615
stack trace: Error: profileSession error: 2 UNKNOWN: Profile function failed with error code: -1
extensionHostProcess.js:615
	at makeWrappedError (./daffodil-vscode/node_modules/@omega-edit/client/dist/cjs/protobuf_ts/utils.js:58:21)
extensionHostProcess.js:615
	at Object.callback (./daffodil-vscode/node_modules/@omega-edit/client/dist/cjs/protobuf_ts/session.js:643:64)
extensionHostProcess.js:615
	at Object.onReceiveStatus (./daffodil-vscode/node_modules/@grpc/grpc-js/build/src/client.js:193:36)
extensionHostProcess.js:615
	at Object.onReceiveStatus (./daffodil-vscode/node_modules/@grpc/grpc-js/build/src/client-interceptors.js:360:141)
extensionHostProcess.js:615
	at Object.onReceiveStatus (./daffodil-vscode/node_modules/@grpc/grpc-js/build/src/client-interceptors.js:323:181)
extensionHostProcess.js:615
	at ./daffodil-vscode/node_modules/@grpc/grpc-js/build/src/resolving-call.js:129:78
extensionHostProcess.js:615
	at process.processTicksAndRejections (node:internal/process/task_queues:84:11)

scholarsmate · 2026-04-23T20:00:00Z

@stricklandrbls, thanks for testing that. I'll try to reproduce it and get it fixed. We'll want to hit this pretty hard and find edge cases and if the problem(s) are on the Ωedit™ side, I'll cover any/all regressions with unit tests there and push out a bug fix release.

stricklandrbls · 2026-04-24T14:14:51Z

Getting this different error output to the debug console when attempting to profile:

rejected promise not handled within 1 second: Error: profileSession error: 8 RESOURCE_EXHAUSTED: Bandwidth exhausted or memory limit exceeded
extensionHostProcess.js:176
stack trace: Error: profileSession error: 8 RESOURCE_EXHAUSTED: Bandwidth exhausted or memory limit exceeded
	at makeWrappedError (/<path>/<to>/daffodil-vscode/node_modules/@omega-edit/client/dist/cjs/protobuf_ts/utils.js:58:21)
	at Object.callback (/<path>/<to>/daffodil-vscode/node_modules/@omega-edit/client/dist/cjs/protobuf_ts/session.js:643:64)
	at Object.onReceiveStatus (/<path>/<to>/daffodil-vscode/node_modules/@grpc/grpc-js/build/src/client.js:193:36)
	at Object.onReceiveStatus (/<path>/<to>/daffodil-vscode/node_modules/@grpc/grpc-js/build/src/client-interceptors.js:360:141)
	at Object.onReceiveStatus (/<path>/<to>/daffodil-vscode/node_modules/@grpc/grpc-js/build/src/client-interceptors.js:323:181)
	at /<path>/<to>/daffodil-vscode/node_modules/@grpc/grpc-js/build/src/resolving-call.js:129:78
	at process.processTicksAndRejections (node:internal/process/task_queues:77:11)

scholarsmate · 2026-04-24T14:57:32Z

@stricklandrbls, can you give me details on the file you're attempting to profile and how you're profiling it (e.g., are you using a range)? I've been using large images from the Webb telescope because they are big (100+MB PNG) and binary (and beautiful) to test the data editor. For smaller files, I load misc source files, and the .vsix file itself. Based on this finding, I may consider adding some scaling tests on the Ωedit™ side to test the limits of the core library and gRPC. Ωedit™ ought to be able to handle any size file given a proportional amount of time. The gRPC profile is surprising because it's just handling coordinates and counts, nothing that would be considered resource intensive.

stricklandrbls · 2026-04-24T15:33:22Z

@scholarsmate - I found it's unrelate to this PR. I had an old version of OE still running as a process from a previous run.

scholarsmate · 2026-04-24T18:36:57Z

@stricklandrbls, you're really emphasizing the importance of the new Ωedit™ v2 lifecycle management.

stricklandrbls · 2026-04-24T23:48:20Z

@stricklandrbls, you're really emphasizing the importance of the new Ωedit™ v2 lifecycle management.

Gotta love it!

In other words, I think that this might be fixed due to the changes to the message registry pr. Copilot was actually useful and noticed a property misspelling that may have been causing the OE server to bomb out

I'll try rebasing those changes with this PR to see it it's resolved.

scholarsmate · 2026-05-01T16:01:48Z

@stricklandrbls, how's testing going?

stricklandrbls · 2026-05-01T17:25:25Z

@stricklandrbls, how's testing going?

Hadn't had much of a chance lately due to a surgery but I'm planning to hop on here in a bit to test it out!

scholarsmate requested a review from stricklandrbls April 17, 2026 19:45

scholarsmate self-assigned this Apr 17, 2026

scholarsmate added enhancement New feature or request dependencies Pull requests that update a dependency file build Issues related to building of the code typescript data editor Issues related to the Data Editor capability labels Apr 17, 2026

scholarsmate added this to daffodil-vscode v1.6.0 Apr 17, 2026

scholarsmate added this to the 1.6.0 milestone Apr 17, 2026

scholarsmate moved this to In Review in daffodil-vscode v1.6.0 Apr 17, 2026

scholarsmate requested review from CoverRyan and Copilot April 17, 2026 19:47

Copilot started reviewing on behalf of scholarsmate April 17, 2026 19:47 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

Comment thread src/dataEditor/dataEditorClient.ts

Comment thread src/tests/suite/dataEditor.test.ts Outdated

Comment thread package.json Outdated

Comment thread build/yarn-scripts.ts Outdated

Comment thread build/yarn-scripts.ts

scholarsmate force-pushed the omega-edit-v2-upgrade branch from 04255ff to b41f4a1 Compare April 17, 2026 20:15

scholarsmate marked this pull request as draft April 17, 2026 20:31

scholarsmate force-pushed the omega-edit-v2-upgrade branch from b41f4a1 to cbae7b9 Compare April 17, 2026 22:24

scholarsmate marked this pull request as ready for review April 18, 2026 02:30

scholarsmate requested a review from Copilot April 18, 2026 02:31

Copilot started reviewing on behalf of scholarsmate April 18, 2026 02:31 View session

Copilot AI reviewed Apr 18, 2026

View reviewed changes

Comment thread src/dataEditor/include/server/ServerInfo.ts Outdated

Comment thread build/yarn-scripts.ts

scholarsmate force-pushed the omega-edit-v2-upgrade branch from cbae7b9 to f9a0bc8 Compare April 18, 2026 02:47

scholarsmate requested a review from Copilot April 18, 2026 02:48

Copilot started reviewing on behalf of scholarsmate April 18, 2026 02:48 View session

Copilot AI reviewed Apr 18, 2026

View reviewed changes

Comment thread src/dataEditor/dataEditorClient.ts Outdated

Comment thread src/svelte/src/App.svelte Outdated

Comment thread src/svelte/src/components/dataEditor.svelte

scholarsmate force-pushed the omega-edit-v2-upgrade branch from f9a0bc8 to 1e652d0 Compare April 18, 2026 03:01

scholarsmate requested a review from Copilot April 18, 2026 03:01

Copilot started reviewing on behalf of scholarsmate April 18, 2026 03:02 View session

Copilot AI reviewed Apr 18, 2026

View reviewed changes

scholarsmate mentioned this pull request Apr 24, 2026

TDML zipping 1272 #1671

Draft

2 tasks

Conversation

scholarsmate commented Apr 17, 2026

Enhancement Request: Upgrade Ωedit™ to v2.0.0

Summary

Details

Review Instructions:

Wiki:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

stricklandrbls commented Apr 23, 2026

Uh oh!

scholarsmate commented Apr 23, 2026

Uh oh!

stricklandrbls commented Apr 24, 2026

Uh oh!

scholarsmate commented Apr 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stricklandrbls commented Apr 24, 2026

Uh oh!

scholarsmate commented Apr 24, 2026

Uh oh!

stricklandrbls commented Apr 24, 2026

Uh oh!

scholarsmate commented May 1, 2026

Uh oh!

stricklandrbls commented May 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

scholarsmate commented Apr 24, 2026 •

edited

Loading