[WIP] Contents: avoid double-URIdecoding paths

[tomjakubowski]

Hello! We're working on a jupyterlite integration over at https://prospective.co. I'm thrilled to contribute a bug fix back to jupyterlite! 🎉

References

Addresses #1211

Code changes

The paths coming in to /api/contents need to be URI decoded, because jupyterlab's frontend URI encodes them.

The existing Contents API would sometimes double-decode the filenames. For example, Contents.createCheckpoint() would decode the path once, then call this.get() on the path, which would decode it again.

To prevent double-decoding, the URI decode is moved out of the Contents class and into the route definitions.

User-facing changes

Users can now add both files from URLs containing percent-encoded characters, and files from their filesystem with names like hello%20world.txt.

Backwards-incompatible changes

This has a side effect of changing the Contents class API to accept "regular" paths, and not URI-encoded ones. For example, Contents.get("hello%20world.txt") will now return a file named hello%20world.txt on the filesystem, instead of a file named hello world.txt.

[github-actions]

👈 Try it on ReadTheDocs

[tomjakubowski]

My coworker and I started on a ui-test for this, a new test which ran through "Open from URL", which is where I first saw the problem in #1211

Now that the fix is ready, the bug seems larger in scope than just opening from URLs. For example, dragging a file named hello%20world.txt into Jupyterlite would cause the same behavior. Would it be acceptable to instead write a unit/regression test for this in the contents package?

[tomjakubowski]

still some weirdness on this branch! so very much a wip, which I have now marked

example of some remaining weirdness:

1. Create a folder on your filesystem with files called hello%20world.txt and hello world.txt. See foo.zip
2. Drag and drop hello world.txt into Jupyterlite.
3. Drag and drop hello%20world.txt into Jupyterlite. Instead of adding a new file, it overwrites hello world.txt and renames it to hello%20world.txt

[jtpio]

You can also use the -g Playwright command line option to only run a subset of the test suite.

[tomjakubowski]

thanks! nice tip