@squiz/component-logger-lib 1.32.1-alpha.22 → 1.32.1-alpha.26

package/.npm/_logs/{2023-04-28T06_34_24_877Z-debug-0.log → 2023-05-03T01_21_21_355Z-debug-0.log}

@@ -1,37 +1,37 @@
 0 verbose cli /usr/local/bin/node /usr/local/bin/npm
 1 info using npm@9.5.0
 2 info using node@v18.15.0
-3 timing npm:load:whichnode Completed in 2ms
-4 timing config:load:defaults Completed in 2ms
-5 timing config:load:file:/usr/local/lib/node_modules/npm/npmrc Completed in 1ms
-6 timing config:load:builtin Completed in 1ms
+3 timing npm:load:whichnode Completed in 1ms
+4 timing config:load:defaults Completed in 3ms
+5 timing config:load:file:/usr/local/lib/node_modules/npm/npmrc Completed in 0ms
+6 timing config:load:builtin Completed in 0ms
 7 timing config:load:cli Completed in 2ms
-8 timing config:load:env Completed in 1ms
+8 timing config:load:env Completed in 2ms
 9 info found workspace root at /builds/developer-experience/cmp
 10 timing config:load:file:/builds/developer-experience/cmp/.npmrc Completed in 0ms
 11 timing config:load:project Completed in 20ms
-12 timing config:load:file:/root/.npmrc Completed in 0ms
-13 timing config:load:user Completed in 2ms
-14 timing config:load:file:/usr/local/etc/npmrc Completed in 0ms
-15 timing config:load:global Completed in 0ms
+12 timing config:load:file:/root/.npmrc Completed in 1ms
+13 timing config:load:user Completed in 1ms
+14 timing config:load:file:/usr/local/etc/npmrc Completed in 1ms
+15 timing config:load:global Completed in 1ms
 16 timing config:load:setEnvs Completed in 1ms
-17 timing config:load Completed in 29ms
-18 timing npm:load:configload Completed in 29ms
-19 timing npm:load:mkdirpcache Completed in 1ms
-20 timing npm:load:mkdirplogs Completed in 0ms
+17 timing config:load Completed in 30ms
+18 timing npm:load:configload Completed in 30ms
+19 timing npm:load:mkdirpcache Completed in 0ms
+20 timing npm:load:mkdirplogs Completed in 1ms
 21 verbose title npm run compile
 22 verbose argv "run" "compile" "--"
 23 timing npm:load:setTitle Completed in 1ms
-24 timing config:load:flatten Completed in 4ms
+24 timing config:load:flatten Completed in 5ms
 25 timing npm:load:display Completed in 6ms
-26 verbose logfile logs-max:10 dir:/builds/developer-experience/cmp/packages/component-logger-lib/.npm/_logs/2023-04-28T06_34_24_877Z-
-27 verbose logfile /builds/developer-experience/cmp/packages/component-logger-lib/.npm/_logs/2023-04-28T06_34_24_877Z-debug-0.log
+26 verbose logfile logs-max:10 dir:/builds/developer-experience/cmp/packages/component-logger-lib/.npm/_logs/2023-05-03T01_21_21_355Z-
+27 verbose logfile /builds/developer-experience/cmp/packages/component-logger-lib/.npm/_logs/2023-05-03T01_21_21_355Z-debug-0.log
 28 timing npm:load:logFile Completed in 4ms
 29 timing npm:load:timers Completed in 0ms
 30 timing npm:load:configScope Completed in 0ms
 31 timing npm:load Completed in 43ms
 32 silly logfile done cleaning log files
-33 timing command:run Completed in 2253ms
+33 timing command:run Completed in 4267ms
 34 verbose exit 0
-35 timing npm Completed in 2308ms
+35 timing npm Completed in 4327ms
 36 info ok

package/jest.integration.config.ts

@@ -0,0 +1,15 @@
+import type { Config } from 'jest';
+import { config as dotEnvConfig } from 'dotenv';
+
+dotEnvConfig();
+
+// Sync object
+const config: Config = {
+  preset: 'ts-jest',
+  testTimeout: 60_000,
+  testEnvironment: 'node',
+  testRegex: '.*\\.integration\\.spec\\.ts$',
+  maxWorkers: 1,
+};
+
+export default config;

package/lib/component-log-message.d.ts

@@ -5,5 +5,5 @@ export interface ComponentLogMessage {
     timestamp: string;
     message: string;
     tags?: string;
-    traceId?: string;
+    traceid?: string;
 }

package/lib/component-logger-config.d.ts

@@ -1,7 +1,7 @@
 export interface ComponentLoggerConfig {
     enabled: boolean;
-    logUrl?: string;
-    key?: string;
-    tenantId?: string;
+    logUrl: string;
+    key: string;
+    tenantId: string;
     tags?: string;
 }

package/lib/component-logger.d.ts

@@ -8,6 +8,6 @@ export declare class ComponentLogger {
     info(message: string | any, traceId?: string): Promise<void>;
     warn(message: string | any, traceId?: string): Promise<void>;
     error(message: string | any, traceId?: string): Promise<void>;
-    append(level: ComponentLogLevel, message: string | any, traceId?: string): Promise<void>;
+    protected append(level: ComponentLogLevel, message: string | any, traceId?: string): Promise<void>;
     flush(): Promise<void>;
 }

package/lib/component-logger.integration.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/component-logger.integration.spec.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const dx_common_lib_1 = require("@squiz/dx-common-lib");
+const _1 = require(".");
+describe('ComponentLogger', () => {
+    it('should sending log messages', async () => {
+        const logger = await (0, _1.getComponentLogger)({
+            enabled: true,
+            tenantId: 'integration-test',
+            accessCredentials: (0, dx_common_lib_1.parseEnvVarForVar)('LOGGING_SERVICE_API_CREDENTIALS'),
+            tags: 'env:dev integration-test',
+        });
+        await logger.info('The quick brown fox', '123');
+        await logger.flush();
+    });
+});
+//# sourceMappingURL=component-logger.integration.spec.js.map

package/lib/component-logger.integration.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-logger.integration.spec.js","sourceRoot":"","sources":["../src/component-logger.integration.spec.ts"],"names":[],"mappings":";;AAAA,wDAAyD;AACzD,wBAAuC;AAEvC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,MAAM,GAAG,MAAM,IAAA,qBAAkB,EAAC;YACtC,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,kBAAkB;YAC5B,iBAAiB,EAAE,IAAA,iCAAiB,EAAC,iCAAiC,CAAC;YACvE,IAAI,EAAE,0BAA0B;SACjC,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/component-logger.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComponentLogger = void 0;
 const superagent_1 = __importDefault(require("superagent"));
+const MESSAGE_BATCH_SIZE = 100;
 class ComponentLogger {
     constructor(config) {
         this.config = config;
@@ -41,18 +42,18 @@ class ComponentLogger {
             timestamp: new Date().toISOString(),
             message: payload,
             tags: this.config.tags,
-            traceId: traceId,
+            traceid: traceId,
         });
-        if (this.batch.length == 100) {
+        if (this.batch.length == MESSAGE_BATCH_SIZE) {
             await this.flush();
-            this.batch = [];
         }
     }
     async flush() {
         if (this.config.enabled && this.batch.length > 0) {
             try {
-                const url = `${this.config.logUrl}/${this.config.tenantId}`;
-                await superagent_1.default.post(url).set('X-API-Key', this.config.key).send(this.batch);
+                const url = `${this.config.logUrl.replace(/\/+$/, '')}/${this.config.tenantId}`;
+                await superagent_1.default.post(url).set('x-api-key', this.config.key).send(this.batch);
+                this.batch = [];
             }
             catch (err) {
                 console.error(err);

package/lib/component-logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"component-logger.js","sourceRoot":"","sources":["../src/component-logger.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAoC;AAIpC,MAAa,eAAe;IAG1B,YAAqB,MAA6B;QAA7B,WAAM,GAAN,MAAM,CAAuB;QAF1C,UAAK,GAA+B,EAAE,CAAC;QAG7C,IAAI,MAAM,CAAC,OAAO,EAAE;YAClB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;gBAClB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;aAC9C;YACD,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;gBACf,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;aAC3C;YACD,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;gBACpB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;aAChD;SACF;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAAqB,EAAE,OAAgB;QACjD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAqB,EAAE,OAAgB;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAqB,EAAE,OAAgB;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAAqB,EAAE,OAAgB;QACjD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAwB,EAAE,OAAqB,EAAE,OAAgB;QAC5E,MAAM,OAAO,GAAG,OAAO,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE/E,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YACd,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,gBAAgB;YACzB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;YACtB,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,GAAG,EAAE;YAC5B,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YACnB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;SACjB;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YAChD,IAAI;gBACF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAC5D,MAAM,oBAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,GAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAChF;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACnB,MAAM,GAAG,CAAC;aACX;SACF;IACH,CAAC;CACF;AA9DD,0CA8DC"}
+{"version":3,"file":"component-logger.js","sourceRoot":"","sources":["../src/component-logger.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAoC;AAIpC,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAE/B,MAAa,eAAe;IAG1B,YAAqB,MAA6B;QAA7B,WAAM,GAAN,MAAM,CAAuB;QAF1C,UAAK,GAA+B,EAAE,CAAC;QAG7C,IAAI,MAAM,CAAC,OAAO,EAAE;YAClB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;gBAClB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;aAC9C;YACD,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;gBACf,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;aAC3C;YACD,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;gBACpB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;aAChD;SACF;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAAqB,EAAE,OAAgB;QACjD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAqB,EAAE,OAAgB;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAqB,EAAE,OAAgB;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAAqB,EAAE,OAAgB;QACjD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAES,KAAK,CAAC,MAAM,CAAC,KAAwB,EAAE,OAAqB,EAAE,OAAgB;QACtF,MAAM,OAAO,GAAG,OAAO,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE/E,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YACd,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,gBAAgB;YACzB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;YACtB,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,kBAAkB,EAAE;YAC3C,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;SACpB;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YAChD,IAAI;gBACF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAChF,MAAM,oBAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC9E,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;aACjB;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACnB,MAAM,GAAG,CAAC;aACX;SACF;IACH,CAAC;CACF;AA9DD,0CA8DC"}

package/lib/component-logger.spec.js

@@ -1,42 +1,223 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const component_logger_1 = require("./component-logger");
-const process = __importStar(require("process"));
+const superagent_1 = __importDefault(require("superagent"));
+const postSetMock = {
+    send: jest.fn(),
+};
+const postMock = {
+    set: () => {
+        return postSetMock;
+    },
+};
+jest.mock('superagent', () => ({
+    post: () => {
+        return postMock;
+    },
+}));
+const loggerConfig = {
+    enabled: true,
+    logUrl: 'some-log-url',
+    key: 'some-key',
+    tenantId: 'some-tenant-id',
+    tags: 'some-tags',
+};
 describe('ComponentLogger', () => {
-    it('should allow sending log messages', async () => {
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+    beforeAll(() => {
+        jest.useFakeTimers();
+        jest.setSystemTime(new Date('2023-05-28T00:00:00.000Z'));
+    });
+    afterAll(() => {
+        jest.useRealTimers();
+    });
+    it('should throw error if config.logUrl is not set', async () => {
+        const loggerConfig = {
+            enabled: true,
+            logUrl: '',
+            key: 'some-key',
+            tenantId: 'some-tenant-id',
+            tags: 'some-tags',
+        };
+        expect(() => new component_logger_1.ComponentLogger(loggerConfig)).toThrow('config.logUrl is required');
+    });
+    it('should throw error if config.key is not set', async () => {
         const config = {
-            enabled: JSON.parse((process.env.COMPONENT_LOGGER_ENABLED || 'false').toLocaleLowerCase()),
-            logUrl: process.env.COMPONENT_LOGGER_URL,
-            key: process.env.COMPONENT_LOGGER_KEY,
-            tenantId: process.env.COMPONENT_LOGGER_TENANT_ID,
-            tags: process.env.COMPONENT_LOGGER_TAGS,
+            enabled: true,
+            logUrl: 'some-log-url',
+            key: '',
+            tenantId: 'some-tenant-id',
+            tags: 'some-tags',
+        };
+        expect(() => new component_logger_1.ComponentLogger(config)).toThrow('config.key is required');
+    });
+    it('should throw error if config.tenantId is not set', async () => {
+        const loggerConfig = {
+            enabled: true,
+            logUrl: 'some-log-url',
+            key: 'some-key',
+            tenantId: '',
+            tags: 'some-tags',
+        };
+        expect(() => new component_logger_1.ComponentLogger(loggerConfig)).toThrow('config.tenantId is required');
+    });
+    it('should set correct log service URL and API key', async () => {
+        const postSpy = jest.spyOn(superagent_1.default, 'post');
+        const postSetSpy = jest.spyOn(postMock, 'set');
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
+        await logger.info('The quick brown fox', '123');
+        await logger.flush();
+        expect(postSpy).toBeCalledWith('some-log-url/some-tenant-id');
+        expect(postSetSpy).toBeCalledWith('x-api-key', 'some-key');
+    });
+    it('should strip off extra "/" on the logUrl', async () => {
+        const loggerConfig = {
+            enabled: true,
+            logUrl: 'some-log-url/',
+            key: 'some-key',
+            tenantId: 'some-tenant-id',
+            tags: 'some-tags',
+        };
+        const postSpy = jest.spyOn(superagent_1.default, 'post');
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
+        await logger.info('The quick brown fox', '123');
+        await logger.flush();
+        expect(postSpy).toBeCalledWith('some-log-url/some-tenant-id');
+    });
+    it('should not send message if disabled', async () => {
+        const loggerConfig = {
+            enabled: false,
+            logUrl: 'some-log-url',
+            key: 'some-key',
+            tenantId: 'some-tenant-id',
+            tags: 'some-tags',
         };
-        const logger = new component_logger_1.ComponentLogger(config);
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
+        await logger.warn('this message wont be sent', '123');
+        await logger.flush();
+        expect(postSetMock.send).toBeCalledTimes(0);
+    });
+    it('should send the log messages in batch', async () => {
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
+        await logger.info('The quick brown fox 1', '123');
+        await logger.info('The quick brown fox 2', '124');
+        await logger.flush();
+        const expectedMessages = [
+            {
+                level: 'INFO',
+                service: 'render-runtime',
+                timestamp: '2023-05-28T00:00:00.000Z',
+                message: 'The quick brown fox 1',
+                tags: 'some-tags',
+                traceid: '123',
+            },
+            {
+                level: 'INFO',
+                service: 'render-runtime',
+                timestamp: '2023-05-28T00:00:00.000Z',
+                message: 'The quick brown fox 2',
+                tags: 'some-tags',
+                traceid: '124',
+            },
+        ];
+        expect(postSetMock.send).toBeCalledWith(expectedMessages);
+    });
+    it('should json encode the message if not string', async () => {
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
+        await logger.warn(['this', 'is', 'not string'], '123');
+        await logger.flush();
+        const expectedMessages = [
+            {
+                level: 'WARN',
+                service: 'render-runtime',
+                timestamp: '2023-05-28T00:00:00.000Z',
+                message: '["this","is","not string"]',
+                tags: 'some-tags',
+                traceid: '123',
+            },
+        ];
+        expect(postSetMock.send).toBeCalledWith(expectedMessages);
+    });
+    it('should not send message if there is nothing the message queue', async () => {
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
+        await logger.flush();
+        expect(postSetMock.send).toBeCalledTimes(0);
+    });
+    it('should clear the message queue after sending the message', async () => {
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
         await logger.info('The quick brown fox', '123');
+        // flushing the log messages again should trigger send only once
+        await logger.flush();
+        await logger.flush();
+        await logger.flush();
+        await logger.flush();
+        expect(postSetMock.send).toBeCalledTimes(1);
+    });
+    it('should not send message till queue reaching the max message count', async () => {
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
+        await logger.info('The quick brown fox', '123');
+        expect(postSetMock.send).toBeCalledTimes(0);
+    });
+    it('should automatically flush the queue after reaching the max message count', async () => {
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
+        for (let count = 0; count <= 100; count++) {
+            await logger.info('The quick brown fox', `${count}`);
+        }
+        // this should send all 100 messages above in a single go
+        expect(postSetMock.send).toBeCalledTimes(1);
+    });
+    it('should send debug message', async () => {
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
+        await logger.debug('some debug message', '123');
+        await logger.flush();
+        const expectedMessages = [
+            {
+                level: 'DEBUG',
+                service: 'render-runtime',
+                timestamp: '2023-05-28T00:00:00.000Z',
+                message: 'some debug message',
+                tags: 'some-tags',
+                traceid: '123',
+            },
+        ];
+        expect(postSetMock.send).toBeCalledWith(expectedMessages);
+    });
+    it('should send warn message', async () => {
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
+        await logger.warn('some warn message', '123');
+        await logger.flush();
+        const expectedMessages = [
+            {
+                level: 'WARN',
+                service: 'render-runtime',
+                timestamp: '2023-05-28T00:00:00.000Z',
+                message: 'some warn message',
+                tags: 'some-tags',
+                traceid: '123',
+            },
+        ];
+        expect(postSetMock.send).toBeCalledWith(expectedMessages);
+    });
+    it('should send error message', async () => {
+        const logger = new component_logger_1.ComponentLogger(loggerConfig);
+        await logger.error('some error message', '123');
         await logger.flush();
+        const expectedMessages = [
+            {
+                level: 'ERROR',
+                service: 'render-runtime',
+                timestamp: '2023-05-28T00:00:00.000Z',
+                message: 'some error message',
+                tags: 'some-tags',
+                traceid: '123',
+            },
+        ];
+        expect(postSetMock.send).toBeCalledWith(expectedMessages);
     });
 });
 //# sourceMappingURL=component-logger.spec.js.map

package/lib/component-logger.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"component-logger.spec.js","sourceRoot":"","sources":["../src/component-logger.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yDAAqD;AAErD,iDAAmC;AAEnC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,MAAM,GAA0B;YACpC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,IAAI,OAAO,CAAC,CAAC,iBAAiB,EAAE,CAAC;YAC1F,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,oBAAoB;YACxC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,oBAAoB;YACrC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,0BAA0B;YAChD,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB;SACxC,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,MAAM,CAAC,CAAC;QAE3C,MAAM,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"component-logger.spec.js","sourceRoot":"","sources":["../src/component-logger.spec.ts"],"names":[],"mappings":";;;;;AAAA,yDAAqD;AAErD,4DAAoC;AAEpC,MAAM,WAAW,GAAG;IAClB,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;CAChB,CAAC;AACF,MAAM,QAAQ,GAAG;IACf,GAAG,EAAE,GAAG,EAAE;QACR,OAAO,WAAW,CAAC;IACrB,CAAC;CACF,CAAC;AACF,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,CAAC;IAC7B,IAAI,EAAE,GAAG,EAAE;QACT,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF,CAAC,CAAC,CAAC;AAEJ,MAAM,YAAY,GAA0B;IAC1C,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,cAAc;IACtB,GAAG,EAAE,UAAU;IACf,QAAQ,EAAE,gBAAgB;IAC1B,IAAI,EAAE,WAAW;CAClB,CAAC;AAEF,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,GAAG,EAAE;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,YAAY,GAA0B;YAC1C,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,EAAE;YACV,GAAG,EAAE,UAAU;YACf,QAAQ,EAAE,gBAAgB;YAC1B,IAAI,EAAE,WAAW;SAClB,CAAC;QACF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,MAAM,GAA0B;YACpC,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,cAAc;YACtB,GAAG,EAAE,EAAE;YACP,QAAQ,EAAE,gBAAgB;YAC1B,IAAI,EAAE,WAAW;SAClB,CAAC;QACF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,kCAAe,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,YAAY,GAA0B;YAC1C,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,cAAc;YACtB,GAAG,EAAE,UAAU;YACf,QAAQ,EAAE,EAAE;YACZ,IAAI,EAAE,WAAW;SAClB,CAAC;QACF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAU,EAAE,MAAM,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAE/C,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QACjD,MAAM,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QAErB,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,6BAA6B,CAAC,CAAC;QAC9D,MAAM,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,YAAY,GAA0B;YAC1C,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,eAAe;YACvB,GAAG,EAAE,UAAU;YACf,QAAQ,EAAE,gBAAgB;YAC1B,IAAI,EAAE,WAAW;SAClB,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAU,EAAE,MAAM,CAAC,CAAC;QAE/C,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QACjD,MAAM,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QAErB,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,6BAA6B,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,YAAY,GAA0B;YAC1C,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,cAAc;YACtB,GAAG,EAAE,UAAU;YACf,QAAQ,EAAE,gBAAgB;YAC1B,IAAI,EAAE,WAAW;SAClB,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;QACtD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,MAAM,CAAC,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;QAClD,MAAM,MAAM,CAAC,IAAI,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;QAClD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QAErB,MAAM,gBAAgB,GAAG;YACvB;gBACE,KAAK,EAAE,MAAM;gBACb,OAAO,EAAE,gBAAgB;gBACzB,SAAS,EAAE,0BAA0B;gBACrC,OAAO,EAAE,uBAAuB;gBAChC,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,KAAK;aACf;YACD;gBACE,KAAK,EAAE,MAAM;gBACb,OAAO,EAAE,gBAAgB;gBACzB,SAAS,EAAE,0BAA0B;gBACrC,OAAO,EAAE,uBAAuB;gBAChC,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,KAAK;aACf;SACF,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,EAAE,KAAK,CAAC,CAAC;QACvD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QAErB,MAAM,gBAAgB,GAAG;YACvB;gBACE,KAAK,EAAE,MAAM;gBACb,OAAO,EAAE,gBAAgB;gBACzB,SAAS,EAAE,0BAA0B;gBACrC,OAAO,EAAE,4BAA4B;gBACrC,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,KAAK;aACf;SACF,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;QAChD,gEAAgE;QAChE,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;QACjF,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;QACzF,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QAEjD,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,GAAG,EAAE,KAAK,EAAE,EAAE;YACzC,MAAM,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;SACtD;QACD,yDAAyD;QACzD,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,MAAM,CAAC,KAAK,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QAErB,MAAM,gBAAgB,GAAG;YACvB;gBACE,KAAK,EAAE,OAAO;gBACd,OAAO,EAAE,gBAAgB;gBACzB,SAAS,EAAE,0BAA0B;gBACrC,OAAO,EAAE,oBAAoB;gBAC7B,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,KAAK;aACf;SACF,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC9C,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QAErB,MAAM,gBAAgB,GAAG;YACvB;gBACE,KAAK,EAAE,MAAM;gBACb,OAAO,EAAE,gBAAgB;gBACzB,SAAS,EAAE,0BAA0B;gBACrC,OAAO,EAAE,mBAAmB;gBAC5B,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,KAAK;aACf;SACF,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,MAAM,GAAG,IAAI,kCAAe,CAAC,YAAY,CAAC,CAAC;QAEjD,MAAM,MAAM,CAAC,KAAK,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QAErB,MAAM,gBAAgB,GAAG;YACvB;gBACE,KAAK,EAAE,OAAO;gBACd,OAAO,EAAE,gBAAgB;gBACzB,SAAS,EAAE,0BAA0B;gBACrC,OAAO,EAAE,oBAAoB;gBAC7B,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,KAAK;aACf;SACF,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/getComponentLogger.d.ts

@@ -0,0 +1,8 @@
+import { ComponentLogger } from './component-logger';
+export declare function getComponentLogger(config: {
+    enabled: boolean;
+    tenantId: string;
+    accessSecret?: string | false | undefined;
+    accessCredentials?: string | false | undefined;
+    tags: string;
+}): Promise<ComponentLogger>;

package/lib/getComponentLogger.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getComponentLogger = void 0;
+const component_logger_1 = require("./component-logger");
+const client_secrets_manager_1 = require("@aws-sdk/client-secrets-manager");
+async function getComponentLogger(config) {
+    if (config.accessSecret && config.accessCredentials) {
+        throw new Error('Only either of Logging Service API accessSecret or accessCredentials should be provided');
+    }
+    let apiAccessString = '';
+    if (config.enabled) {
+        if (config.accessCredentials) {
+            apiAccessString = config.accessCredentials;
+        }
+        else if (config.accessSecret) {
+            apiAccessString = await getSecretString(config.accessSecret);
+        }
+    }
+    let apiAccessInfo = {
+        url: '',
+        key: '',
+    };
+    if (apiAccessString.length) {
+        apiAccessInfo = JSON.parse(apiAccessString);
+    }
+    return new component_logger_1.ComponentLogger({
+        enabled: config.enabled,
+        tenantId: config.tenantId,
+        logUrl: apiAccessInfo.url,
+        key: apiAccessInfo.key,
+        tags: config.tags,
+    });
+}
+exports.getComponentLogger = getComponentLogger;
+async function getSecretString(id) {
+    const client = new client_secrets_manager_1.SecretsManagerClient({});
+    const result = await client.send(new client_secrets_manager_1.GetSecretValueCommand({ SecretId: id }));
+    if (result.SecretString === undefined) {
+        throw new Error(`Secret ${id} could not be found`);
+    }
+    return result.SecretString;
+}
+//# sourceMappingURL=getComponentLogger.js.map

package/lib/getComponentLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getComponentLogger.js","sourceRoot":"","sources":["../src/getComponentLogger.ts"],"names":[],"mappings":";;;AAAA,yDAAqD;AACrD,4EAA8F;AAOvF,KAAK,UAAU,kBAAkB,CAAC,MAMxC;IACC,IAAI,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,iBAAiB,EAAE;QACnD,MAAM,IAAI,KAAK,CAAC,yFAAyF,CAAC,CAAC;KAC5G;IAED,IAAI,eAAe,GAAG,EAAE,CAAC;IACzB,IAAI,MAAM,CAAC,OAAO,EAAE;QAClB,IAAI,MAAM,CAAC,iBAAiB,EAAE;YAC5B,eAAe,GAAG,MAAM,CAAC,iBAAiB,CAAC;SAC5C;aAAM,IAAI,MAAM,CAAC,YAAY,EAAE;YAC9B,eAAe,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;SAC9D;KACF;IACD,IAAI,aAAa,GAAkB;QACjC,GAAG,EAAE,EAAE;QACP,GAAG,EAAE,EAAE;KACR,CAAC;IACF,IAAI,eAAe,CAAC,MAAM,EAAE;QAC1B,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;KAC7C;IAED,OAAO,IAAI,kCAAe,CAAC;QACzB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,MAAM,EAAE,aAAa,CAAC,GAAG;QACzB,GAAG,EAAE,aAAa,CAAC,GAAG;QACtB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAC,CAAC;AACL,CAAC;AAlCD,gDAkCC;AAED,KAAK,UAAU,eAAe,CAAC,EAAU;IACvC,MAAM,MAAM,GAAG,IAAI,6CAAoB,CAAC,EAAE,CAAC,CAAC;IAE5C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,8CAAqB,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAE9E,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;KACpD;IAED,OAAO,MAAM,CAAC,YAAY,CAAC;AAC7B,CAAC"}

package/lib/getComponentLogger.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/getComponentLogger.spec.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getComponentLogger_1 = require("./getComponentLogger");
+describe('getComponentLogger', () => {
+    it('should return the logger object', async () => {
+        const logger = await (0, getComponentLogger_1.getComponentLogger)({
+            enabled: false,
+            accessCredentials: JSON.stringify({
+                url: 'some-url',
+                key: 'some-key',
+            }),
+            tags: 'some-tags',
+            tenantId: 'some-tenant-id',
+        });
+        expect(logger).toBeTruthy();
+    });
+    it('should throw error if both accessSecret and accessCredential is provided', async () => {
+        const logger = (0, getComponentLogger_1.getComponentLogger)({
+            enabled: false,
+            accessSecret: 'some-access-secret',
+            accessCredentials: 'some-access-creds',
+            tags: 'some-tags',
+            tenantId: 'some-tenant-id',
+        });
+        await expect(logger).rejects.toThrowError('Only either of Logging Service API accessSecret or accessCredentials should be provided');
+    });
+});
+//# sourceMappingURL=getComponentLogger.spec.js.map

package/lib/getComponentLogger.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getComponentLogger.spec.js","sourceRoot":"","sources":["../src/getComponentLogger.spec.ts"],"names":[],"mappings":";;AAAA,6DAA0D;AAG1D,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,MAAM,GAAoB,MAAM,IAAA,uCAAkB,EAAC;YACvD,OAAO,EAAE,KAAK;YACd,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC;gBAChC,GAAG,EAAE,UAAU;gBACf,GAAG,EAAE,UAAU;aAChB,CAAC;YACF,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,gBAAgB;SAC3B,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QACxF,MAAM,MAAM,GAAG,IAAA,uCAAkB,EAAC;YAChC,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,oBAAoB;YAClC,iBAAiB,EAAE,mBAAmB;YACtC,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,gBAAgB;SAC3B,CAAC,CAAC;QACH,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,YAAY,CACvC,yFAAyF,CAC1F,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/index.d.ts

@@ -1 +1,2 @@
 export { ComponentLogger } from './component-logger';
+export { getComponentLogger } from './getComponentLogger';

package/lib/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComponentLogger = void 0;
+exports.getComponentLogger = exports.ComponentLogger = void 0;
 var component_logger_1 = require("./component-logger");
 Object.defineProperty(exports, "ComponentLogger", { enumerable: true, get: function () { return component_logger_1.ComponentLogger; } });
+var getComponentLogger_1 = require("./getComponentLogger");
+Object.defineProperty(exports, "getComponentLogger", { enumerable: true, get: function () { return getComponentLogger_1.getComponentLogger; } });
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAAqD;AAA5C,mHAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAAqD;AAA5C,mHAAA,eAAe,OAAA;AACxB,2DAA0D;AAAjD,wHAAA,kBAAkB,OAAA"}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@squiz/component-logger-lib",
-  "version": "1.32.1-alpha.22",
+  "version": "1.32.1-alpha.26",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
-    "test": "jest --passWithNoTests",
+    "test": "jest -c jest.config.ts",
+    "test:integration": "jest -c jest.integration.config.ts",
     "compile": "tsc"
   },
   "author": "",
@@ -13,11 +14,12 @@
     "superagent": "^8.0.9"
   },
   "devDependencies": {
+    "@squiz/dx-common-lib": "1.32.1-alpha.19",
     "@types/node": "18.15.2",
     "dotenv": "^16.0.3",
     "jest": "29.4.1",
     "ts-jest": "29.0.5",
     "ts-node": "10.9.1"
   },
-  "gitHead": "2ad540de21c3f73986bae9aed062a44e34521b75"
+  "gitHead": "a87ea107611743ec410eb21fc4f20d23cefb06f7"
 }

package/src/component-log-message.ts

@@ -6,5 +6,5 @@ export interface ComponentLogMessage {
   timestamp: string;
   message: string;
   tags?: string;
-  traceId?: string;
+  traceid?: string;
 }

package/src/component-logger-config.ts

@@ -1,7 +1,7 @@
 export interface ComponentLoggerConfig {
   enabled: boolean;
-  logUrl?: string;
-  key?: string;
-  tenantId?: string;
+  logUrl: string;
+  key: string;
+  tenantId: string;
   tags?: string; //TODO: Probably should be an array of key-value pairs?
 }

package/src/component-logger.integration.spec.ts

@@ -0,0 +1,16 @@
+import { parseEnvVarForVar } from '@squiz/dx-common-lib';
+import { getComponentLogger } from '.';
+
+describe('ComponentLogger', () => {
+  it('should sending log messages', async () => {
+    const logger = await getComponentLogger({
+      enabled: true,
+      tenantId: 'integration-test',
+      accessCredentials: parseEnvVarForVar('LOGGING_SERVICE_API_CREDENTIALS'),
+      tags: 'env:dev integration-test',
+    });
+
+    await logger.info('The quick brown fox', '123');
+    await logger.flush();
+  });
+});