Merge pull request #988 from jasongrout/publicpath

Compute the public path automatically

Author: martinRenou

js/amd-public-path.js

@@ -0,0 +1,8 @@
+// In an AMD module, we set the public path using the magic requirejs 'module' dependency
+// See https://github.com/requirejs/requirejs/wiki/Differences-between-the-simplified-CommonJS-wrapper-and-standard-AMD-define#module
+// Since 'module' is a requirejs magic module, we must include 'module' in the webpack externals configuration.
+var module = require('module');
+var url = new URL(module.uri, document.location)
+// Using lastIndexOf('/')+1 gives us the empty string if there is no '/', so pathname becomes '/'
+url.pathname = url.pathname.slice(0,url.pathname.lastIndexOf('/')+1);
+__webpack_public_path__ = `${url.origin}${url.pathname}`;

js/src/notebook.js

@@ -1,7 +1,4 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-// Setup notebook base URL
-__webpack_public_path__ = document.querySelector('body').getAttribute('data-base-url') + 'nbextensions/jupyter-leaflet/';
-
 module.exports = require('./index.js');

js/webpack.config.js

@@ -1,76 +1,85 @@
-var path = require('path');
-var version = require('./package.json').version;
-var crypto = require('crypto');
+var path = require("path");
+var crypto = require("crypto");
 
 // Workaround for loaders using "md4" by default, which is not supported in FIPS-compliant OpenSSL
 var cryptoOrigCreateHash = crypto.createHash;
 crypto.createHash = (algorithm) =>
-  cryptoOrigCreateHash(algorithm == 'md4' ? 'sha256' : algorithm);
+  cryptoOrigCreateHash(algorithm == "md4" ? "sha256" : algorithm);
 
 var rules = [
-    {
-        test: /\.css$/,
-        use: ['style-loader', 'css-loader']
-    },
-    {
-        test: /\.(jpg|png|gif|svg)$/,
-        use: [
-            {
-                loader: 'file-loader',
-                options: {
-                    esModule: false,
-                }
-            }
-        ],
-    }
+  { test: /\.css$/, use: ["style-loader", "css-loader"] },
+  { test: /\.(jpg|png|gif|svg)$/i, type: "asset" },
 ];
 
 var resolve = {
-    fallback: {
-        "crypto": require.resolve("crypto-browserify"),
-        "buffer": require.resolve("buffer/"),
-        "stream": require.resolve("stream-browserify")
-    }
+  fallback: {
+    crypto: require.resolve("crypto-browserify"),
+    buffer: require.resolve("buffer/"),
+    stream: require.resolve("stream-browserify"),
+  },
 };
 
 module.exports = [
-    {// Notebook extension
-        entry: './src/extension.js',
-        output: {
-            filename: 'extension.js',
-            path: path.resolve(__dirname, '..', 'ipyleaflet', 'nbextension'),
-            libraryTarget: 'amd'
-        },
-        resolve: resolve
+  {
+    // Notebook extension
+    //
+    // This bundle only contains the part of the JavaScript that is run on
+    // load of the notebook. This section generally only performs
+    // some configuration for requirejs, and provides the legacy
+    // "load_ipython_extension" function which is required for any notebook
+    // extension.
+    entry: "./src/extension.js",
+    output: {
+      filename: "extension.js",
+      path: path.resolve(__dirname, "..", "ipyleaflet", "nbextension"),
+      libraryTarget: "amd",
+    },
+    resolve: resolve,
+  },
+  {
+    // Bundle for the notebook containing the custom widget views and models
+    //
+    // This bundle contains the implementation for the custom widget views and
+    // custom widget.
+    // It must be an amd module
+    entry: ["./amd-public-path.js", "./src/notebook.js"],
+    output: {
+      filename: "index.js",
+      path: path.resolve(__dirname, "..", "ipyleaflet", "nbextension"),
+      libraryTarget: "amd",
+      publicPath: "", // Set in amd-public-path.js
+    },
+    devtool: "source-map",
+    module: {
+      rules: rules,
+    },
+    // 'module' is the magic requirejs dependency used to set the publicPath
+    externals: ["@jupyter-widgets/base", "module"],
+    resolve: resolve,
+  },
+  {
+    // Embeddable jupyter-leaflet bundle
+    //
+    // This bundle is identical to the notebook bundle containing the custom
+    // widget views and models. The only difference is it is placed in the
+    // dist/ directory and shipped with the npm package for use from a CDN
+    // like jsdelivr.
+    //
+    // The target bundle is always `dist/index.js`, which is the path
+    // required by the custom widget embedder.
+    entry: ["./amd-public-path.js", "./src/embed.js"],
+    output: {
+      filename: "index.js",
+      path: path.resolve(__dirname, "dist"),
+      libraryTarget: "amd",
+      publicPath: "", // Set in amd-public-path.js
     },
-    {// jupyter-leaflet bundle for the classic notebook
-        entry: './src/notebook.js',
-        output: {
-            filename: 'index.js',
-            path: path.resolve(__dirname, '..', 'ipyleaflet', 'nbextension'),
-            libraryTarget: 'amd',
-            publicPath: '',
-        },
-        devtool: 'source-map',
-        module: {
-            rules: rules
-        },
-        externals: ['@jupyter-widgets/base'],
-        resolve: resolve
+    devtool: "source-map",
+    module: {
+      rules: rules,
     },
-    {// jupyter-leaflet bundle for unpkg
-        entry: './src/embed.js',
-        output: {
-            filename: 'index.js',
-            path: path.resolve(__dirname, 'dist'),
-            libraryTarget: 'amd',
-            publicPath: 'https://unpkg.com/jupyter-leaflet@' + version + '/dist/'
-        },
-        devtool: 'source-map',
-        module: {
-            rules: rules
-        },
-        externals: ['@jupyter-widgets/base'],
-        resolve: resolve
-    }
+    // 'module' is the magic requirejs dependency used to set the publicPath
+    externals: ["@jupyter-widgets/base", "module"],
+    resolve: resolve,
+  },
 ];