@atlassian/webresource-webpack-plugin 4.10.2-64a2ef2

package/test/use-cases/data-providers/webpack.config.js

@@ -0,0 +1,73 @@
+const path = require('path');
+const WrmPlugin = require('../../../src/WrmPlugin');
+const FRONTEND_SRC_DIR = path.join(__dirname, 'src');
+const OUTPUT_DIR = path.join(__dirname, 'target');
+
+const dataProviders = {
+    'my-first-entry-point': [
+        {
+            key: 'first-data-provider',
+            class: 'data.provider.JavaClass',
+        },
+
+        // Invalid shape
+        [],
+    ],
+
+    'my-second-entry-point': [
+        {
+            key: 'foo-data-provider',
+            class: 'data.provider.FooClass',
+        },
+
+        {
+            key: 'bar-data-provider',
+            class: 'data.provider.BarClass',
+        },
+
+        // Missing class
+        {
+            key: 'provider-with-missing-class',
+        },
+
+        // Missing key
+        {
+            class: 'provider-with-missing-key',
+        },
+    ],
+
+    // Missing entry point
+    'invalid-entry-point': [
+        {
+            key: 'foo',
+            class: 'DataProvider',
+        },
+    ],
+
+    // Invalid value of data provider lists
+    'my-third-entry-point': true,
+};
+
+module.exports = () => ({
+    mode: 'development',
+    entry: {
+        'my-first-entry-point': path.join(FRONTEND_SRC_DIR, 'first.js'),
+        'my-second-entry-point': path.join(FRONTEND_SRC_DIR, 'second.js'),
+        'my-third-entry-point': path.join(FRONTEND_SRC_DIR, 'third.js'),
+    },
+    plugins: [
+        new WrmPlugin({
+            pluginKey: 'com.atlassian.plugin.test',
+            xmlDescriptors: path.join(OUTPUT_DIR, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml'),
+            verbose: false,
+            dataProvidersMap: dataProviders,
+        }),
+    ],
+
+    output: {
+        filename: '[name].js',
+        path: OUTPUT_DIR,
+    },
+});
+
+module.exports.dataProviders = dataProviders;

package/test/use-cases/data-providers/webpack.config.with-map.js

@@ -0,0 +1,33 @@
+const path = require('path');
+const WrmPlugin = require('../../../src/WrmPlugin');
+const FRONTEND_SRC_DIR = path.join(__dirname, 'src');
+const OUTPUT_DIR = path.join(__dirname, 'target');
+
+const { dataProviders } = require('./webpack.config');
+
+const dataProvidersMap = new Map();
+
+for (const [entryPointKey, providers] of Object.entries(dataProviders)) {
+    dataProvidersMap.set(entryPointKey, providers);
+}
+
+module.exports = {
+    mode: 'development',
+    entry: {
+        'my-first-entry-point': path.join(FRONTEND_SRC_DIR, 'first.js'),
+        'my-second-entry-point': path.join(FRONTEND_SRC_DIR, 'second.js'),
+        'my-third-entry-point': path.join(FRONTEND_SRC_DIR, 'third.js'),
+    },
+    plugins: [
+        new WrmPlugin({
+            pluginKey: 'com.atlassian.plugin.test',
+            xmlDescriptors: path.join(OUTPUT_DIR, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml'),
+            verbose: false,
+            dataProvidersMap,
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: OUTPUT_DIR,
+    },
+};

package/test/use-cases/ensure-runtime-overwrite-of-mini-css-extract-plugin/ensure-runtime-overwrite-of-mini-css-extract-plugin.test.js

@@ -0,0 +1,86 @@
+const assert = require('chai').assert;
+const parse = require('xml-parser');
+const webpack = require('webpack');
+const fs = require('fs');
+const path = require('path');
+
+const targetDir = path.join(__dirname, 'target');
+const webresourceOutput = path.join(targetDir, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml');
+
+describe('ensure-runtime-overwrite-of-mini-css-extract-plugin', function() {
+    describe('mini-css-extract-plugin is defined before wrm-plugin', () => {
+        const config = require('./webpack.before.config.js');
+
+        beforeEach(done => {
+            webpack(config, () => {
+                done();
+            });
+        });
+
+        it('should inject a WRM pre-condition checker into the webpack runtime', () => {
+            // setup
+            const bundleFile = fs.readFileSync(path.join(targetDir, 'app-before.js'), 'utf-8');
+
+            const expectedRuntimeAdjustment = `
+/******/ 		var promises = [];
+/******/
+/******/ 		if(installedChunks[chunkId] === 0) { // 0 means "already installed".
+/******/ 		    return Promise.resolve();
+/******/ 		}
+/******/
+/******/ 		if (installedChunks[chunkId]) {
+/******/ 		    return installedChunks[chunkId][2];
+/******/ 		}
+/******/
+/******/ 		promises.push(
+/******/ 		    new Promise(function(resolve, reject) {
+/******/ 		        installedChunks[chunkId] = [resolve, reject];
+/******/ 		    }),
+/******/ 		    new Promise(function(resolve, reject) {
+/******/ 		        WRM.require('wrc!com.atlassian.plugin.test:' + chunkId).then(resolve, reject);
+/******/ 		    })
+/******/ 		);
+/******/ 		return installedChunks[chunkId][2] = Promise.all(promises);`;
+
+            assert.include(bundleFile, expectedRuntimeAdjustment, 'expect runtime overwrite');
+        });
+    });
+
+    describe('mini-css-extract-plugin is defined after wrm-plugin', () => {
+        const config = require('./webpack.after.config.js');
+
+        beforeEach(done => {
+            webpack(config, () => {
+                done();
+            });
+        });
+
+        it('should inject a WRM pre-condition checker into the webpack runtime', () => {
+            // setup
+            const bundleFile = fs.readFileSync(path.join(targetDir, 'app-after.js'), 'utf-8');
+
+            const expectedRuntimeAdjustment = `
+/******/ 		var promises = [];
+/******/
+/******/ 		if(installedChunks[chunkId] === 0) { // 0 means "already installed".
+/******/ 		    return Promise.resolve();
+/******/ 		}
+/******/
+/******/ 		if (installedChunks[chunkId]) {
+/******/ 		    return installedChunks[chunkId][2];
+/******/ 		}
+/******/
+/******/ 		promises.push(
+/******/ 		    new Promise(function(resolve, reject) {
+/******/ 		        installedChunks[chunkId] = [resolve, reject];
+/******/ 		    }),
+/******/ 		    new Promise(function(resolve, reject) {
+/******/ 		        WRM.require('wrc!com.atlassian.plugin.test:' + chunkId).then(resolve, reject);
+/******/ 		    })
+/******/ 		);
+/******/ 		return installedChunks[chunkId][2] = Promise.all(promises);`;
+
+            assert.include(bundleFile, expectedRuntimeAdjustment, 'expect runtime overwrite');
+        });
+    });
+});

package/test/use-cases/ensure-runtime-overwrite-of-mini-css-extract-plugin/src/app.js

@@ -0,0 +1,5 @@
+import styles from './styles.css';
+
+document.querySelector('body').innerHTML = `<div class="${styles.wurst}"><div class="${styles.tricky}"></div></div>`;
+
+import('./app2');

package/test/use-cases/ensure-runtime-overwrite-of-mini-css-extract-plugin/src/app2.js

@@ -0,0 +1,5 @@
+import styles from './styles2.css';
+
+document
+    .querySelector('body')
+    .insertAdjacentHTML('afterbegin', `<div class="${styles.wurst}"><div class="${styles.tricky}"></div></div>`);

package/test/use-cases/ensure-runtime-overwrite-of-mini-css-extract-plugin/src/rect.svg

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg width="48px" height="64px" viewBox="0 0 48 64" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <rect width="48" height="64" style="fill:rgb(0,0,255)" />
+</svg>

package/test/use-cases/ensure-runtime-overwrite-of-mini-css-extract-plugin/src/rect2.svg

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg width="64" height="48" viewBox="0 0 64 48" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <rect width="64" height="48" style="fill:rgb(255,0,0)" />
+</svg>

package/test/use-cases/ensure-runtime-overwrite-of-mini-css-extract-plugin/src/styles.css

@@ -0,0 +1,8 @@
+.wurst {
+    background-color: red;
+    background-image: url('./ice2.jpg');
+}
+
+.tricky {
+    background: url('./ice.png');
+}

package/test/use-cases/ensure-runtime-overwrite-of-mini-css-extract-plugin/src/styles2.css

@@ -0,0 +1,8 @@
+.wurst {
+    background-color: red;
+    background-image: url('./rect2.svg');
+}
+
+.tricky {
+    background: url('./rect.svg');
+}

package/test/use-cases/ensure-runtime-overwrite-of-mini-css-extract-plugin/webpack.after.config.js

@@ -0,0 +1,51 @@
+const path = require('path');
+const MiniCssExtractPlugin = require('mini-css-extract-plugin');
+
+const WrmPlugin = require('../../../src/WrmPlugin');
+const FRONTEND_SRC_DIR = path.join(__dirname, 'src');
+const OUTPUT_DIR = path.join(__dirname, 'target');
+
+module.exports = {
+    mode: 'development',
+    devtool: false,
+    entry: {
+        'app-after': path.join(FRONTEND_SRC_DIR, 'app.js'),
+    },
+    module: {
+        rules: [
+            {
+                test: /\.(css)$/,
+                use: [
+                    MiniCssExtractPlugin.loader,
+                    {
+                        loader: 'css-loader',
+                        options: {
+                            modules: true,
+                        },
+                    },
+                ],
+            },
+            {
+                test: /\.(jpg|png|svg)$/,
+                loader: 'file-loader',
+            },
+        ],
+    },
+    plugins: [
+        new WrmPlugin({
+            pluginKey: 'com.atlassian.plugin.test',
+            xmlDescriptors: path.join(OUTPUT_DIR, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml'),
+            verbose: false,
+        }),
+        new MiniCssExtractPlugin({
+            // Options similar to the same options in webpackOptions.output
+            // both options are optional
+            filename: '[name].css',
+            chunkFilename: '[id].css',
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: OUTPUT_DIR,
+    },
+};

package/test/use-cases/ensure-runtime-overwrite-of-mini-css-extract-plugin/webpack.before.config.js

@@ -0,0 +1,51 @@
+const path = require('path');
+const MiniCssExtractPlugin = require('mini-css-extract-plugin');
+
+const WrmPlugin = require('../../../src/WrmPlugin');
+const FRONTEND_SRC_DIR = path.join(__dirname, 'src');
+const OUTPUT_DIR = path.join(__dirname, 'target');
+
+module.exports = {
+    mode: 'development',
+    devtool: false,
+    entry: {
+        'app-before': path.join(FRONTEND_SRC_DIR, 'app.js'),
+    },
+    module: {
+        rules: [
+            {
+                test: /\.(css)$/,
+                use: [
+                    MiniCssExtractPlugin.loader,
+                    {
+                        loader: 'css-loader',
+                        options: {
+                            modules: true,
+                        },
+                    },
+                ],
+            },
+            {
+                test: /\.(jpg|png|svg)$/,
+                loader: 'file-loader',
+            },
+        ],
+    },
+    plugins: [
+        new MiniCssExtractPlugin({
+            // Options similar to the same options in webpackOptions.output
+            // both options are optional
+            filename: '[name].css',
+            chunkFilename: '[id].css',
+        }),
+        new WrmPlugin({
+            pluginKey: 'com.atlassian.plugin.test',
+            xmlDescriptors: path.join(OUTPUT_DIR, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml'),
+            verbose: false,
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: OUTPUT_DIR,
+    },
+};

package/test/use-cases/jsonp-function-name/jsonp-function-name.test.js

@@ -0,0 +1,37 @@
+const assert = require('chai').assert;
+const parse = require('xml-parser');
+const webpack = require('webpack');
+const fs = require('fs');
+const path = require('path');
+
+const targetDir = path.join(__dirname, 'target');
+const appOutput = path.join(targetDir, 'app.js');
+
+describe('jsonp-function-name', function() {
+    const config = require('./webpack.config.js');
+
+    let appCode;
+    let stats;
+
+    before(done => {
+        webpack(config, (err, st) => {
+            stats = st;
+
+            appCode = fs.readFileSync(appOutput, 'utf-8');
+            done();
+        });
+    });
+
+    it('should create a webresources without errors', () => {
+        assert.equal(stats.hasErrors(), false);
+        assert.equal(stats.hasWarnings(), false);
+    });
+
+    it('should not overwrite the webpack jsonp function if specified in the options and not the default name', () => {
+        assert.include(
+            appCode,
+            'var jsonpArray = window["someGivenName"] = window["someGivenName"] || [];',
+            'expect the webpack jsonp global function to be renamed'
+        );
+    });
+});

package/test/use-cases/jsonp-function-name/src/app.js

@@ -0,0 +1 @@
+import('./foo');

package/test/use-cases/jsonp-function-name/src/foo.js

@@ -0,0 +1,2 @@
+import _ from 'underscore';
+export default 'foo';

package/test/use-cases/jsonp-function-name/webpack.config.js

@@ -0,0 +1,35 @@
+const path = require('path');
+
+const WrmPlugin = require('../../../src/WrmPlugin');
+const FRONTEND_SRC_DIR = path.join(__dirname, 'src');
+const OUTPUT_DIR = path.join(__dirname, 'target');
+
+const providedDependencies = new Map();
+providedDependencies.set('jquery', {
+    dependency: 'jira.webresources:jquery',
+    import: "require('jquery')",
+});
+providedDependencies.set('underscore', {
+    dependency: 'com.atlassian.plugin.jslibs:underscore-1.4.4',
+    import: "require('underscore')",
+});
+
+module.exports = {
+    mode: 'development',
+    entry: {
+        app: path.join(FRONTEND_SRC_DIR, 'app.js'),
+    },
+    plugins: [
+        new WrmPlugin({
+            pluginKey: 'com.atlassian.plugin.test',
+            xmlDescriptors: path.join(OUTPUT_DIR, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml'),
+            verbose: false,
+            providedDependencies,
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: OUTPUT_DIR,
+        jsonpFunction: 'someGivenName',
+    },
+};

package/test/use-cases/jsonp-function-name-default/jsonp-function-name-default.test.js

@@ -0,0 +1,39 @@
+const assert = require('chai').assert;
+const parse = require('xml-parser');
+const webpack = require('webpack');
+const fs = require('fs');
+const path = require('path');
+
+const targetDir = path.join(__dirname, 'target');
+const appOutput = path.join(targetDir, 'app.js');
+
+describe('jsonp-function-name-default', function() {
+    const config = require('./webpack.config.js');
+
+    let appCode;
+    let error;
+    let stats;
+
+    before(done => {
+        webpack(config, (err, st) => {
+            error = err;
+            stats = st;
+
+            appCode = fs.readFileSync(appOutput, 'utf-8');
+            done();
+        });
+    });
+
+    it('should create a webresources without errors', () => {
+        assert.equal(stats.hasErrors(), false);
+        assert.equal(stats.hasWarnings(), false);
+    });
+
+    it('should rename the webpack jsonp function to a unique name for the plugin', () => {
+        assert.include(
+            appCode,
+            'var jsonpArray = window["atlassianWebpackJsonp83fba49a01db9a0da5906cb1dd5f4166"] = window["atlassianWebpackJsonp83fba49a01db9a0da5906cb1dd5f4166"] || [];',
+            'expect the webpack jsonp global function to be renamed'
+        );
+    });
+});

package/test/use-cases/jsonp-function-name-default/src/app.js

@@ -0,0 +1 @@
+import('./foo');

package/test/use-cases/jsonp-function-name-default/src/foo.js

@@ -0,0 +1,2 @@
+import _ from 'underscore';
+export default 'foo';

package/test/use-cases/jsonp-function-name-default/webpack.config.js

@@ -0,0 +1,34 @@
+const path = require('path');
+
+const WrmPlugin = require('../../../src/WrmPlugin');
+const FRONTEND_SRC_DIR = path.join(__dirname, 'src');
+const OUTPUT_DIR = path.join(__dirname, 'target');
+
+const providedDependencies = new Map();
+providedDependencies.set('jquery', {
+    dependency: 'jira.webresources:jquery',
+    import: "require('jquery')",
+});
+providedDependencies.set('underscore', {
+    dependency: 'com.atlassian.plugin.jslibs:underscore-1.4.4',
+    import: "require('underscore')",
+});
+
+module.exports = {
+    mode: 'development',
+    entry: {
+        app: path.join(FRONTEND_SRC_DIR, 'app.js'),
+    },
+    plugins: [
+        new WrmPlugin({
+            pluginKey: 'com.atlassian.plugin.test',
+            xmlDescriptors: path.join(OUTPUT_DIR, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml'),
+            verbose: false,
+            providedDependencies,
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: OUTPUT_DIR,
+    },
+};

package/test/use-cases/location-prefix/location-prefix.test.js

@@ -0,0 +1,29 @@
+const assert = require('chai').assert;
+const parse = require('xml-parser');
+const webpack = require('webpack');
+const fs = require('fs');
+const path = require('path');
+
+const targetDir = path.join(__dirname, 'target');
+const webresourceOutput = path.join(targetDir, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml');
+
+describe('location-prefix', function() {
+    let config = require('./webpack.config.js');
+    let results, contextEntryNode;
+
+    before(done => {
+        webpack(config, (err, stats) => {
+            let xmlFile = fs.readFileSync(webresourceOutput, 'utf-8');
+            results = parse(xmlFile);
+            contextEntryNode = results.root.children.find(n => n.attributes.key === 'entrypoint-simple-entry');
+            done();
+        });
+    });
+
+    it("add prefix to direct and external dependencies' location value", () => {
+        const nodes = contextEntryNode.children.filter(n => n.name === 'resource');
+        assert.propertyVal(nodes[0].attributes, 'location', 'js/simple-entry.js');
+        assert.propertyVal(nodes[1].attributes, 'location', 'js/template.soy');
+        assert.propertyVal(nodes[2].attributes, 'location', 'js/styles.less');
+    });
+});

package/test/use-cases/location-prefix/src/simple.js

@@ -0,0 +1,6 @@
+define('module/a', [
+    'wr-resource!ultimate/name/at/runtime.js!template.soy',
+    'wr-resource!ultimate/name/at/runtime.css!styles.less',
+], function() {
+    console.log('it really is simple.');
+});

package/test/use-cases/location-prefix/webpack.config.js

@@ -0,0 +1,25 @@
+const path = require('path');
+const WrmPlugin = require('../../../src/WrmPlugin');
+const FRONTEND_SRC_DIR = path.resolve(__dirname, 'src');
+const OUTPUT_DIR = path.resolve(__dirname, 'target');
+
+module.exports = {
+    mode: 'development',
+    context: FRONTEND_SRC_DIR,
+    entry: {
+        'simple-entry': path.join(FRONTEND_SRC_DIR, 'simple.js'),
+    },
+    plugins: [
+        new WrmPlugin({
+            pluginKey: 'com.atlassian.plugin.test',
+            contextMap: { 'simple-entry': [''] },
+            xmlDescriptors: path.join(__dirname, 'target', 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml'),
+            locationPrefix: 'js',
+            verbose: false,
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: path.resolve(OUTPUT_DIR),
+    },
+};

package/test/use-cases/provided-module-replacement/provided-module-replacement.test.js

@@ -0,0 +1,63 @@
+const assert = require('chai').assert;
+const parse = require('xml-parser');
+const webpack = require('webpack');
+const fs = require('fs');
+const path = require('path');
+
+const targetDir = path.join(__dirname, 'target');
+const webresourceOutput = path.join(targetDir, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml');
+
+describe('provided-modules-replacement', function() {
+    let stats;
+    let error;
+    let entry;
+    let dependencies;
+
+    function getDependencies(node) {
+        return node.children.filter(n => n.name === 'dependency');
+    }
+
+    function getContent(nodes) {
+        return nodes.map(n => n.content);
+    }
+
+    function runWebpack(config, done) {
+        webpack(config, (err, st) => {
+            error = err;
+            stats = st;
+
+            const xmlFile = fs.readFileSync(webresourceOutput, 'utf-8');
+            const results = parse(xmlFile);
+            entry = results.root.children.find(n => n.attributes.key.startsWith('entry'));
+            dependencies = getContent(getDependencies(entry));
+            done();
+        });
+    }
+
+    function runTheTestsFor(config) {
+        beforeEach(done => runWebpack(config, done));
+
+        it('should create a webresource with dependencies for each async chunk', () => {
+            assert.ok(entry);
+            assert.ok(dependencies);
+            assert.equal(stats.hasErrors(), false);
+            assert.equal(stats.hasWarnings(), false);
+        });
+
+        it('add a dependency for the provided module to the webresource', () => {
+            assert.include(dependencies, 'jira.webresources:jquery');
+            assert.include(dependencies, 'com.atlassian.plugin.jslibs:underscore-1.4.4');
+            assert.include(dependencies, 'a.plugin.key:webresource-key');
+        });
+    }
+
+    describe('using a map', () => {
+        const config = require('./webpack.config.with-map.js');
+        runTheTestsFor(config);
+    });
+
+    describe('using a plain object', () => {
+        const config = require('./webpack.config.with-object.js');
+        runTheTestsFor(config);
+    });
+});

package/test/use-cases/provided-module-replacement/src/app.js

@@ -0,0 +1,3 @@
+import $ from 'jquery';
+import 'wr-dependency!a.plugin.key:webresource-key';
+import _ from 'underscore';