feat: Add basic logger (#20)

[yokuze]

Note: both request / access logs: #28 and sampling have been broken out into a separate ticket: #26 to be addressed in a different PR.

[coveralls]

Coverage increased (+0.07%) to 99.196% when pulling ecdccc9 on yokuze:logging_20 into 250c469 on silvermine:master.

[coveralls]

Coverage increased (+0.06%) to 99.265% when pulling 2dca77e on yokuze:logging_20 into a7b2af1 on silvermine:master.

[jthomerson]

indentation

[jthomerson]

a bunch more of these in this file

[yokuze]

🤦‍♂️

[jthomerson]

some double spaces here

[jthomerson]

any reason why export default wasn't just added to the function declaration above?

[yokuze]

Not that I can think of.

[jthomerson]

Pushed these changes (ignoring all space since there were a lot of whitespace fixes):

jrthomer@lappy ~/git-clones/silvermine/lambda-express
[ logging_20 ] $ git diff --ignore-all-space ecdccc9..3bf98ba
diff --git a/src/logging/is-debug-level-or-more-verbose.ts b/src/logging/is-debug-level-or-more-verbose.ts
index 430da74..9c0c20e 100644
--- a/src/logging/is-debug-level-or-more-verbose.ts
+++ b/src/logging/is-debug-level-or-more-verbose.ts
@@ -5,9 +5,7 @@ import levels from './levels';
  * @returns `true` if the given log level is `'debug'` or a more verbose level (e.g.
  * `'trace'`).
  */
-function isDebugLevelOrMoreVerbose(level: LogLevel): boolean {
+export default function isDebugLevelOrMoreVerbose(level: LogLevel): boolean {
    // More verbose levels have lower priority numbers
    return levels[level] <= levels.debug;
 }
-
-export default isDebugLevelOrMoreVerbose;
diff --git a/src/logging/logging-types.ts b/src/logging/logging-types.ts
index d52cbc8..e094b67 100644
--- a/src/logging/logging-types.ts
+++ b/src/logging/logging-types.ts
@@ -127,7 +127,7 @@ export type LogLevels = {
 };
 
 /**
- * Configuration to initialize a Logger with.
+ * Configuration to initialize a `Logger` with.
  */
 export interface LoggerConfig {
 
@@ -193,7 +193,7 @@ export interface DebugLogObject extends LogObject {
    remaining: number;
 
    /**
-    * The Lambda event source type that triggered the current Request.
+    * The Lambda event source type that triggered the current `Request`.
     */
    int: LambdaEventSourceType;

[yokuze]

@jthomerson Here's the diff of the actual changes:

diff --git a/src/Router.ts b/src/Router.ts
index c6c1619..bd32fc8 100644
--- a/src/Router.ts
+++ b/src/Router.ts
@@ -16,6 +16,7 @@ import { RouteMatchingProcessorChain } from './chains/RouteMatchingProcessorChai
 import { MatchAllRequestsProcessorChain } from './chains/MatchAllRequestsProcessorChain';
 import { SubRouterProcessorChain } from './chains/SubRouterProcessorChain';
 import Route from './Route';
+import { Optional } from './utils/common-types';

 const DEFAULT_OPTS: RouterOptions = {
    caseSensitive: false,
@@ -27,7 +28,7 @@ export default class Router implements IRouter {
    public readonly routerOptions: RouterOptions;
    private readonly _processors: IRequestMatchingProcessorChain[] = [];

-   public constructor(options?: RouterOptions) {
+   public constructor(options?: Optional<RouterOptions>) {
       this.routerOptions = _.defaults(options, DEFAULT_OPTS);
    }

diff --git a/src/utils/common-types.ts b/src/utils/common-types.ts
index 4f9c984..ed95855 100644
--- a/src/utils/common-types.ts
+++ b/src/utils/common-types.ts
@@ -6,6 +6,8 @@ export interface StringArrayOfStringsMap { [s: string]: string[] }
 export interface KeyValueStringObject { [k: string]: (string | string[] | KeyValueStringObject) }
 // Removes `readonly` modifier and make all keys writable again
 export type Writable<T> = { -readonly [P in keyof T]-?: T[P] };
+// Makes all keys on an object optional
+export type Optional<T> = { [P in keyof T]? : T[P] };

[yokuze]

@jthomerson if you accept the approach above, I'll open a ticket / PR to add Optional<T> to our toolbox project.

[jthomerson]

I just pushed a change to use Partial instead of our own Optional, ADIRL

jrthomer@lappy ~/git-clones/silvermine/lambda-express
[ logging_20 ] $ git diff
diff --git a/src/Router.ts b/src/Router.ts
index bd32fc8..8bf9848 100644
--- a/src/Router.ts
+++ b/src/Router.ts
@@ -16,7 +16,6 @@ import { RouteMatchingProcessorChain } from './chains/RouteMatchingProcessorChai
 import { MatchAllRequestsProcessorChain } from './chains/MatchAllRequestsProcessorChain';
 import { SubRouterProcessorChain } from './chains/SubRouterProcessorChain';
 import Route from './Route';
-import { Optional } from './utils/common-types';
 
 const DEFAULT_OPTS: RouterOptions = {
    caseSensitive: false,
@@ -28,7 +27,7 @@ export default class Router implements IRouter {
    public readonly routerOptions: RouterOptions;
    private readonly _processors: IRequestMatchingProcessorChain[] = [];
 
-   public constructor(options?: Optional<RouterOptions>) {
+   public constructor(options?: Partial<RouterOptions>) {
       this.routerOptions = _.defaults(options, DEFAULT_OPTS);
    }
 
diff --git a/src/utils/common-types.ts b/src/utils/common-types.ts
index ed95855..4f9c984 100644
--- a/src/utils/common-types.ts
+++ b/src/utils/common-types.ts
@@ -6,8 +6,6 @@ export interface StringArrayOfStringsMap { [s: string]: string[] }
 export interface KeyValueStringObject { [k: string]: (string | string[] | KeyValueStringObject) }
 // Removes `readonly` modifier and make all keys writable again
 export type Writable<T> = { -readonly [P in keyof T]-?: T[P] };
-// Makes all keys on an object optional
-export type Optional<T> = { [P in keyof T]? : T[P] };
 
 export function isStringMap(o: any): o is StringMap {
    if (!_.isObject(o) || _.isArray(o)) { // because arrays are objects