Modify /compiler-info to show both active and inactive compilers (#16)

etsy · Mar 29, 2022 · de05037 · de05037
1 parent 4764cf3
commit de05037
Show file tree

Hide file tree

Showing 4 changed files with 85 additions and 3 deletions.
diff --git a/lib/CompilerManager.js b/lib/CompilerManager.js
@@ -147,7 +147,7 @@ class CompilerManager {
      */
     getAllCompilerInfo() {
         const result = { compilers: {}, leastUsedCompiler: null };
-        Object.entries(this.activeCompilers).forEach(([name, compiler]) => {
+        Object.keys(this.activeCompilers).forEach((name) => {
             result.compilers[name] = this.getInfoForCompiler(name);
         });
         result.leastUsedCompiler = this.getLeastUsedCompiler();

diff --git a/lib/constants.js b/lib/constants.js
@@ -6,6 +6,7 @@ const FIRST_BUILD = "first-build";
 const BUILDING = "building";
 const ERROR = "error";
 const DONE = "done";
+const NOT_BUILT = "not-built";
 
 module.exports = {
     PLUGIN_NAME,
@@ -14,4 +15,5 @@ module.exports = {
     BUILDING,
     ERROR,
     DONE,
+    NOT_BUILT,
 };
diff --git a/lib/middleware.js b/lib/middleware.js
@@ -29,6 +29,7 @@ const {
     FIRST_BUILD,
     ERROR,
     DONE,
+    NOT_BUILT,
 } = require("./constants");
 
 // we're leaving manager detached from Kevin to keep it and its methods private
@@ -357,7 +358,17 @@ class Kevin {
                 // this endpoint shows general details about each compiler,
                 // particularly metrics around its use and whether it may
                 // be eligible for eviction
-                res.json(manager.getAllCompilerInfo());
+                // 2022 note: adding config names so this endpoint
+                // also shows the inactive compilers
+                const { compilers, leastUsedCompiler } = manager.getAllCompilerInfo();
+                this.configs.forEach(({ name }) => {
+                    if (Object.prototype.hasOwnProperty.call(compilers, name)) {
+                        return;
+                    }
+                    compilers[name] = { status: NOT_BUILT };
+                });
+
+                res.json({ compilers, leastUsedCompiler });
                 return;
             }
 

diff --git a/test/lib/CompilerManager.test.js b/test/lib/CompilerManager.test.js
@@ -94,7 +94,7 @@ describe("getStatus", () => {
 });
 
 describe("getAllBuildStatuses", () => {
-    it("should show the build states of all compilers", () => {
+    it("should show the build states of active compilers", () => {
         const manager = new CompilerManager();
         manager.manageCompiler("nick", getMockCompiler(), {});
         manager.manageCompiler("elback", getMockCompiler(), {}, BUILDING);
@@ -118,3 +118,72 @@ describe("getAllBuildStatuses", () => {
         });
     });
 });
+
+describe("getAllCompilerInfo", () => {
+    it("should return an object with active compilers", () => {
+        const manager = new CompilerManager();
+        // Active compilers
+        manager.manageCompiler("iam", getMockCompiler(), {});
+        manager.manageCompiler("an", getMockCompiler(), {}, BUILDING);
+        manager.manageCompiler("active", getMockCompiler(), {}, DONE);
+        manager.manageCompiler("region", getMockCompiler(), {}, ERROR);
+
+        expect(manager.getAllCompilerInfo()).toEqual(
+            expect.objectContaining({
+                compilers: {
+                    iam: expect.objectContaining({
+                        status: FIRST_BUILD,
+                    }),
+                    an: expect.objectContaining({
+                        status: BUILDING,
+                    }),
+                    active: expect.objectContaining({
+                        status: DONE,
+                    }),
+                    region: expect.objectContaining({
+                        status: ERROR,
+                    }),
+                },
+            })
+        );
+    });
+
+    it("should return more information about the active compilers", () => {
+        const manager = new CompilerManager();
+
+        manager.manageCompiler("iam", getMockCompiler(), {});
+        manager.manageCompiler("an", getMockCompiler(), {}, BUILDING);
+        manager.manageCompiler("active", getMockCompiler(), {}, DONE);
+        manager.manageCompiler("region", getMockCompiler(), {}, ERROR);
+
+        const moreInfo = {
+            errors: expect.any(Array),
+            frequency: expect.any(Number),
+            frecency: expect.any(Number),
+            frequencyChecks: expect.any(Array),
+            pinned: expect.any(Boolean),
+        };
+
+        expect(manager.getAllCompilerInfo()).toEqual({
+            compilers: expect.objectContaining({
+                iam: {
+                    status: FIRST_BUILD,
+                    ...moreInfo,
+                },
+                an: {
+                    status: BUILDING,
+                    ...moreInfo,
+                },
+                active: {
+                    status: DONE,
+                    ...moreInfo,
+                },
+                region: {
+                    status: ERROR,
+                    ...moreInfo,
+                },
+            }),
+            leastUsedCompiler: expect.any(String),
+        });
+    });
+});