fix(typescript): use only named exports

sonicoder86 · ngabor84 · sonicoder86 · commit dd45f371bc5b · 2022-08-26T16:43:02.000+02:00
EME-5173

BREAKING CHANGE: remove default exports to make named exports work properly

Co-authored-by: Gabor Nemeth &lt;gabor.nemeth@emarsys.com&gt;
diff --git a/README.md b/README.md
@@ -11,10 +11,13 @@ npm install @emartech/json-logger
 
 ### Usage
 
+#### Script
+
 ```javascript
 process.env.DEBUG = 'redis';
-const mongoLogger = require('@emartech/json-logger')('mongo');
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const mongoLogger = createLogger('mongo');
+const redisLogger = createLogger('redis');
 
 redisLogger.info('connected', { domain: 'yahoo' });
 // {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z","domain":"yahoo"}
@@ -26,6 +29,47 @@ redisLogger.fromError('query', new Error('Unauthorized'), { problem: 'missmatch'
 // {"name":"redis","action":"query","level":50,"time":"2016-08-15T08:50:23.569Z","error_name":"Error","error_stack":"Error: Unauthorized\n    at Object.<anonymous> (/home/blacksonic/workspace/bunyan-debug/example.js:15:32)\n    at Module._compile (module.js:541:32)\n    at Object.Module._extensions..js (module.js:550:10)\n    at Module.load (module.js:458:32)\n    at tryModuleLoad (module.js:417:12)\n    at Function.Module._load (module.js:409:3)\n    at Module.runMain (module.js:575:10)\n    at run (bootstrap_node.js:352:7)\n    at startup (bootstrap_node.js:144:9)\n    at bootstrap_node.js:467:3","error_message":"Unauthorized","problem":"missmatch"}
 ```
 
+#### Class
+
+```javascript
+const { createLogger } = require('@emartech/json-logger');
+const logger = createLogger('Exporter');
+
+class Exporter {
+  export() {
+    mongoLogger.info('export', { customer_id: 123 });
+  }
+}
+```
+
+```typescript
+import { createLogger } from '@emartech/json-logger';
+const logger = createLogger('Exporter');
+
+class Exporter {
+  export() {
+    mongoLogger.info('export', { customer_id: 123 });
+  }
+}
+```
+
+#### Tests
+
+```javascript
+import { Logger } from '@emartech/json-logger';
+
+describe('Exporter', () => {
+  it('should log', () => {
+    jest.spyOn(Logger.prototype, 'info').mockReturnValue();
+    const exporter = new Exporter();
+    
+    exporter.export();
+
+    expect(Logger.prototype.info).toHaveBeenCalledWith('export', { customer_id: 123 });
+  })
+});
+```
+
 More examples can be found in the `examples` directory.
 
 ### API
@@ -39,11 +83,12 @@ Disabled instances output no logs.
 
 ```javascript
 process.env.DEBUG = 'redis,mysql';
+const { createLogger } = require('@emartech/json-logger');
 
-const mongoLogger = require('@emartech/json-logger')('mongo');
+const mongoLogger = createLogger('mongo');
 // mongo instance will be disabled
 
-const redisLogger = require('@emartech/json-logger')('redis');
+const redisLogger = createLogger('redis');
 // redis instance will be enabled
 ```
 
@@ -52,7 +97,8 @@ const redisLogger = require('@emartech/json-logger')('redis');
 Prints the provided data to the console in JSON format.
 
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const redisLogger = createLogger('redis');
 
 redisLogger.info('connected', { domain: 'yahoo' });
 // {"name":"redis","action":"connected","level":30,"time":"2016-08-15T08:50:23.566Z","domain":"yahoo"}
@@ -92,7 +138,8 @@ The displayed line contains the stack trace, the name and the message of the err
 The log level defaults to error.
 
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const redisLogger = createLogger('redis');
 
 redisLogger.fromError('query', new Error('Unauthorized'), { problem: 'missmatch' });
 // {"name":"redis","action":"query","level":50,"time":"2016-08-15T08:50:23.569Z","error_name":"Error","error_stack":"Error: Unauthorized\n    at Object.<anonymous> (/home/blacksonic/workspace/bunyan-debug/example.js:15:32)\n    at Module._compile (module.js:541:32)\n    at Object.Module._extensions..js (module.js:550:10)\n    at Module.load (module.js:458:32)\n    at tryModuleLoad (module.js:417:12)\n    at Function.Module._load (module.js:409:3)\n    at Module.runMain (module.js:575:10)\n    at run (bootstrap_node.js:352:7)\n    at startup (bootstrap_node.js:144:9)\n    at bootstrap_node.js:467:3","error_message":"Unauthorized","problem":"missmatch"}
@@ -109,7 +156,8 @@ but also logs the elapsed time in milliseconds from the creation of the instance
 The elapsed time will be logged into the `duration` field.
 
 ```javascript
-const redisLogger = require('@emartech/json-logger')('redis');
+const { createLogger } = require('@emartech/json-logger');
+const redisLogger = createLogger('redis');
 
 const timer = redisLogger.timer();
 
@@ -127,9 +175,9 @@ With transformers we can alter the data to be logged before passing to the forma
 It is a perfect place to add the name of the machine is running on or the request id associated with the current thread stored on a continuation local storage. 
 
 ```javascript
-const Logger = require('@emartech/json-logger');
+const { createLogger } = require('@emartech/json-logger');
 
-Logger.configure({
+createLogger.configure({
   formatter: JSON.stringify,
   output: console.log,
   transformers: []
@@ -160,11 +208,11 @@ For automating
 
 ```javascript
 const Koa = require('koa');
-const logFactory = require('@emartech/json-logger');
+const { createLogger } = require('@emartech/json-logger');
 const clsAdapter = require('@emartech/cls-adapter');
-const logger = logFactory('redis');
+const logger = createLogger('redis');
 
-logFactory.configure({
+createLogger.configure({
   transformers: [
     clsAdapter.addContextStorageToInput()
   ]
diff --git a/examples/express.js b/examples/express.js
@@ -1,12 +1,12 @@
 'use strict';
 
 const express = require('express');
-const logFactory = require('../dist');
+const { createLogger } = require('../dist');
 const clsAdapter = require('@emartech/cls-adapter');
-const logger = logFactory('example');
+const logger = createLogger('example');
 const port = 3000;
 
-logFactory.configure({
+createLogger.configure({
   transformers: [
     clsAdapter.addContextStorageToInput()
   ]
diff --git a/examples/index-js.js b/examples/index-js.js
@@ -1,10 +1,10 @@
 'use strict';
 
 process.env.DEBUG = 'redis';
-const logger = require('../dist');
+const { createLogger } = require('../dist');
 
-const mongoLogger = logger('mongo');
-const redisLogger = logger('redis');
+const mongoLogger = createLogger('mongo');
+const redisLogger = createLogger('redis');
 
 // simple info logging with enabled namespace
 redisLogger.info('connected', { domain: 'yahoo' });
diff --git a/examples/index-ts.ts b/examples/index-ts.ts
@@ -1,8 +1,8 @@
 process.env.DEBUG = 'redis';
-import logger from '../dist';
+import { createLogger } from '../dist';
 
-const mongoLogger = logger('mongo');
-const redisLogger = logger('redis');
+const mongoLogger = createLogger('mongo');
+const redisLogger = createLogger('redis');
 
 // simple info logging with enabled namespace
 redisLogger.info('connected', { domain: 'yahoo' });
diff --git a/examples/koa.js b/examples/koa.js
@@ -1,13 +1,13 @@
 'use strict';
 
 const Koa = require('koa');
-const logFactory = require('../dist');
+const { createLogger } = require('../dist');
 
 const clsAdapter = require('@emartech/cls-adapter');
-const logger = logFactory('example');
+const logger = createLogger('example');
 const port = 3000;
 
-logFactory.configure({
+createLogger.configure({
   transformers: [
     clsAdapter.addContextStorageToInput()
   ]
diff --git a/src/index.spec.js b/src/index.spec.js
@@ -1,9 +1,8 @@
 'use strict';
 
-const logFactory = require('./index');
-const { Logger } = require('./logger/logger');
+const { createLogger, Logger } = require('./index');
 
-describe('LogFactory', function() {
+describe('createLogger', function() {
   beforeEach(function() {
     process.env.DEBUG = 'mongo';
   });
@@ -13,25 +12,16 @@ describe('LogFactory', function() {
   });
 
   it('should return an enabled log instance when env variable is set to same', function() {
-    const logger = logFactory('mongo');
+    const logger = createLogger('mongo');
 
     expect(logger).to.be.an.instanceOf(Logger);
     expect(logger.isEnabled()).to.be.true;
   });
 
   it('should return a disabled log instance when different', function() {
-    const logger = logFactory('redis');
+    const logger = createLogger('redis');
 
     expect(logger).to.be.an.instanceOf(Logger);
     expect(logger.isEnabled()).to.be.false;
   });
-
-  it('should be mockable through public interface', function() {
-    this.sandbox.stub(logFactory.Logger.prototype, 'info');
-
-    const logger = logFactory('mongo');
-    logger.info('hello');
-
-    expect(logFactory.Logger.prototype.info).to.have.been.calledWith('hello');
-  })
 });
diff --git a/src/index.ts b/src/index.ts
@@ -5,21 +5,16 @@ export { Timer } from './timer/timer';
 import { isNamespaceEnabled } from './enabled/enabled';
 import { formatter } from './formatter';
 
-export function logFactory(namespace: string): Logger {
+export function createLogger(namespace: string): Logger {
   return new Logger(namespace, isNamespaceEnabled(
-    logFactory.getNamespaces(), namespace
+    createLogger.getNamespaces(), namespace
   ));
 }
 
-logFactory.Logger = Logger;
-logFactory.Timer = Timer;
-logFactory.getNamespaces = function(): string {
+createLogger.getNamespaces = function(): string {
   return process.env.DEBUG || '';
 };
-logFactory.configure = function(options: LoggerConfig): void {
+createLogger.configure = function(options: LoggerConfig): void {
   Logger.configure(options);
 };
-logFactory.formatter = formatter;
-
-export default logFactory;
-module.exports = logFactory;
+createLogger.formatter = formatter;
