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

package/test/use-cases/specify-transformation/extend-transformations.test.js

@@ -0,0 +1,69 @@
+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-transformation', function() {
+    const config = require('./webpack.extend-tranformations.config');
+
+    let stats;
+    let error;
+    let wrNodes;
+
+    function getWebresourceLike(needle) {
+        return wrNodes.find(n => n.attributes.key.indexOf(needle) > -1);
+    }
+
+    function getTransformation(node) {
+        return node.children.filter(childNode => childNode.name === 'transformation');
+    }
+
+    function getTransformationByExtension(transformations, extname) {
+        return transformations.filter(transformation => transformation.attributes.extension === extname)[0];
+    }
+
+    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;
+            done();
+        });
+    });
+
+    describe('extending transformations', () => {
+        let entryJsTrans, lessTrans, svgTrans;
+
+        beforeEach(function() {
+            const entrypointTransformations = getTransformation(getWebresourceLike('app-one'));
+            const assetTransformations = getTransformation(getWebresourceLike('assets'));
+
+            assert.ok(entrypointTransformations);
+            assert.ok(assetTransformations);
+
+            entryJsTrans = getTransformationByExtension(entrypointTransformations, 'js');
+
+            lessTrans = getTransformationByExtension(assetTransformations, 'less');
+            svgTrans = getTransformationByExtension(assetTransformations, 'svg');
+        });
+
+        it('should include default transformations', () => {
+            assert.include(entryJsTrans.children.map(c => c.attributes.key), 'jsI18n');
+            assert.include(lessTrans.children.map(c => c.attributes.key), 'lessTransformer');
+        });
+
+        it('should contain additional transformers', () => {
+            assert.include(entryJsTrans.children.map(c => c.attributes.key), 'custom-transformer');
+            assert.include(entryJsTrans.children.map(c => c.attributes.key), 'foo-transformer');
+
+            assert.include(svgTrans.children.map(c => c.attributes.key), 'bar');
+        });
+    });
+});

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

@@ -0,0 +1,100 @@
+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-transformation', function() {
+    const config = require('./webpack.specify-transformations.config');
+
+    let stats;
+    let error;
+    let wrNodes;
+
+    function getWebresourceLike(needle) {
+        return wrNodes.find(n => n.attributes.key.indexOf(needle) > -1);
+    }
+
+    function getTransformation(node) {
+        return node.children.filter(childNode => childNode.name === 'transformation');
+    }
+
+    function getTransformationByExtension(transformations, extname) {
+        return transformations.filter(transformation => transformation.attributes.extension === extname)[0];
+    }
+
+    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;
+            done();
+        });
+    });
+
+    it('should run without error', () => {
+        assert.ok(wrNodes);
+        assert.equal(stats.hasErrors(), false, error);
+        assert.equal(stats.hasWarnings(), false);
+    });
+
+    describe('add transformation for file extensions', () => {
+        let entryJsTrans, entrySoyTrans, entryLessTrans;
+        let jsTrans, htmlTrans, lessTrans, soyTrans, svgTrans, txtTrans;
+
+        beforeEach(function() {
+            const entrypointTransformations = getTransformation(getWebresourceLike('app-one'));
+            const assetTransformations = getTransformation(getWebresourceLike('assets'));
+
+            assert.ok(entrypointTransformations);
+            assert.ok(assetTransformations);
+
+            entryJsTrans = getTransformationByExtension(entrypointTransformations, 'js');
+            entrySoyTrans = getTransformationByExtension(entrypointTransformations, 'soy');
+            entryLessTrans = getTransformationByExtension(entrypointTransformations, 'less');
+
+            jsTrans = getTransformationByExtension(assetTransformations, 'js');
+            htmlTrans = getTransformationByExtension(assetTransformations, 'html');
+            lessTrans = getTransformationByExtension(assetTransformations, 'less');
+            soyTrans = getTransformationByExtension(assetTransformations, 'soy');
+            svgTrans = getTransformationByExtension(assetTransformations, 'svg');
+            txtTrans = getTransformationByExtension(assetTransformations, 'txt');
+        });
+
+        it('should remove default transformations from web-resources', () => {
+            assert.equal(entrySoyTrans, null);
+            assert.equal(entryLessTrans, null);
+            assert.notInclude(entryJsTrans.children.map(c => c.attributes.key), 'jsI18n');
+
+            // the defaults should not end up on the assets web-resource either,
+            // since there aren't any assets of those types in the graph.
+            assert.equal(jsTrans, null);
+            assert.equal(lessTrans, null);
+            assert.equal(soyTrans, null);
+        });
+
+        it('should add custom transformations to web-resources', () => {
+            assert.include(entryJsTrans.children.map(c => c.attributes.key), 'foo');
+            assert.include(entryJsTrans.children.map(c => c.attributes.key), 'bar');
+
+            assert.include(txtTrans.children.map(c => c.attributes.key), 'bar');
+
+            assert.include(htmlTrans.children.map(c => c.attributes.key), 'stuff');
+            assert.include(htmlTrans.children.map(c => c.attributes.key), 'n stuff');
+
+            assert.equal(svgTrans, null);
+        });
+
+        it('should not produce duplicated transformations', () => {
+            const transformationNames = txtTrans.children.map(c => c.attributes.key);
+
+            assert.equal(transformationNames.length, 1);
+        });
+    });
+});

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

@@ -0,0 +1,13 @@
+import $ from 'jquery';
+import text from './test.txt';
+import styles from './test.less';
+import body from './test.html';
+import rect from './rect.svg';
+
+$(() => {
+    $('body')
+        .text(text)
+        .html(body)
+        .css(styles)
+        .append(rect);
+});

package/test/use-cases/specify-transformation/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/specify-transformation/src/test.html

@@ -0,0 +1 @@
+<p>hello there again!</p>

package/test/use-cases/specify-transformation/src/test.less

@@ -0,0 +1 @@
+.foo { color: red; }

package/test/use-cases/specify-transformation/src/test.txt

@@ -0,0 +1 @@
+hello, world!

package/test/use-cases/specify-transformation/webpack.disable-tranformations.config.js

@@ -0,0 +1,31 @@
+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'),
+    },
+    module: {
+        rules: [
+            {
+                test: /\.(?!js)/,
+                use: 'file-loader',
+            },
+        ],
+    },
+    plugins: [
+        new WrmPlugin({
+            pluginKey: 'com.atlassian.plugin.test',
+            xmlDescriptors: path.join(OUTPUT_DIR, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml'),
+            transformationMap: false,
+            verbose: false,
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: OUTPUT_DIR,
+    },
+};

package/test/use-cases/specify-transformation/webpack.extend-tranformations.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');
+
+module.exports = {
+    mode: 'development',
+    entry: {
+        'app-one': path.join(FRONTEND_SRC_DIR, 'app.js'),
+    },
+    module: {
+        rules: [
+            {
+                test: /\.(?!js)/,
+                use: 'file-loader',
+            },
+        ],
+    },
+    plugins: [
+        new WrmPlugin({
+            pluginKey: 'com.atlassian.plugin.test',
+            xmlDescriptors: path.join(OUTPUT_DIR, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml'),
+            transformationMap: WrmPlugin.extendTransformations({
+                js: ['custom-transformer', 'foo-transformer'],
+                svg: ['bar'],
+            }),
+            verbose: false,
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: OUTPUT_DIR,
+    },
+};

package/test/use-cases/specify-transformation/webpack.specify-transformations.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');
+
+module.exports = {
+    mode: 'development',
+    entry: {
+        'app-one': path.join(FRONTEND_SRC_DIR, 'app.js'),
+    },
+    module: {
+        rules: [
+            {
+                test: /\.(?!js)/,
+                use: 'file-loader',
+            },
+        ],
+    },
+    plugins: [
+        new WrmPlugin({
+            pluginKey: 'com.atlassian.plugin.test',
+            xmlDescriptors: path.join(OUTPUT_DIR, 'META-INF', 'plugin-descriptor', 'wr-webpack-bundles.xml'),
+            transformationMap: {
+                js: ['foo', 'bar'],
+                html: ['stuff', 'n stuff'],
+                txt: ['bar', 'bar'],
+            },
+            verbose: false,
+        }),
+    ],
+    output: {
+        filename: '[name].js',
+        path: OUTPUT_DIR,
+    },
+};

package/test/use-cases/split-chunks/split-chunks.test.js

@@ -0,0 +1,102 @@
+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('split-chunks', function() {
+    const config = require('./webpack.config.js');
+
+    let stats;
+    let error;
+    let entryApp;
+    let entryApp2;
+    let splitChunkShared;
+    let testEntryApp;
+    let testEntryApp2;
+
+    function getChild(node, name) {
+        return node.children.filter(n => n.name === name);
+    }
+
+    function getContent(nodes) {
+        return nodes.map(n => n.content);
+    }
+
+    before(done => {
+        webpack(config, (err, st) => {
+            error = err;
+            stats = st;
+
+            const xmlFile = fs.readFileSync(webresourceOutput, 'utf-8');
+            const results = parse(xmlFile);
+            entryApp = results.root.children.find(n => n.attributes.key === 'entrypoint-app');
+            entryApp2 = results.root.children.find(n => n.attributes.key === 'entrypoint-app2');
+            splitChunkShared = results.root.children.find(n => n.attributes.key === 'split_app~app2');
+            testEntryApp = results.root.children.find(n => n.attributes.key === '__test__entrypoint-app');
+            testEntryApp2 = results.root.children.find(n => n.attributes.key === '__test__entrypoint-app2');
+            done();
+        });
+    });
+
+    it('should create a webresources with dependencies and resources as appropriate', () => {
+        assert.ok(entryApp);
+        assert.ok(entryApp2);
+        assert.ok(splitChunkShared);
+
+        assert.equal(error, null);
+        assert.equal(stats.hasErrors(), false);
+        assert.equal(stats.hasWarnings(), false);
+    });
+
+    describe('split chunk for shared modules', () => {
+        it('should create a web-resource for the split chunk', () => {
+            assert.ok(splitChunkShared);
+            assert.equal(
+                getChild(splitChunkShared, 'resource').length,
+                1,
+                'split chunk contains unexpected amount of resources'
+            );
+        });
+
+        it('should contain all dependencies specified in at least 2 entry-points', () => {
+            const deps = getContent(getChild(splitChunkShared, 'dependency'));
+            assert.include(deps, 'jira.webresources:jquery', 'jquery dependency not found in split chunk');
+            assert.include(
+                deps,
+                'com.atlassian.plugin.jslibs:underscore-1.4.4',
+                'underscore dependency not found in split chunk'
+            );
+        });
+    });
+
+    describe('entry points', () => {
+        let depsApp;
+        let depsApp2;
+        beforeEach(() => {
+            depsApp = getContent(getChild(entryApp, 'dependency'));
+            depsApp2 = getContent(getChild(entryApp2, 'dependency'));
+        });
+        it('should not have direct dependency to shared deps', () => {
+            assert.notInclude(depsApp, 'jira.webresources:jquery', 'unexpected dependency found');
+            assert.notInclude(depsApp, 'com.atlassian.plugin.jslibs:underscore-1.4.4', 'unexpected dependency found');
+            assert.notInclude(depsApp2, 'jira.webresources:jquery', 'unexpected dependency found');
+            assert.notInclude(depsApp2, 'com.atlassian.plugin.jslibs:underscore-1.4.4', 'unexpected dependency found');
+        });
+
+        it('should have dependency to split chunks', () => {
+            assert.include(depsApp, 'com.atlassian.plugin.test:split_app~app2', 'expected dependency not found');
+            assert.include(depsApp2, 'com.atlassian.plugin.test:split_app~app2', 'expected dependency not found');
+        });
+    });
+
+    describe('test web-resources', () => {
+        it('should not have any test entries', () => {
+            assert.equal(testEntryApp, undefined, 'test entrypoint is undefined');
+            assert.equal(testEntryApp2, undefined, 'test entrypoint is undefined');
+        });
+    });
+});

package/test/use-cases/split-chunks/src/app.js

@@ -0,0 +1,7 @@
+import $ from 'jquery';
+import foo from './foo';
+import bar from './bar';
+
+$(() => {
+    $('body').html(`hello world, ${bar} ${foo}`);
+});

package/test/use-cases/split-chunks/src/app2.js

@@ -0,0 +1,7 @@
+import $ from 'jquery';
+import foo2 from './foo2';
+import bar from './bar';
+
+$(() => {
+    $('body').html(`hello world, ${bar} ${foo2}`);
+});

package/test/use-cases/split-chunks/src/bar.js

@@ -0,0 +1,2 @@
+import $ from 'jquery';
+export default 'bar';

package/test/use-cases/split-chunks/src/foo.js

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

package/test/use-cases/split-chunks/src/foo2.js

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

package/test/use-cases/split-chunks/webpack.config.js

@@ -0,0 +1,42 @@
+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',
+    devtool: false,
+    entry: {
+        app: path.join(FRONTEND_SRC_DIR, 'app.js'),
+        app2: path.join(FRONTEND_SRC_DIR, 'app2.js'),
+    },
+    optimization: {
+        splitChunks: {
+            minSize: 0,
+            chunks: 'all',
+        },
+    },
+    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/split-chunks-with-runtime/split-chunks-with-runtime.test.js

@@ -0,0 +1,114 @@
+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('split-chunks-with-runtime', function() {
+    const config = require('./webpack.config.js');
+
+    let stats;
+    let error;
+    let entryApp;
+    let entryApp2;
+    let splitChunkApp;
+    let splitChunkApp2;
+    let splitChunkShared;
+    let testEntryApp;
+    let testEntryApp2;
+
+    function getChild(node, name) {
+        return node.children.filter(n => n.name === name);
+    }
+
+    function getContent(nodes) {
+        return nodes.map(n => n.content);
+    }
+
+    function getAttribute(nodes, attribute) {
+        return nodes.map(n => n.attributes[attribute]);
+    }
+
+    before(done => {
+        webpack(config, (err, st) => {
+            error = err;
+            stats = st;
+
+            const xmlFile = fs.readFileSync(webresourceOutput, 'utf-8');
+            const results = parse(xmlFile);
+            entryApp = results.root.children.find(n => n.attributes.key === 'entrypoint-app');
+            entryApp2 = results.root.children.find(n => n.attributes.key === 'entrypoint-app2');
+            splitChunkApp = results.root.children.find(n => n.attributes.key === 'split_app');
+            splitChunkApp2 = results.root.children.find(n => n.attributes.key === 'split_app2');
+            splitChunkShared = results.root.children.find(n => n.attributes.key === 'split_app~app2');
+            testEntryApp = results.root.children.find(n => n.attributes.key === '__test__entrypoint-app');
+            testEntryApp2 = results.root.children.find(n => n.attributes.key === '__test__entrypoint-app2');
+            done();
+        });
+    });
+
+    it('should create a webresources with dependencies and resources as appropriate', () => {
+        assert.ok(entryApp);
+        assert.ok(entryApp2);
+        assert.ok(splitChunkApp);
+        assert.ok(splitChunkApp2);
+        assert.ok(splitChunkShared);
+
+        assert.equal(error, null);
+        assert.equal(stats.hasErrors(), false);
+        assert.equal(stats.hasWarnings(), false);
+    });
+
+    describe('split chunk for shared modules', () => {
+        it('should create a web-resource for the split chunk', () => {
+            assert.ok(splitChunkShared);
+            assert.equal(
+                getChild(splitChunkShared, 'resource').length,
+                1,
+                'split chunk contains unexpected amount of resources'
+            );
+        });
+
+        it('should contain all dependencies specified in at least 2 entry-points', () => {
+            const deps = getContent(getChild(splitChunkShared, 'dependency'));
+            assert.include(deps, 'jira.webresources:jquery', 'jquery dependency not found in split chunk');
+            assert.include(
+                deps,
+                'com.atlassian.plugin.jslibs:underscore-1.4.4',
+                'underscore dependency not found in split chunk'
+            );
+        });
+    });
+
+    describe('entry points', () => {
+        let depsApp;
+        let depsApp2;
+        beforeEach(() => {
+            depsApp = getContent(getChild(entryApp, 'dependency'));
+            depsApp2 = getContent(getChild(entryApp2, 'dependency'));
+        });
+        it('should not have direct dependency to shared deps', () => {
+            assert.notInclude(depsApp, 'jira.webresources:jquery', 'unexpected dependency found');
+            assert.notInclude(depsApp, 'com.atlassian.plugin.jslibs:underscore-1.4.4', 'unexpected dependency found');
+            assert.notInclude(depsApp2, 'jira.webresources:jquery', 'unexpected dependency found');
+            assert.notInclude(depsApp2, 'com.atlassian.plugin.jslibs:underscore-1.4.4', 'unexpected dependency found');
+        });
+
+        it('should have dependency to split chunks', () => {
+            assert.include(depsApp, 'com.atlassian.plugin.test:split_app', 'expected dependency not found');
+            assert.include(depsApp, 'com.atlassian.plugin.test:split_app~app2', 'expected dependency not found');
+            assert.include(depsApp2, 'com.atlassian.plugin.test:split_app2', 'expected dependency not found');
+            assert.include(depsApp2, 'com.atlassian.plugin.test:split_app~app2', 'expected dependency not found');
+        });
+    });
+
+    describe('test web-resources', () => {
+        it('should not have any test entries', () => {
+            assert.equal(testEntryApp, undefined, 'test entrypoint is undefined');
+            assert.equal(testEntryApp2, undefined, 'test entrypoint is undefined');
+        });
+    });
+});

package/test/use-cases/split-chunks-with-runtime/src/app.js

@@ -0,0 +1,7 @@
+import $ from 'jquery';
+import foo from './foo';
+import bar from './bar';
+
+$(() => {
+    $('body').html(`hello world, ${bar} ${foo}`);
+});

package/test/use-cases/split-chunks-with-runtime/src/app2.js

@@ -0,0 +1,7 @@
+import $ from 'jquery';
+import foo2 from './foo2';
+import bar from './bar';
+
+$(() => {
+    $('body').html(`hello world, ${bar} ${foo2}`);
+});

package/test/use-cases/split-chunks-with-runtime/src/bar.js

@@ -0,0 +1,2 @@
+import $ from 'jquery';
+export default 'bar';

package/test/use-cases/split-chunks-with-runtime/src/foo.js

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

package/test/use-cases/split-chunks-with-runtime/src/foo2.js

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

package/test/use-cases/split-chunks-with-runtime/webpack.config.js

@@ -0,0 +1,43 @@
+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',
+    devtool: false,
+    entry: {
+        app: path.join(FRONTEND_SRC_DIR, 'app.js'),
+        app2: path.join(FRONTEND_SRC_DIR, 'app2.js'),
+    },
+    optimization: {
+        runtimeChunk: true,
+        splitChunks: {
+            minSize: 0,
+            chunks: 'all',
+        },
+    },
+    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,
+    },
+};