add ok level to logger

1024pix · Sep 12, 2023 · b78e110 · b78e110
1 parent f3c8485
commit b78e110
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/common/services/logger.js b/common/services/logger.js
@@ -21,9 +21,13 @@ const info = ({ event, message, job, stack }, injectedLogger = console) => {
 const warn = ({ event, message, job, stack }, injectedLogger = console) => {
   injectedLogger.warn(serialize({ event, message, job, stack, level: 'warn' }));
 };
+const ok = ({ event, message, job, stack }, injectedLogger = console) => {
+  injectedLogger.ok(serialize({ event, message, job, stack, level: 'ok' }));
+};
 
 module.exports = {
   error,
   info,
   warn,
+  ok,
 };
diff --git a/test/unit/common/services/logger_test.js b/test/unit/common/services/logger_test.js
@@ -97,4 +97,36 @@ describe('logger', function () {
       });
     });
   });
+  describe('ok', function () {
+    describe('when an message is passed', function () {
+      it('should call injectedLogger ok', function () {
+        // given
+        const injectedLogger = { ok: sinon.stub() };
+
+        // when
+        logger.ok({ event: 'toto', message: 'titi', stack: 'stack' }, injectedLogger);
+
+        // then
+        expect(injectedLogger.ok.calledOnce).to.be.true;
+        expect(injectedLogger.ok.firstCall.args[0]).to.equal(
+          '{"event":"toto","message":"titi","stack":"stack","level":"ok"}',
+        );
+      });
+    });
+    describe('when an object is passed', function () {
+      it('should call injectedLogger warn with object in message', function () {
+        // given
+        const injectedLogger = { ok: sinon.stub() };
+
+        // when
+        logger.ok({ event: 'toto', message: { foo: 'bar' }, stack: 'stack' }, injectedLogger);
+
+        // then
+        expect(injectedLogger.ok.calledOnce).to.be.true;
+        expect(injectedLogger.ok.firstCall.args[0]).to.equal(
+          '{"event":"toto","message":"{\\"foo\\":\\"bar\\"}","stack":"stack","level":"ok"}',
+        );
+      });
+    });
+  });
 });