File Radar Extension (jupyter-server#158)

* add file radar extension

* add extension to plugin list

* explicitly calculate coverage from all files

* jest config point at ts

* working tests

* remove unnecessary testing logic

* add yarn.lock back in and remove unused imports in test/utils

* bump test coverage threshold

jest.config.js

@@ -11,8 +11,9 @@ config.coverageThreshold = {
   global: {
     functions: 90,
     lines: 85,
-    statements: -15
+    statements: -20
   }
 };
+config.collectCoverageFrom = ['src/**/*.{ts,tsx}'];
 
 module.exports = config;

src/fileradar.ts

@@ -0,0 +1,37 @@
+import { IMainMenu } from '@jupyterlab/mainmenu';
+
+import {
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+
+/**
+ * Build an external links menu item.
+ */
+export const FileRadarPlugin: JupyterFrontEndPlugin<void> = {
+  id: 'data_studio:file_radar_plugin',
+  autoStart: true,
+  requires: [IMainMenu],
+  activate: (app: JupyterFrontEnd, mainMenu: IMainMenu) => {
+    console.log('JupyterLab extension "File Radar" is activated!');
+
+    const radarUrl =
+      'rdar://new/problem/component=ACI%20Data%20Studio&version=Support';
+    const commandID = 'help:file-radar';
+
+    app.commands.addCommand(commandID, {
+      label: 'File a Radar',
+      isEnabled: () => true,
+      isVisible: () => true,
+      execute: () => {
+        window.open(radarUrl);
+      }
+    });
+
+    mainMenu.helpMenu.addGroup([
+      {
+        command: commandID
+      }
+    ]);
+  }
+};

src/index.ts

@@ -2,10 +2,12 @@ import { JupyterFrontEndPlugin } from '@jupyterlab/application';
 
 import { ExternalLinksPlugin } from './externallinks';
 import { kernelStatusPlugin } from './status';
+import { FileRadarPlugin } from './fileradar';
 
 const plugins: JupyterFrontEndPlugin<any>[] = [
   kernelStatusPlugin,
-  ExternalLinksPlugin
+  ExternalLinksPlugin,
+  FileRadarPlugin
 ];
 
 export default plugins;

test/fileradar.spec.ts

@@ -0,0 +1,65 @@
+// import { CommandRegistry } from '@lumino/commands';
+
+import { JupyterLab } from '@jupyterlab/application';
+
+import { MainMenu } from '@jupyterlab/mainmenu';
+import { CommandRegistry } from '@lumino/commands';
+import { JupyterServer } from '@jupyterlab/testutils';
+
+import { FileRadarPlugin } from '../src/fileradar';
+
+jest.useFakeTimers(); // Keep at the Top of the file
+const server = new JupyterServer();
+
+beforeAll(async () => {
+  jest.setTimeout(20000);
+  await server.start();
+});
+
+afterAll(async () => {
+  await server.shutdown();
+});
+
+describe('status', () => {
+  let app: JupyterLab;
+  let registry: CommandRegistry;
+  let mainMenu: MainMenu;
+
+  beforeEach(async () => {
+    // Wait for the server to start before creating the application
+    // so we pick up the page config (base url, etc.)
+    app = new JupyterLab();
+    registry = app.commands;
+    mainMenu = new MainMenu(registry);
+  });
+
+  it('should handle file radar link', () => {
+    FileRadarPlugin.activate(app, mainMenu);
+    const registry = app.commands;
+    const helpMenu = mainMenu.helpMenu;
+    const commandID = 'help:file-radar';
+
+    // Assert that the command is registered when the
+    // extension is activated.
+    expect(registry.hasCommand(commandID)).toEqual(true);
+    // Assert that the helpmenu includes the new item.
+    expect(helpMenu.items).toEqual(
+      expect.arrayContaining([expect.objectContaining({ command: commandID })])
+    );
+
+    // Set up a spy to see if the window opens
+    // a radar.
+    const closeSpy = jest.fn();
+    window.open = jest.fn().mockReturnValue({ close: closeSpy });
+    window.close = jest.fn();
+
+    // Execute the command and assert that a radar is opened.
+    registry.execute(commandID);
+    expect(window.open).toHaveBeenCalled();
+    expect(window.open).toHaveBeenCalledWith(
+      'rdar://new/problem/component=ACI%20Data%20Studio&version=Support'
+    );
+
+    jest.runAllTimers();
+  });
+});

test/utils.ts

@@ -9,7 +9,6 @@ import {
 } from '@jupyterlab/notebook';
 
 import { NBTestUtils } from '@jupyterlab/testutils';
-
 /**
  * Create a notebook widget factory.
  */