Store original path as returned from contents API in the Contents.IModel

[krassowski]

References

Fixes #13155 using solution (b) as proposed solutions in #13155 (comment). I have moderate doubts on whether this is the best solution; (c) seems cleaner but I am not convinced if getting the cleaner solution is worth introducing a breaking change, see discussion in #13155 (whereas this PR could still be backported to 3.5).

Code changes

Adds optional serverPath attribute to Contents.IModel and populates it in ContentsManager methods by path returned by the server.

Note: an example of the issue was actually in our tests all along: DEFAULT_FILE has path foo/test which is correctly returned when creating a file:

jupyterlab/packages/services/test/contents/index.spec.ts

Lines 329 to 335 in 376e52c

	it('should create a file on an additional drive', async () => {
	const other = new Drive({ name: 'other', serverSettings });
	contents.addDrive(other);
	handleRequest(other, 201, DEFAULT_FILE);
	const model = await contents.newUntitled({ path: 'other:/foo' });
	expect(model.path).toBe('other:foo/test');
	});

but when a file is queried with get:

jupyterlab/packages/services/test/contents/index.spec.ts

Lines 242 to 249 in 376e52c

	it('should get a file from an additional drive', async () => {
	const drive = new Drive({ name: 'other', serverSettings });
	contents.addDrive(drive);
	handleRequest(drive, 200, DEFAULT_FILE);
	const options: Contents.IFetchOptions = { type: 'file' };
	const model = await contents.get('other:/foo', options);
	expect(model.path).toBe('other:foo');
	});

then other:foo instead of other:foo/test gets returned. This PR adds foo/test on extra property, serverPath (which for now is optional in the interface).

User-facing changes

None.

Backwards-incompatible changes

None

[jupyterlab-probot]

Thanks for making a pull request to jupyterlab!
To try out this branch on binder, follow this link:

[fcollonval]

@krassowski thanks for pointing out the inconsistency.

I would be in favor to force IModel.path to be consistent - it sounds to me like a bug to have a new file path not matching the one obtained for getting the same file.

Otherwise I'm 👍 to add the serverPath to allow backport.

[fcollonval]

CI failures are not relevant

[fcollonval]

@meeseeksdev please backport to 3.6.x