feat!: update deps, refactor, remove selfContained and more (#84)

- clean and update dependencies
- Replace deps with node alternatives: request, lodash
- make package ESM only
- upgrade node to 22
- Add more config examples and improve README with examples
- remove selfContained option. This option was adding a lot of code and complexity. Building a site which actually does not do any outside requests is difficult to guarantee in this context and the existing implementation had a lot of problems and cases not covered.
- enable server side inclusions in dev apache configuration.
- allow the config CLI argument to be passed multiple times
- split code into separate files, which required a lot of refactoring
- improve lock reliability, and use it only when using the CLI to build
- fix build config when passed an absolute layout path
- adapt dev docker compose to allow to switch between builds easily via environment variable
- update release action

BREAKING CHANGES: Package is now ESM only. Upgrade node to 22. Support for `selfContained` was removed. Only use lock when run with CLI. Remove `pidFile` config and use temporary file instead.

Author: stropitek

.eslintrc.yml

@@ -6,18 +6,17 @@ on:
       - main
   pull_request:
 
-env:
-  NODE_VERSION: 20.x
-
 jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version-file: package.json
       - name: Install dependencies
         run: npm install
+      - name: Run prettier
+        run: npm run prettier
       - name: Run ESLint
         run: npm run eslint

.github/workflows/nodejs.yml

@@ -5,18 +5,12 @@ on:
     branches:
       - main
 
-env:
-  NODE_VERSION: 20.x
-
 jobs:
-  release-please:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Get package name
-        run: echo "PACKAGE_NAME=$(jq .name package.json | tr -d '"')" >> $GITHUB_ENV
-      - uses: GoogleCloudPlatform/release-please-action@v2
-        id: release
-        with:
-          token: ${{ secrets.BOT_TOKEN }}
-          release-type: node
-          package-name: ${{ env.PACKAGE_NAME }}
+  release:
+    # Documentation: https://github.com/zakodium/workflows#release
+    uses: zakodium/workflows/.github/workflows/release.yml@release-v1
+    with:
+      npm: true
+    secrets:
+      github-token: ${{ secrets.BOT_TOKEN }}
+      npm-token: ${{ secrets.NPM_BOT_TOKEN }}

.github/workflows/release.yml

@@ -1,4 +1,9 @@
 build
 config.json
 layouts.json
-node_modules
+node_modules
+coverage
+
+test-coverage.js
+
+

.gitignore

@@ -1 +1,4 @@
-*.html
+*.html
+themes
+lib
+CHANGELOG.md

.prettierignore

@@ -1,4 +1,4 @@
-FROM node:20-slim
+FROM node:22-slim
 
 RUN apt-get update && apt-get install -y cron git
 
@@ -14,7 +14,7 @@ RUN touch /var/log/cron.log
 COPY start.sh /start.sh
 RUN chmod 744 /start.sh
 
-COPY on-tabs-config.json /on-tabs-config.json
+COPY ./configs/on-tabs.json /on-tabs-config.json
 
 COPY ./ ./
 

Dockerfile

@@ -1,23 +1,27 @@
 # flavor-builder
+
 Visualizer website generator
 
 ## Test the build
 
 To test the build, run:
 
 ```bash
-DEBUG=flavor-builder:info node bin/build.js  --config=./cheminfo-config.json
+DEBUG=flavor-builder:info node bin/build.js  --config=./configs/cheminfo.json
 ```
 
-As configured by `cheminfo-config.json`, this will write to the `build` directory:
+There are other build configurations available in the `configs` directory to test.
+
+As configured by `configs/cheminfo.json`, this will write to the `build` directory:
+
 - `cheminfo-revisions.json` and `cheminfo-md5.json` which keep track of what has been updated.
-- `cheminfo-flavor-builder.pid` which is used as a lock to know if a build is already in progress.
 - `out` directory which contains the result of the build
 
 Build the admin page by running:
+
 ```bash
 mkdir build/out/on-tabs
-node node_modules/visualizer-on-tabs/bin/build.js --outDir=$(realpath ./build/out/on-tabs/) --config=$(realpath ./on-tabs-config.json)
+node node_modules/visualizer-on-tabs/bin/build.js --outDir=$(realpath ./build/cheminfo/out/on-tabs/) --config=$(realpath ./configs/on-tabs.json)
 ```
 
 To test the built website using apache, run:
@@ -26,9 +30,41 @@ To test the built website using apache, run:
 docker compose up -d
 ```
 
-And visit `http://localhost:6060`, and `http://localhost:6060` for the visualizer admin page.
+Home page: `http://localhost:6060`
+Example of on-tabs page: `http://localhost:6060/flavor/eln/reaction/index.html`
+
+If you built the admin page, you can access it at: `http://localhost:6060/on-tabs/`
+
+## Build with couchdb authentication
+
+If access to the CouchDB database is protected, use the `COUCHDB_USER` and `COUCHDB_PASSWORD` environment variables to provide the credentials.
+
+For example, assuming you have a working couchdb instance on `localhost:5984`, you could run:
+
+```bash
+DEBUG=flavor-builder:info COUCHDB_USER=admin COUCHDB_PASSWORD=<FILL_PASSWORD_HERE> node bin/build.js --config=./configs/scipeaks.json
+```
+
+````bash
+
+## Test an alternative build
+
+Use your own configuration or build from one of the existing ones in the `configs` directory.
+
+```bash
+DEBUG=flavor-builder:info node bin/build.js  --config=./configs/flavor-1024.json
+# Will serve build/flavor-1024/out/ on port 6060
+SERVE_DIR=flavor-1024 docker compose up -d
+open http://localhost:6060/
+````
+
+> **Warning**
+> The `on-tabs` page is not fully functional in this setup.
+
+> [!WARNING]  
+> Critical content demanding immediate user attention due to potential risks.
 
-The admin page or the `on-tabs` pages build by the flavor-builder are not expected to work with this setup.
+TODO: example with couch authentication.
 
 ## CLI usage
 
@@ -43,5 +79,3 @@ It is responsible for building static assets but not for running a web server li
 - The outputs of the builds are written to `/var/www/html/` base directory on the container.
 - Runs a command when the container starts that builds the visualizer admin page to the `on-tabs` directory, based on the `/on-tabs-config.json` configuration file.
 - Runs a command every minute which builds pages to the base directory based on the `/flavor-config.json` configuration file.
-
-

README.md

@@ -0,0 +1,10 @@
+FROM httpd:2-alpine
+
+# my-httpd.conf was created by first getting the default httpd.conf:
+# $ docker run --rm httpd:2-alpine cat /usr/local/apache2/conf/httpd.conf > configs/httpd.conf
+# Then, it was modified to allow for SSI
+# `LoadModule include_module`: Loads the SSI module.
+# `Options ... Includes`: Enables SSI in the specified directory.
+# `AddType` and `AddOutputFilter`: Ensures .html files are parsed for SSI.
+
+COPY ./httpd.conf /usr/local/apache2/conf/httpd.conf

apache.Dockerfile

@@ -1,23 +1,29 @@
 #!/usr/bin/env node
 
-'use strict';
+import { tmpdir } from 'node:os';
+import path from 'node:path';
+import process from 'node:process';
 
-let args = require('minimist')(process.argv.slice(2));
+import minimist from 'minimist';
 
-let flavorBuilder = require('../src/index');
-const log = require('../src/log');
+import { build } from '../src/index.js';
+import { acquireLock, releaseLock } from '../src/lock.js';
+import log from '../src/log.js';
 
-let configs = args.config.split(',');
-let prom = [];
-for (let i = 0; i < configs.length; i++) {
-  prom.push(flavorBuilder.build(configs[i]));
+let args = minimist(process.argv.slice(2));
+const configFiles =
+  typeof args.config === 'string' ? args.config.split(',') : args.config;
+
+const pidFile = path.join(tmpdir(), 'flavor-builder.pid');
+let isProcessLocked = acquireLock(pidFile);
+if (isProcessLocked) {
+  throw new Error('flavor-builder already running');
+}
+
+for (let i = 0; i < configFiles.length; i++) {
+  await build(configFiles[i]);
 }
 
-Promise.all(prom)
-  .then(() => {
-    log.info('done build');
-  })
-  .catch((e) => {
-    console.error('Error building with flavor-builder', e, e.stack);
-    process.exit(1);
-  });
+await releaseLock(pidFile);
+
+log.info('done build');

bin/build.js

@@ -0,0 +1,8 @@
+services:
+  httpd:
+    build:
+      dockerfile: ./apache.Dockerfile
+    volumes:
+      - ./build/${SERVE_DIR-cheminfo}/out:/usr/local/apache2/htdocs
+    ports:
+      - 6060:80