Restructure data editor messaging with Message Registry by stricklandrbls · Pull Request #1647 · apache/daffodil-vscode

stricklandrbls · 2026-03-26T17:42:55Z

Closes #1659
Closes #1058
Closes #669

Description

Implemented a Message Registry which provides type-safe message content inspection for messages sent between the data editor, dfdl extension, and the Svelte UI.
Restructured some legacy Svelte stores into Svelte v5 runes.
Resolved issues related to message content mismathcing and message content being processed by multiple data editors when the message was intended for a single data editor instance.

Wiki

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

Review Instructions including Screenshots

Developer Perspective Reviews

In any portion of the data editor's extension source, verify that message content is appropriately inspected and the VSCode intellisense engine emits correct types when invoking this.panel.postMessage(...).

Screenshots ( dataEditorClient.ts -> 'fileInfo')

In any portion of the data editor's Svelte UI source, verify that message content is appropriately inspected and the VSCode intellisense engine emits correct types when invoking addListener(...).

Screenshots ( DataEditorLineFeed.svelte -> 'viewportRefresh')

In any portion of the data editor's Svelte UI source, verify that message content is appropriately inspected and the VSCode intellisense engine emits correct types when invoking vscode.postMessage(...).

Screenshots ( App.svelte -> 'requestEditedData')

Functionality Review

Verify that all message traffic behaves as expected. Message content can be identified within the ./src/ext_types/message.ts & ./src/ext_types/messageContent.ts

CoverRyan

CI seems to be failing consistently and it doesn't appear to be an issue with the CI.

stricklandrbls · 2026-04-09T18:35:18Z

CI seems to be failing consistently and it doesn't appear to be an issue with the CI.

#1659 is the issue I created for fixing the CI

shanedell · 2026-04-10T01:37:15Z

@stricklandrbls Will the updates to fix #1659 be added to this PR? My personal input would be, to add those changes here. I would rather have additional changes in this PR and a working CI then to merge this PR and introduce broken CI into main which requires another PR to fix.

stricklandrbls · 2026-04-10T04:30:12Z

@stricklandrbls Will the updates to fix #1659 be added to this PR? My personal input would be, to add those changes here. I would rather have additional changes in this PR and a working CI then to merge this PR and introduce broken CI into main which requires another PR to fix.

Yeah those changes would fix the CI I created the separate issue because it required multiple additional dev dependencies.

I can add that issue as one that will close this PR.

This PR resolved the CI failing jobs.

Copilot

Pull request overview

Copilot reviewed 50 out of 55 changed files in this pull request and generated 13 comments.

Comments suppressed due to low confidence (1)

src/svelte/src/components/ServerMetrics/ServerMetrics.svelte:31

heartbeat is initialized with omegaEditPort, but later code assigns/uses heartbeat.port (e.g., in the heartbeat listener and template). This adds a new property at runtime and leaves the declared omegaEditPort unused/incorrect. Rename the state field to match the payload (port) or keep using omegaEditPort consistently.

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

Copilot

Pull request overview

Copilot reviewed 50 out of 55 changed files in this pull request and generated 10 comments.

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

Copilot

Pull request overview

Copilot reviewed 54 out of 59 changed files in this pull request and generated 8 comments.

Comments suppressed due to low confidence (1)

src/svelte/src/stores/index.ts:265

These derived(...) stores call isRegularSizedFile(), but isRegularSizedFile is backed by a Svelte v5 $derived rune (not a Svelte store). Because it isn’t listed in the dependency array, changes to fileMetricsState.computedSize won’t trigger recomputation, so editMode can become stale when file size changes (e.g. on initial counts message). Consider reintroducing a Svelte-store regularSizedFile dependency, or migrate these derived stores to runes so reactivity stays consistent.

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

Copilot

Pull request overview

Copilot reviewed 56 out of 61 changed files in this pull request and generated 7 comments.

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

…ocha

Copilot

Pull request overview

Copilot reviewed 57 out of 62 changed files in this pull request and generated 9 comments.

Comments suppressed due to low confidence (3)

src/svelte/src/stores/index.ts:263

editMode no longer depends on fileMetricsState.computedSize; it only reruns when the selection changes. If counts/save events flip the file between the special 1-byte case and a regular file, the editor mode stays stale and the UI keeps using the wrong single-vs-multiple-byte path.
src/svelte/src/stores/states.svelte.ts:24
formatMsgId() prefixes debug-attached editors with dfdl-, but this check uses includes() instead of startsWith(). Any normal file whose basename happens to contain dfdl- will be misclassified as debug-attached and start reacting to debugger byte-position events.
src/svelte/src/stores/index.ts:418
applicable has the same dependency hole as editMode and originalDataSegment: it reads isRegularSizedFile() but never subscribes to fileMetricsState.computedSize. After a size-changing edit/save, the Apply button can stay enabled/disabled for the wrong editing mode until some unrelated store update happens.

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

+  formatMsgId(id: string, isDFDLDebugAttached: boolean = false) {
+    let idStr = id.substring(0, UI_MSG_ID_MAX_LEN)
+    idStr = idStr.replaceAll(' ', '_')
+    return isDFDLDebugAttached ? 'dfdl-' + idStr : idStr
+  }


+      .replace('__extension_msg_id__', msgId)
+
+    vsWebview.html = indexHTML
+  }


+  ) {
+    vscode.window.onDidChangeActiveColorTheme((newTheme) => {


 export const originalDataSegment = derived(
-  [viewport, selectionDataStore, regularSizedFile],
-  ([$viewport, $selectionData, $regularSizedFile]) => {
+  [viewport, selectionDataStore],
+  ([$viewport, $selectionData]) => {
    if (!$viewport.data) return []
-    if (!$regularSizedFile) return $viewport.data
+    if (!isRegularSizedFile()) return $viewport.data


          <Button
            fn={replace}
            description="Replace the current match"
-            disabledBy={!replaceable || replaceErrDisplay}
+            isDisabled={!replaceable || replaceErrDisplay}
          >


+  addListener('heartbeat', (data) => {
+    const {
+      latency,
+      port,
+      serverCpuLoadAverage,
+      serverTimestamp,
+      serverUptime,
+      serverUsedMemory,
+      sessionCount,
+      serverInfo,
+    } = data
+    heartbeat.latency = latency
+    heartbeat.port = port


+          const languageResponse = await getLanguage(
+            this.omegaSessionId,
+            startOffset,
+            length,
+            characterCount!.getByteOrderMark()
+          )
+          await this.panel.postMessage('profile', {
+            startOffset: startOffset,
+            length: length,
+            byteProfile: byteProfile,
+            numAscii: numAscii(byteProfile),
+            language: languageResponse.getLanguage(),
+            contentType: contentTypeResponse.getContentType(),
+            characterCount: {
+              byteOrderMark: characterCount!.getByteOrderMark(),
+              byteOrderMarkBytes: characterCount!.getByteOrderMarkBytes(),
+              singleByteCount: characterCount!.getSingleByteChars(),
+              doubleByteCount: characterCount!.getDoubleByteChars(),
+              tripleByteCount: characterCount!.getTripleByteChars(),
+              quadByteCount: characterCount!.getQuadByteChars(),
+              invalidBytes: characterCount!.getInvalidBytes(),
            },


+    Most of the open source code in the Saxon product is governed by the Mozilla Public
+    License version 2.0, which is reproduced below.
+
+- 'sax' in extension/dist/ext/extension.js
+- 'sax' in node_modules/vite
+  This product bundles 'sax' from the above files.
+  These files are available under the BlueOak-1.0.0 license:
+
+    Most of the open source code in the Saxon product is governed by the Blue Oak Model License
+    version 1.0.0, which is reproduced below.


+    Most of the open source code in the Saxon product is governed by the Mozilla Public
+    License version 2.0, which is reproduced below.
+
+- 'sax' in extension/dist/ext/extension.js
+- 'sax' in node_modules/vite
+  This product bundles 'sax' from the above files.
+  These files are available under the BlueOak-1.0.0 license:
+
+    Most of the open source code in the Saxon product is governed by the Blue Oak Model License
+    version 1.0.0, which is reproduced below.


stricklandrbls added this to the 1.6.0 milestone Mar 26, 2026

stricklandrbls requested review from CoverRyan, JeremyYao, duboisfordwork, hdalsania, lrbarber, naga-panchumarty, rthomas320, scholarsmate and shanedell March 26, 2026 17:42

stricklandrbls self-assigned this Mar 26, 2026

stricklandrbls added typescript code quality Issues related to code quality data editor Issues related to the Data Editor capability extension Issues releated to the VSCode Extension labels Mar 26, 2026

stricklandrbls added this to daffodil-vscode v1.6.0 Mar 26, 2026

stricklandrbls force-pushed the data-editor-message-registry branch 3 times, most recently from 65b3fd8 to 8404e0c Compare March 26, 2026 18:11

stricklandrbls moved this to In Review in daffodil-vscode v1.6.0 Mar 27, 2026

stricklandrbls force-pushed the data-editor-message-registry branch 2 times, most recently from dc8d15a to 55d963f Compare March 31, 2026 01:40

CoverRyan previously requested changes Apr 9, 2026

View reviewed changes

stricklandrbls force-pushed the data-editor-message-registry branch 4 times, most recently from e5d837d to d3e7b54 Compare April 13, 2026 21:42

scholarsmate requested a review from Copilot April 25, 2026 02:15

Copilot started reviewing on behalf of scholarsmate April 25, 2026 02:16 View session

Copilot AI reviewed Apr 25, 2026

View reviewed changes

stricklandrbls force-pushed the data-editor-message-registry branch 5 times, most recently from 72c22db to ed1adec Compare April 25, 2026 06:44

scholarsmate requested a review from Copilot April 26, 2026 14:39

Copilot started reviewing on behalf of scholarsmate April 26, 2026 14:40 View session

Copilot AI reviewed Apr 26, 2026

View reviewed changes

stricklandrbls force-pushed the data-editor-message-registry branch 4 times, most recently from e290c32 to c59b811 Compare April 29, 2026 03:49

scholarsmate requested a review from Copilot April 29, 2026 12:39

Copilot started reviewing on behalf of scholarsmate April 29, 2026 12:40 View session

Copilot AI reviewed Apr 29, 2026

View reviewed changes

stricklandrbls force-pushed the data-editor-message-registry branch 3 times, most recently from b305f25 to 59f444c Compare May 2, 2026 22:32

scholarsmate requested a review from Copilot May 2, 2026 23:12

Copilot started reviewing on behalf of scholarsmate May 2, 2026 23:13 View session

Copilot AI reviewed May 2, 2026

View reviewed changes

Implemented Data Editor Message Registry w/ svelte.ts tests fix for M…

93cbaae

…ocha

stricklandrbls force-pushed the data-editor-message-registry branch from 59f444c to 93cbaae Compare May 3, 2026 03:00

scholarsmate requested a review from Copilot May 4, 2026 15:27

Copilot started reviewing on behalf of scholarsmate May 4, 2026 15:28 View session

Copilot AI reviewed May 4, 2026

View reviewed changes

		) {
		vscode.window.onDidChangeActiveColorTheme((newTheme) => {

Conversation

stricklandrbls commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Wiki

Review Instructions including Screenshots

Developer Perspective Reviews

Functionality Review

Uh oh!

CoverRyan 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!

stricklandrbls commented Apr 9, 2026

Uh oh!

shanedell commented Apr 10, 2026

Uh oh!

stricklandrbls commented Apr 10, 2026

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!

Uh oh!

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!

Uh oh!

Uh oh!

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!

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

stricklandrbls commented Mar 26, 2026 •

edited

Loading

CoverRyan left a comment •

edited

Loading