build-firewall-plugin 0.0.6 → 0.0.8

package/build/index.d.ts

@@ -1,4 +1,7 @@
 import { Compiler, RspackPluginInstance } from "@rspack/core";
+/**
+ * @type for plugin input options
+ */
 type Options = {
     /**
      * Path to your JSON file with project rules
@@ -27,6 +30,10 @@ type Options = {
      * node_modules, assets, images, types, intefaces, styles file and directories
      */
     exceptions?: string[];
+    /**
+     * type of output
+     */
+    outputType?: 'default' | 'object';
 };
 export declare class BuildFirewallPlugin implements RspackPluginInstance {
     private readonly config;

package/build/index.js

@@ -50,7 +50,7 @@ const isValidSchema = (value) => {
             && Array.isArray(layer.allow) && Array.isArray(layer.deny)));
 };
 /**
- * @function resolveLayer normilize module resource
+ * @function resolveLayer normilizes module resource
  */
 function resolveLayer(resource, layers) {
     const normalized = resource.replace(/\\/g, '/');
@@ -61,6 +61,26 @@ function resolveLayer(resource, layers) {
     }
     return null;
 }
+;
+/**
+ * @function prepareOutput is for object type output
+ */
+function prepareOutput(params) {
+    const { total, modules, warnings, layers } = params;
+    return {
+        plugin: 'Build Firewall Plugin',
+        message_type: 'output',
+        hooks: ['thisCompilation', 'finishModules'],
+        warnings: params.warnings,
+        modules_checked: params.modules,
+        total_modules: params.total,
+        layers: {
+            amount: params.layers.amount,
+            kind: params.layers.items,
+        },
+    };
+}
+;
 class BuildFirewallPlugin {
     constructor(options) {
         this.config = {
@@ -69,6 +89,7 @@ class BuildFirewallPlugin {
             report: false,
             generateFile: false,
             mode: template.mode,
+            outputType: 'default',
             layers: template.layers,
             name: 'build-firewall-plugin.rules.json',
         };
@@ -80,17 +101,18 @@ class BuildFirewallPlugin {
         this.shouldRunAgain = false;
         compiler.hooks.thisCompilation.tap('BuildFirewallPluginThisCompilation', (compilation) => {
             compilation.hooks.finishModules.tap('BuildFirewallPluginThisCompilationFinishModules', (modules) => {
+                console.log('[Build Firewall Plugin] Starting... \n');
                 /**
                  * Creating or Validating a rules file
                  */
+                const pathToFile = path_1.default.resolve(compiler.context, this.config.name);
                 if (!this.config.path) {
                     try {
-                        const pathToFile = path_1.default.resolve(compiler.context, this.config.name);
                         fs_1.default.writeFileSync(pathToFile, JSON.stringify(template));
                         this.shouldRunAgain = true;
                         this.config.path = pathToFile;
-                        console.log(`[Build Firewall Plugin] Created a template of ${this.config.name} file successfully`);
-                        console.log(`[Build Firewall Plugin] Check and edit a ${this.config.name} file if it is not passing for your project`);
+                        console.log(`[Build Firewall Plugin] Created a template of ${this.config.name} file successfully \n`);
+                        console.log(`[Build Firewall Plugin] Check and edit a ${this.config.name} file if it is not passing for your project \n`);
                     }
                     catch (e) {
                         console.error(`[Build Firewall Plugin] Could not create a rules file: \n ${e}`);
@@ -100,24 +122,23 @@ class BuildFirewallPlugin {
                 }
                 else {
                     try {
-                        const pathToFile = path_1.default.resolve(compiler.context, this.config.name);
                         const rawFile = fs_1.default.readFileSync(pathToFile).toString();
                         const extention = path_1.default.extname(pathToFile);
                         const isJSON = extention.endsWith('.json');
                         if (!isJSON) {
-                            console.error(`[Build Firewall Plugin] Your ${this.config.name} file is not a JSON`);
+                            console.error(`[Build Firewall Plugin] Your ${this.config.name} file is not a JSON \n`);
                             return;
                         }
                         ;
                         if (rawFile.length < 0) {
-                            console.error(`[Build Firewall Plugin] Your ${this.config.name} file is empty`);
+                            console.error(`[Build Firewall Plugin] Your ${this.config.name} file is empty \n`);
                             return;
                         }
                         ;
                         const parsedFile = JSON.parse(rawFile);
                         const isObject = typeof parsedFile === 'object';
                         if (!isObject) {
-                            console.error(`[Build Firewall Plugin] Your ${this.config.name} file value is not an object`);
+                            console.error(`[Build Firewall Plugin] Your ${this.config.name} file value is not an object \n`);
                             return;
                         }
                         ;
@@ -130,16 +151,16 @@ class BuildFirewallPlugin {
                                         mode: 'warn'
                                     } 
                                 }
-                            `);
+                            \n`);
                             return;
                         }
                         ;
                         this.config.layers = parsedFile.layers;
                         this.config.mode = parsedFile.mode || 'warn';
-                        console.log(`Your ${this.config.name} file is valid!`);
+                        console.log(`[Build Firewall Plugin] Your ${this.config.name} file is valid! \n`);
                     }
                     catch (e) {
-                        console.error(`[Build Firewall Plugin] Error while validating your ${this.config.name} file \n ${e}`);
+                        console.error(`[Build Firewall Plugin] Error while validating your ${this.config.name} file \n ${e} \n`);
                         return;
                     }
                     ;
@@ -150,6 +171,10 @@ class BuildFirewallPlugin {
                 /**
                  * plugin logic
                  */
+                let checkedModules = 0;
+                let warningsAmount = 0;
+                let totalModules = Array.from(modules).length;
+                const outputLayers = Object.keys(this.config.layers);
                 for (const module of modules) {
                     const fromResource = module.nameForCondition();
                     if (!fromResource)
@@ -157,11 +182,16 @@ class BuildFirewallPlugin {
                     const fromLayer = resolveLayer(fromResource, this.config.layers);
                     if (!fromLayer)
                         continue;
+                    const seen = new Set();
                     for (const dependency of module.dependencies) {
                         const toModule = compilation.moduleGraph.getModule(dependency);
                         const toModuleResource = toModule === null || toModule === void 0 ? void 0 : toModule.nameForCondition();
                         if (!toModuleResource)
                             continue;
+                        const moduleKey = `${fromResource}::${toModuleResource}`;
+                        const hasLogged = seen.has(moduleKey);
+                        if (hasLogged)
+                            continue;
                         const isException = this.config.exceptions.some(e => toModuleResource.includes(e));
                         if (isException) {
                             continue;
@@ -176,13 +206,31 @@ class BuildFirewallPlugin {
                         const rules = this.config.layers[fromLayer];
                         if (!rules)
                             continue;
-                        const isDenided = rules.deny.includes(toLayer);
-                        const isAllowed = rules.allow.includes(toLayer);
-                        if (isDenided || !isAllowed) {
-                            console.log(`[Build Firewall Plugin] Dependency ${toModuleResource} is not allowed to import in ${fromResource}`);
+                        const isDenied = rules.deny.includes(toLayer);
+                        const hasAllow = rules.allow.length > 0;
+                        const isAllowed = !hasAllow || rules.allow.includes(toLayer);
+                        checkedModules++;
+                        if (isDenied || !isAllowed) {
+                            seen.add(moduleKey);
+                            warningsAmount++;
+                            if (this.config.outputType === 'default') {
+                                console.log(`\n [Build Firewall Plugin] Module ${toModuleResource} is not allowed to import in ${fromResource} \n`);
+                            }
                         }
                     }
                 }
+                if (this.config.outputType === 'object') {
+                    const output = prepareOutput({
+                        total: totalModules,
+                        modules: checkedModules,
+                        warnings: warningsAmount,
+                        layers: {
+                            items: outputLayers,
+                            amount: outputLayers.length,
+                        },
+                    });
+                    console.log(JSON.stringify(output, null, 2));
+                }
             });
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "build-firewall-plugin",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "type": "commonjs",
   "license": "MIT",
   "main": "build/index.js",