speed up build process by importing voyager build script into source/ui

use legacy-peer-deps for voyager until Smithsonian/dpo-voyager#243 is merged

fix build scripts to properly skip voyager standalone build

.github/workflows/build.yml

@@ -17,11 +17,9 @@ jobs:
           node-version: 16
           cache: 'npm'
       - name: install voyager dependencies
-        run: (cd source/voyager && npm ci)
+        run: (cd source/voyager && npm ci --legacy-peer-deps)
       - name: install ui dependencies
         run: npm ci && (cd source/ui && npm ci)
-      - name: build voyager
-        run: npm run build-voyager
       - name: build UI
         run: npm run build-ui
   build-server:

Dockerfile

@@ -7,7 +7,7 @@ COPY source/server/package*.json /app/source/server/
 RUN (cd /app/source/server && npm ci)
 
 COPY source/voyager/package*.json /app/source/voyager/
-RUN (cd /app/source/voyager && npm ci)
+RUN (cd /app/source/voyager && npm ci --legacy-peer-deps)
 
 COPY source/ui/package*.json /app/source/ui/
 RUN (cd /app/source/ui && npm ci)
@@ -21,9 +21,6 @@ RUN npm run build-server
 # outputs files in /app/source/server/dist
 
 COPY source/voyager /app/source/voyager
-RUN npm run build-voyager
-# files are automatically picked up by build-ui
-
 COPY source/ui /app/source/ui
 RUN npm run build-ui
 # outputs files in /app/dist

README.md

@@ -0,0 +1,16 @@
+# eCorpus
+
+## Description
+
+This is the code repository for **eCorpus**, a content management system by the [eThesaurus](https://ethesaurus.holusion.com) consortium.
+
+## Repository structure
+
+The repository uses recursive [submodules](https://git-scm.com/docs/gitsubmodules), because the upstream [DPO-Voyager](https://github.com/) uses them.
+
+It means some commands will need to be run with the `--recurse-submodules` flag, or you will need to run `git submodule update --init --recursive` after cloning the repository.
+
+eg: `git clone --recurse-submodules [email protected]:Holusion/eCorpus`
+
+Day-to-day operations can be simplified by configuring git (globally or for thsi repository) to always recurse by default : `git config submodule.recurse true`.
+

package.json

@@ -7,7 +7,6 @@
     "test": "echo \"Error: no test specified\" && exit 1",
     "build-ui": "cd source/ui && webpack --mode=production",
     "build-server": "tsc -b source/server",
-    "build-voyager": "cd source/voyager/source/client; webpack --mode=production --env=app=all",
     "watch": "cd source/server && HOT_RELOAD=1 NODE_ENV=development ROOT_DIR=\"../../\" nodemon -e ts,js -w . -w ../ui/webpack.config.js -x ts-node index.ts"
   },
   "author": "Holusion <[email protected]>",

source/server/templates/explorer.hbs

@@ -1,3 +1,3 @@
 
 <voyager-explorer resourceroot="/dist/" root="/scenes/{{scene}}/" referrer="{{referrer}}" lang="{{lang}}"></voyager-explorer>
-<script type="text/javascript" src="/dist/js/voyager-explorer.min.js"></script>
+<script type="text/javascript" src="/dist/js/voyager-explorer.js"></script>

source/server/templates/story.hbs

@@ -1,4 +1,4 @@
 
 <voyager-story resourceRoot="/dist/" root="/scenes/{{scene}}/" referrer="{{referrer}}" lang="{{lang}}" mode="{{mode}}"></voyager-story>
-<script type="text/javascript" src="/dist/js/voyager-story.min.js"></script>
-<link rel="stylesheet" href="/dist/css/voyager-story.min.css">
+<script type="text/javascript" src="/dist/js/voyager-story.js"></script>
+<link rel="stylesheet" href="/dist/css/voyager-story.css">

source/ui/webpack.config.js

@@ -42,16 +42,16 @@ const dirs = {
     assets: path.resolve( project, "source/ui/assets"),
 };
 
+const createVoyagerConfig = require(path.join(project, "source/voyager/source/client/webpack.config.js"));
 
 
 ////////////////////////////////////////////////////////////////////////////////
 
-module.exports = function createAppConfig(env, argv)
+module.exports = function createAppConfig(env, argv={})
 {
     const isDevMode = (typeof argv?.mode !== "undefined") ? argv.mode !== "production" : process.env["NODE_ENV"] !== "production";
     const devMode = isDevMode ? "development" : "production";
 
-
     const config = {
         mode: devMode,
         cache: {type: "filesystem"},
@@ -64,7 +64,7 @@ module.exports = function createAppConfig(env, argv)
             filename: "js/[name].js",
 
             publicPath: '/',
-            clean: true,
+            clean: false,
         },
 
         resolve: {
@@ -98,7 +98,7 @@ module.exports = function createAppConfig(env, argv)
                     },
                     { 
                         from: "{js,js/draco,css,language,images}/*.{js,json,wasm,css,jpg,png,svg}",
-                        context: path.join(project, "source/voyager/dist/"),
+                        context: path.join(project, "source/voyager/assets/"),
                         force: false,
                         priority: 1,
                     },
@@ -161,5 +161,28 @@ module.exports = function createAppConfig(env, argv)
         config.devtool = "source-map";
     }
 
-    return config;
+    const voyagerConfig = createVoyagerConfig({app: "all"}, argv);
+    /********************************
+     * Override voyagerConfig's options
+     ********************************/
+
+    //Always use the same file name
+    Object.assign(voyagerConfig.output, {
+        clean: false,
+        filename: "js/[name].js",
+    });
+
+    //Remove HTML exports
+    voyagerConfig.plugins = voyagerConfig.plugins.filter(p=>p.constructor?.name !="HtmlWebpackPlugin");
+    //Remove Copy Plugin
+    voyagerConfig.plugins = voyagerConfig.plugins.filter(p=>p.constructor?.name !="CopyPlugin");
+
+    const cssPlugin = voyagerConfig.plugins.find(p=>p.constructor?.name =="MiniCssExtractPlugin");
+    if(!cssPlugin) throw new Error("MiniCssExtractPlugin not found in voyagerConfig.plugins");
+    Object.assign(cssPlugin.options, {
+        filename: "css/[name].css",
+        chunkFilename: "css/[name].css",
+    });
+
+    return [config, voyagerConfig];
 }