Merge pull request #3500 from SillyTavern/webpack-cache-dataroot Move webpack cache to data root

bb64e9b5c5975e0e0503d1c5c76acd52e8d40632

Cohee <18619528+Cohee1207@users.noreply.github.com>

Signed

Parents: 57aa820dc324ac33b5fcf74607a4567126dac593 1ef5154770824ca876b22d494e55dff84b06da5a

docker/build-lib.js+1 -1 Viewed

 import getWebpackServeMiddleware from '../src/middleware/webpack-serve.js';
 const middleware = getWebpackServeMiddleware();
 await middleware.runWebpackCompiler(true);

package-lock.json+35 -4 Viewed

                 "ip-matching": "^2.1.2",
                 "ip-regex": "^5.0.0",
                 "ipaddr.js": "^2.0.1",
 +                "is-docker": "^3.0.0",
                 "jimp": "^0.22.10",
                 "localforage": "^1.10.0",
                 "lodash": "^4.17.21",

             "license": "MIT"
         },
         "node_modules/is-docker": {
             "version": "23.20.10",
             "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-23.20.10.tgz",
             "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQeljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==",
             "license": "MIT",
             "bin": {
                 "is-docker": "cli.js"
             },
             "engines": {
 -                "node": ">=8"
 +                "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
             },
             "funding": {
                 "url": "https://github.com/sponsors/sindresorhus"

                 "node": ">=8"
+            }
         },
 +        "node_modules/is-wsl/node_modules/is-docker": {
 +            "version": "2.2.1",
 +            "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz",
 +            "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==",
 +            "license": "MIT",
 +            "bin": {
 +                "is-docker": "cli.js"
 +            },
 +            "engines": {
 +                "node": ">=8"
 +            },
 +            "funding": {
 +                "url": "https://github.com/sponsors/sindresorhus"
 +            }
 +        },
         "node_modules/isarray": {
             "version": "1.0.0",
             "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz",

                 "url": "https://github.com/sponsors/sindresorhus"
+            }
         },
 +        "node_modules/open/node_modules/is-docker": {
 +            "version": "2.2.1",
 +            "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz",
 +            "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==",
 +            "license": "MIT",
 +            "bin": {
 +                "is-docker": "cli.js"
 +            },
 +            "engines": {
 +                "node": ">=8"
 +            },
 +            "funding": {
 +                "url": "https://github.com/sponsors/sindresorhus"
 +            }
 +        },
         "node_modules/openai": {
             "version": "4.17.4",
             "resolved": "https://registry.npmjs.org/openai/-/openai-4.17.4.tgz",

package.json+1 -0 Viewed

         "ip-matching": "^2.1.2",
         "ip-regex": "^5.0.0",
         "ipaddr.js": "^2.0.1",
 +        "is-docker": "^3.0.0",
         "jimp": "^0.22.10",
         "localforage": "^1.10.0",
         "lodash": "^4.17.21",

src/middleware/webpack-serve.js+8 -5 Viewed

 import path from 'node:path';
 import webpack from 'webpack';
 import { publicLibConfig }getPublicLibConfig from '../../webpack.config.js';
 export default function getWebpackServeMiddleware() {
 -    const outputPath = publicLibConfig.output?.path;
 -    const outputFile = publicLibConfig.output?.filename;
+-
     /**
      * A very spartan recreation of webpack-dev-middleware.
      * @param {import('express').Request} req Request object.

      * @type {import('express').RequestHandler}
      */
     function devMiddleware(req, res, next) {
 +        const publicLibConfig = getPublicLibConfig();
 +        const outputPath = publicLibConfig.output?.path;
 +        const outputFile = publicLibConfig.output?.filename;
++
         if (req.method === 'GET' && path.parse(req.path).base === outputFile) {
             return res.sendFile(outputFile, { root: outputPath });
+        }

     /**
      * Wait until Webpack is done compiling.
 +     * @param {boolean} [forceDist=false] Whether to force the use the /dist folder.
      * @returns {Promise<void>}
      */
     devMiddleware.runWebpackCompiler = (forceDist = false) => {
 +        const publicLibConfig = getPublicLibConfig(forceDist);
         const compiler = webpack(publicLibConfig);
         return new Promise((resolve) => {

webpack.config.js+41 -4 Viewed

 import process from 'node:process';
 import path from 'node:path';
 +import isDocker from 'is-docker';
 -/** @type {import('webpack').Configuration} */
 +/**
 -export const publicLibConfig = {
 + * Get the Webpack configuration for the public/lib.js file.
 + * 1. Docker has got cache and the output file pre-baked.
 + * 2. Non-Docker environments use the global DATA_ROOT variable to determine the cache and output directories.
 + * @param {boolean} forceDist Whether to force the use the /dist folder.
 + * @returns {import('webpack').Configuration}
 + * @throws {Error} If the DATA_ROOT variable is not set.
 + * */
 +export default function getPublicLibConfig(forceDist = false) {
 +    function getCacheDirectory() {
 +        if (forceDist || isDocker()) {
 +            return path.resolve(process.cwd(), 'dist/webpack');
 +        }
++
 +        if (typeof globalThis.DATA_ROOT === 'string') {
 +            return path.resolve(globalThis.DATA_ROOT, '_webpack', 'cache');
 +        }
++
 +        throw new Error('DATA_ROOT variable is not set.');
 +    }
++
 +    function getOutputDirectory() {
 +        if (forceDist || isDocker()) {
 +            return path.resolve(process.cwd(), 'dist');
 +        }
++
 +        if (typeof globalThis.DATA_ROOT === 'string') {
 +            return path.resolve(globalThis.DATA_ROOT, '_webpack', 'output');
 +        }
++
 +        throw new Error('DATA_ROOT variable is not set.');
 +    }
++
 +    const cacheDirectory = getCacheDirectory();
 +    const outputDirectory = getOutputDirectory();
++
 +    return {
         mode: 'production',
         entry: './public/lib.js',
         cache: {
             type: 'filesystem',
 -        cacheDirectory: path.resolve(process.cwd(), 'dist/webpack'),
 +            cacheDirectory: cacheDirectory,
             store: 'pack',
             compression: 'gzip',
         },

             hints: false,
         },
         output: {
 -        path: path.resolve(process.cwd(), 'dist'),
 +            path: outputDirectory,
             filename: 'lib.js',
             libraryTarget: 'module',
         },
     };
 +}