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

package/test/use-cases/simple/simple.test.js

@@ -0,0 +1,83 @@
+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('simple', function() {
+    let config = require('./webpack.config.js');
+
+    it('compiles an xml file', done => {
+        webpack(config, (err, stats) => {
+            if (err) {
+                throw err;
+            }
+            assert.equal(stats.hasErrors(), false);
+            assert.equal(stats.hasWarnings(), false);
+            assert.equal(fs.existsSync(webresourceOutput), true);
+            done();
+        });
+    });
+
+    describe('a web-resource for a webpack entry point', function() {
+        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('exists', () => {
+            assert.typeOf(contextEntryNode, 'object');
+        });
+
+        it('has an i18n transformation', () => {
+            let node = contextEntryNode.children[0];
+            assert.nestedPropertyVal(node, 'name', 'transformation');
+            assert.nestedPropertyVal(node, 'attributes.extension', 'js');
+            assert.nestedPropertyVal(node, 'children[0].name', 'transformer');
+            assert.nestedPropertyVal(node, 'children[0].attributes.key', 'jsI18n');
+        });
+
+        // @deprecated
+        it('has a context named after the entry point', () => {
+            let node = contextEntryNode.children
+                .filter(n => n.name === 'context')
+                .find(n => n.content === 'simple-entry');
+            assert.nestedPropertyVal(node, 'name', 'context');
+            assert.nestedPropertyVal(node, 'content', 'simple-entry');
+        });
+
+        it('has a resource that references the generated bundle file', () => {
+            let node = contextEntryNode.children.find(n => n.name === 'resource');
+            assert.nestedPropertyVal(node, 'name', 'resource');
+            assert.nestedPropertyVal(node, 'attributes.type', 'download');
+            assert.nestedPropertyVal(node, 'attributes.name', 'simple-entry.js');
+            assert.nestedPropertyVal(node, 'attributes.location', 'simple-entry.js');
+        });
+    });
+
+    describe('a web-resource for the (web-resource) deps of an entry point', function() {
+        let results, contextDepsNode;
+
+        before(done => {
+            webpack(config, (err, stats) => {
+                let xmlFile = fs.readFileSync(webresourceOutput, 'utf-8');
+                results = parse(xmlFile);
+                contextDepsNode = results.root.children.find(n => n.attributes.key === 'entrypoint-simple-entry');
+                done();
+            });
+        });
+
+        it('exists', () => {
+            assert.typeOf(contextDepsNode, 'object');
+        });
+    });
+});

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

@@ -0,0 +1,3 @@
+define('module/a', [], function() {
+    console.log('it really is simple.');
+});

package/test/use-cases/simple/webpack.config.js

@@ -0,0 +1,24 @@
+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'),
+            verbose: false,
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: path.resolve(OUTPUT_DIR),
+    },
+};

package/test/use-cases/single-runtime-chunk/single-runtime-chunk.test.js

@@ -0,0 +1,132 @@
+const assert = require('chai').assert;
+const parse = require('xml-parser');
+const webpack = require('webpack');
+const fs = require('fs');
+const path = require('path');
+const { setBaseDependencies } = require('../../../src/settings/base-dependencies');
+const RUNTIME_WR_KEY = 'common-runtime';
+const targetDir = path.join(__dirname, 'target');
+const webresourceOutput = path.join(targetDir, 'META-INF', 'plugin-descriptor', 'wr-single.xml');
+
+describe('single runtime chunk', function() {
+    const baseConfig = require('./webpack.config.js');
+    const PLUGIN_KEY = 'com.atlassian.plugin.test';
+    const BASE_DEPS = ['base.context:dep1', 'base.context:dep2'];
+
+    function getResources(node) {
+        return node.children.filter(n => n.name === 'resource');
+    }
+
+    function getDependencies(node) {
+        return node.children.filter(n => n.name === 'dependency');
+    }
+
+    function runTheTestsFor(config, runtimeName, runtimeWrKey) {
+        let wrNodes;
+        runtimeWrKey = runtimeWrKey || RUNTIME_WR_KEY;
+
+        before(function(done) {
+            setBaseDependencies(BASE_DEPS);
+
+            webpack(config, (err, st) => {
+                const xmlFile = fs.readFileSync(webresourceOutput, 'utf-8');
+                const results = parse(xmlFile);
+                wrNodes = results.root.children.filter(n => n.name === 'web-resource');
+                done();
+            });
+        });
+
+        it('creates a web-resource for the runtime', function() {
+            const wrKeys = wrNodes.map(n => n.attributes.key);
+            assert.include(wrKeys, runtimeWrKey, 'dedicated web-resource for the runtime not found');
+        });
+
+        it('adds the runtime to the dedicated web-resource for it', function() {
+            const runtimeWR = wrNodes.find(n => n.attributes.key === runtimeWrKey);
+            const runtimeResources = getResources(runtimeWR);
+            const runtimeResourceLocations = runtimeResources.map(n => n.attributes.location);
+            assert.equal(runtimeResources.length, 1, 'should only have a single resource');
+            assert.equal(runtimeResourceLocations[0], runtimeName, 'should be the runtime');
+        });
+
+        it('adds base dependencies to the runtime web-resource', function() {
+            const runtimeWR = wrNodes.find(n => n.attributes.key === runtimeWrKey);
+            const dependencies = getDependencies(runtimeWR);
+            const dependencyNames = dependencies.map(d => d.content);
+            assert.includeMembers(dependencyNames, BASE_DEPS, 'runtime should include base deps, but did not');
+        });
+
+        it('does not add the runtime to more than one web-resource', function() {
+            const allResourceNodes = [].concat.apply([], wrNodes.map(getResources));
+            const allResourceLocations = allResourceNodes.map(n => n.attributes.location);
+            const runtimeCount = allResourceLocations.filter(loc => loc === runtimeName).length;
+            assert.equal(runtimeCount, 1, `${runtimeName} was added to multiple web-resources`);
+        });
+
+        it('adds a dependency on the runtime to each entrypoint web-resource', function() {
+            const entrypoints = wrNodes.filter(n => n.attributes.key.startsWith('entry'));
+            entrypoints.forEach(entry => {
+                const wrName = entry.attributes.key;
+                const dependencies = getDependencies(entry);
+                const dependencyNames = dependencies.map(d => d.content);
+                assert.include(
+                    dependencyNames,
+                    `${PLUGIN_KEY}:${runtimeWrKey}`,
+                    `web-resource ${wrName} should depend on runtime, but doesn't`
+                );
+            });
+        });
+    }
+
+    describe('when configured as "single"', function() {
+        const config = baseConfig('single', webresourceOutput);
+
+        runTheTestsFor(config, 'runtime.js');
+    });
+
+    describe('when configured with a static name', function() {
+        const name = 'custom';
+        const config = baseConfig({ name }, webresourceOutput);
+
+        runTheTestsFor(config, `${name}.js`);
+    });
+
+    describe('when configured with a name and custom output format', function() {
+        const name = 'fun';
+        const config = baseConfig({ name }, webresourceOutput);
+        config.output.filename = 'prefixed.[name].suffixed.js';
+
+        runTheTestsFor(config, `prefixed.${name}.suffixed.js`);
+    });
+
+    describe('when configured with a web-resource key', function() {
+        const name = 'custom';
+        const webresourceKey = 'foobar';
+        const config = baseConfig({ name }, webresourceOutput, webresourceKey);
+
+        runTheTestsFor(config, `${name}.js`, webresourceKey);
+    });
+
+    describe('when not configured', function() {
+        const config = baseConfig(false, webresourceOutput);
+        let wrNodes;
+
+        before(function(done) {
+            webpack(config, (err, st) => {
+                const xmlFile = fs.readFileSync(webresourceOutput, 'utf-8');
+                const results = parse(xmlFile);
+                wrNodes = results.root.children.filter(n => n.name === 'web-resource');
+                done();
+            });
+        });
+
+        it('does not create a web-resource for the runtime', function() {
+            const wrKeys = wrNodes.map(n => n.attributes.key);
+            assert.notInclude(
+                wrKeys,
+                RUNTIME_WR_KEY,
+                'dedicated web-resource for the runtime present but should not be'
+            );
+        });
+    });
+});

package/test/use-cases/single-runtime-chunk/src/first.js

@@ -0,0 +1,2 @@
+import shared from './shared';
+console.log(shared);

package/test/use-cases/single-runtime-chunk/src/second.js

@@ -0,0 +1,2 @@
+import shared from './shared';
+console.log(shared);

package/test/use-cases/single-runtime-chunk/src/shared.js

@@ -0,0 +1,3 @@
+export default {
+    foo: 'bar',
+};

package/test/use-cases/single-runtime-chunk/src/third.js

@@ -0,0 +1,2 @@
+import shared from './shared';
+console.log(shared);

package/test/use-cases/single-runtime-chunk/webpack.config.js

@@ -0,0 +1,33 @@
+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 = (runtimeChunk, webresourceOutput, singleRuntimeWebResourceKey) => ({
+    mode: 'development',
+    context: FRONTEND_SRC_DIR,
+    entry: {
+        first: path.join(FRONTEND_SRC_DIR, 'first.js'),
+        second: path.join(FRONTEND_SRC_DIR, 'second.js'),
+        third: path.join(FRONTEND_SRC_DIR, 'third.js'),
+    },
+    optimization: {
+        runtimeChunk,
+        splitChunks: {
+            minSize: 0,
+            chunks: 'all',
+        },
+    },
+    plugins: [
+        new WrmPlugin({
+            pluginKey: 'com.atlassian.plugin.test',
+            xmlDescriptors: webresourceOutput,
+            verbose: false,
+            singleRuntimeWebResourceKey,
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: path.resolve(OUTPUT_DIR),
+    },
+});

package/test/use-cases/specify-asset-dev-hash/specify-asset-dev-hash.test.js

@@ -0,0 +1,33 @@
+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 libraryDescriptor = path.join(targetDir, 'META-INF', 'plugin-descriptor', 'library.xml');
+const featureDescriptor = path.join(targetDir, 'META-INF', 'plugin-descriptor', 'main.xml');
+
+describe('specify-asset-dev-hash', function() {
+    let config = require('./webpack.config.js');
+    let results;
+    let libDevNode;
+    let featDevNode;
+
+    before(done => {
+        webpack(config, (err, stats) => {
+            let libXMLFile = fs.readFileSync(libraryDescriptor, 'utf-8');
+            let featXMLFile = fs.readFileSync(featureDescriptor, 'utf-8');
+            results = parse(libXMLFile);
+            libDevNode = results.root.children.find(n => n.attributes.key === 'assets-libDevAssets');
+            results = parse(featXMLFile);
+            featDevNode = results.root.children.find(n => n.attributes.key === 'assets-featDevAssets');
+            done();
+        });
+    });
+
+    it('uses custom dev asset hashes provided in webpack config', () => {
+        assert.exists(libDevNode, 'node called assets-libDevAssets should exist');
+        assert.exists(featDevNode, 'node called assets-featDevAssets should exist');
+    });
+});

package/test/use-cases/specify-asset-dev-hash/src/feature.js

@@ -0,0 +1,6 @@
+define('module/second', [
+    '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/specify-asset-dev-hash/src/library.js

@@ -0,0 +1,6 @@
+define('module/first', [
+    '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/specify-asset-dev-hash/webpack.config.js

@@ -0,0 +1,71 @@
+const path = require('path');
+const merge = require('webpack-merge');
+const WrmPlugin = require('../../../src/WrmPlugin');
+const FRONTEND_SRC_DIR = path.resolve(__dirname, 'src');
+const OUTPUT_DIR = path.resolve(__dirname, 'target');
+
+const getLibraryWrmConfig = () => {
+    return {
+        webresourceKeyMap: {
+            library: 'libResource',
+        },
+        devAssetsHash: 'libDevAssets',
+    };
+};
+
+const getFeatureWrmConfig = () => {
+    return {
+        webresourceKeyMap: {
+            feature: 'featResource',
+        },
+        devAssetsHash: 'featDevAssets',
+    };
+};
+
+const webResourcePlugin = isLibrary => {
+    const baseWrmConfig = {
+        pluginKey: 'com.atlassian.plugin.test',
+        xmlDescriptors: path.join(
+            __dirname,
+            'target',
+            'META-INF',
+            'plugin-descriptor',
+            isLibrary ? 'library.xml' : 'main.xml'
+        ),
+    };
+
+    return new WrmPlugin(merge(baseWrmConfig, isLibrary ? getLibraryWrmConfig() : getFeatureWrmConfig()));
+};
+
+const webpackConfigForLibrary = {
+    name: 'Library',
+    context: __dirname,
+    entry: {
+        library: path.join(FRONTEND_SRC_DIR, 'library.js'),
+    },
+    output: {
+        library: '[name]',
+        libraryTarget: 'amd',
+        filename: '[name].js',
+        path: path.resolve(OUTPUT_DIR),
+    },
+    plugins: [webResourcePlugin(true)],
+};
+
+const webpackConfigForFeature = {
+    name: 'Feature',
+    context: __dirname,
+    mode: 'development',
+    entry: {
+        feature: path.join(FRONTEND_SRC_DIR, 'feature.js'),
+    },
+    output: {
+        library: '',
+        libraryTarget: 'var',
+        filename: '[name].js',
+        path: path.resolve(OUTPUT_DIR),
+    },
+    plugins: [webResourcePlugin(false)],
+};
+
+module.exports = [webpackConfigForLibrary, webpackConfigForFeature];

package/test/use-cases/specify-conditions/specify-conditions.test.js

@@ -0,0 +1,106 @@
+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('specify-conditions', function() {
+    const config = require('./webpack.config.js');
+
+    let stats;
+    let error;
+    let wrNodes;
+
+    function getWebresourceLike(needle) {
+        return wrNodes.find(n => n.attributes.key.indexOf(needle) > -1);
+    }
+
+    function getCondition(node) {
+        return node.children.filter(childNode => childNode.name === 'condition');
+    }
+
+    function getConditions(node) {
+        return node.children.filter(childNode => childNode.name === 'conditions');
+    }
+
+    function getContent(nodes) {
+        return nodes.map(n => n.content);
+    }
+
+    beforeEach(done => {
+        webpack(config, (err, st) => {
+            error = err;
+            stats = st;
+
+            const xmlFile = fs.readFileSync(webresourceOutput, 'utf-8');
+            const results = parse(xmlFile);
+            wrNodes = results.root.children.filter(n => n.attributes.key.startsWith('entry'));
+            done();
+        });
+    });
+
+    it('should run without error', () => {
+        assert.ok(wrNodes);
+        assert.equal(stats.hasErrors(), false);
+        assert.equal(stats.hasWarnings(), false);
+    });
+
+    describe('add conditions to entry-points', () => {
+        it('should add nextes conditions as specified in the conditionMap to app-one', () => {
+            const wrWithGoodConfig = getWebresourceLike('app-one');
+            const conditions = getConditions(wrWithGoodConfig);
+
+            assert.ok(conditions);
+            assert.equal(1, conditions.length);
+
+            const condition = conditions[0];
+            assert.equal('AND', condition.attributes.type);
+            assert.equal(2, condition.children.length);
+
+            assert.equal(
+                JSON.stringify(condition),
+                `{"name":"conditions","attributes":{"type":"AND"},"children":[{"name":"conditions","attributes":{"type":"OR"},"children":[{"name":"condition","attributes":{"class":"foo.bar.baz","invert":"true"},"children":[{"name":"param","attributes":{"name":"permission"},"children":[],"content":"admin"}],"content":""},{"name":"condition","attributes":{"class":"foo.bar.baz2"},"children":[{"name":"param","attributes":{"name":"permission"},"children":[],"content":"project"}],"content":""}],"content":""},{"name":"condition","attributes":{"class":"foo.bar.baz3"},"children":[{"name":"param","attributes":{"name":"permission"},"children":[],"content":"admin"}],"content":""}],"content":""}`
+            );
+        });
+
+        it('should add simple condition as specified in condition map to app-two', () => {
+            const wrWithGoodConfig = getWebresourceLike('app-two');
+            const conditions = getCondition(wrWithGoodConfig);
+
+            assert.ok(conditions);
+            assert.equal(1, conditions.length);
+
+            const condition = conditions[0];
+            assert.equal('foo.bar.baz', condition.attributes.class);
+            assert.equal('true', condition.attributes.invert);
+
+            assert.equal(
+                JSON.stringify(condition),
+                `{"name":"condition","attributes":{"class":"foo.bar.baz","invert":"true"},"children":[{"name":"param","attributes":{"name":"permission"},"children":[],"content":"admin"}],"content":""}`
+            );
+        });
+
+        it('should add multiple conditions as specified in condition map to app-three', () => {
+            const wrWithGoodConfig = getWebresourceLike('app-three');
+            const conditions = getCondition(wrWithGoodConfig);
+
+            assert.ok(conditions);
+            assert.equal(2, conditions.length);
+
+            const condition1 = conditions[0];
+            assert.equal('foo.bar.baz', condition1.attributes.class);
+            assert.equal('true', condition1.attributes.invert);
+            const condition2 = conditions[1];
+            assert.equal('foo.bar.baz2', condition2.attributes.class);
+            assert.equal(undefined, condition2.attributes.invert);
+
+            assert.equal(
+                JSON.stringify(conditions),
+                `[{"name":"condition","attributes":{"class":"foo.bar.baz","invert":"true"},"children":[{"name":"param","attributes":{"name":"permission"},"children":[],"content":"admin"}],"content":""},{"name":"condition","attributes":{"class":"foo.bar.baz2"},"children":[{"name":"param","attributes":{"name":"permission"},"children":[],"content":"project"}],"content":""}]`
+            );
+        });
+    });
+});

package/test/use-cases/specify-conditions/src/app.js

@@ -0,0 +1,5 @@
+import $ from 'jquery';
+
+$(() => {
+    $('body').html('hello world');
+});

package/test/use-cases/specify-conditions/webpack.config.js

@@ -0,0 +1,65 @@
+const path = require('path');
+const WrmPlugin = require('../../../src/WrmPlugin');
+const FRONTEND_SRC_DIR = path.join(__dirname, 'src');
+const OUTPUT_DIR = path.join(__dirname, 'target');
+
+module.exports = {
+    mode: 'development',
+    entry: {
+        'app-one': path.join(FRONTEND_SRC_DIR, 'app.js'),
+        'app-two': path.join(FRONTEND_SRC_DIR, 'app.js'),
+        'app-three': 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'),
+            conditionMap: {
+                'app-one': {
+                    type: 'AND',
+                    conditions: [
+                        {
+                            type: 'OR',
+                            conditions: [
+                                {
+                                    class: 'foo.bar.baz',
+                                    invert: true,
+                                    params: [{ attributes: { name: 'permission' }, value: 'admin' }],
+                                },
+                                {
+                                    class: 'foo.bar.baz2',
+                                    params: [{ attributes: { name: 'permission' }, value: 'project' }],
+                                },
+                            ],
+                        },
+                        {
+                            class: 'foo.bar.baz3',
+                            params: [{ attributes: { name: 'permission' }, value: 'admin' }],
+                        },
+                    ],
+                },
+                'app-two': {
+                    class: 'foo.bar.baz',
+                    invert: true,
+                    params: [{ attributes: { name: 'permission' }, value: 'admin' }],
+                },
+                'app-three': [
+                    {
+                        class: 'foo.bar.baz',
+                        invert: true,
+                        params: [{ attributes: { name: 'permission' }, value: 'admin' }],
+                    },
+                    {
+                        class: 'foo.bar.baz2',
+                        params: [{ attributes: { name: 'permission' }, value: 'project' }],
+                    },
+                ],
+            },
+            verbose: false,
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: OUTPUT_DIR,
+    },
+};