Include type of bundle in logging #34

Author: Silic0nS0ldier

src/bundle-orchastrator.ts

@@ -5,7 +5,7 @@ import { Config } from "./config/config.js";
 import extend from "just-extend";
 import { resolve as resolvePath } from "path";
 import PluginError from "plugin-error";
-import { BundleStreamFactory, Bundle } from "./bundle.js";
+import { BundleStreamFactory, Bundle, BundleType } from "./bundle.js";
 
 const PluginName = "@userfrosting/gulp-bundle-assets";
 
@@ -55,6 +55,7 @@ export interface Bundlers {
  */
 function bundleFactory(
     name: string,
+    type: BundleType,
     rawPaths: string[],
     cwd: string,
     joiner: BundleStreamFactory,
@@ -67,7 +68,7 @@ function bundleFactory(
         paths.push(path);
         logger.trace(`Resolved path: "${path}"`);
     }
-    return new Bundle(name, paths, joiner, logger);
+    return new Bundle(name, type, paths, joiner, logger);
 }
 
 /**
@@ -146,14 +147,14 @@ export class BundleOrchastrator extends Transform {
                 // JS
                 if (bundle.scripts) {
                     this.logger.trace("Starting processing of script paths");
-                    this.scriptBundles.add(bundleFactory(name, bundle.scripts, cwd, joiner.Scripts, this.logger));
+                    this.scriptBundles.add(bundleFactory(name, "script", bundle.scripts, cwd, joiner.Scripts, this.logger));
                     this.logger.trace("Completed processing of script paths");
                 }
 
                 // CSS
                 if (bundle.styles) {
                     this.logger.trace("Starting processing of style paths");
-                    this.styleBundles.add(bundleFactory(name, bundle.styles, cwd, joiner.Styles, this.logger));
+                    this.styleBundles.add(bundleFactory(name, "style", bundle.styles, cwd, joiner.Styles, this.logger));
                     this.logger.trace("Completed processing of style paths");
                 }
             }

src/bundle.test.ts

@@ -17,6 +17,7 @@ function bundleFactoryEcho(src: Readable): Stream {
 test("Ignores unused files", async t => {
     const bundle = new Bundle(
         "test",
+        "script",
         [
             resolvePath("./test-used-1.js"),
             resolvePath("./test-used-2.js"),
@@ -44,6 +45,7 @@ test("Ignores unused files", async t => {
 test("Returns a stream once feed sends in the last required file", async t => {
     const bundle = new Bundle(
         "test",
+        "script",
         [
             resolvePath("./test-1.js"),
             resolvePath("./test-2.js"),
@@ -69,6 +71,7 @@ test("Returns a stream once feed sends in the last required file", async t => {
 test("Multiple non-Vinyl chunks returned by bundle stream", async t => {
     const bundle = new Bundle(
         "test",
+        "script",
         [ resolvePath("./test-1.js") ],
         function (): Stream {
             return intoStream.object([ {}, {} ]);
@@ -86,6 +89,7 @@ test("Multiple non-Vinyl chunks returned by bundle stream", async t => {
 test("Single non-Vinyl chunks returned by bundle stream", async t => {
     const bundle = new Bundle(
         "test",
+        "script",
         [ resolvePath("./test-1.js") ],
         function (): Stream {
             return intoStream.object({});

src/bundle.ts

@@ -16,11 +16,14 @@ export interface BundleStreamFactory {
     (src: Readable, name: string): Stream;
 }
 
+export type BundleType = "style" | "script";
+
 /**
  * Represents a bundle to be bundled, assists in process.
  */
 export class Bundle {
     public readonly name: string;
+    private readonly type: BundleType;
     private readonly initialPaths: readonly string[];
     private remainingPaths: string[];
     private readonly files: Map<string, Vinyl> = new Map();
@@ -34,11 +37,13 @@ export class Bundle {
      */
     constructor(
         name: string,
+        type: BundleType,
         paths: string[],
         streamFactory: BundleStreamFactory,
         logger: Logger
     ) {
         this.name = name;
+        this.type = type;
         this.initialPaths = paths.slice(0);
         this.remainingPaths = paths.slice(0);
         this.streamFactory = streamFactory;
@@ -47,6 +52,7 @@ export class Bundle {
             "Bundle tracker created",
             {
                 bundleName: this.name,
+                type: this.type,
                 files: this.initialPaths,
             }
         );
@@ -69,6 +75,7 @@ export class Bundle {
                 "Retaining file for later bundling",
                 {
                     bundleName: this.name,
+                    type: this.type,
                     path: file.path,
                 }
             );
@@ -78,6 +85,7 @@ export class Bundle {
                 "Ignoring unused file",
                 {
                     bundleName: this.name,
+                    type: this.type,
                     path: file.path,
                 }
             );
@@ -97,10 +105,11 @@ export class Bundle {
                 "Creating bundle stream",
                 {
                     bundleName: this.name,
+                    type: this.type,
                     inFiles: this.initialPaths,
                 }
             );
-            this.logger.info("Started bundling", { bundleName: this.name });
+            this.logger.info("Started bundling", { bundleName: this.name, type: this.type });
             const chunks = await getStream.array(
                 this.streamFactory(
                     intoStream.object(orderedFiles),
@@ -115,6 +124,7 @@ export class Bundle {
                         "Chunk returned by bundle stream is not a Vinyl instance",
                         {
                             bundleName: this.name,
+                            type: this.type,
                             chunk,
                         }
                     );
@@ -123,8 +133,8 @@ export class Bundle {
             }
 
             // Perform bundling, and collect results
-            this.logger.trace("Bundle stream completed", { bundleName: this.name });
-            this.logger.info("Finished bundling", { bundleName: this.name });
+            this.logger.trace("Bundle stream completed", { bundleName: this.name, type: this.type });
+            this.logger.info("Finished bundling", { bundleName: this.name, type: this.type });
 
             return chunks as Vinyl[];
         }