@relative-ci/webpack-plugin 5.0.0-alpha.15

package/LICENSE

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright 2018 Viorel Cojocaru, contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,32 @@
+<a href="https://relative-ci.com">
+  <img alt="RelativeCI" src="https://raw.githubusercontent.com/relative-ci/agent/master/assets/relative-ci--logo.png" width="96" />
+</a>
+
+# RelativeCI webpack-plugin agent
+
+> Send bundle stats and CI build information to [RelativeCI](https://relative-ci.com?utm_source=github&utm_medium=agent).
+
+To get started, follow [RelativeCI Setup guide for webpack-plugin](https://relative-ci.com/documentation/setup?utm_source=github&utm_medium=agent).
+
+[![npm](https://img.shields.io/npm/v/@relative-ci/webpack-plugin.svg)](https://www.npmjs.com/package/@relative-ci/webpack-plugin)
+[![node version](https://img.shields.io/node/v/@relative-ci/webpack-plugin.svg)](https://www.npmjs.com/package/@relative-ci/webpack-plugin)
+[![Socket Badge](https://socket.dev/api/badge/npm/package/@relative-ci/webpack-plugin)](https://socket.dev/npm/package/@relative-ci/webpack-plugin)
+[![ci](https://github.com/relative-ci/agent/actions/workflows/ci.yml/badge.svg)](https://github.com/relative-ci/agent/actions/workflows/ci.yml)
+[![CodeQL](https://github.com/relative-ci/agent/actions/workflows/codeql.yml/badge.svg)](https://github.com/relative-ci/agent/actions/workflows/codeql.yml)
+
+## Other packages
+
+### [`@relative-ci/cli`](https://github.com/relative-ci/agent/tree/master/packages/cli)
+
+[![npm](https://img.shields.io/npm/v/@relative-ci/cli.svg)](https://www.npmjs.com/package/@relative-ci/cli)
+[![node version](https://img.shields.io/node/v/@relative-ci/cli.svg)](https://www.npmjs.com/package/@relative-ci/cli)
+[![Socket Badge](https://socket.dev/api/badge/npm/package/@relative-ci/cli)](https://socket.dev/npm/package/@relative-ci/cli)
+[![ci](https://github.com/relative-ci/agent/actions/workflows/ci.yml/badge.svg)](https://github.com/relative-ci/agent/actions/workflows/ci.yml)
+[![CodeQL](https://github.com/relative-ci/agent/actions/workflows/codeql.yml/badge.svg)](https://github.com/relative-ci/agent/actions/workflows/codeql.yml)
+
+To get started, follow [RelativeCI Setup guide for CLI](https://relative-ci.com/documentation/setup/agent/cli?utm_source=github&utm_medium=agent).
+
+## Other agents
+
+- [GitHub action](https://github.com/relative-ci/cli-action)
+- [CircleCI orbit (soon)](https://github.com/relative-ci/roadmap/issues/46)

package/lib/cjs/index.js

@@ -0,0 +1,78 @@
+'use strict';
+
+var webpack = require('webpack');
+var _ = require('lodash');
+var core = require('@relative-ci/core');
+var loadEnv = require('@relative-ci/core/env');
+var ingest = require('@relative-ci/core/ingest');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var webpack__default = /*#__PURE__*/_interopDefault(webpack);
+var ___default = /*#__PURE__*/_interopDefault(_);
+var loadEnv__default = /*#__PURE__*/_interopDefault(loadEnv);
+var ingest__default = /*#__PURE__*/_interopDefault(ingest);
+
+const PLUGIN_NAME = 'RelativeCiAgent';
+const DEFAULT_OPTIONS = {
+    includeCommitMessage: true,
+    payloadFilepath: null,
+    stats: {
+        assets: true,
+        chunks: true,
+        modules: true,
+    },
+};
+const isWebpack5 = parseInt(webpack__default.default.version, 10) === 5;
+async function sendStats(compilation, options) {
+    const { stats: statsOptions, failOnError, ...config } = options;
+    const data = compilation.getStats().toJson(statsOptions);
+    const logger = compilation.compiler?.getInfrastructureLogger
+        ? compilation.compiler.getInfrastructureLogger(PLUGIN_NAME)
+        : console;
+    try {
+        core.validateWebpackStats(data);
+        const params = loadEnv__default.default({}, { includeCommitMessage: config?.includeCommitMessage });
+        const artifactsData = core.filterArtifacts([{ key: core.SOURCE_WEBPACK_STATS, data }]);
+        const response = await ingest__default.default(artifactsData, params, config, logger);
+        core.logResponse(response);
+    }
+    catch (error) {
+        if (failOnError) {
+            compilation.errors.push(error);
+        }
+        else {
+            logger.warn(error); // catch error to prevent failure on error
+        }
+    }
+}
+class RelativeCIAgentWebpackPlugin {
+    constructor(options) {
+        this.options = options;
+    }
+    apply(compiler) {
+        const { isCi } = loadEnv.getCiEnv({ includeCommitMessage: this.options?.includeCommitMessage });
+        const options = ___default.default.merge({}, DEFAULT_OPTIONS, {
+            enabled: isCi,
+        }, this.options);
+        core.debug(options);
+        // Skip if not enabled
+        if (!options.enabled) {
+            core.debug(`${PLUGIN_NAME} is disabled, skip sending data`);
+            return;
+        }
+        if (isWebpack5) {
+            compiler.hooks.make.tap(PLUGIN_NAME, (compilation) => {
+                compilation.hooks.processAssets.tap({ name: PLUGIN_NAME, stage: webpack__default.default.Compilation.PROCESS_ASSETS_STAGE_REPORT }, () => sendStats(compilation, options));
+            });
+            return;
+        }
+        compiler.hooks.emit.tapAsync(PLUGIN_NAME, async (compilation, callback) => {
+            await sendStats(compilation, options);
+            callback();
+        });
+    }
+}
+
+module.exports = RelativeCIAgentWebpackPlugin;
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../src/index.ts"],"sourcesContent":[null],"names":["webpack","validateWebpackStats","loadEnv","filterArtifacts","SOURCE_WEBPACK_STATS","ingest","logResponse","getCiEnv","_","debug"],"mappings":";;;;;;;;;;;;;;;AA4CA,MAAM,WAAW,GAAG,iBAAiB;AAErC,MAAM,eAAe,GAAG;AACtB,IAAA,oBAAoB,EAAE,IAAI;AAC1B,IAAA,eAAe,EAAE,IAAI;AACrB,IAAA,KAAK,EAAE;AACL,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,OAAO,EAAE,IAAI;AACd,KAAA;CACF;AAED,MAAM,UAAU,GAAG,QAAQ,CAACA,wBAAO,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC;AAEtD,eAAe,SAAS,CACtB,WAAwB,EACxB,OAA4C,EAAA;AAE5C,IAAA,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO;IAC/D,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC;AAExD,IAAA,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,EAAE;UACjC,WAAW,CAAC,QAAQ,CAAC,uBAAuB,CAAC,WAAW;UACxD,OAAO;AAEX,IAAA,IAAI;QACFC,yBAAoB,CAAC,IAAI,CAAC;AAE1B,QAAA,MAAM,MAAM,GAAGC,wBAAO,CAAC,EAAE,EAAE,EAAE,oBAAoB,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC;AAClF,QAAA,MAAM,aAAa,GAAGC,oBAAe,CAAC,CAAC,EAAE,GAAG,EAAEC,yBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;AAC5E,QAAA,MAAM,QAAQ,GAAG,MAAMC,uBAAM,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;QAEpEC,gBAAW,CAAC,QAAQ,CAAC;;IACrB,OAAO,KAAU,EAAE;QACnB,IAAI,WAAW,EAAE;AACf,YAAA,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;;aACzB;AACL,YAAA,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;AAGzB;AAEA,MAAM,4BAA4B,CAAA;AAGhC,IAAA,WAAA,CAAY,OAA4C,EAAA;AACtD,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;;AAGxB,IAAA,KAAK,CAAC,QAAkB,EAAA;AACtB,QAAA,MAAM,EAAE,IAAI,EAAE,GAAGC,gBAAQ,CAAC,EAAE,oBAAoB,EAAE,IAAI,CAAC,OAAO,EAAE,oBAAoB,EAAE,CAAC;QAEvF,MAAM,OAAO,GAAwCC,kBAAC,CAAC,KAAK,CAC1D,EAAE,EACF,eAAe,EACf;AACE,YAAA,OAAO,EAAE,IAAI;AACd,SAAA,EACD,IAAI,CAAC,OAAO,CACb;QAEDC,UAAK,CAAC,OAAO,CAAC;;AAGd,QAAA,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;AACpB,YAAAA,UAAK,CAAC,CAAA,EAAG,WAAW,CAAA,+BAAA,CAAiC,CAAC;YACtD;;QAGF,IAAI,UAAU,EAAE;AACd,YAAA,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,WAAW,KAAI;AACnD,gBAAA,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CACjC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAET,wBAAO,CAAC,WAAW,CAAC,2BAA2B,EAAE,EAC7E,MAAM,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CACtC;AACH,aAAC,CAAC;YAEF;;AAGF,QAAA,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAC1B,WAAW,EACX,OAAO,WAAW,EAAE,QAAQ,KAAI;AAC9B,YAAA,MAAM,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC;AACrC,YAAA,QAAQ,EAAE;AACZ,SAAC,CACF;;AAEJ;;;;"}

package/lib/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/lib/esm/index.js

@@ -0,0 +1,69 @@
+import webpack from 'webpack';
+import _ from 'lodash';
+import { debug, validateWebpackStats, filterArtifacts, SOURCE_WEBPACK_STATS, logResponse } from '@relative-ci/core';
+import loadEnv, { getCiEnv } from '@relative-ci/core/env';
+import ingest from '@relative-ci/core/ingest';
+
+const PLUGIN_NAME = 'RelativeCiAgent';
+const DEFAULT_OPTIONS = {
+    includeCommitMessage: true,
+    payloadFilepath: null,
+    stats: {
+        assets: true,
+        chunks: true,
+        modules: true,
+    },
+};
+const isWebpack5 = parseInt(webpack.version, 10) === 5;
+async function sendStats(compilation, options) {
+    const { stats: statsOptions, failOnError, ...config } = options;
+    const data = compilation.getStats().toJson(statsOptions);
+    const logger = compilation.compiler?.getInfrastructureLogger
+        ? compilation.compiler.getInfrastructureLogger(PLUGIN_NAME)
+        : console;
+    try {
+        validateWebpackStats(data);
+        const params = loadEnv({}, { includeCommitMessage: config?.includeCommitMessage });
+        const artifactsData = filterArtifacts([{ key: SOURCE_WEBPACK_STATS, data }]);
+        const response = await ingest(artifactsData, params, config, logger);
+        logResponse(response);
+    }
+    catch (error) {
+        if (failOnError) {
+            compilation.errors.push(error);
+        }
+        else {
+            logger.warn(error); // catch error to prevent failure on error
+        }
+    }
+}
+class RelativeCIAgentWebpackPlugin {
+    constructor(options) {
+        this.options = options;
+    }
+    apply(compiler) {
+        const { isCi } = getCiEnv({ includeCommitMessage: this.options?.includeCommitMessage });
+        const options = _.merge({}, DEFAULT_OPTIONS, {
+            enabled: isCi,
+        }, this.options);
+        debug(options);
+        // Skip if not enabled
+        if (!options.enabled) {
+            debug(`${PLUGIN_NAME} is disabled, skip sending data`);
+            return;
+        }
+        if (isWebpack5) {
+            compiler.hooks.make.tap(PLUGIN_NAME, (compilation) => {
+                compilation.hooks.processAssets.tap({ name: PLUGIN_NAME, stage: webpack.Compilation.PROCESS_ASSETS_STAGE_REPORT }, () => sendStats(compilation, options));
+            });
+            return;
+        }
+        compiler.hooks.emit.tapAsync(PLUGIN_NAME, async (compilation, callback) => {
+            await sendStats(compilation, options);
+            callback();
+        });
+    }
+}
+
+export { RelativeCIAgentWebpackPlugin as default };
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AA4CA,MAAM,WAAW,GAAG,iBAAiB;AAErC,MAAM,eAAe,GAAG;AACtB,IAAA,oBAAoB,EAAE,IAAI;AAC1B,IAAA,eAAe,EAAE,IAAI;AACrB,IAAA,KAAK,EAAE;AACL,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,OAAO,EAAE,IAAI;AACd,KAAA;CACF;AAED,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC;AAEtD,eAAe,SAAS,CACtB,WAAwB,EACxB,OAA4C,EAAA;AAE5C,IAAA,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO;IAC/D,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC;AAExD,IAAA,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,EAAE;UACjC,WAAW,CAAC,QAAQ,CAAC,uBAAuB,CAAC,WAAW;UACxD,OAAO;AAEX,IAAA,IAAI;QACF,oBAAoB,CAAC,IAAI,CAAC;AAE1B,QAAA,MAAM,MAAM,GAAG,OAAO,CAAC,EAAE,EAAE,EAAE,oBAAoB,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC;AAClF,QAAA,MAAM,aAAa,GAAG,eAAe,CAAC,CAAC,EAAE,GAAG,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;AAC5E,QAAA,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;QAEpE,WAAW,CAAC,QAAQ,CAAC;;IACrB,OAAO,KAAU,EAAE;QACnB,IAAI,WAAW,EAAE;AACf,YAAA,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;;aACzB;AACL,YAAA,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;AAGzB;AAEA,MAAM,4BAA4B,CAAA;AAGhC,IAAA,WAAA,CAAY,OAA4C,EAAA;AACtD,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;;AAGxB,IAAA,KAAK,CAAC,QAAkB,EAAA;AACtB,QAAA,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,EAAE,oBAAoB,EAAE,IAAI,CAAC,OAAO,EAAE,oBAAoB,EAAE,CAAC;QAEvF,MAAM,OAAO,GAAwC,CAAC,CAAC,KAAK,CAC1D,EAAE,EACF,eAAe,EACf;AACE,YAAA,OAAO,EAAE,IAAI;AACd,SAAA,EACD,IAAI,CAAC,OAAO,CACb;QAED,KAAK,CAAC,OAAO,CAAC;;AAGd,QAAA,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;AACpB,YAAA,KAAK,CAAC,CAAA,EAAG,WAAW,CAAA,+BAAA,CAAiC,CAAC;YACtD;;QAGF,IAAI,UAAU,EAAE;AACd,YAAA,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,WAAW,KAAI;AACnD,gBAAA,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CACjC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,2BAA2B,EAAE,EAC7E,MAAM,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CACtC;AACH,aAAC,CAAC;YAEF;;AAGF,QAAA,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAC1B,WAAW,EACX,OAAO,WAAW,EAAE,QAAQ,KAAI;AAC9B,YAAA,MAAM,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC;AACrC,YAAA,QAAQ,EAAE;AACZ,SAAC,CACF;;AAEJ;;;;"}

package/lib/esm/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/lib/types/index.d.ts

@@ -0,0 +1,34 @@
+import { type Compiler, type Configuration } from 'webpack';
+import { type PluginConfig } from '@relative-ci/core';
+type RelativeCIAgentWebpackPluginOptions = {
+    /**
+     * Plugin is enabled - sends data to RelativeCI
+     * @default env-ci isCi value
+     */
+    enabled?: boolean;
+    /**
+     * Throw error when validation or ingestion fails
+     * @default {false}
+     */
+    failOnError?: boolean;
+    /**
+     * Read commit message from git
+     * @default true
+     */
+    includeCommitMessage?: PluginConfig['includeCommitMessage'];
+    /**
+     * Output payload on a local file for debugging
+     */
+    payloadFilepath?: PluginConfig['payloadFilepath'];
+    /**
+     * Webpack stats options
+     * @default assets, chunks, modules
+     */
+    stats?: Configuration['stats'];
+};
+declare class RelativeCIAgentWebpackPlugin {
+    options: RelativeCIAgentWebpackPluginOptions;
+    constructor(options: RelativeCIAgentWebpackPluginOptions);
+    apply(compiler: Compiler): void;
+}
+export default RelativeCIAgentWebpackPlugin;

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@relative-ci/webpack-plugin",
+  "version": "5.0.0-alpha.15",
+  "description": "Webpack plugin that sends bundle stats and CI build information to RelativeCI",
+  "keywords": [
+    "webpack",
+    "rspack",
+    "bundle-size",
+    "bundle-analyzer",
+    "bundle-stats",
+    "stats",
+    "bundle",
+    "size",
+    "assets",
+    "chunks",
+    "modules"
+  ],
+  "repository": "https://github.com/relative-ci/agent",
+  "bugs": {
+    "url": "https://github.com/relative-ci/agent/issues"
+  },
+  "homepage": "https://relative-ci.com/documentation/setup/agent/webpack-plugin",
+  "license": "MIT",
+  "author": {
+    "name": "Viorel Cojocaru",
+    "email": "vio@relative-ci.com",
+    "url": "https://relative-ci.com"
+  },
+  "engines": {
+    "node": ">= 18.0.0"
+  },
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/types/index.d.ts",
+  "scripts": {
+    "build": "npm run clean && tsc && rollup -c && npm run build-type",
+    "build-type": "echo '{\"type\":\"commonjs\"}' > lib/cjs/package.json && echo '{\"type\":\"module\"}' > lib/esm/package.json",
+    "clean": "rimraf ./lib",
+    "clean-deps": "rimraf ./test/webpack/*/node_modules ./node_modules",
+    "lint": "eslint .",
+    "test": "vitest src --passWithNoTests --run"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "28.0.3",
+    "@rollup/plugin-node-resolve": "16.0.0",
+    "@rollup/plugin-replace": "6.0.2",
+    "@rollup/plugin-typescript": "12.1.2",
+    "@tsconfig/node18": "^18.2.4",
+    "@types/lodash": "4.17.16",
+    "memory-fs": "0.5.0",
+    "rimraf": "6.0.1",
+    "rollup": "4.35.0",
+    "rollup-plugin-node-externals": "8.0.0",
+    "typescript": "5.8.2",
+    "vitest": "3.0.8",
+    "webpack": "5.98.0"
+  },
+  "dependencies": {
+    "@relative-ci/core": "5.0.0-alpha.15",
+    "lodash": "4.17.21"
+  },
+  "peerDependencies": {
+    "webpack": "^4.0.0 || ^5.0.0-rc.1"
+  },
+  "gitHead": "dfeab530e9200e052d773105be6911cb6aeda94b"
+}