Fix broken NPM bundle by publishing in ES-Module format #1958

elikoga · 2025-05-06T10:44:00Z

Closes #1943
Repeat of #1944 with different head branch

Testable by placing "@novnc/novnc": "npm:@elikoga/[email protected]", in package.json

Uses exports in package.json to make sure that old imports still work

This one incorporates the review requests in the previous PR by simply dropping the conversion step using babel.

CI Passes in my repo

CendioOssman · 2025-05-06T14:45:51Z

Please don't open a new PR as that means it is more difficult to see all the context. You can just adjust the existing one with your changes.

elikoga · 2025-05-06T15:14:56Z

@CendioOssman sadly github does not allow changing the head branch of the PR. Your request is to history-rewrite my original PRs head (master)? I can do that but for me it makes it more difficult to understand the context in the future.

elikoga · 2025-05-07T14:24:47Z

Yeah I literally can't reopen the other PR or this one.

samhed · 2025-05-12T17:33:06Z

Continue here then, strange behavior by GitHub..

CendioOssman · 2025-05-14T09:19:09Z

package.json

+  "exports": {
+    ".": "./core/rfb.js",
+    "./lib/*": "./core/*.js",
+    "./lib/*.js": "./core/*.js",
+    "./core/*": "./core/*.js",
+    "./core/*.js": "./core/*.js",
+    "./lib/vendor/*": "./vendor/*.js",
+    "./lib/vendor/*.js": "./vendor/*.js",
+    "./vendor/*": "./vendor/*.js",
+    "./vendor/*.js": "./vendor/*.js",
+    "./package.json": "./package.json"
+  },


RFB is our only interface. Do we need anything more than the first line?

There are uses I could find online using the github search:

with lib: https://github.com/SDU-eScience/UCloud/blob/e78be592106cd915bb9004fc095daa5140e23ed1/frontend-web/webclient/app/Applications/Jobs/Vnc.tsx#L13

https://github.com/kubevirt-ui/kubevirt-plugin/blob/447047ed328719698db1f9e1de5f2db81dc40b89/src/utils/components/Consoles/components/vnc-console/VncConsole.tsx#L6

with core: https://github.com/harvester/dashboard/blob/6da3d8db703521eef18cb30ad60c4148bba4edff/pkg/harvester/components/novnc/NovncConsoleWrapper.vue#L5

And since I do not want these inputs to break I have written it as it is there.

I could probably remove the part about vendor, since it does not seem to be used.

Those are all unsupported usages of noVNC. I'm not keen on giving any illusion of that being official and stable.

Ideally, we just have:

"exports": "./core/rfb.js",

Which is the only supported interface at the moment.

The question is what that transition means for people. Given that we are switching from CommonJS to modules, I assume there is some transition work needed anyway? So might be a good idea to do this at the same time?

util/logging.js is clearly also exposed api, otherwise, the provided example vnc.html would not work:

noVNC/vnc.html

Line 53 in 4cb5aa4

import * as Log from './core/util/logging.js';

As are the files under input/key*:

noVNC/app/ui.js

Lines 15 to 17 in 4cb5aa4

import KeyTable from "../core/input/keysym.js";

import keysyms from "../core/input/keysymdef.js";

import Keyboard from "../core/input/keyboard.js";

Exposed is not the same as supported or stable. I.e. you use them at your own risk. We will not consider it a bug if we change them in a way that breaks callers.

For our internal use, that is fine as we can change it at the same time. But external users cannot really do the same safely.

I'm aware this will cause some pain for some users. But that might be the best thing in the long run, as that will force a discussion of what is missing from the official API and needs to be added.

package.json

CendioOssman · 2025-05-14T09:20:23Z

package.json

-  "directories": {
-    "lib": "lib",
-    "doc": "docs",
-    "test": "tests"
-  },


Are these not used anymore?

See npm js docs: directories

The CommonJS Packages spec details a few ways that you can indicate the structure of your package using a directories object. If you look at npm's package.json, you'll see that it has directories for doc, lib, and man.

In the future, this information may be used in other creative ways.

Since this is no longer exported using ComonJS Modules, I am not sure who would use this.

Sounds fair. But let's have a separate commit that explicitly states that these are being removed because they are old and unused.

Can probably put the removal of "browser" in the same commit.

Hi 👋
Just checking in to see if there are any updates on this thread

utils/genkeysymdef.cjs

micheldpcarlos · 2025-05-27T12:22:28Z

Hey! Just wondering if there’s any ETA on when this might get merged. :)
Happy to assist if anything’s needed to move it along. Thanks!

LeeTeng2001 · 2025-06-27T08:59:59Z

damn nobody use this huh

CendioOssman · 2025-06-30T14:06:43Z

@elikoga, is this still on your todo list?

seandilda · 2025-07-08T15:49:44Z

damn nobody use this huh

This is still an issue for me. I'm currently having to lock at version 1.5.0 so that I can properly bundle the code.

jsuchenia · 2025-07-09T12:22:53Z

damn nobody use this huh

This is still an issue for me. I'm currently having to lock at version 1.5.0 so that I can properly bundle the code.

I think that @elikoga is doing his best to implement a change, you can test his changes from his repo (https://github.com/elikoga/noVNC/tree/switch-to-es-module-publish-and-use-exports) and let here know if that's suitable for you

From a number of projects referencing this broken version (1.6.0 via code builders) - you're not the only one waiting for a fix

@CendioOssman Do you need any help in a validation of a changes here?

CendioOssman · 2025-07-11T13:28:11Z

@CendioOssman Do you need any help in a validation of a changes here?

Please do. We don't use the npm version ourselves, so feedback from actual users is very welcome. Including on the proposed adjustments in my reviews.

jsuchenia · 2025-07-22T20:56:34Z

@CendioOssman Do you need any help in a validation of a changes here?

Please do. We don't use the npm version ourselves, so feedback from actual users is very welcome. Including on the proposed adjustments in my reviews.

Ok - so I've created a simple project that uses ViteJS and ReactJS (samples in this gist) - and confirmed an issue with 1.6.0 version
Then - I've switched to a branch from this PR - and it's working as expected - no errors and code works fine

So - for web-based apps this change will give a possibility to bundle a code using modern package manages.

What other tests shall I perform?

GeTOUO · 2025-07-30T10:07:56Z

这个事项还在推进中吗？是否有一个可供期望的发布时间？目前我也是因为这个问题导致不得不停留在v1.5.0

elikoga · 2025-07-30T10:11:08Z

这个事项还在推进中吗？是否有一个可供期望的发布时间？目前我也是因为这个问题导致不得不停留在v1.5.0

I am still available to look at it if needed. I do not know when it will be released. Upstream is not directly concerned with keeping npm up to date due to their releasing mechanisms not going through there. 1.5.0 is still completely fine, unless you need one of the newer features.

GeTOUO · 2025-07-30T10:15:44Z

这个事项还在推进中吗？是否有一个可供期望的发布时间？目前我也是因为这个问题导致不得不停留在v1.5.0

如果需要，我仍然可以查看它。我不知道什么时候会发布。上游并不直接关注保持 npm 的最新状态，因为它们的发布机制没有通过那里。1.5.0 仍然完全没问题，除非您需要更新的功能之一。

好的，我可以继续使用1.5.0,但还是非常期待这个合并能帮助我升级到1.6.0以上。感谢。

jsuchenia · 2025-08-21T20:18:15Z

@CendioOssman What shall we do to merge that mr? It's been few months to merge so simple (and organisational) change?

CendioOssman · 2025-09-15T13:56:14Z

I made the last discussed adjustments and merged this. It will momentarily be available from NPM under the "dev" tag. Please have a look and see how it works.

torchsec-roni · 2025-09-16T06:49:01Z

Is there another semver release planned soon?

CendioOssman · 2025-09-16T06:54:11Z

That's the idea. Hopefully a beta soon.

ianb-mp · 2025-09-18T01:47:41Z

I've tested 1.6.0-g44b7489 - lgtm 👍

This was referenced May 6, 2025

Fix broken NPM bundle by publishing in ES-Module format #1944

Closed

noVNC cannot be bundled due to top-level await in browser.js #1943

Closed

CendioOssman closed this May 6, 2025

samhed reopened this May 12, 2025

CendioOssman requested changes May 14, 2025

View reviewed changes

rszwajko mentioned this pull request May 14, 2025

CNV-49659: Update novnc from 1.5.0 to 1.6.0 kubevirt-ui/kubevirt-plugin#2575

Closed

martinpitt mentioned this pull request Jul 16, 2025

Bump @novnc/novnc from 1.4.0 to 1.6.0 cockpit-project/cockpit-machines#2063

Closed

elikoga added 2 commits September 15, 2025 15:35

Remove deprecated "directories" entry

6cf0204

Convert NPM bundle to ES-Module format

fe29dc6

CendioOssman force-pushed the switch-to-es-module-publish-and-use-exports branch from a940f34 to fe29dc6 Compare September 15, 2025 13:43

CendioOssman merged commit 44b7489 into novnc:master Sep 15, 2025
11 checks passed

	import KeyTable from "../core/input/keysym.js";
	import keysyms from "../core/input/keysymdef.js";
	import Keyboard from "../core/input/keyboard.js";

Fix broken NPM bundle by publishing in ES-Module format #1958

Fix broken NPM bundle by publishing in ES-Module format #1958

Uh oh!

Conversation

elikoga commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CendioOssman commented May 6, 2025

Uh oh!

elikoga commented May 6, 2025

Uh oh!

elikoga commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samhed commented May 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

micheldpcarlos commented May 27, 2025

Uh oh!

LeeTeng2001 commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CendioOssman commented Jun 30, 2025

Uh oh!

seandilda commented Jul 8, 2025

Uh oh!

jsuchenia commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CendioOssman commented Jul 11, 2025

Uh oh!

jsuchenia commented Jul 22, 2025

Uh oh!

GeTOUO commented Jul 30, 2025

Uh oh!

elikoga commented Jul 30, 2025

Uh oh!

GeTOUO commented Jul 30, 2025

Uh oh!

jsuchenia commented Aug 21, 2025

Uh oh!

Uh oh!

CendioOssman commented Sep 15, 2025

Uh oh!

torchsec-roni commented Sep 16, 2025

Uh oh!

CendioOssman commented Sep 16, 2025

Uh oh!

ianb-mp commented Sep 18, 2025

Uh oh!

Uh oh!

elikoga commented May 6, 2025 •

edited

Loading

elikoga commented May 7, 2025 •

edited

Loading

LeeTeng2001 commented Jun 27, 2025 •

edited

Loading

jsuchenia commented Jul 9, 2025 •

edited

Loading