Service worker fixes, JupyterLab 3.5.1

[bollwyvl]

References

• [wip] Update to pyodide 0.22.0, use pyodide and serviceworker types #871, but without the pyodide version change
• Service worker fixes, JupyterLab 3.5.1 #892, but not closed

Code changes

• add exact-pinned pyodide to pyodide-kernel/package.json#/devDependencies
  • only ever import typed in .ts
  • is the source of truth for all other versions

• bump to pyodide 0.22.0a3

• add @types/emscripten (such as it is)
• remove duplicated ERRNO_CODES
• remove use of private pyodide._module
• update key dev deps
  • lerna 6
  • typedoc 0.23
  • typescript 4.9
  • prettier 2.8
• refactor BroadcastChannel out of server, put in contents
• make pyolite more resilient to missing ServiceWorker and BroadcastChannel
• moves services.js into server/sw.ts
  • add a new webpack plugin to hoist it up to the root of the app (or the scope is wrong) and add the content hash to the file name
• add SKIP_ESLINT env var

  • the pre-commit hooks still fail sometimes, so git commit -n it shall be!

• remove plotly until compatible with ipywidgets 8

  • Incompatible FigureWidget with ipywidgets 8.0.0rc0 plotly/plotly.py#3686

User-facing changes

• site deployers
  • can disable the ServiceWorker
• end users
  • should get fewer stale serves of services.js with cache-busting

Backwards-incompatible changes

• some Emscripten-related types and classes have moved
• the name of services.js is no longer predictable (hash-based)

[github-actions]

👈 Try it on ReadTheDocs

[martinRenou]

Headsup that this will go in conflict with #898

[bollwyvl]

Not worried too much about that given the breaking changes in 3.6 anyway. We may have to keep 3.5 running for a while

…

On Thu, Dec 8, 2022, 09:23 martinRenou ***@***.***> wrote: Headsup that this will go in conflict with #898 <#898> — Reply to this email directly, view it on GitHub <#899 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAALCRD6AFVLBFY6YK67NXLWMH4NXANCNFSM6AAAAAASYIN6KQ> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[stevejpurves]

couple of questions:

How can a site deployer disable the service worker? should we expect to be able to set a new option in the jupyter-config-data?

... and add the content hash to the file name

So this is the content hash of the sw.ts file and will remain stable across releases/builds otherwise?

[bollwyvl]

How can a site deployer disable the service worker?

added some docs here: ada7479

the content hash of the sw.ts file and will remain stable across releases/builds otherwise?

I believe it's the hash of the output, which isn't precisely deterministic (or rather, has many independent variables of which the source of sw.ts is only one). A new sw-{hash}.js will only (but very possibly) change with a new release of jupyterlite 0.1.0b{n+1}. Two successive runs of jupyter lite build without pip installing something will always have the same sw-{hash}.js.

[jtpio]

Maybe we could rename this file from sw.ts to serviceworker.ts so it's more explicit?

And the existing serviceworker.ts to serviceworkerwrapper.ts?

[bollwyvl]

perhaps serviceworker.ts and servicemanager.ts?

[bollwyvl]

or service-registration.ts

[bollwyvl]

3a39e7f went with ServiceManager, etc

[jtpio]

Thanks. Although ServiceManager can probably be a bit confusing since there is already a ServiceManager in JupyterLab?

[jtpio]

ServiceWorkerManager would be fine I guess?

[bollwyvl]

Excellent point, updated in 0bf86c2.

[jtpio]

Thanks!

[qqdaiyu55]

@jtpio With this upgrade, we should include your fix: jupyterlab/jupyterlab#12849.
However I checked the bundle file package/build/7941.dc36874.js of jupyterlite v0.1.0-b16, it does not include your change. Did I miss anything here?

[jtpio]

@qqdaiyu55 I think jupyterlab/jupyterlab#12849 was not backported to 3.5 so it's not available in JupyterLite.

We should however be able to pick it up when updating to the JupyterLab 4 packages in #826.

[qqdaiyu55]

@jtpio Thanks for reply. I'm implementing a custom drive and try to get it work for jupyterlite, and see the same issue reported here: jupyterlab/jupyterlab#12755.
Uncaught (in promise) Error: ContentsManager: renaming files must occur within a Drive

From my understanding, for any custom drive extension (e.g. jupyterlab-github), I should see the same renaming error when I opened a new document in root directory (e.g. CustomDrive:test.txt), if we didn't pick the fix into jupyterlite?