From 9131fdbbfbb9138387f9be7c8058ae680df34350 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Thu, 22 Apr 2021 02:40:09 -0700 Subject: [PATCH] GUACAMOLE-773: Automatically generate dependencies for NPM modules. --- guacamole/src/main/frontend/package-lock.json | 6 + guacamole/src/main/frontend/package.json | 1 + .../plugins/dependency-list-plugin.js | 146 ++++++++++++++++++ guacamole/src/main/frontend/webpack.config.js | 5 + 4 files changed, 158 insertions(+) create mode 100644 guacamole/src/main/frontend/plugins/dependency-list-plugin.js diff --git a/guacamole/src/main/frontend/package-lock.json b/guacamole/src/main/frontend/package-lock.json index a4b5f7fc0..a9d306d4d 100644 --- a/guacamole/src/main/frontend/package-lock.json +++ b/guacamole/src/main/frontend/package-lock.json @@ -3001,6 +3001,12 @@ "pkg-dir": "^3.0.0" } }, + "find-package-json": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/find-package-json/-/find-package-json-1.2.0.tgz", + "integrity": "sha512-+SOGcLGYDJHtyqHd87ysBhmaeQ95oWspDKnMXBrnQ9Eq4OkLNqejgoaD8xVWu6GPa0B6roa6KinCMEMcVeqONw==", + "dev": true + }, "find-up": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", diff --git a/guacamole/src/main/frontend/package.json b/guacamole/src/main/frontend/package.json index 44c5c9018..8a6034ce5 100644 --- a/guacamole/src/main/frontend/package.json +++ b/guacamole/src/main/frontend/package.json @@ -27,6 +27,7 @@ "css-loader": "^5.2.4", "css-minimizer-webpack-plugin": "^1.3.0", "exports-loader": "^1.1.1", + "find-package-json": "^1.2.0", "google-closure-compiler": "^20210302.0.0", "html-webpack-plugin": "^4.5.2", "mini-css-extract-plugin": "^1.5.0", diff --git a/guacamole/src/main/frontend/plugins/dependency-list-plugin.js b/guacamole/src/main/frontend/plugins/dependency-list-plugin.js new file mode 100644 index 000000000..3fd62caaf --- /dev/null +++ b/guacamole/src/main/frontend/plugins/dependency-list-plugin.js @@ -0,0 +1,146 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +const finder = require('find-package-json'); +const fs = require('fs'); +const path = require('path'); +const validateOptions = require('schema-utils'); + +/** + * The name of this plugin. + * + * @type {string} + */ +const PLUGIN_NAME = 'dependency-list-plugin'; + +/** + * The schema of the configuration options object accepted by the constructor + * of DependencyListPlugin. + * + * @see https://github.com/webpack/schema-utils/blob/v1.0.0/README.md#usage + */ +const PLUGIN_OPTIONS_SCHEMA = { + type: 'object', + properties: { + + /** + * The name of the file that should contain the dependency list. By + * default, this will be "npm-dependencies.txt". + */ + filename: { type: 'string' }, + + /** + * The path in which the dependency list file should be saved. By + * default, this will be the output path of the Webpack compiler. + */ + path: { type: 'string' } + + }, + additionalProperties: false +}; + +/** + * Webpack plugin that automatically lists each of the NPM dependencies + * included within any bundles produced by the compile process. + */ +class DependencyListPlugin { + + /** + * Creates a new DependencyListPlugin configured with the given options. + * The options given must conform to the options schema. + * + * @see PLUGIN_OPTIONS_SCHEMA + * + * @param {*} options + * The configuration options to apply to the plugin. + */ + constructor(options = {}) { + validateOptions(PLUGIN_OPTIONS_SCHEMA, options, 'DependencyListPlugin'); + this.options = options; + } + + /** + * Entrypoint for all Webpack plugins. This function will be invoked when + * the plugin is being associated with the compile process. + * + * @param {Compiler} compiler + * A reference to the Webpack compiler. + */ + apply(compiler) { + + /** + * Logger for this plugin. + * + * @type {Logger} + */ + const logger = compiler.getInfrastructureLogger(PLUGIN_NAME); + + /** + * The full path to the output file that should contain the list of + * discovered NPM module dependencies. + * + * @type {string} + */ + const outputFile = path.join( + this.options.path || compiler.options.output.path, + this.options.filename || 'npm-dependencies.txt' + ); + + // Wait for compilation to fully complete + compiler.hooks.done.tap(PLUGIN_NAME, (stats) => { + + const moduleCoords = {}; + + // Map each file used within any bundle built by the compiler to + // its corresponding NPM package, ignoring files that have no such + // package + stats.compilation.fileDependencies.forEach(file => { + + // Locate NPM package corresponding to file dependency (there + // may not be one) + const moduleFinder = finder(file); + const npmPackage = moduleFinder.next().value; + + // Translate absolute path into more readable path relative to + // root of compilation process + const relativePath = path.relative(compiler.options.context, file); + + if (npmPackage.name) { + moduleCoords[npmPackage.name + ':' + npmPackage.version] = true; + logger.info('File dependency "%s" mapped to NPM package "%s" (v%s)', + relativePath, npmPackage.name, npmPackage.version); + } + else + logger.info('Skipping file dependency "%s" (no NPM package)', + relativePath); + + }); + + // Write all discovered NPM packages to configured output file + const sortedCoords = Object.keys(moduleCoords).sort(); + fs.writeFileSync(outputFile, sortedCoords.join('\n') + '\n'); + + }); + + } + +} + +module.exports = DependencyListPlugin; + diff --git a/guacamole/src/main/frontend/webpack.config.js b/guacamole/src/main/frontend/webpack.config.js index bcace2ddc..7496d5b77 100644 --- a/guacamole/src/main/frontend/webpack.config.js +++ b/guacamole/src/main/frontend/webpack.config.js @@ -22,6 +22,7 @@ const { CleanWebpackPlugin } = require('clean-webpack-plugin'); const ClosureWebpackPlugin = require('closure-webpack-plugin'); const CopyPlugin = require('copy-webpack-plugin'); const CssMinimizerPlugin = require('css-minimizer-webpack-plugin'); +const DependencyListPlugin = require('./plugins/dependency-list-plugin'); const HtmlWebpackPlugin = require('html-webpack-plugin'); const MiniCssExtractPlugin = require('mini-css-extract-plugin'); const webpack = require('webpack'); @@ -144,6 +145,10 @@ module.exports = { chunkFilename: '[id].guacamole.[contenthash].css' }), + // List all bundled node modules for sake of automatic LICENSE file + // generation / sanity checks + new DependencyListPlugin(), + // Automatically require used modules new webpack.ProvidePlugin({ jstz: 'jstz',