Reset the `next` npm tag for `@jupyterlab/rendermime-interfaces` #14335

jtpio · 2023-04-07T12:45:34Z

Problem

Currently downstreams using the @jupyterlab/buildutils/lib/update-dependency.js script to update the @jupyterlab packages pull version 4.0.0-alpha.9 because it is marked as next.

However the version was unbumped to 3.8.x for JupyterLab 4: 3.8.0-beta.1 to avoid forcing mimerender extension to update their extensions for JupyterLab 4.

Proposed Solution

We should reset the next tag to point to the 3.8.x version so it's easier to update the packages during the beta and rc cycles.

Additional context

This usually comes up when updating Notebook 7 to the latest JupyterLab 4 pre-releases: https://github.com/jupyter/notebook

The text was updated successfully, but these errors were encountered:

jtpio · 2023-04-07T12:47:21Z

Actually not sure if resetting the tag (for example manually) would help, or if JupyterLab will make it point to 4.0.0-alpha.9 anyway during the release process. Probably the answer is in the release scripts.

fcollonval · 2023-04-11T17:15:45Z

I fixed it manually - we should check at the next release if it is consistent or not.

jtpio · 2023-04-27T16:13:51Z

Looks like it's back to pointing to 4.0.0-alpha.9:

Maybe we'll have to update the deploy scripts in JupyterLab to add a special case for this package.

fcollonval · 2023-04-28T14:45:46Z

Thanks for checking out @jtpio

jtpio · 2023-05-15T07:13:02Z

Bumping to 4.0.x to check that again after the final 4.0 release.

hbcarlos · 2023-05-18T16:54:01Z

Hi! I think we have a small problem with this package.

I just created an extension for jupyterlab v3 from the cookiecutter. I tried to install it before changing anything, and it failed.

yarn run v1.21.1
$ jlpm build:lib && jlpm build:labextension:dev
$ tsc --sourceMap
node_modules/@jupyterlab/rendermime/lib/widgets.d.ts:8:31 - error TS2420: Class 'RenderedCommon' incorrectly implements interface 'IRenderer'.
  The types of 'title.owner.layout' are incompatible between these types.
    Type 'import("/home/carlos/Documents/blockly-widgets/jupyterlab_blockly_widgets/node_modules/@lumino/widgets/types/layout").Layout | null' is not assignable to type 'import("/home/carlos/Documents/blockly-widgets/jupyterlab_blockly_widgets/node_modules/@jupyterlab/rendermime-interfaces/node_modules/@lumino/widgets/types/layout").Layout | null'.
      Type 'import("/home/carlos/Documents/blockly-widgets/jupyterlab_blockly_widgets/node_modules/@lumino/widgets/types/layout").Layout' is not assignable to type 'import("/home/carlos/Documents/blockly-widgets/jupyterlab_blockly_widgets/node_modules/@jupyterlab/rendermime-interfaces/node_modules/@lumino/widgets/types/layout").Layout'.
        Property '[Symbol.iterator]' is missing in type 'import("/home/carlos/Documents/blockly-widgets/jupyterlab_blockly_widgets/node_modules/@lumino/widgets/types/layout").Layout' but required in type 'import("/home/carlos/Documents/blockly-widgets/jupyterlab_blockly_widgets/node_modules/@jupyterlab/rendermime-interfaces/node_modules/@lumino/widgets/types/layout").Layout'.

8 export declare abstract class RenderedCommon extends Widget implements IRenderMime.IRenderer {
                                ~~~~~~~~~~~~~~

  node_modules/@jupyterlab/rendermime-interfaces/node_modules/@lumino/widgets/types/layout.d.ts:83:14
    83     abstract [Symbol.iterator](): IterableIterator<Widget>;
                    ~~~~~~~~~~~~~~~~~
    '[Symbol.iterator]' is declared here.

The problem is that we updated the dependencies of @jupyterlab/rendermime-interfaces to lumino v2 and released it as a minor version (v3.8.0). When creating a new extension for jupyterlab v3 it installs @jupyterlab/rendermime-interfaces v3.8.0 with lumino v2.

We should bump the version of the packages to 4 or maybe allow both versions of Lumino.

echarles · 2023-05-18T18:15:37Z

I opened #13647 some time ago for exactly this.

jhgoebbert · 2023-05-19T10:59:09Z

Also @jupyterlab/docregistry version 3.x is infected by the bug - and so are many other @lumino 1.x extensions:
https://github.com/jupyterlab/jupyterlab/blob/v3.6.3/packages/docregistry/package.json#L52

jtpio · 2023-05-22T09:07:29Z

Could switching to use the ~ specifier instead of ^ help mitigate this issue ("@jupyterlab/rendermime-interfaces": "~3.6.3") ? This would then require a new JupyterLab 3.6.x release.

jhgoebbert · 2023-05-23T17:01:14Z

Yes, a new JupyerLab 3.6.4 which fixes its package.json files could be a solution.
.
In the long run it would be even better if a version 4.0.0 of @jupyterlab/rendermime-interfaces would exist and 3.8.0 could be yanked. But there might be other reasons why that is no option. 🤔

krassowski · 2023-06-04T21:17:33Z

Just FYI, 3.6.4 was released but it did not include the fix yet. THere is a PR here #14618 and would need to go in 3.6.5.

Note: this also affects CI of nbdime.

fcollonval · 2023-06-09T05:47:04Z

4.0.2 has been released and it should fix this (rendermime-interfaces 3.8.2 supports both lumino 1.x and 2.x)

Could some of you please confirm it fixes your issue?

jhgoebbert · 2023-06-09T06:08:37Z

I tried to build the dask-labextension https://github.com/dask/dask-labextension for JupyterLab 3.6.4 but unfortunately it still fails with

      node_modules/@jupyterlab/rendermime/lib/widgets.d.ts(8,31): error TS2420: Class 'RenderedCommon' incorrectly implements interface 'IRenderer'.
        The types of 'title.owner.layout' are incompatible between these types.
          Type 'import("/dev/shm/dask_labextension-6.1.0/node_modules/@lumino/widgets/types/layout").Layout' is not assignable to type 'import("/dev/shm/dask_labextension-6.1.0/node_modules/@jupyterlab/rendermime-interfaces/node_modules/@lumino/widgets/types/layout").Layout'.
            Property '[Symbol.iterator]' is missing in type 'import("/dev/shm/dask_labextension-6.1.0/node_modules/@lumino/widgets/types/layout").Layout' but required in type 'import("/dev/shm/dask_labextension-6.1.0/node_modules/@jupyterlab/rendermime-interfaces/node_modules/@lumino/widgets/types/layout").Layout'.

I double checked if rendermime-interface 3.8.2 is really used and checked /dev/shm/dask_labextension-6.1.0/node_modules/@jupyterlab/rendermime-interfaces/package.json but it shows `"version": "3.8.2",´.

Two different versions of @lumino/widgets are the mismatch:

/dev/shm/dask_labextension/dask_labextension-6.1.0/node_modules/@lumino/widgets/package.json -> version 1.37.2
/dev/shm/dask_labextension-6.1.0/node_modules/@jupyterlab/rendermime-interfaces/node_modules/@lumino/widgets/package.json -> version 2.1.1

krassowski · 2023-06-09T10:14:56Z

It works for me; the previously failing CI build of nbdime, is now passing smoothly.

Locally a clean install after removing all node_modules (and any resolution pins for rendermime-interface package if you had any) works fine too (just upgrading rendermime-interface may not give you the right versions of other packages I think).

jhgoebbert · 2023-06-28T12:14:20Z

I tried to build the dask-labextension https://github.com/dask/dask-labextension for JupyterLab 3.6.5 but unfortunately it still fails

      node_modules/@jupyterlab/rendermime/lib/widgets.d.ts(8,31): error TS2420: Class 'RenderedCommon' incorrectly implements interface 'IRenderer'.
        The types of 'title.owner.layout' are incompatible between these types.
          Type 'import("dask_labextension-6.1.0/node_modules/@lumino/widgets/types/layout").Layout' is not assignable to type 'import("dask_labextension-6.1.0/node_modules/@jupyterlab/rendermime-interfaces/node_modules/@lumino/widgets/types/layout").Layout'.
            Property '[Symbol.iterator]' is missing in type 'import("dask_labextension-6.1.0/node_modules/@lumino/widgets/types/layout").Layout' but required in type 'import("dask_labextension-6.1.0/node_modules/@jupyterlab/rendermime-interfaces/node_modules/@lumino/widgets/types/layout").Layout'.

fcollonval · 2023-06-28T14:48:05Z

@jhgoebbert I solved the issue using the following commands within a fresh environment on the main branch:

# Installation on the current working lock file
jlpm install

# Upgrade to latest 3.x packages
jlpm upgrade --caret --scope jupyterlab

# Minimize dependency versions
jlpm add -D yarn-deduplicate@^5.0.0
jlpm yarn-deduplicate -s fewer
jlpm install

# Should succeed
jlpm build

jhgoebbert · 2023-06-28T16:28:01Z

Thank you very much for the work-around!
.
After the first jlpm install I can see in yarn.lock the duplication of @lumino/widgets which seems to be the source of the problem:

"@lumino/widgets@^1.17.0", "@lumino/widgets@^1.37.2":
  version "1.37.2"
  resolved "https://registry.yarnpkg.com/@lumino/widgets/-/widgets-1.37.2.tgz#b408fae221ecec2f1b028607782fbe1e82588bce"
  integrity sha512-NHKu1NBDo6ETBDoNrqSkornfUCwc8EFFzw6+LWBfYVxn2PIwciq2SdiJGEyNqL+0h/A9eVKb5ui5z4cwpRekmQ==
  dependencies:
   [..]

"@lumino/widgets@^1.37.2 || ^2.1.1":
  version "2.2.0"
  resolved "https://registry.yarnpkg.com/@lumino/widgets/-/widgets-2.2.0.tgz#c949045e45d13388a1d07f2234dd96658d994d35"
  integrity sha512-nQ5UXjcl+Tvddeev0We5aoW2erm5KffKCJZEo6/1i4t2cj90v2ndqtXtbiCjeQOBDojIH6u1BVPtUExTh00cbA==
  dependencies:

This looks like an issue in JupyterLab instead of something which can be fixed in dask-labextension, am I right?

fcollonval · 2023-06-28T16:38:20Z

Not really, it is a choice of the package manager (here yarn) to resolve the constraints:

@lumino/widgets@^1.17.0
@lumino/widgets@^1.37.2
@lumino/widgets@^1.37.2 || ^2.1.1

By installing the version 1.37.2 and 2.2.0 when actually 1.37.2 could resolve all of them (what would happen with pip or conda for example) - this is the pain of JavaScript packaging.

This is usually solved by working on reducing duplication with tool like yarn-deduplicate or by using package manager options; namely resolutions for yarn and overrides for npm.

jhgoebbert · 2023-06-28T16:49:47Z

Thank you, I think I understand now.

That makes things really difficult for everyone who provides extensions through PyPI as they do not know how the local package manager will handle this. 🤔
Could that be handled inside of jupyter_packaging->install_npm() as it is called from setup.py anyway:
( e.g. https://github.com/dask/dask-labextension/blob/main/setup.py#L65 )

jtpio · 2023-10-09T09:14:27Z

There seems to be another issue with the @jupyterlab/rendermime-interfaces package.

The current main (targeting JupyterLab 4.1) defines the following version:

jupyterlab/packages/rendermime-interfaces/package.json

Line 3 in 0b33a5c

"version": "3.8.3-alpha.1",

While the 4.0.x defines this version:

jupyterlab/packages/rendermime-interfaces/package.json

Line 3 in 1470525

"version": "3.8.6",

So 4.0.x is "ahead" of main, which can be quite confusing and can also cause issues downstream when using the 4.1 packages, as noticed in jupyter/notebook#7096. Specifying ^3.8.3-alpha.1 or ~3.8.3-alpha.1 resolves to 3.8.6, but this creates incompatibility probably due to #15142 which updated some of the lumino dependencies.

Should the version of @jupyterlab/rendermime-interfaces on main be bumped to 3.9.0-alpha.1?

jtpio · 2023-10-09T09:25:20Z

Also if we don't manually bump the version of the @jupyterlab/rendermime-interfaces now, it will likely create a collision when releasing JupyterLab 4.1.3 as it would bump to 3.8.6.

jtpio added enhancement status:Needs Triage Applied to new issues that need triage labels Apr 7, 2023

jtpio removed the status:Needs Triage Applied to new issues that need triage label Apr 7, 2023

jtpio added this to the 4.0.0 milestone Apr 7, 2023

jtpio added maintenance and removed enhancement labels Apr 7, 2023

JasonWeill assigned fcollonval Apr 19, 2023

jtpio modified the milestones: 4.0.0, 4.0.x May 15, 2023

jhgoebbert mentioned this issue May 19, 2023

JLab 4.0 side-effect: Class 'RenderedCommon' incorrectly implements interface 'IRenderer'. dask/dask-labextension#260

Closed

krassowski mentioned this issue May 24, 2023

Crash when building react-widget jupyterlab/extension-examples#234

Closed

This was referenced May 31, 2023

Fix rendermime-interfaces #14617

Closed

Allow Lumino 1.x version for rendermime-interfaces #14618

Merged

jtpio mentioned this issue Oct 9, 2023

Bump @jupyterlab/rendermime-interfaces to 3.9.0-alpha.1 #15240

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reset the `next` npm tag for `@jupyterlab/rendermime-interfaces` #14335

Reset the `next` npm tag for `@jupyterlab/rendermime-interfaces` #14335

jtpio commented Apr 7, 2023

jtpio commented Apr 7, 2023

fcollonval commented Apr 11, 2023

jtpio commented Apr 27, 2023

fcollonval commented Apr 28, 2023

jtpio commented May 15, 2023

hbcarlos commented May 18, 2023

echarles commented May 18, 2023

jhgoebbert commented May 19, 2023 •

edited

Loading

jtpio commented May 22, 2023

jhgoebbert commented May 23, 2023

krassowski commented Jun 4, 2023

fcollonval commented Jun 9, 2023

jhgoebbert commented Jun 9, 2023 •

edited

Loading

krassowski commented Jun 9, 2023

jhgoebbert commented Jun 28, 2023

fcollonval commented Jun 28, 2023 •

edited

Loading

jhgoebbert commented Jun 28, 2023

fcollonval commented Jun 28, 2023

jhgoebbert commented Jun 28, 2023

jtpio commented Oct 9, 2023 •

edited

Loading

jtpio commented Oct 9, 2023 •

edited

Loading

Reset the next npm tag for @jupyterlab/rendermime-interfaces #14335

Reset the next npm tag for @jupyterlab/rendermime-interfaces #14335

Comments

jtpio commented Apr 7, 2023

Problem

Proposed Solution

Additional context

jtpio commented Apr 7, 2023

fcollonval commented Apr 11, 2023

jtpio commented Apr 27, 2023

fcollonval commented Apr 28, 2023

jtpio commented May 15, 2023

hbcarlos commented May 18, 2023

echarles commented May 18, 2023

jhgoebbert commented May 19, 2023 • edited Loading

jtpio commented May 22, 2023

jhgoebbert commented May 23, 2023

krassowski commented Jun 4, 2023

fcollonval commented Jun 9, 2023

jhgoebbert commented Jun 9, 2023 • edited Loading

krassowski commented Jun 9, 2023

jhgoebbert commented Jun 28, 2023

fcollonval commented Jun 28, 2023 • edited Loading

jhgoebbert commented Jun 28, 2023

fcollonval commented Jun 28, 2023

jhgoebbert commented Jun 28, 2023

jtpio commented Oct 9, 2023 • edited Loading

jtpio commented Oct 9, 2023 • edited Loading

Reset the `next` npm tag for `@jupyterlab/rendermime-interfaces` #14335

Reset the `next` npm tag for `@jupyterlab/rendermime-interfaces` #14335

jhgoebbert commented May 19, 2023 •

edited

Loading

jhgoebbert commented Jun 9, 2023 •

edited

Loading

fcollonval commented Jun 28, 2023 •

edited

Loading

jtpio commented Oct 9, 2023 •

edited

Loading

jtpio commented Oct 9, 2023 •

edited

Loading