Move "Launch Classic Notebook" to its own plugin (#10086)

packages/help-extension/src/index.tsx

@@ -65,344 +65,364 @@ const LAB_IS_SECURE = window.location.protocol === 'https:';
  */
 const HELP_CLASS = 'jp-Help';
 
+/**
+ * A plugin to add a command to open the Classic Notebook interface.
+ */
+const launchClassic: JupyterFrontEndPlugin<void> = {
+  id: '@jupyterlab/help-extension:launch-classic',
+  autoStart: true,
+  requires: [ITranslator],
+  optional: [IMainMenu, ICommandPalette],
+  activate: (
+    app: JupyterFrontEnd,
+    translator: ITranslator,
+    menu: IMainMenu | null,
+    palette: ICommandPalette | null
+  ): void => {
+    const { commands } = app;
+    const trans = translator.load('jupyterlab');
+    const category = trans.__('Help');
+
+    commands.addCommand(CommandIDs.launchClassic, {
+      label: trans.__('Launch Classic Notebook'),
+      execute: () => {
+        window.open(PageConfig.getBaseUrl() + 'tree');
+      }
+    });
+
+    if (menu) {
+      const helpMenu = menu.helpMenu;
+      const launchClassicGroup = [CommandIDs.launchClassic].map(command => ({
+        command
+      }));
+      helpMenu.addGroup(launchClassicGroup, 1);
+    }
+
+    if (palette) {
+      palette.addItem({ command: CommandIDs.launchClassic, category });
+    }
+  }
+};
+
 /**
  * The help handler extension.
  */
 const plugin: JupyterFrontEndPlugin<void> = {
-  activate,
   id: '@jupyterlab/help-extension:plugin',
+  autoStart: true,
   requires: [IMainMenu, ITranslator],
   optional: [ICommandPalette, ILayoutRestorer, IInspector],
-  autoStart: true
-};
-
-/**
- * Export the plugin as default.
- */
-export default plugin;
-
-/**
- * Activate the help handler extension.
- *
- * @param app - The phosphide application object.
- *
- * returns A promise that resolves when the extension is activated.
- */
-function activate(
-  app: JupyterFrontEnd,
-  mainMenu: IMainMenu,
-  translator: ITranslator,
-  palette: ICommandPalette | null,
-  restorer: ILayoutRestorer | null,
-  inspector: IInspector | null
-): void {
-  const trans = translator.load('jupyterlab');
-  let counter = 0;
-  const category = trans.__('Help');
-  const namespace = 'help-doc';
-  const baseUrl = PageConfig.getBaseUrl();
-  const { commands, shell, serviceManager } = app;
-  const tracker = new WidgetTracker<MainAreaWidget<IFrame>>({ namespace });
-  const resources = [
-    {
-      text: trans.__('JupyterLab Reference'),
-      url: 'https://jupyterlab.readthedocs.io/en/stable/'
-    },
-    {
-      text: trans.__('JupyterLab FAQ'),
-      url:
-        'https://jupyterlab.readthedocs.io/en/stable/getting_started/faq.html'
-    },
-    {
-      text: trans.__('Jupyter Reference'),
-      url: 'https://jupyter.org/documentation'
-    },
-    {
-      text: trans.__('Jupyter Forum'),
-      url: 'https://discourse.jupyter.org/c/jupyterlab'
-    },
-    {
-      text: trans.__('Markdown Reference'),
-      url: 'https://commonmark.org/help/'
-    }
-  ];
-
-  resources.sort((a: any, b: any) => {
-    return a.text.localeCompare(b.text);
-  });
-
-  // Handle state restoration.
-  if (restorer) {
-    void restorer.restore(tracker, {
-      command: CommandIDs.open,
-      args: widget => ({
-        url: widget.content.url,
-        text: widget.content.title.label
-      }),
-      name: widget => widget.content.url
-    });
-  }
+  activate: (
+    app: JupyterFrontEnd,
+    mainMenu: IMainMenu,
+    translator: ITranslator,
+    palette: ICommandPalette | null,
+    restorer: ILayoutRestorer | null,
+    inspector: IInspector | null
+  ): void => {
+    const trans = translator.load('jupyterlab');
+    let counter = 0;
+    const category = trans.__('Help');
+    const namespace = 'help-doc';
+    const baseUrl = PageConfig.getBaseUrl();
+    const { commands, shell, serviceManager } = app;
+    const tracker = new WidgetTracker<MainAreaWidget<IFrame>>({ namespace });
+    const resources = [
+      {
+        text: trans.__('JupyterLab Reference'),
+        url: 'https://jupyterlab.readthedocs.io/en/stable/'
+      },
+      {
+        text: trans.__('JupyterLab FAQ'),
+        url:
+          'https://jupyterlab.readthedocs.io/en/stable/getting_started/faq.html'
+      },
+      {
+        text: trans.__('Jupyter Reference'),
+        url: 'https://jupyter.org/documentation'
+      },
+      {
+        text: trans.__('Jupyter Forum'),
+        url: 'https://discourse.jupyter.org/c/jupyterlab'
+      },
+      {
+        text: trans.__('Markdown Reference'),
+        url: 'https://commonmark.org/help/'
+      }
+    ];
 
-  /**
-   * Create a new HelpWidget widget.
-   */
-  function newHelpWidget(url: string, text: string): MainAreaWidget<IFrame> {
-    // Allow scripts and forms so that things like
-    // readthedocs can use their search functionality.
-    // We *don't* allow same origin requests, which
-    // can prevent some content from being loaded onto the
-    // help pages.
-    const content = new IFrame({
-      sandbox: ['allow-scripts', 'allow-forms']
+    resources.sort((a: any, b: any) => {
+      return a.text.localeCompare(b.text);
     });
-    content.url = url;
-    content.addClass(HELP_CLASS);
-    content.title.label = text;
-    content.id = `${namespace}-${++counter}`;
-    const widget = new MainAreaWidget({ content });
-    widget.addClass('jp-Help');
-    return widget;
-  }
 
-  // Populate the Help menu.
-  const helpMenu = mainMenu.helpMenu;
-  const labGroup = [
-    CommandIDs.about,
-    CommandIDs.launchClassic
-  ].map(command => ({ command }));
-  helpMenu.addGroup(labGroup, 0);
-
-  // Contextual help in its own group
-  const contextualHelpGroup = [
-    inspector ? 'inspector:open' : undefined
-  ].map(command => ({ command }));
-  helpMenu.addGroup(contextualHelpGroup, 0);
-
-  const resourcesGroup = resources.map(args => ({
-    args,
-    command: CommandIDs.open
-  }));
-  helpMenu.addGroup(resourcesGroup, 10);
-
-  // Generate a cache of the kernel help links.
-  const kernelInfoCache = new Map<
-    string,
-    KernelMessage.IInfoReplyMsg['content']
-  >();
-  serviceManager.sessions.runningChanged.connect((m, sessions) => {
-    // If a new session has been added, it is at the back
-    // of the session list. If one has changed or stopped,
-    // it does not hurt to check it.
-    if (!sessions.length) {
-      return;
-    }
-    const sessionModel = sessions[sessions.length - 1];
-    if (!sessionModel.kernel || kernelInfoCache.has(sessionModel.kernel.name)) {
-      return;
+    // Handle state restoration.
+    if (restorer) {
+      void restorer.restore(tracker, {
+        command: CommandIDs.open,
+        args: widget => ({
+          url: widget.content.url,
+          text: widget.content.title.label
+        }),
+        name: widget => widget.content.url
+      });
     }
-    const session = serviceManager.sessions.connectTo({
-      model: sessionModel,
-      kernelConnectionOptions: { handleComms: false }
-    });
 
-    void session.kernel?.info.then(kernelInfo => {
-      const name = session.kernel!.name;
+    /**
+     * Create a new HelpWidget widget.
+     */
+    function newHelpWidget(url: string, text: string): MainAreaWidget<IFrame> {
+      // Allow scripts and forms so that things like
+      // readthedocs can use their search functionality.
+      // We *don't* allow same origin requests, which
+      // can prevent some content from being loaded onto the
+      // help pages.
+      const content = new IFrame({
+        sandbox: ['allow-scripts', 'allow-forms']
+      });
+      content.url = url;
+      content.addClass(HELP_CLASS);
+      content.title.label = text;
+      content.id = `${namespace}-${++counter}`;
+      const widget = new MainAreaWidget({ content });
+      widget.addClass('jp-Help');
+      return widget;
+    }
 
-      // Check the cache second time so that, if two callbacks get scheduled,
-      // they don't try to add the same commands.
-      if (kernelInfoCache.has(name)) {
+    // Populate the Help menu.
+    const helpMenu = mainMenu.helpMenu;
+    const labGroup = [CommandIDs.about].map(command => ({ command }));
+    helpMenu.addGroup(labGroup, 0);
+
+    // Contextual help in its own group
+    const contextualHelpGroup = [
+      inspector ? 'inspector:open' : undefined
+    ].map(command => ({ command }));
+    helpMenu.addGroup(contextualHelpGroup, 0);
+
+    const resourcesGroup = resources.map(args => ({
+      args,
+      command: CommandIDs.open
+    }));
+    helpMenu.addGroup(resourcesGroup, 10);
+
+    // Generate a cache of the kernel help links.
+    const kernelInfoCache = new Map<
+      string,
+      KernelMessage.IInfoReplyMsg['content']
+    >();
+    serviceManager.sessions.runningChanged.connect((m, sessions) => {
+      // If a new session has been added, it is at the back
+      // of the session list. If one has changed or stopped,
+      // it does not hurt to check it.
+      if (!sessions.length) {
         return;
       }
-      // Set the Kernel Info cache.
-      kernelInfoCache.set(name, kernelInfo);
-
-      // Utility function to check if the current widget
-      // has registered itself with the help menu.
-      const usesKernel = () => {
-        let result = false;
-        const widget = app.shell.currentWidget;
-        if (!widget) {
-          return result;
-        }
-        helpMenu.kernelUsers.forEach(u => {
-          if (u.tracker.has(widget) && u.getKernel(widget)?.name === name) {
-            result = true;
-          }
-        });
-        return result;
-      };
-
-      // Add the kernel banner to the Help Menu.
-      const bannerCommand = `help-menu-${name}:banner`;
-      const spec = serviceManager.kernelspecs?.specs?.kernelspecs[name];
-      if (!spec) {
+      const sessionModel = sessions[sessions.length - 1];
+      if (
+        !sessionModel.kernel ||
+        kernelInfoCache.has(sessionModel.kernel.name)
+      ) {
         return;
       }
-      const kernelName = spec.display_name;
-      let kernelIconUrl = spec.resources['logo-64x64'];
-      if (kernelIconUrl) {
-        const index = kernelIconUrl.indexOf('kernelspecs');
-        kernelIconUrl = baseUrl + kernelIconUrl.slice(index);
-      }
-      commands.addCommand(bannerCommand, {
-        label: trans.__('About the %1 Kernel', kernelName),
-        isVisible: usesKernel,
-        isEnabled: usesKernel,
-        execute: () => {
-          // Create the header of the about dialog
-          const headerLogo = <img src={kernelIconUrl} />;
-          const title = (
-            <span className="jp-About-header">
-              {headerLogo}
-              <div className="jp-About-header-info">{kernelName}</div>
-            </span>
-          );
-          const banner = <pre>{kernelInfo.banner}</pre>;
-          const body = <div className="jp-About-body">{banner}</div>;
-
-          return showDialog({
-            title,
-            body,
-            buttons: [
-              Dialog.createButton({
-                label: trans.__('Dismiss'),
-                className: 'jp-About-button jp-mod-reject jp-mod-styled'
-              })
-            ]
+      const session = serviceManager.sessions.connectTo({
+        model: sessionModel,
+        kernelConnectionOptions: { handleComms: false }
+      });
+
+      void session.kernel?.info.then(kernelInfo => {
+        const name = session.kernel!.name;
+
+        // Check the cache second time so that, if two callbacks get scheduled,
+        // they don't try to add the same commands.
+        if (kernelInfoCache.has(name)) {
+          return;
+        }
+        // Set the Kernel Info cache.
+        kernelInfoCache.set(name, kernelInfo);
+
+        // Utility function to check if the current widget
+        // has registered itself with the help menu.
+        const usesKernel = () => {
+          let result = false;
+          const widget = app.shell.currentWidget;
+          if (!widget) {
+            return result;
+          }
+          helpMenu.kernelUsers.forEach(u => {
+            if (u.tracker.has(widget) && u.getKernel(widget)?.name === name) {
+              result = true;
+            }
           });
+          return result;
+        };
+
+        // Add the kernel banner to the Help Menu.
+        const bannerCommand = `help-menu-${name}:banner`;
+        const spec = serviceManager.kernelspecs?.specs?.kernelspecs[name];
+        if (!spec) {
+          return;
         }
-      });
-      helpMenu.addGroup([{ command: bannerCommand }], 20);
-
-      // Add the kernel info help_links to the Help menu.
-      const kernelGroup: Menu.IItemOptions[] = [];
-      (kernelInfo.help_links || []).forEach(link => {
-        const commandId = `help-menu-${name}:${link.text}`;
-        commands.addCommand(commandId, {
-          label: link.text,
+        const kernelName = spec.display_name;
+        let kernelIconUrl = spec.resources['logo-64x64'];
+        if (kernelIconUrl) {
+          const index = kernelIconUrl.indexOf('kernelspecs');
+          kernelIconUrl = baseUrl + kernelIconUrl.slice(index);
+        }
+        commands.addCommand(bannerCommand, {
+          label: trans.__('About the %1 Kernel', kernelName),
           isVisible: usesKernel,
           isEnabled: usesKernel,
           execute: () => {
-            return commands.execute(CommandIDs.open, link);
+            // Create the header of the about dialog
+            const headerLogo = <img src={kernelIconUrl} />;
+            const title = (
+              <span className="jp-About-header">
+                {headerLogo}
+                <div className="jp-About-header-info">{kernelName}</div>
+              </span>
+            );
+            const banner = <pre>{kernelInfo.banner}</pre>;
+            const body = <div className="jp-About-body">{banner}</div>;
+
+            return showDialog({
+              title,
+              body,
+              buttons: [
+                Dialog.createButton({
+                  label: trans.__('Dismiss'),
+                  className: 'jp-About-button jp-mod-reject jp-mod-styled'
+                })
+              ]
+            });
           }
         });
-        kernelGroup.push({ command: commandId });
-      });
-      helpMenu.addGroup(kernelGroup, 21);
+        helpMenu.addGroup([{ command: bannerCommand }], 20);
+
+        // Add the kernel info help_links to the Help menu.
+        const kernelGroup: Menu.IItemOptions[] = [];
+        (kernelInfo.help_links || []).forEach(link => {
+          const commandId = `help-menu-${name}:${link.text}`;
+          commands.addCommand(commandId, {
+            label: link.text,
+            isVisible: usesKernel,
+            isEnabled: usesKernel,
+            execute: () => {
+              return commands.execute(CommandIDs.open, link);
+            }
+          });
+          kernelGroup.push({ command: commandId });
+        });
+        helpMenu.addGroup(kernelGroup, 21);
 
-      // Dispose of the session object since we no longer need it.
-      session.dispose();
+        // Dispose of the session object since we no longer need it.
+        session.dispose();
+      });
     });
-  });
-
-  commands.addCommand(CommandIDs.about, {
-    label: trans.__('About %1', app.name),
-    execute: () => {
-      // Create the header of the about dialog
-      const versionNumber = trans.__('Version %1', app.version);
-      const versionInfo = (
-        <span className="jp-About-version-info">
-          <span className="jp-About-version">{versionNumber}</span>
-        </span>
-      );
-      const title = (
-        <span className="jp-About-header">
-          <jupyterIcon.react margin="7px 9.5px" height="auto" width="58px" />
-          <div className="jp-About-header-info">
-            <jupyterlabWordmarkIcon.react height="auto" width="196px" />
-            {versionInfo}
+
+    commands.addCommand(CommandIDs.about, {
+      label: trans.__('About %1', app.name),
+      execute: () => {
+        // Create the header of the about dialog
+        const versionNumber = trans.__('Version %1', app.version);
+        const versionInfo = (
+          <span className="jp-About-version-info">
+            <span className="jp-About-version">{versionNumber}</span>
+          </span>
+        );
+        const title = (
+          <span className="jp-About-header">
+            <jupyterIcon.react margin="7px 9.5px" height="auto" width="58px" />
+            <div className="jp-About-header-info">
+              <jupyterlabWordmarkIcon.react height="auto" width="196px" />
+              {versionInfo}
+            </div>
+          </span>
+        );
+
+        // Create the body of the about dialog
+        const jupyterURL = 'https://jupyter.org/about.html';
+        const contributorsURL =
+          'https://github.com/jupyterlab/jupyterlab/graphs/contributors';
+        const externalLinks = (
+          <span className="jp-About-externalLinks">
+            <a
+              href={contributorsURL}
+              target="_blank"
+              rel="noopener noreferrer"
+              className="jp-Button-flat"
+            >
+              {trans.__('CONTRIBUTOR LIST')}
+            </a>
+            <a
+              href={jupyterURL}
+              target="_blank"
+              rel="noopener noreferrer"
+              className="jp-Button-flat"
+            >
+              {trans.__('ABOUT PROJECT JUPYTER')}
+            </a>
+          </span>
+        );
+        const copyright = (
+          <span className="jp-About-copyright">
+            {trans.__('© 2015-2021 Project Jupyter Contributors')}
+          </span>
+        );
+        const body = (
+          <div className="jp-About-body">
+            {externalLinks}
+            {copyright}
           </div>
-        </span>
-      );
-
-      // Create the body of the about dialog
-      const jupyterURL = 'https://jupyter.org/about.html';
-      const contributorsURL =
-        'https://github.com/jupyterlab/jupyterlab/graphs/contributors';
-      const externalLinks = (
-        <span className="jp-About-externalLinks">
-          <a
-            href={contributorsURL}
-            target="_blank"
-            rel="noopener noreferrer"
-            className="jp-Button-flat"
-          >
-            {trans.__('CONTRIBUTOR LIST')}
-          </a>
-          <a
-            href={jupyterURL}
-            target="_blank"
-            rel="noopener noreferrer"
-            className="jp-Button-flat"
-          >
-            {trans.__('ABOUT PROJECT JUPYTER')}
-          </a>
-        </span>
-      );
-      const copyright = (
-        <span className="jp-About-copyright">
-          {trans.__('© 2015-2021 Project Jupyter Contributors')}
-        </span>
-      );
-      const body = (
-        <div className="jp-About-body">
-          {externalLinks}
-          {copyright}
-        </div>
-      );
-
-      return showDialog({
-        title,
-        body,
-        buttons: [
-          Dialog.createButton({
-            label: trans.__('Dismiss'),
-            className: 'jp-About-button jp-mod-reject jp-mod-styled'
-          })
-        ]
-      });
-    }
-  });
+        );
+
+        return showDialog({
+          title,
+          body,
+          buttons: [
+            Dialog.createButton({
+              label: trans.__('Dismiss'),
+              className: 'jp-About-button jp-mod-reject jp-mod-styled'
+            })
+          ]
+        });
+      }
+    });
 
-  commands.addCommand(CommandIDs.open, {
-    label: args => args['text'] as string,
-    execute: args => {
-      const url = args['url'] as string;
-      const text = args['text'] as string;
-      const newBrowserTab = (args['newBrowserTab'] as boolean) || false;
+    commands.addCommand(CommandIDs.open, {
+      label: args => args['text'] as string,
+      execute: args => {
+        const url = args['url'] as string;
+        const text = args['text'] as string;
+        const newBrowserTab = (args['newBrowserTab'] as boolean) || false;
+
+        // If help resource will generate a mixed content error, load externally.
+        if (
+          newBrowserTab ||
+          (LAB_IS_SECURE && URLExt.parse(url).protocol !== 'https:')
+        ) {
+          window.open(url);
+          return;
+        }
 
-      // If help resource will generate a mixed content error, load externally.
-      if (
-        newBrowserTab ||
-        (LAB_IS_SECURE && URLExt.parse(url).protocol !== 'https:')
-      ) {
-        window.open(url);
-        return;
+        const widget = newHelpWidget(url, text);
+        void tracker.add(widget);
+        shell.add(widget, 'main');
+        return widget;
       }
+    });
 
-      const widget = newHelpWidget(url, text);
-      void tracker.add(widget);
-      shell.add(widget, 'main');
-      return widget;
-    }
-  });
-
-  commands.addCommand(CommandIDs.launchClassic, {
-    label: trans.__('Launch Classic Notebook'),
-    execute: () => {
-      window.open(PageConfig.getBaseUrl() + 'tree');
+    if (palette) {
+      resources.forEach(args => {
+        palette.addItem({ args, command: CommandIDs.open, category });
+      });
+      palette.addItem({
+        args: { reload: true },
+        command: 'apputils:reset',
+        category
+      });
     }
-  });
-
-  if (palette) {
-    resources.forEach(args => {
-      palette.addItem({ args, command: CommandIDs.open, category });
-    });
-    palette.addItem({
-      args: { reload: true },
-      command: 'apputils:reset',
-      category
-    });
-    palette.addItem({ command: CommandIDs.launchClassic, category });
   }
-}
+};
+
+const plugins: JupyterFrontEndPlugin<any>[] = [launchClassic, plugin];
+export default plugins;