@villedemontreal/correlation-id 5.3.2

package/dist/src/services/correlationIdService.test.js

@@ -0,0 +1,215 @@
+"use strict";
+// tslint:disable max-func-body-length
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const events_1 = require("events");
+const testingConfigurations_1 = require("../utils/testingConfigurations");
+const correlationIdService_1 = require("./correlationIdService");
+(0, testingConfigurations_1.setTestingConfigurations)();
+const uuidMatcher = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/;
+async function timeout(work, ms = 50) {
+    return new Promise(resolve => setTimeout(() => {
+        work();
+        resolve();
+    }, ms));
+}
+describe('Correlation Id Service', () => {
+    describe('createNewId', () => {
+        it('should return UUID', () => {
+            const cid = correlationIdService_1.correlationIdService.createNewId();
+            chai_1.assert.match(cid, uuidMatcher);
+        });
+    });
+    describe('withId correlator', () => {
+        it('with sync function', () => {
+            // GIVEN
+            const expectedResult = '⭐';
+            // WHEN
+            const result = correlationIdService_1.correlationIdService.withId(() => {
+                const actual = correlationIdService_1.correlationIdService.getId();
+                chai_1.assert.match(actual, uuidMatcher, 'getId() should return a uuid');
+                return expectedResult;
+            });
+            // THEN
+            chai_1.assert.strictEqual(result, expectedResult);
+        });
+        it('with async function', async () => {
+            let done = false;
+            const promise = correlationIdService_1.correlationIdService.withId(async () => {
+                await timeout(() => {
+                    const actual = correlationIdService_1.correlationIdService.getId();
+                    chai_1.assert.match(actual, uuidMatcher, 'getId() should return a uuid');
+                    done = true;
+                });
+            });
+            // "withId" doesn't care about a promise to be floating or not
+            chai_1.assert.isFalse(done);
+            await promise;
+        });
+        it('with supplied id', () => {
+            const testId = 'id-1';
+            correlationIdService_1.correlationIdService.withId(() => {
+                const actual = correlationIdService_1.correlationIdService.getId();
+                chai_1.assert.strictEqual(actual, testId, 'getId() should return supplied id');
+            }, testId);
+        });
+        it('with bound emitter', () => {
+            // GIVEN
+            const emitter = new events_1.EventEmitter();
+            let receivedValue = 0;
+            let receivedCid = '';
+            emitter.on('test', value => {
+                receivedValue = value;
+                receivedCid = correlationIdService_1.correlationIdService.getId();
+            });
+            // WHEN
+            let boundEmitter;
+            correlationIdService_1.correlationIdService.withId(() => {
+                boundEmitter = correlationIdService_1.correlationIdService.bind(emitter);
+                chai_1.assert.strictEqual(boundEmitter, emitter);
+            }, 'foo');
+            // THEN
+            boundEmitter.emit('test', 33);
+            chai_1.assert.equal(receivedValue, 33);
+            chai_1.assert.equal(receivedCid, 'foo');
+        });
+        it('with bound function', () => {
+            // GIVEN
+            const func = (msg) => msg + correlationIdService_1.correlationIdService.getId();
+            // WHEN
+            let boundFunc;
+            correlationIdService_1.correlationIdService.withId(() => {
+                boundFunc = correlationIdService_1.correlationIdService.bind(func);
+            }, 'foo');
+            // THEN
+            const result = boundFunc('Bar-');
+            chai_1.assert.equal(result, 'Bar-foo');
+        });
+        it('with bound method', () => {
+            // GIVEN
+            const instance = {
+                title: 'Hello-',
+                say(msg) {
+                    return this.title + msg + correlationIdService_1.correlationIdService.getId();
+                }
+            };
+            // WHEN
+            correlationIdService_1.correlationIdService.withId(() => {
+                instance.say = correlationIdService_1.correlationIdService.bind(instance.say);
+            }, 'foo');
+            // THEN
+            const result = instance.say('Bar-');
+            chai_1.assert.equal(result, 'Hello-Bar-foo');
+        });
+        it('with resolved promise', async () => {
+            let done = false;
+            const promise = correlationIdService_1.correlationIdService.withId(() => Promise.resolve(correlationIdService_1.correlationIdService.getId()).then(id => {
+                chai_1.assert.match(id, uuidMatcher, 'Promise should resolve correlation id');
+                done = true;
+            }));
+            // "withId" doesn't care about a promise to be floating or not
+            chai_1.assert.isFalse(done);
+            await promise;
+        });
+        it('with nested functions', () => {
+            correlationIdService_1.correlationIdService.withId(() => {
+                const cid1 = correlationIdService_1.correlationIdService.getId();
+                chai_1.assert.match(cid1, uuidMatcher, 'correlationIdService.getId() should return a UUID');
+                correlationIdService_1.correlationIdService.withId(() => {
+                    const cid2 = correlationIdService_1.correlationIdService.getId();
+                    chai_1.assert.notEqual(cid2, cid1, 'correlationIdService.getId() should return a different id for every scope');
+                    chai_1.assert.match(cid2, uuidMatcher, 'correlationIdService.getId() should return a UUID');
+                });
+                const cid3 = correlationIdService_1.correlationIdService.getId();
+                chai_1.assert.strictEqual(cid3, cid1, 'correlationIdService.getId() should return the same id for the same scope');
+                chai_1.assert.match(cid3, uuidMatcher, 'correlationIdService.getId() should return a UUID');
+            });
+        });
+        it('with async function', async function () {
+            const duration = 25;
+            setSlowThreshold(this, duration);
+            // GIVEN
+            const expectedResult = '⭐';
+            // WHEN
+            const result = await correlationIdService_1.correlationIdService.withId(async () => {
+                chai_1.assert.equal(correlationIdService_1.correlationIdService.getId(), 'foo');
+                await timeout(() => {
+                    chai_1.assert.equal(correlationIdService_1.correlationIdService.getId(), 'foo');
+                }, duration);
+                chai_1.assert.equal(correlationIdService_1.correlationIdService.getId(), 'foo');
+                return expectedResult;
+            }, 'foo');
+            // THEN
+            chai_1.assert.strictEqual(result, expectedResult);
+        });
+    });
+    describe('withIdAsync correlator', () => {
+        it('with async function', async function () {
+            const duration = 25;
+            setSlowThreshold(this, duration);
+            // GIVEN
+            const expectedResult = '⭐';
+            // WHEN
+            const result = await correlationIdService_1.correlationIdService.withIdAsync(async () => {
+                chai_1.assert.equal(correlationIdService_1.correlationIdService.getId(), 'foo');
+                await timeout(() => {
+                    chai_1.assert.equal(correlationIdService_1.correlationIdService.getId(), 'foo');
+                }, duration);
+                chai_1.assert.equal(correlationIdService_1.correlationIdService.getId(), 'foo');
+                return expectedResult;
+            }, 'foo');
+            // THEN
+            chai_1.assert.strictEqual(result, expectedResult);
+        });
+        it('with error in callback', async () => {
+            try {
+                await correlationIdService_1.correlationIdService.withIdAsync(async () => {
+                    chai_1.assert.equal(correlationIdService_1.correlationIdService.getId(), 'foo');
+                    throw new Error('some error...');
+                }, 'foo');
+                chai_1.assert.fail('expected error');
+            }
+            catch (err) {
+                chai_1.assert.equal(err.message, 'some error...');
+            }
+        });
+        it('with error after await', async function () {
+            const duration = 25;
+            setSlowThreshold(this, duration);
+            try {
+                await correlationIdService_1.correlationIdService.withIdAsync(async () => {
+                    chai_1.assert.equal(correlationIdService_1.correlationIdService.getId(), 'foo');
+                    // tslint:disable-next-line: no-empty
+                    await timeout(() => { }, duration);
+                    throw new Error('some error...');
+                }, 'foo');
+                chai_1.assert.fail('expected error');
+            }
+            catch (err) {
+                chai_1.assert.equal(err.message, 'some error...');
+            }
+        });
+        it('with nested async functions', async function () {
+            const duration = 25;
+            setSlowThreshold(this, 2 * duration);
+            await correlationIdService_1.correlationIdService.withIdAsync(async () => {
+                chai_1.assert.equal(correlationIdService_1.correlationIdService.getId(), 'foo');
+                await timeout(async () => {
+                    await correlationIdService_1.correlationIdService.withIdAsync(async () => {
+                        await timeout(() => {
+                            chai_1.assert.equal(correlationIdService_1.correlationIdService.getId(), 'bar');
+                        }, duration);
+                    }, 'bar');
+                }, duration);
+                chai_1.assert.equal(correlationIdService_1.correlationIdService.getId(), 'foo');
+            }, 'foo');
+        });
+    });
+    function setSlowThreshold(context, expectedTestDuration) {
+        // Cf. https://mochajs.org/#test-duration
+        // 10: budgeted test case own processing time
+        // ×2: for the estimation to sit around "slow/2" in Mocha scale (and no warning shows up)
+        context.slow((expectedTestDuration + 10) * 2);
+    }
+});
+//# sourceMappingURL=correlationIdService.test.js.map

package/dist/src/services/correlationIdService.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"correlationIdService.test.js","sourceRoot":"","sources":["../../../src/services/correlationIdService.test.ts"],"names":[],"mappings":";AAAA,sCAAsC;;AAEtC,+BAA8B;AAC9B,mCAAsC;AACtC,0EAA0E;AAC1E,iEAA8D;AAE9D,IAAA,gDAAwB,GAAE,CAAC;AAE3B,MAAM,WAAW,GAAW,gEAAgE,CAAC;AAE7F,KAAK,UAAU,OAAO,CAAC,IAA2B,EAAE,KAAa,EAAE;IACjE,OAAO,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE,CACjC,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,EAAE,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC,EAAE,EAAE,CAAC,CACP,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACtC,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAC5B,MAAM,GAAG,GAAG,2CAAoB,CAAC,WAAW,EAAE,CAAC;YAC/C,aAAM,CAAC,KAAK,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAC5B,QAAQ;YACR,MAAM,cAAc,GAAW,GAAG,CAAC;YAEnC,OAAO;YACP,MAAM,MAAM,GAAG,2CAAoB,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC9C,MAAM,MAAM,GAAG,2CAAoB,CAAC,KAAK,EAAE,CAAC;gBAC5C,aAAM,CAAC,KAAK,CAAC,MAAM,EAAE,WAAW,EAAE,8BAA8B,CAAC,CAAC;gBAClE,OAAO,cAAc,CAAC;YACxB,CAAC,CAAC,CAAC;YAEH,OAAO;YACP,aAAM,CAAC,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;YACnC,IAAI,IAAI,GAAY,KAAK,CAAC;YAE1B,MAAM,OAAO,GAAG,2CAAoB,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;gBACrD,MAAM,OAAO,CAAC,GAAG,EAAE;oBACjB,MAAM,MAAM,GAAG,2CAAoB,CAAC,KAAK,EAAE,CAAC;oBAC5C,aAAM,CAAC,KAAK,CAAC,MAAM,EAAE,WAAW,EAAE,8BAA8B,CAAC,CAAC;oBAClE,IAAI,GAAG,IAAI,CAAC;gBACd,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,8DAA8D;YAC9D,aAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrB,MAAM,OAAO,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;YAC1B,MAAM,MAAM,GAAG,MAAM,CAAC;YACtB,2CAAoB,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC/B,MAAM,MAAM,GAAG,2CAAoB,CAAC,KAAK,EAAE,CAAC;gBAC5C,aAAM,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,mCAAmC,CAAC,CAAC;YAC1E,CAAC,EAAE,MAAM,CAAC,CAAC;QACb,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAC5B,QAAQ;YACR,MAAM,OAAO,GAAG,IAAI,qBAAY,EAAE,CAAC;YACnC,IAAI,aAAa,GAAG,CAAC,CAAC;YACtB,IAAI,WAAW,GAAG,EAAE,CAAC;YACrB,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;gBACzB,aAAa,GAAG,KAAK,CAAC;gBACtB,WAAW,GAAG,2CAAoB,CAAC,KAAK,EAAE,CAAC;YAC7C,CAAC,CAAC,CAAC;YAEH,OAAO;YACP,IAAI,YAA0B,CAAC;YAC/B,2CAAoB,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC/B,YAAY,GAAG,2CAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAClD,aAAM,CAAC,WAAW,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAC5C,CAAC,EAAE,KAAK,CAAC,CAAC;YAEV,OAAO;YACP,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC9B,aAAM,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YAChC,aAAM,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;YAC7B,QAAQ;YACR,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,GAAG,2CAAoB,CAAC,KAAK,EAAE,CAAC;YAEjE,OAAO;YACP,IAAI,SAAkC,CAAC;YACvC,2CAAoB,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC/B,SAAS,GAAG,2CAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9C,CAAC,EAAE,KAAK,CAAC,CAAC;YAEV,OAAO;YACP,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;YACjC,aAAM,CAAC,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;YAC3B,QAAQ;YACR,MAAM,QAAQ,GAAG;gBACf,KAAK,EAAE,QAAQ;gBACf,GAAG,CAAC,GAAW;oBACb,OAAO,IAAI,CAAC,KAAK,GAAG,GAAG,GAAG,2CAAoB,CAAC,KAAK,EAAE,CAAC;gBACzD,CAAC;aACF,CAAC;YAEF,OAAO;YACP,2CAAoB,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC/B,QAAQ,CAAC,GAAG,GAAG,2CAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACzD,CAAC,EAAE,KAAK,CAAC,CAAC;YAEV,OAAO;YACP,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpC,aAAM,CAAC,KAAK,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;YACrC,IAAI,IAAI,GAAY,KAAK,CAAC;YAE1B,MAAM,OAAO,GAAG,2CAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,CAC/C,OAAO,CAAC,OAAO,CAAC,2CAAoB,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;gBACtD,aAAM,CAAC,KAAK,CAAC,EAAE,EAAE,WAAW,EAAE,uCAAuC,CAAC,CAAC;gBACvE,IAAI,GAAG,IAAI,CAAC;YACd,CAAC,CAAC,CACH,CAAC;YAEF,8DAA8D;YAC9D,aAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrB,MAAM,OAAO,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;YAC/B,2CAAoB,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC/B,MAAM,IAAI,GAAG,2CAAoB,CAAC,KAAK,EAAE,CAAC;gBAC1C,aAAM,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,mDAAmD,CAAC,CAAC;gBAErF,2CAAoB,CAAC,MAAM,CAAC,GAAG,EAAE;oBAC/B,MAAM,IAAI,GAAG,2CAAoB,CAAC,KAAK,EAAE,CAAC;oBAC1C,aAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,2EAA2E,CAAC,CAAC;oBACzG,aAAM,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,mDAAmD,CAAC,CAAC;gBACvF,CAAC,CAAC,CAAC;gBAEH,MAAM,IAAI,GAAG,2CAAoB,CAAC,KAAK,EAAE,CAAC;gBAC1C,aAAM,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,2EAA2E,CAAC,CAAC;gBAC5G,aAAM,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,mDAAmD,CAAC,CAAC;YACvF,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK;YAC7B,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAEjC,QAAQ;YACR,MAAM,cAAc,GAAW,GAAG,CAAC;YAEnC,OAAO;YACP,MAAM,MAAM,GAAG,MAAM,2CAAoB,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;gBAC1D,aAAM,CAAC,KAAK,CAAC,2CAAoB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;gBAClD,MAAM,OAAO,CAAC,GAAG,EAAE;oBACjB,aAAM,CAAC,KAAK,CAAC,2CAAoB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;gBACpD,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACb,aAAM,CAAC,KAAK,CAAC,2CAAoB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;gBAClD,OAAO,cAAc,CAAC;YACxB,CAAC,EAAE,KAAK,CAAC,CAAC;YAEV,OAAO;YACP,aAAM,CAAC,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,EAAE,CAAC,qBAAqB,EAAE,KAAK;YAC7B,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAEjC,QAAQ;YACR,MAAM,cAAc,GAAW,GAAG,CAAC;YAEnC,OAAO;YACP,MAAM,MAAM,GAAG,MAAM,2CAAoB,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;gBAC/D,aAAM,CAAC,KAAK,CAAC,2CAAoB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;gBAClD,MAAM,OAAO,CAAC,GAAG,EAAE;oBACjB,aAAM,CAAC,KAAK,CAAC,2CAAoB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;gBACpD,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACb,aAAM,CAAC,KAAK,CAAC,2CAAoB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;gBAClD,OAAO,cAAc,CAAC;YACxB,CAAC,EAAE,KAAK,CAAC,CAAC;YAEV,OAAO;YACP,aAAM,CAAC,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;YACtC,IAAI;gBACF,MAAM,2CAAoB,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;oBAChD,aAAM,CAAC,KAAK,CAAC,2CAAoB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;oBAClD,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;gBACnC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACV,aAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC/B;YAAC,OAAO,GAAG,EAAE;gBACZ,aAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;aAC5C;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wBAAwB,EAAE,KAAK;YAChC,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAEjC,IAAI;gBACF,MAAM,2CAAoB,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;oBAChD,aAAM,CAAC,KAAK,CAAC,2CAAoB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;oBAClD,qCAAqC;oBACrC,MAAM,OAAO,CAAC,GAAG,EAAE,GAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;oBAClC,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;gBACnC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACV,aAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC/B;YAAC,OAAO,GAAG,EAAE;gBACZ,aAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;aAC5C;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK;YACrC,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,gBAAgB,CAAC,IAAI,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC;YAErC,MAAM,2CAAoB,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;gBAChD,aAAM,CAAC,KAAK,CAAC,2CAAoB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;gBAClD,MAAM,OAAO,CAAC,KAAK,IAAI,EAAE;oBACvB,MAAM,2CAAoB,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE;wBAChD,MAAM,OAAO,CAAC,GAAG,EAAE;4BACjB,aAAM,CAAC,KAAK,CAAC,2CAAoB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;wBACpD,CAAC,EAAE,QAAQ,CAAC,CAAC;oBACf,CAAC,EAAE,KAAK,CAAC,CAAC;gBACZ,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACb,aAAM,CAAC,KAAK,CAAC,2CAAoB,CAAC,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;YACpD,CAAC,EAAE,KAAK,CAAC,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,SAAS,gBAAgB,CAAC,OAAsB,EAAE,oBAA4B;QAC5E,yCAAyC;QACzC,6CAA6C;QAC7C,yFAAyF;QACzF,OAAO,CAAC,IAAI,CAAC,CAAC,oBAAoB,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;AACH,CAAC,CAAC,CAAC"}

package/dist/src/utils/logger.d.ts

@@ -0,0 +1,11 @@
+import { ILogger } from '@villedemontreal/logger';
+/**
+ * Creates a Logger.
+ */
+export declare function createLogger(name: string): ILogger;
+/**
+ * A Logger that uses a dummy cid provider.
+ *
+ * Only use this when running the tests!
+ */
+export declare function getTestingLoggerCreator(): (name: string) => ILogger;

package/dist/src/utils/logger.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTestingLoggerCreator = exports.createLogger = void 0;
+const logger_1 = require("@villedemontreal/logger");
+const configs_1 = require("../config/configs");
+let testingLoggerLibInitialised = false;
+/**
+ * Creates a Logger.
+ */
+function createLogger(name) {
+    // ==========================================
+    // We use a LazyLogger so the real Logger
+    // is only created when the first
+    // log is actually performed... At that point,
+    // our "configs.loggerCreator" configuration
+    // must have been set by the code using our library!
+    //
+    // This pattern allows calling code to import
+    // modules from us in which a logger is
+    // created in the global scope :
+    //
+    // let logger = createLogger('someName');
+    //
+    // Without a Lazy Logger, the library configurations
+    // would at that moment *not* have been set yet
+    // (by the calling code) and an Error would be thrown
+    // because the "configs.loggerCreator" is required.
+    // ==========================================
+    return new logger_1.LazyLogger(name, (nameArg) => {
+        return configs_1.configs.loggerCreator(nameArg);
+    });
+}
+exports.createLogger = createLogger;
+function initTestingLoggerConfigs() {
+    const loggerConfig = new logger_1.LoggerConfigs(() => 'test-cid');
+    loggerConfig.setLogLevel(logger_1.LogLevel.DEBUG);
+    (0, logger_1.initLogger)(loggerConfig);
+}
+/**
+ * A Logger that uses a dummy cid provider.
+ *
+ * Only use this when running the tests!
+ */
+function getTestingLoggerCreator() {
+    return (name) => {
+        if (!testingLoggerLibInitialised) {
+            initTestingLoggerConfigs();
+            testingLoggerLibInitialised = true;
+        }
+        return new logger_1.Logger(name);
+    };
+}
+exports.getTestingLoggerCreator = getTestingLoggerCreator;
+//# sourceMappingURL=logger.js.map

package/dist/src/utils/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../src/utils/logger.ts"],"names":[],"mappings":";;;AAAA,oDAA2G;AAC3G,+CAA4C;AAE5C,IAAI,2BAA2B,GAAG,KAAK,CAAC;AAExC;;GAEG;AACH,SAAgB,YAAY,CAAC,IAAY;IACvC,6CAA6C;IAC7C,yCAAyC;IACzC,iCAAiC;IACjC,8CAA8C;IAC9C,4CAA4C;IAC5C,oDAAoD;IACpD,EAAE;IACF,6CAA6C;IAC7C,uCAAuC;IACvC,gCAAgC;IAChC,EAAE;IACF,yCAAyC;IACzC,EAAE;IACF,oDAAoD;IACpD,+CAA+C;IAC/C,qDAAqD;IACrD,mDAAmD;IACnD,6CAA6C;IAC7C,OAAO,IAAI,mBAAU,CAAC,IAAI,EAAE,CAAC,OAAe,EAAE,EAAE;QAC9C,OAAO,iBAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAtBD,oCAsBC;AAED,SAAS,wBAAwB;IAC/B,MAAM,YAAY,GAAkB,IAAI,sBAAa,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;IACxE,YAAY,CAAC,WAAW,CAAC,iBAAQ,CAAC,KAAK,CAAC,CAAC;IACzC,IAAA,mBAAU,EAAC,YAAY,CAAC,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB;IACrC,OAAO,CAAC,IAAY,EAAW,EAAE;QAC/B,IAAI,CAAC,2BAA2B,EAAE;YAChC,wBAAwB,EAAE,CAAC;YAC3B,2BAA2B,GAAG,IAAI,CAAC;SACpC;QAED,OAAO,IAAI,eAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC,CAAC;AACJ,CAAC;AATD,0DASC"}

package/dist/src/utils/testingConfigurations.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Call this when your need to set
+ * *Testing* configurations to the current
+ * library, without the need for a calling code
+ * to do so.
+ *
+ * A test Correlation Id will be used!
+ */
+export declare function setTestingConfigurations(): void;

package/dist/src/utils/testingConfigurations.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setTestingConfigurations = void 0;
+const init_1 = require("../config/init");
+const logger_1 = require("../utils/logger");
+/**
+ * Call this when your need to set
+ * *Testing* configurations to the current
+ * library, without the need for a calling code
+ * to do so.
+ *
+ * A test Correlation Id will be used!
+ */
+function setTestingConfigurations() {
+    (0, init_1.init)((0, logger_1.getTestingLoggerCreator)());
+}
+exports.setTestingConfigurations = setTestingConfigurations;
+//# sourceMappingURL=testingConfigurations.js.map

package/dist/src/utils/testingConfigurations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testingConfigurations.js","sourceRoot":"","sources":["../../../src/utils/testingConfigurations.ts"],"names":[],"mappings":";;;AAAA,yCAAsC;AACtC,4CAA0D;AAE1D;;;;;;;GAOG;AACH,SAAgB,wBAAwB;IACtC,IAAA,WAAI,EAAC,IAAA,gCAAuB,GAAE,CAAC,CAAC;AAClC,CAAC;AAFD,4DAEC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@villedemontreal/correlation-id",
+  "version": "5.3.2",
+  "description": "Express middleware to set a correlation in Express. The correlation id will be consistent across async calls within the handling of a request.",
+  "main": "dist/src/index.js",
+  "typings": "dist/src",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "scripts": {
+    "start": "node run test",
+    "test": "mocha --require ts-node/register src/**/*.test.ts",
+    "compile": "node run compile",
+    "lint": "echo 'not yet implemented'",
+    "lint-fix": "echo 'not yet implemented'",
+    "prettier": "echo 'not yet implemented'",
+    "prettier-fix": "echo 'not yet implemented'",
+    "watch": "echo 'not yet implemented'"
+  },
+  "keywords": [
+    "montreal",
+    "cid",
+    "correlation ID",
+    "request",
+    "debug"
+  ],
+  "author": "Ville de Montréal",
+  "license": "MIT",
+  "dependencies": {
+    "@types/app-root-path": "1.2.4",
+    "@types/cls-hooked": "4.3.3",
+    "@types/lodash": "4.14.182",
+    "@types/uuid": "8.3.4",
+    "@villedemontreal/logger": "6.5.6",
+    "app-root-path": "3.0.0",
+    "cls-hooked": "4.2.2",
+    "http-header-fields-typed": "1.3.0",
+    "lodash": "4.17.21",
+    "semver": "7.3.7",
+    "uuid": "8.3.2"
+  },
+  "devDependencies": {
+    "@types/chai": "4.3.1",
+    "@types/express": "4.17.13",
+    "@types/fs-extra": "9.0.13",
+    "@types/mocha": "9.1.1",
+    "@types/semver": "7.3.10",
+    "@types/supertest": "2.0.12",
+    "@villedemontreal/scripting": "2.1.5",
+    "@villedemontreal/lint-config": "1.7.7",
+    "chai": "4.3.6",
+    "express": "4.18.1",
+    "fs-extra": "10.1.0",
+    "mocha": "9.2.2",
+    "mocha-jenkins-reporter": "0.4.7",
+    "supertest": "6.2.3",
+    "tslint": "6.1.2",
+    "ts-node": "^10.8.1",
+    "typescript": "4.7.4"
+  }
+}

package/src/config/configs.ts

@@ -0,0 +1,26 @@
+import { ILogger } from '@villedemontreal/logger';
+
+/**
+ * Http Client Config
+ */
+export class Configs {
+  private loggerCreatorVar: (name: string) => ILogger;
+
+  /**
+   * Sets the Logger creator.
+   */
+  public setLoggerCreator(loggerCreator: (name: string) => ILogger) {
+    this.loggerCreatorVar = loggerCreator;
+  }
+
+  /**
+   * The Logger creator
+   */
+  get loggerCreator(): (name: string) => ILogger {
+    if (!this.loggerCreatorVar) {
+      throw new Error(`The Logger Creator HAS to be set as a configuration! Please call the init(...) fonction first.`);
+    }
+    return this.loggerCreatorVar;
+  }
+}
+export let configs: Configs = new Configs();

package/src/config/constants.ts

@@ -0,0 +1,40 @@
+import { path as appRoot } from 'app-root-path';
+import * as path from 'path';
+
+/**
+ * Library constants
+ */
+export class Constants {
+  /**
+   * The library root. When this library is used
+   * as a dependency in a project, the "libRoot"
+   * will be the path to the dependency folder,
+   * inside the "node_modules".
+   */
+  public libRoot: string;
+
+  /**
+   * The app root. When this library is used
+   * as a dependency in a project, the "appRoot"
+   * will be the path to the root project!
+   */
+  public appRoot: string;
+
+  constructor() {
+    // From the "dist/src/config" folder
+    this.libRoot = path.normalize(__dirname + '/../../..');
+    this.appRoot = appRoot;
+  }
+
+  /**
+   * Extra values that we can add to the original Express request.
+   */
+  get requestExtraVariables() {
+    return {
+      cidReceivedInRequest: '_cidReceivedInRequest',
+      cidNew: '_cidNew'
+    };
+  }
+}
+
+export let constants: Constants = new Constants();

package/src/config/init.ts

@@ -0,0 +1,33 @@
+import { ILogger } from '@villedemontreal/logger';
+import { configs } from './configs';
+
+let libIsInited: boolean = false;
+
+/**
+ * Inits the library.
+ */
+export function init(loggerCreator: (name: string) => ILogger): void {
+  if (!loggerCreator) {
+    throw new Error(`The Logger Creator is required.`);
+  }
+  configs.setLoggerCreator(loggerCreator);
+
+  // ==========================================
+  // Set as being "properly initialized".
+  // At the very end of the "init()" function!
+  // ==========================================
+  libIsInited = true;
+}
+
+/**
+ * Is the library properly initialized?
+ *
+ * This function MUST be named "isInited()"!
+ * Code using this library may loop over all its "@villemontreal"
+ * dependencies and, if one of those exports a "isInited" fonction,
+ * it will enforce that the lib has been properly initialized before
+ * starting...
+ */
+export function isInited(): boolean {
+  return libIsInited;
+}

package/src/index.ts

@@ -0,0 +1,9 @@
+export * from './services/correlationIdService';
+export * from './middleware/correlationIdMiddleware';
+
+// ==========================================
+// We do not export the configs instance itself,
+// only the "init()" method, so we can define
+// required parameters.
+// ==========================================
+export * from './config/init';