Merge pull request #3 from egomobile/improvings

useMongoLogger() works similar to api-log now

Author: ekmobile

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log (@egomobile/mongo-log)
 
+## 0.3.0
+
+- BREAKING CHANGE: [useMongoLogger](https://egomobile.github.io/mongo-log/modules.html#useMongoLogger) returns an [AsyncLoggerMiddleware](https://egomobile.github.io/js-log/modules.html#AsyncLoggerMiddleware) now, similar to [api-log](https://github.com/egomobile/api-log)
+- pinned all non-e.GO packages in [package.json](https://github.com/egomobile/mongo-log/blob/master/package.json) file
+
 ## 0.2.0
 
 - move [@egomobile/mongo](https://github.com/egomobile/node-mongo) and [@egomobile/log](https://github.com/egomobile/js-log) to [peerDependencies](https://nodejs.org/uk/blog/npm/peer-dependencies/) in `package.json`

README.md

@@ -22,13 +22,17 @@ The following modules are defined in [peerDependencies](https://nodejs.org/uk/bl
 ## Usage
 
 ```typescript
-import log, { useMongoLogger } from "@egomobile/mongo-log";
+import log, {
+  consoleLogger as useConsoleLogger,
+  useFallback,
+  useMongoLogger,
+} from "@egomobile/mongo-log";
 
-// run this, if you do not want to use console.log
-// log.reset();
+// reset the logger to configure it from scratch
+log.reset();
 
-// add middleware
-log.use(useMongoLogger());
+// use mongo logger as first middleware and console logger as a fallback
+log.use(useFallback(useMongoLogger(), useConsoleLogger()));
 
 log("foo"); // default: debug
 log.debug("foo"); // debug

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@egomobile/mongo-log",
-    "version": "0.2.0",
+    "version": "0.3.0",
     "description": "Extension for js-log, that writes to Mongo databases.",
     "main": "lib/index.js",
     "engines": {
@@ -48,20 +48,20 @@
         "@types/node": "12.20.27"
     },
     "devDependencies": {
-        "@egomobile/log": "0.2.1",
-        "@egomobile/mongo": "1.0.0",
-        "@egomobile/tsconfig": "5.0.0",
+        "@egomobile/log": "^0.3.0",
+        "@egomobile/mongo": "^1.0.0",
+        "@egomobile/tsconfig": "^5.0.0",
         "del-cli": "4.0.1",
         "eslint": "7.32.0",
-        "eslint-config-ego": "0.15.0",
+        "eslint-config-ego": "^0.15.0",
         "nodemon": "2.0.13",
         "ts-node": "10.2.1",
         "tslint": "6.1.3",
         "typedoc": "0.22.5",
         "typescript": "4.4.3"
     },
     "peerDependencies": {
-        "@egomobile/log": "0.2.1",
-        "@egomobile/mongo": "1.0.0"
+        "@egomobile/log": "^0.3.0",
+        "@egomobile/mongo": "^1.0.0"
     }
 }

package.json

@@ -13,7 +13,7 @@
 // You should have received a copy of the GNU Lesser General Public License
 // along with this program. If not, see <http://www.gnu.org/licenses/>.
 
-import log, { LoggerMiddleware } from '@egomobile/log';
+import log, { AsyncLoggerMiddleware, LoggerMiddleware, LogType, NextFunction } from '@egomobile/log';
 import { MongoDatabase } from '@egomobile/mongo';
 import type { IMongoLogContext, IUseMongoLoggerOptions, MongoLogCollectionProvider, MongoLogDatabaseProvider, MongoLogDocumentFactory } from './types';
 
@@ -27,24 +27,32 @@ export const defaultMongoCollection = 'logs';
  *
  * @example
  * ```
- * import log, { useMongoLogger } from "@egomobile/mongo-log"
+ * import log, { consoleLogger as useConsoleLogger, useFallback, useMongoLogger } from "@egomobile/mongo-log"
  *
- * // add as additional middleware
- * log.use(useMongoLogger())
+ * // reset the logger to configure it from scratch
+ * log.reset()
  *
- * log("foo")  // default: debug
- * log.debug("foo")  // debug
- * log.error("foo")  // error
- * log.warn("foo")  // warning
- * log.info("foo")  // information
- * log.trace("foo")  // trace
+ * // use mongo logger as first middleware and console logger as a fallback
+ * log.use(
+ *   useFallback(
+ *     useMongoLogger(),
+ *     useConsoleLogger()
+ *   )
+ * )
+ *
+ * log("foo") // default: debug
+ * log.debug("foo") // debug
+ * log.error("foo") // error
+ * log.warn("foo") // warning
+ * log.info("foo") // information
+ * log.trace("foo") // trace
  * ```
  *
  * @param {IUseMongoLoggerOptions|MongoLogDatabaseProvider|null|undefined} [optionsOrDatabase] The custom options or the database to use.
  *
- * @returns {LoggerMiddleware} The new middleware.
+ * @returns {AsyncLoggerMiddleware|LoggerMiddleware} The new middleware.
  */
-export function useMongoLogger(optionsOrDatabase?: IUseMongoLoggerOptions | MongoLogDatabaseProvider | null | undefined): LoggerMiddleware {
+export function useMongoLogger(optionsOrDatabase?: IUseMongoLoggerOptions | MongoLogDatabaseProvider | null | undefined): AsyncLoggerMiddleware | LoggerMiddleware {
     // setup with defaults
     let collectionProvider: MongoLogCollectionProvider = () => defaultMongoCollection;
     let dbProvider: MongoLogDatabaseProvider = () => MongoDatabase.open();
@@ -91,16 +99,20 @@ export function useMongoLogger(optionsOrDatabase?: IUseMongoLoggerOptions | Mong
         }
     }
 
-    return (type, args) => {
-        (async () => {
-            const time = new Date();
+    return (type: LogType, args: any[], done?: NextFunction) => {
+        const time = new Date();
 
-            const context: IMongoLogContext = {
-                args,
-                time,
-                type
-            };
+        if (!done) {
+            done = () => { };
+        }
 
+        const context: IMongoLogContext = {
+            args,
+            time,
+            type
+        };
+
+        (async () => {
             // collect all data for the collection
             const connection = await Promise.resolve(dbProvider(context));
             const collectionName = await Promise.resolve(collectionProvider(context));
@@ -111,7 +123,11 @@ export function useMongoLogger(optionsOrDatabase?: IUseMongoLoggerOptions | Mong
 
                 await collection.insertOne(document);
             });
-        })();
+        })().then(() => {
+            done!();
+        }).catch(error => {
+            done!(error);
+        });
     };
 }