missed passing some logger functions appropriate object signature

jbolda · Jul 13, 2024 · 3c3522f · 3c3522f
1 parent db348e8
commit 3c3522f
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 126 deletions.
diff --git a/.changes/logger-poorly-formatted-objects.md b/.changes/logger-poorly-formatted-objects.md
@@ -0,0 +1,6 @@
+---
+"covector": patch:bug
+"action": patch:bug
+---
+
+Missed some logger function which were improperly passed an non-message object. If rendering an object, it requires `msg` and `renderAsYAML`.
diff --git a/packages/covector/src/arbitrary.ts b/packages/covector/src/arbitrary.ts
@@ -79,8 +79,10 @@ export function* arbitrary({
   });
 
   if (dryRun) {
-    logger.info("==== commands ready to run ===");
-    logger.info(commands);
+    logger.info({
+      msg: "==== commands ready to run ===",
+      renderAsYAML: commands,
+    });
   }
 
   if (commands.length === 0) {
@@ -143,8 +145,7 @@ export function* arbitrary({
   });
 
   if (dryRun) {
-    logger.info("==== result ===");
-    logger.info(pkgCommandsRan);
+    logger.info({ msg: "==== result ===", renderAsYAML: pkgCommandsRan });
   }
 
   return <CovectorPublish>{ commandsRan: pkgCommandsRan, pipeTemplate };

diff --git a/packages/covector/src/publish.ts b/packages/covector/src/publish.ts
@@ -79,8 +79,10 @@ export function* publish({
   });
 
   if (dryRun) {
-    logger.info("==== commands ready to run ===");
-    logger.info(commands);
+    logger.info({
+      msg: "==== commands ready to run ===",
+      renderAsYAML: commands,
+    });
   }
 
   if (commands.length === 0) {
@@ -143,8 +145,7 @@ export function* publish({
   });
 
   if (dryRun) {
-    logger.info("==== result ===");
-    logger.info(pkgCommandsRan);
+    logger.info({ msg: "==== result ===", renderAsYAML: pkgCommandsRan });
   }
 
   return <CovectorPublish>{ commandsRan: pkgCommandsRan, pipeTemplate };

diff --git a/packages/covector/src/status.ts b/packages/covector/src/status.ts
@@ -117,10 +117,10 @@ export function* status({
   } else if (!!pre && assembledChanges?.changes?.length === 0) {
     if (logs) {
       logger.info("There are no changes.");
-      logger.info(
-        "We have previously released the changes in these files:",
-        changesPaths
-      );
+      logger.info({
+        msg: "We have previously released the changes in these files:",
+        renderAsYAML: changesPaths,
+      });
     }
     return { pkgReadyToPublish: [], response: "No changes." };
   } else {

diff --git a/packages/covector/src/version.ts b/packages/covector/src/version.ts
@@ -88,8 +88,10 @@ export function* version({
     cwd,
   });
   if (dryRun) {
-    logger.info("==== commands ready to run ===");
-    logger.info(commands);
+    logger.info({
+      msg: "==== commands ready to run ===",
+      renderAsYAML: commands,
+    });
   }
 
   let pkgCommandsRan: CommandsRan = Object.keys(config.packages).reduce(
@@ -186,8 +188,7 @@ export function* version({
   }
 
   if (dryRun) {
-    logger.info("==== result ===");
-    logger.info(pkgCommandsRan);
+    logger.info({ msg: "==== result ===", renderAsYAML: pkgCommandsRan });
   }
 
   return <CovectorVersion>{ commandsRan: pkgCommandsRan, pipeTemplate };

diff --git a/packages/covector/test/integration/complex.test.ts b/packages/covector/test/integration/complex.test.ts
@@ -304,21 +304,13 @@ describe("integration test for complex commands", () => {
             command: "version",
             msg: "==== commands ready to run ===",
             level: 30,
-          },
-          {
-            command: "version",
-            // command data piped
-            level: 30,
+            renderAsYAML: {},
           },
           {
             command: "version",
             msg: "==== result ===",
             level: 30,
-          },
-          {
-            command: "version",
-            // command data piped
-            level: 30,
+            renderAsYAML: {},
           },
           {
             msg: "completed",
@@ -361,21 +353,19 @@ describe("integration test for complex commands", () => {
             command: "publish",
             msg: "==== data piped into commands ===",
             level: 30,
+            renderAsYAML: {},
           },
           {
             command: "publish",
             msg: "==== data piped into commands ===",
             level: 30,
+            renderAsYAML: {},
           },
           {
             command: "publish",
             msg: "==== commands ready to run ===",
             level: 30,
-          },
-          {
-            command: "publish",
-            // TODO this has extra, check render YAML
-            level: 30,
+            renderAsYAML: {},
           },
           {
             command: "publish",
@@ -391,12 +381,7 @@ describe("integration test for complex commands", () => {
             command: "publish",
             msg: "==== result ===",
             level: 30,
-          },
-          {
-            command: "publish",
-            // TODO check YAML render
-            // msg: "boop",
-            level: 30,
+            renderAsYAML: {},
           },
           {
             msg: "completed",
@@ -426,25 +411,20 @@ describe("integration test for complex commands", () => {
           {
             command: "arbitrary",
             msg: "==== data piped into commands ===",
-            // TODO check YAML render
             level: 30,
+            renderAsYAML: {},
           },
           {
             command: "arbitrary",
             msg: "==== data piped into commands ===",
-            // TODO check YAML render
             level: 30,
+            renderAsYAML: {},
           },
           {
             command: "arbitrary",
             msg: "==== commands ready to run ===",
-            // TODO check YAML render
-            level: 30,
-          },
-          {
-            command: "arbitrary",
-            // TODO check command output
             level: 30,
+            renderAsYAML: {},
           },
           {
             command: "arbitrary",
@@ -490,11 +470,7 @@ describe("integration test for complex commands", () => {
             command: "arbitrary",
             msg: "==== result ===",
             level: 30,
-          },
-          {
-            command: "arbitrary",
-            // TODO check result output
-            level: 30,
+            renderAsYAML: {},
           },
           {
             msg: "completed",
@@ -525,22 +501,19 @@ describe("integration test for complex commands", () => {
             command: "arbitrary",
             msg: "==== data piped into commands ===",
             level: 30,
+            renderAsYAML: {},
           },
           {
             command: "arbitrary",
             msg: "==== data piped into commands ===",
             level: 30,
+            renderAsYAML: {},
           },
           {
             command: "arbitrary",
             msg: "==== commands ready to run ===",
             level: 30,
-          },
-          {
-            command: "arbitrary",
-            // msg: "boop",
-            // data pipe
-            level: 30,
+            renderAsYAML: {},
           },
           {
             command: "arbitrary",
@@ -556,12 +529,7 @@ describe("integration test for complex commands", () => {
             command: "arbitrary",
             msg: "==== result ===",
             level: 30,
-          },
-          {
-            command: "arbitrary",
-            // msg: "boop",
-            // result
-            level: 30,
+            renderAsYAML: {},
           },
           {
             msg: "completed",