mike-jumper commented on a change in pull request #616:
URL: https://github.com/apache/guacamole-client/pull/616#discussion_r644451733
##########
File path: guacamole/src/main/frontend/package.json
##########
@@ -0,0 +1,35 @@
+{
+ "private": true,
+ "scripts": {
+ "build": "webpack --progress"
+ },
+ "dependencies": {
+ "@simonwep/pickr": "1.8.1",
+ "angular": "1.8.2",
+ "angular-route": "1.8.2",
+ "angular-templatecache-webpack-plugin": "^1.0.1",
Review comment:
Reading up on this a bit, it seems the best approach is to use `^`
except where there's a specific reason not to:
* It's the default for npm and therefore the least surprising to anyone
already well-steeped in that ecosystem.
* It avoids duplicating the duty of `package-lock.json`, which we are
including in version control here following the _other_ established best
practice for npm.
I definitely prefer the Maven approach of absolute reproducibility by
default (with the Maven equivalent to `^` and `~` being considered bad practice
and almost never used), but we're stuck with the npm approach here.
I'll update to 🥕s everywhere.
##########
File path: guacamole/src/main/frontend/src/app/index/indexModule.js
##########
@@ -17,22 +17,37 @@
* under the License.
*/
+require('angular-module-shim.js');
+require('relocateParameters.js');
+
+require('angular-translate-interpolation-messageformat');
+require('angular-translate-loader-static-files');
+
/**
* The module for the root of the application.
*/
angular.module('index', [
+
+ require('angular-route'),
+ require('angular-translate'),
+
'auth',
'client',
'clipboard',
'home',
'login',
'manage',
'navigation',
- 'ngRoute',
- 'ngTouch',
'notification',
- 'pascalprecht.translate',
'rest',
'settings',
+
Review comment:
I thought it made sense to visually separate things into three groups:
* AngularJS modules from external libraries
* AngularJS modules we define ourselves with actual code
* AngularJS modules that are generated at build time (just `templates-main`)
##########
File path: guacamole/src/main/frontend/src/app/index/indexModule.js
##########
@@ -17,22 +17,37 @@
* under the License.
*/
+require('angular-module-shim.js');
Review comment:
Yep, exactly.
##########
File path: guacamole/src/main/frontend/src/app/index/indexModule.js
##########
@@ -17,22 +17,37 @@
* under the License.
*/
+require('angular-module-shim.js');
+require('relocateParameters.js');
+
+require('angular-translate-interpolation-messageformat');
+require('angular-translate-loader-static-files');
+
/**
* The module for the root of the application.
*/
angular.module('index', [
+
+ require('angular-route'),
Review comment:
These are the external AngularJS libraries that we depend on. It's a
convention with AngularJS libraries within NPM to simply export the name of the
relevant AngularJS module, so `require('angular-route')` here returns a
JavaScript string that is the name of the AngularJS module providing routing.
##########
File path: 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)
Review comment:
🙀 Oops
##########
File path: 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)
Review comment:
Fixed via rebase.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
