Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix default viewers override #6923

Merged
merged 3 commits into from
Jun 19, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 40 additions & 5 deletions packages/application-extension/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ const TREE_PATTERN = new RegExp('/(notebooks|edit)/(.*)');
*/
const STRIP_IPYNB = /\.ipynb$/;

/**
* The JupyterLab document manager plugin id.
*/
const JUPYTERLAB_DOCMANAGER_PLUGIN_ID =
'@jupyterlab/docmanager-extension:plugin';

/**
* The command IDs used by the application plugin.
*/
Expand Down Expand Up @@ -178,12 +184,14 @@ const opener: JupyterFrontEndPlugin<void> = {
id: '@jupyter-notebook/application-extension:opener',
autoStart: true,
requires: [IRouter, IDocumentManager],
optional: [ISettingRegistry],
activate: (
app: JupyterFrontEnd,
router: IRouter,
docManager: IDocumentManager
docManager: IDocumentManager,
settingRegistry: ISettingRegistry | null
): void => {
const { commands } = app;
const { commands, docRegistry } = app;

const command = 'router:tree';
commands.addCommand(command, {
Expand All @@ -195,10 +203,37 @@ const opener: JupyterFrontEndPlugin<void> = {
return;
}

const file = decodeURIComponent(path);
const urlParams = new URLSearchParams(parsed.search);
const factory = urlParams.get('factory') ?? 'default';
app.started.then(async () => {
const file = decodeURIComponent(path);
const urlParams = new URLSearchParams(parsed.search);
let defaultFactory = docRegistry.defaultWidgetFactory(path).name;

// Explicitely get the default viewers from the settings because
Copy link
Member Author

@jtpio jtpio Jun 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can track that in a JupyterLab issue so it can be discussed.

// JupyterLab might not have had the time to load the settings yet (race condition)
// Relevant code: https://github.com/jupyterlab/jupyterlab/blob/d56ff811f39b3c10c6d8b6eb27a94624b753eb53/packages/docmanager-extension/src/index.tsx#L265-L293
if (settingRegistry) {
const settings = await settingRegistry.load(
JUPYTERLAB_DOCMANAGER_PLUGIN_ID
);
const defaultViewers = settings.get('defaultViewers').composite as {
[ft: string]: string;
};
// get the file types for the path
const types = docRegistry.getFileTypesForPath(path);
// for each file type, check if there is a default viewer and if it
// is available in the docRegistry. If it is the case, use it as the
// default factory
types.forEach((ft) => {
if (
defaultViewers[ft.name] !== undefined &&
docRegistry.getWidgetFactory(defaultViewers[ft.name])
) {
defaultFactory = defaultViewers[ft.name];
}
});
}

const factory = urlParams.get('factory') ?? defaultFactory;
docManager.open(file, factory, undefined, {
ref: '_noref',
});
Expand Down