jupyterlab-tour 3.1.4 → 4.0.0

package/README.md

@@ -1,18 +1,20 @@
 # jupyterlab-tour
 
-[![Extension status](https://img.shields.io/badge/status-ready-success "ready to be used")](https://jupyterlab-contrib.github.io/)
+[![Extension status](https://img.shields.io/badge/status-ready-success 'ready to be used')](https://jupyterlab-contrib.github.io/)
 [![Github Actions Status](https://github.com/jupyterlab-contrib/jupyterlab-tour/workflows/Build/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab-tour/actions?query=workflow%3ABuild)
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-tour.git/master?urlpath=lab)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-tour/main?urlpath=lab)
 [![npm](https://img.shields.io/npm/v/jupyterlab-tour)](https://www.npmjs.com/package/jupyterlab-tour)
 [![PyPI](https://img.shields.io/pypi/v/jupyterlab-tour)](https://pypi.org/project/jupyterlab-tour)
 [![conda-forge](https://img.shields.io/conda/vn/conda-forge/jupyterlab-tour)](https://anaconda.org/conda-forge/jupyterlab-tour)
 
 A JupyterLab UI Tour based on [react-joyride](https://docs.react-joyride.com).
 
-![demo](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-tour/master/doc/tourDemo.gif)
+![demo](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-tour/main/doc/tourDemo.gif)
 
 ## Install
 
+To install the extension, execute:
+
 ```bash
 pip install jupyterlab-tour
 ```
@@ -31,31 +33,38 @@ This extension has the following features:
   - Welcome tour
   - Notebook tour
   - User-defined features in Settings
-- Toast proposing to start a tour - to experienced users the need to exit each time the tour.
-- If a tour has already be seen by the user, this is saved in the state database. So you can start tour on event only if the user have not seen it; e.g. the welcome tour is launched at JupyterLab start except if the user have seen it.
+- Toast proposing to start a Tour
+- If a Tour has already be seen by the user, this is saved in the state database. So you
+  can start Tour on event only if the user have not seen it; e.g. the _Welcome Tour_ is
+  launched at JupyterLab start except if the user have seen it.
 
 > The state is cleaned if this extension is updated
 
 - Tooltip are styled using JupyterLab theming system
 - Commands to _add_ and _launch_ tours
-- Through the tour manager (`ITourManager` extension token), add, modify or delete a tour
-- Connect to tour events through signals
-- Override the default style (and options) for the tour separately
+- Through the _Tour Manager_ (`ITourManager` extension token), add, modify or delete a
+  Tour
+- Connect to Tour events through signals
+- Override the default style (and options) for the Tour separately
 
-This extension is inspired by [@cdat/jupyterlab-tutorial](https://github.com/CDAT/jupyterlab-tutorial) licensed under BSD 3-Clause License with Copyright (c) 2020, Lawrence Livermore National Security, LLC.
+This extension is inspired by
+[@cdat/jupyterlab-tutorial](https://github.com/CDAT/jupyterlab-tutorial) licensed under
+BSD 3-Clause License with Copyright (c) 2020, Lawrence Livermore National Security, LLC.
 
 ## Requirements
 
-- JupyterLab >= 3.0
+- JupyterLab >= 3.6
 
-For JupyterLab 2.x, have look [there](https://github.com/jupyterlab-contrib/jupyterlab-tour/tree/2.x).
+For JupyterLab 2.x, have look
+[there](https://github.com/jupyterlab-contrib/jupyterlab-tour/tree/2.x).
 
-> For developers, the API has changed between v3 (for JupyterLab 3) and v2 (for JupyterLab 2).
+> For developers, the API has changed between v3 (for JupyterLab 3) and v2 (for
+> JupyterLab 2).
 
-## How to add a tour with Advanced Settings
+## How to add a Tour with Advanced Settings
 
-As a user of JupyterLab, after you've installed `jupyterlab-tour`, you can create
-your own _Tours_ as data.
+As a user of JupyterLab, after you've installed `jupyterlab-tour`, you can create your
+own _Tours_ as data.
 
 - Open the JupyterLab _Advanced Settings_ panel <kbd>Ctrl+,</kbd>
 - Select _Tours_ from list of settings groups
@@ -71,20 +80,18 @@ overlay when pressed:
 ```json5
 // json5 can have comments
 {
-  "tours": [
+  tours: [
     {
-      "id": "my-tour",
-      "label": "My First Tour",
+      id: 'my-tour',
+      label: 'My First Tour',
       // steps are required, and have many, many options
-      "steps": [
-        {"target": "#jp-MainLogo", "content": "Look at this!"}
-      ],
+      steps: [{ target: '#jp-MainLogo', content: 'Look at this!' }],
       // below here not required!
-      "options": {
-        "styles": {
-          "options": {
+      options: {
+        styles: {
+          options: {
             // you can use jupyterlab theme variables
-            "backgroundColor": "var(--jp-warn-color0)"
+            backgroundColor: 'var(--jp-warn-color0)'
           }
         }
       }
@@ -93,42 +100,65 @@ overlay when pressed:
 }
 ```
 
+## How to add a Tour to a Notebook
+
+The same JSON used to create a Tour in _Advanced Settings_ can be added to a Notebook.
+
+- Open the Notebook
+- Open the _Property Inspector_ sidebar (the "gears" icon)
+- Open _Advanced Tools_
+- Create a key in _Notebook Metadata_ like:
+
+```json
+{
+  "jupyterlab-tour": {
+    "tours": []
+  }
+}
+```
+
+Now, when the notebook is opened, a "pin" icon will be visible in the _Notebook Toolbar_
+which will allow lauching one (or all) of the tours saved in the Notebook.
+
 ### Shipping a Tour to Binder
 
-On Binder, and elsewhere, you can store the above (_without_ comments) in
-an [overrides.json] file and put it in the _right place_,
-e.g. `{sys.prefix}/share/jupyter/lab/settings/overrides.json`. When JupyterLab is
-next opened, those overrides will become the defaults, and your tour will be available.
+On Binder, and elsewhere, you can store the above (_without_ comments) in an
+[overrides.json] file and put it in the _right place_, e.g.
+`{sys.prefix}/share/jupyter/lab/settings/overrides.json`. When JupyterLab is next
+opened, those overrides will become the defaults, and your Tour will be available.
 
 An example `overrides.json` might look like:
-```json5
+
+```json
 {
   "jupyterlab-tour:user-tours": {
-    "tours": [
-      // that tour up there!
-    ]
+    "tours": []
   }
 }
 ```
 
-[overrides.json]: https://jupyterlab.readthedocs.io/en/stable/user/directories.html#overrides-json
+[overrides.json]:
+  https://jupyterlab.readthedocs.io/en/stable/user/directories.html#overrides-json
 
-## How to add tour for my JupyterLab extension
+## How to add Tour for my JupyterLab extension
 
-As an extension developer, there are two methods to add a tour: the easiest is to use JupyterLab commands and the advanced version is to request this
-extension token `ITourManager`.
+As an extension developer, there are two methods to add a tour: the easiest is to use
+JupyterLab commands and the advanced version is to request this extension token
+`ITourManager`.
 
-### Add easily a tour
+### Add a Tour with TypeScript
 
 ```ts
 const { commands } = app;
-// Add a tour - returns the tour or null if something went wrong
+// Add a Tour - returns the Tour or null if something went wrong
 const tour = (await app.commands.execute('jupyterlab-tour:add', {
-  tour: { // Tour must be of type ITour - see src/tokens.ts
+  tour: {
+    // Tour must be of type ITour - see src/tokens.ts
     id: 'test-jupyterlab-tour:welcome',
     label: 'Welcome Tour',
     hasHelpEntry: true,
-    steps: [  // Step must be of type IStep - see src/tokens.ts
+    steps: [
+      // Step must be of type IStep - see src/tokens.ts
       {
         content:
           'The following tutorial will point out some of the main UI components within JupyterLab.',
@@ -143,46 +173,48 @@ const tour = (await app.commands.execute('jupyterlab-tour:add', {
         target: '#jp-main-dock-panel',
         title: 'Main Content'
       }
-    ],
+    ]
     // can also define `options`
   }
 })) as ITourHandler;
-if ( tour ) {
+if (tour) {
   app.commands.execute('jupyterlab-tour:launch', {
     id: 'test-jupyterlab-tour:welcome',
-    force: false  // Optional, if false the tour will start only if the user have not seen or skipped it
-  })
+    force: false // Optional, if false the Tour will start only if the user have not seen or skipped it
+  });
 }
 ```
 
-> One example is available on [Mamba navigator](https://github.com/mamba-org/gator/blob/master/packages/labextension/src/index.ts#L76).
+> One example is available on
+> [Mamba navigator](https://github.com/mamba-org/gator/blob/master/packages/labextension/src/index.ts#L76).
 > Test it on [binder](https://mybinder.org/v2/gh/mamba-org/gator/master?urlpath=lab).
 
-If you want to react to step changes to trigger elements of the UI (like opening sidebar), you can connect
-to the `stepChanged` signal. Building from the previous example, this snippet will open the filebrowser
-after the first step.
+If you want to react to step changes to trigger elements of the UI (like opening
+sidebar), you can connect to the `stepChanged` signal. Building from the previous
+example, this snippet will open the filebrowser after the first step.
 
 ```ts
-  tour.stepChanged.connect((_, data) => {
-    switch (data.type) {
-      case 'step:after':
-        if (data.step.target === '#jp-main-dock-panel') {
-          commands.execute('filebrowser:activate');
-        }
-        break;
-    }
-  });
+tour.stepChanged.connect((_, data) => {
+  switch (data.type) {
+    case 'step:after':
+      if (data.step.target === '#jp-main-dock-panel') {
+        commands.execute('filebrowser:activate');
+      }
+      break;
+  }
+});
 ```
 
-> `data` is an object of type [`CallbackProps`](https://docs.react-joyride.com/callback).
+> `data` is an object of type
+> [`CallbackProps`](https://docs.react-joyride.com/callback).
 
-## Disabling the User and Default Tours
+## Disabling the User, Notebook, and Default Tours
 
-If you _only_ wish to see the default _Welcome_ and _Notebook_ tours, or ones
-defined by users, they can be disabled via the command line or a well-known file.
+If you _only_ wish to see the default _Welcome_ and _Notebook_ tours, or ones defined by
+users, they can be disabled via the command line or a well-known file.
 
-The examples below disable all tours not provided by third-party extensions.
-Adding `jupyterlab-tour:plugin` to either of these will disable tours altogether!
+The examples below disable all tours not provided by third-party extensions. Adding
+`jupyterlab-tour:plugin` to either of these will disable tours altogether!
 
 ### Disabling Tours from the Command Line
 
@@ -190,6 +222,7 @@ From the command line, run:
 
 ```bash
 jupyter labextension disable "jupyterlab-tour:user-tours"
+jupyter labextension disable "jupyterlab-tour:notebook-tours"
 jupyter labextension disable "jupyterlab-tour:default-tours"
 ```
 
@@ -203,16 +236,19 @@ Create a [pageConfig.json] and put it in _the right place_, e.g.
 {
   "disabledExtensions": {
     "jupyterlab-tour:user-tours": true,
-    "jupyterlab-tour:default-tours": true,
+    "jupyterlab-tour:notebook-tours": true,
+    "jupyterlab-tour:default-tours": true
   }
 }
 ```
 
-[pageConfig.json]: https://jupyterlab.readthedocs.io/en/stable/user/directories.html#labconfig-directories
-
+[pageConfig.json]:
+  https://jupyterlab.readthedocs.io/en/stable/user/directories.html#labconfig-directories
 
 ## Uninstall
 
+To remove the extension, execute:
+
 ```bash
 pip uninstall jupyterlab-tour
 ```
@@ -229,34 +265,76 @@ conda remove -c conda-forge jupyterlab-tour
 
 Note: You will need NodeJS to build the extension package.
 
-The `jlpm` command is JupyterLab's pinned version of
-[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
-`yarn` or `npm` in lieu of `jlpm` below.
+The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that
+is installed with JupyterLab. You may use `yarn` or `npm` in lieu of `jlpm` below.
 
 ```bash
 # Clone the repo to your local environment
 # Change directory to the jupyterlab-tour directory
 # Install package in development mode
-pip install -e .
+pip install -e "."
 # Link your development version of the extension with JupyterLab
 jupyter labextension develop . --overwrite
 # Rebuild extension Typescript source after making changes
-jlpm run build
+jlpm build
 ```
 
-You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+You can watch the source directory and run JupyterLab at the same time in different
+terminals to watch for changes in the extension's source and automatically rebuild the
+extension.
 
 ```bash
 # Watch the source directory in one terminal, automatically rebuilding when needed
-jlpm run watch
+jlpm watch
 # Run JupyterLab in another terminal
 jupyter lab
 ```
 
-With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+With the watch command running, every saved change will immediately be built locally and
+available in your running JupyterLab. Refresh JupyterLab to load the change in your
+browser (you may need to wait several seconds for the extension to be rebuilt).
 
-By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+By default, the `jlpm build` command generates the source maps for this extension to
+make it easier to debug using the browser dev tools. To also generate source maps for
+the JupyterLab core extensions, you can run the following command:
 
 ```bash
 jupyter lab build --minimize=False
 ```
+
+### Development uninstall
+
+```bash
+pip uninstall jupyterlab-tour
+```
+
+In development mode, you will also need to remove the symlink created by
+`jupyter labextension develop` command. To find its location, you can run
+`jupyter labextension list` to figure out where the `labextensions` folder is located.
+Then you can remove the symlink named `jupyterlab-tour` within that folder.
+
+### Testing the extension
+
+#### Frontend tests
+
+This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
+
+To execute them, execute:
+
+```sh
+jlpm
+jlpm test
+```
+
+#### Integration tests
+
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration
+tests (aka user level tests). More precisely, the JupyterLab helper
+[Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle
+testing the extension in JupyterLab.
+
+More information are provided within the [ui-tests](./ui-tests/README.md) README.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)

package/lib/__tests__/plugin.spec.d.ts

@@ -0,0 +1 @@
+import 'jest';

package/lib/__tests__/plugin.spec.js

@@ -0,0 +1,151 @@
+import { Notebook, NotebookModel, NotebookPanel } from '@jupyterlab/notebook';
+import { CommandRegistry } from '@lumino/commands';
+import { DocumentRegistry } from '@jupyterlab/docregistry';
+import { CodeMirrorEditorFactory, CodeMirrorMimeTypeService, EditorLanguageRegistry } from '@jupyterlab/codemirror';
+import { Signal } from '@lumino/signaling';
+import 'jest';
+import { CommandIDs } from '../constants';
+import plugin from '../index';
+import { NS } from '../tokens';
+const DEFAULT_TOURS_SIZE = 2;
+const [corePlugin, userPlugin, notebookPlugin, defaultsPlugin] = plugin;
+function mockApp() {
+    return {
+        commands: new CommandRegistry(),
+        restored: Promise.resolve(),
+        docRegistry: new DocumentRegistry()
+    };
+}
+function aTour() {
+    return {
+        id: 'test-jupyterlab-tour:welcome',
+        label: 'Welcome Tour',
+        hasHelpEntry: true,
+        steps: [
+            {
+                content: 'Tours of Jupyter',
+                placement: 'auto',
+                target: '#jp-MainLogo',
+                title: 'Jupyter'
+            },
+            {
+                content: 'The following tour will point out some of the main UI components within JupyterLab.',
+                placement: 'right',
+                target: '#jp-main-dock-panel',
+                title: 'Welcome to Jupyter Lab!'
+            },
+            {
+                content: 'This is the main content area where notebooks and other content can be viewed and edited.',
+                placement: 'center',
+                target: '#jp-main-dock-panel',
+                title: 'Main Content'
+            }
+        ]
+    };
+}
+function mockSettingRegistry() {
+    const settings = {
+        composite: { tours: [aTour()] }
+    };
+    settings['changed'] = new Signal(settings);
+    return {
+        load: async () => settings
+    };
+}
+function mockNbTracker() {
+    const nbTracker = {};
+    nbTracker.widgetAdded = new Signal(nbTracker);
+    return nbTracker;
+}
+describe(corePlugin.id, () => {
+    describe('activation', () => {
+        it('should create add-tour command', () => {
+            var _a;
+            const app = mockApp();
+            corePlugin.activate(app);
+            expect((_a = app.commands) === null || _a === void 0 ? void 0 : _a.hasCommand(CommandIDs.addTour)).toEqual(true);
+        });
+    });
+    describe('commands', () => {
+        describe(`${CommandIDs.addTour}`, () => {
+            it('should add a tour command', async () => {
+                var _a;
+                const app = mockApp();
+                const manager = corePlugin.activate(app);
+                expect(manager.tours.size).toEqual(0);
+                const tour = await ((_a = app.commands) === null || _a === void 0 ? void 0 : _a.execute(CommandIDs.addTour, {
+                    tour: aTour()
+                }));
+                expect(manager.tours.size).toEqual(1);
+                expect(tour).toBeTruthy();
+                expect(manager.tours.get(tour.id)).toBeTruthy();
+            });
+        });
+    });
+});
+describe(userPlugin.id, () => {
+    describe('activation', () => {
+        it('should have userTours', async () => {
+            const app = mockApp();
+            const manager = corePlugin.activate(app);
+            const settings = mockSettingRegistry();
+            const userManager = userPlugin.activate(app, settings, manager);
+            await userManager.ready;
+            expect(userManager.tourManager.tours.size).toBe(1);
+        });
+    });
+    describe('settings', () => {
+        it('should react to settings', async () => {
+            const app = mockApp();
+            const manager = corePlugin.activate(app);
+            const settingsRegistry = mockSettingRegistry();
+            const userManager = userPlugin.activate(app, settingsRegistry, manager);
+            await userManager.ready;
+            const settings = await settingsRegistry.load('whatever');
+            settings.composite = { tours: [] };
+            settings.changed.emit(void 0);
+            expect(userManager.tourManager.tours.size).toBe(0);
+        });
+    });
+});
+describe(notebookPlugin.id, () => {
+    describe('activation', () => {
+        it('should activate', async () => {
+            const app = mockApp();
+            const manager = corePlugin.activate(app);
+            const nbTracker = mockNbTracker();
+            const notebookTourManager = notebookPlugin.activate(app, nbTracker, manager);
+            const languages = new EditorLanguageRegistry();
+            const factoryService = new CodeMirrorEditorFactory({
+                languages
+            });
+            const mimeTypeService = new CodeMirrorMimeTypeService(languages);
+            const editorFactory = factoryService.newInlineEditor;
+            const notebook = new Notebook({
+                rendermime: null,
+                mimeTypeService,
+                contentFactory: new NotebookPanel.ContentFactory({ editorFactory })
+            });
+            const model = new NotebookModel();
+            notebook.model = model;
+            notebookTourManager.addNotebook(notebook);
+            expect(notebookTourManager.tourManager.tours.size).toBe(0);
+            model.setMetadata(NS, {
+                tours: [aTour()]
+            });
+            expect(notebookTourManager.tourManager.tours.size).toBe(1);
+            model.deleteMetadata(NS);
+            expect(notebookTourManager.tourManager.tours.size).toBe(0);
+        });
+    });
+});
+describe(defaultsPlugin.id, () => {
+    describe('activation', () => {
+        it('should activate', () => {
+            const app = mockApp();
+            const manager = corePlugin.activate(app);
+            defaultsPlugin.activate(app, manager);
+            expect(manager.tours.size).toEqual(DEFAULT_TOURS_SIZE);
+        });
+    });
+});

package/lib/components.js

@@ -37,7 +37,7 @@ class Tour extends React.Component {
         };
     }
     render() {
-        return this.props.tours && this.props.tours[this.state.index] ? (React.createElement(ReactJoyride, Object.assign({ key: this.props.tours[this.state.index].id }, this.props.tours[this.state.index].options, { callback: this._handleJoyrideCallback, run: this.state.run, steps: this.props.tours[this.state.index].steps }))) : null;
+        return this.props.tours && this.props.tours[this.state.index] ? (React.createElement(ReactJoyride, { key: this.props.tours[this.state.index].id, ...this.props.tours[this.state.index].options, callback: this._handleJoyrideCallback, run: this.state.run, steps: this.props.tours[this.state.index].steps })) : null;
     }
 }
 /**