Merge pull request #119 from The-Only-Matrix/feature/loader-build-time-comparison

Feature/loader build time comparison

Author: stephencookdev

README.md

@@ -133,6 +133,23 @@ const smp = new SpeedMeasurePlugin({
 });
 ```
 
+### `options.compareLoadersBuild`
+
+Type: `Object`<br>
+Default: `{}`
+
+This option gives you per loader module count, module time to execute, time comparison
+with previous build of each loader. It takes input as `filePath` which is
+filename where all build details will be written.
+`Note :- i) Node version > 0.10 ii) filePath option is mandatory. iii) The module count will only be visible when the outputFormat is 'humanVerbose'.`,
+e.g.
+
+```javascript
+const smp = new SpeedMeasurePlugin({
+  compareLoadersBuild: { filePath: "./buildInfo.json" },
+});
+```
+
 ### `options.granularLoaderData` _(experimental)_
 
 Type: `Boolean`<br>

index.js

@@ -30,6 +30,8 @@ module.exports = class SpeedMeasurePlugin {
     this.addTimeEvent = this.addTimeEvent.bind(this);
     this.apply = this.apply.bind(this);
     this.provideLoaderTiming = this.provideLoaderTiming.bind(this);
+    this.getLoadersBuildComparison = this.getLoadersBuildComparison.bind(this);
+    this.isValidJson = this.isValidJson.bind(this);
   }
 
   wrap(config) {
@@ -68,6 +70,97 @@ module.exports = class SpeedMeasurePlugin {
     return config;
   }
 
+  isValidJson(strJson) {
+    try {
+      return JSON.parse(strJson) && !!strJson;
+    } catch (e) {
+      return false;
+    }
+  }
+
+  getLoadersBuildComparison() {
+    let objBuildData = { loaderInfo: [] };
+    let loaderFile = this.options.compareLoadersBuild.filePath || "";
+    const outputObj = getLoadersOutput(this.timeEventData.loaders);
+
+    if (outputObj && loaderFile && fs.existsSync(loaderFile)) {
+      let buildDetails = fs.readFileSync(loaderFile);
+      buildDetails = this.isValidJson(buildDetails.toString())
+        ? JSON.parse(buildDetails)
+        : [];
+      const buildCount = buildDetails.length;
+      const buildNo =
+        buildCount > 0 ? buildDetails[buildCount - 1]["buildNo"] + 1 : 1;
+
+      /*********************** Code to create object format of current loader and write in the file. ************************/
+      outputObj.build.forEach((loaderObj, loaderIndex) => {
+        const loaderInfo = {};
+        loaderInfo["Name"] = loaderObj.loaders.join(",") || "";
+        loaderInfo["Time"] = loaderObj.activeTime || "";
+        loaderInfo["Count"] =
+          this.options.outputFormat === "humanVerbose"
+            ? loaderObj.averages.dataPoints
+            : "";
+        loaderInfo[`Comparison`] = "";
+
+        // Getting the comparison from the previous build by default only in case if build data is more then one.
+        if (buildCount > 0) {
+          const prevBuildIndex = buildCount - 1;
+          for (
+            var y = 0;
+            y < buildDetails[prevBuildIndex]["loaderInfo"].length;
+            y++
+          ) {
+            const prevloaderDetails =
+              buildDetails[prevBuildIndex]["loaderInfo"][y];
+            if (
+              loaderInfo["Name"] == prevloaderDetails["Name"] &&
+              prevloaderDetails["Time"]
+            ) {
+              let previousBuildTime =
+                buildDetails[prevBuildIndex]["loaderInfo"][y]["Time"];
+              loaderInfo[`Comparison`] = `buildDiff--> ${Math.abs(
+                previousBuildTime - loaderObj.activeTime
+              )}|${previousBuildTime > loaderObj.activeTime ? "Good" : "Bad"}`;
+            }
+          }
+        }
+
+        objBuildData["loaderInfo"].push(loaderInfo);
+      });
+
+      buildDetails.push({ buildNo, loaderInfo: objBuildData["loaderInfo"] });
+      fs.writeFileSync(loaderFile, JSON.stringify(buildDetails));
+      /****************************************************************************************/
+
+      let outputTable = [];
+      let objCurrentBuild = {};
+
+      for (let i = 0; i < buildDetails.length; i++) {
+        outputTable = [];
+        console.log("--------------------------------------------");
+        console.log("Build No ", buildDetails[i]["buildNo"]);
+        console.log("--------------------------------------------");
+
+        if (buildDetails[i]["loaderInfo"]) {
+          buildDetails[i]["loaderInfo"].forEach(
+            (buildIndex, buildInfoIndex) => {
+              const buildInfo = buildDetails[i]["loaderInfo"][buildInfoIndex];
+              objCurrentBuild = {};
+              objCurrentBuild["Name"] = buildInfo["Name"] || "";
+              objCurrentBuild["Time"] = buildInfo["Time"] || "";
+              if (this.options.outputFormat === "humanVerbose")
+                objCurrentBuild["Count"] = buildInfo["Count"] || 0;
+              objCurrentBuild["Comparison"] = buildInfo["Comparison"] || "";
+              outputTable.push(objCurrentBuild);
+            }
+          );
+        }
+        console.table(outputTable);
+      }
+    }
+  }
+
   getOutput() {
     const outputObj = {};
     if (this.timeEventData.misc)
@@ -151,7 +244,8 @@ module.exports = class SpeedMeasurePlugin {
         const outputFunc = this.options.outputTarget || console.log;
         outputFunc(output);
       }
-
+      // Build Comparison functionality.
+      if (this.options.compareLoadersBuild) this.getLoadersBuildComparison();
       this.timeEventData = {};
     });