feat: require log levels in driver config (#36)

* feat: require log levels in driver config

* fix: correct HTTP driver config in app

* feat: add HTTP driver options

* feat: remove named type

* docs: add inline docs to HttpDriverModule

* test: cover HttpDriverModule.withOptions

apps/lumberjack-app/src/app/app.component.spec.ts

@@ -1,7 +1,7 @@
 import { HttpClientTestingModule } from '@angular/common/http/testing';
 import { createComponentFactory, Spectator } from '@ngneat/spectator';
 
-import { LumberjackModule } from '@ngworker/lumberjack';
+import { LumberjackLogLevel, LumberjackModule } from '@ngworker/lumberjack';
 import { ConsoleDriverModule } from '@ngworker/lumberjack/console-driver';
 import { HttpDriverModule } from '@ngworker/lumberjack/http-driver';
 
@@ -15,7 +15,12 @@ describe('AppComponent', () => {
       HttpClientTestingModule,
       LumberjackModule.forRoot(),
       ConsoleDriverModule.forRoot(),
-      HttpDriverModule.forRoot({ logWagonSize: 5, origin: 'ForestAPP', storeUrl: '/api/logs' }),
+      HttpDriverModule.forRoot({
+        levels: [LumberjackLogLevel.Error],
+        logWagonSize: 5,
+        origin: 'ForestAPP',
+        storeUrl: '/api/logs',
+      }),
     ],
   });
 

apps/lumberjack-app/src/app/app.module.ts

@@ -2,7 +2,7 @@ import { HttpClientModule } from '@angular/common/http';
 import { NgModule } from '@angular/core';
 import { BrowserModule } from '@angular/platform-browser';
 
-import { LumberjackModule } from '@ngworker/lumberjack';
+import { LumberjackLogLevel, LumberjackModule } from '@ngworker/lumberjack';
 import { ConsoleDriverModule } from '@ngworker/lumberjack/console-driver';
 import { HttpDriverModule } from '@ngworker/lumberjack/http-driver';
 
@@ -16,6 +16,7 @@ import { AppComponent } from './app.component';
     LumberjackModule.forRoot(),
     ConsoleDriverModule.forRoot(),
     HttpDriverModule.forRoot({
+      levels: [LumberjackLogLevel.Error],
       origin: 'ForestApp',
       storeUrl: '/api/logs',
       logWagonSize: 2,

libs/ngworker/lumberjack/http-driver/src/index.ts

@@ -3,6 +3,7 @@
  */
 
 export * from './lib/http-driver-config.token';
+export * from './lib/http-driver-options';
 export * from './lib/http-driver-root.module';
 export * from './lib/http-driver.module';
 export * from './lib/http.driver';

libs/ngworker/lumberjack/http-driver/src/lib/http-driver-options.ts

@@ -0,0 +1,5 @@
+import { LogDriverConfig } from '@ngworker/lumberjack';
+
+import { HttpDriverConfig } from './http-driver-config.token';
+
+export type HttpDriverOptions = Omit<HttpDriverConfig, keyof LogDriverConfig>;

libs/ngworker/lumberjack/http-driver/src/lib/http-driver.module.spec.ts

@@ -11,6 +11,7 @@ import {
 } from '@ngworker/lumberjack';
 
 import { HttpDriverConfig } from './http-driver-config.token';
+import { HttpDriverOptions } from './http-driver-options';
 import { HttpDriverModule } from './http-driver.module';
 import { HttpDriver } from './http.driver';
 
@@ -21,7 +22,7 @@ const createHttpDriver = (
   }: {
     config: HttpDriverConfig;
     isLumberjackModuleImportedFirst?: boolean;
-  } = { config: { storeUrl: 'api/json', logWagonSize: 1, origin: 'TEST_MODULE' } }
+  } = { config: { levels: [LumberjackLogLevel.Verbose], storeUrl: 'api/json', logWagonSize: 1, origin: 'TEST_MODULE' } }
 ) => {
   TestBed.configureTestingModule({
     imports: [
@@ -36,14 +37,36 @@ const createHttpDriver = (
 
   return httpDriver;
 };
+const createHttpDriverWithOptions = (
+  {
+    isLumberjackModuleImportedFirst = true,
+    options,
+  }: {
+    isLumberjackModuleImportedFirst?: boolean;
+    options: HttpDriverOptions;
+  } = { options: { storeUrl: 'api/json', logWagonSize: 1, origin: 'TEST_MODULE' } }
+) => {
+  TestBed.configureTestingModule({
+    imports: [
+      HttpClientTestingModule,
+      isLumberjackModuleImportedFirst ? LumberjackModule.forRoot() : [],
+      HttpDriverModule.withOptions(options),
+      isLumberjackModuleImportedFirst ? [] : LumberjackModule.forRoot(),
+    ],
+  });
+
+  const [httpDriver] = (resolveDependency(LogDriverToken) as unknown) as LogDriver[];
+
+  return httpDriver;
+};
 
 describe(HttpDriverModule.name, () => {
   it(`cannot be imported without using the ${HttpDriverModule.forRoot.name} method`, () => {
     expectNgModuleToBeGuarded(HttpDriverModule);
   });
 
   describe(HttpDriverModule.forRoot.name, () => {
-    it('provides the http driver', () => {
+    it('provides the HTTP driver', () => {
       const httpDriver = createHttpDriver();
 
       expect(httpDriver).toBeInstanceOf(HttpDriver);
@@ -65,6 +88,7 @@ describe(HttpDriverModule.name, () => {
 
     it('registers a default level configuration if none is specified', () => {
       const customHttpConfig: HttpDriverConfig = {
+        levels: [LumberjackLogLevel.Verbose],
         storeUrl: 'api/logstore',
         origin: 'TEST_MODULE',
         logWagonSize: 5,
@@ -94,4 +118,64 @@ describe(HttpDriverModule.name, () => {
       expect(actualConfig).toEqual(expectedConfig);
     });
   });
+
+  describe(HttpDriverModule.withOptions.name, () => {
+    it('provides the HTTP driver', () => {
+      const httpDriver = createHttpDriverWithOptions();
+
+      expect(httpDriver).toBeInstanceOf(HttpDriver);
+    });
+
+    it('registers the specified options', () => {
+      const options: HttpDriverOptions = {
+        storeUrl: 'api/logstore',
+        origin: 'TEST_MODULE',
+        logWagonSize: 5,
+      };
+
+      const httpDriver = createHttpDriverWithOptions({ options });
+
+      const actualConfig = httpDriver.config;
+      const expectedConfig: HttpDriverConfig = {
+        ...options,
+        // tslint:disable-next-line: no-any
+        levels: jasmine.any(Array) as any,
+      };
+      expect(actualConfig).toEqual(expectedConfig);
+    });
+
+    it('gets common options from the log driver config', () => {
+      const options: HttpDriverOptions = {
+        storeUrl: 'api/logstore',
+        origin: 'TEST_MODULE',
+        logWagonSize: 5,
+      };
+
+      const httpDriver = createHttpDriverWithOptions({ options });
+
+      const { levels } = httpDriver.config;
+      expect(levels).toEqual([LumberjackLogLevel.Verbose]);
+    });
+
+    it('does register the specified log driver configuration when the lumberjack module is imported after the http driver module', () => {
+      const options: HttpDriverOptions = {
+        storeUrl: 'api/logstore',
+        origin: 'TEST_MODULE',
+        logWagonSize: 5,
+      };
+
+      const httpDriver = createHttpDriverWithOptions({
+        options,
+        isLumberjackModuleImportedFirst: false,
+      });
+
+      const actualConfig = httpDriver.config;
+      const expectedConfig: HttpDriverConfig = {
+        ...options,
+        // tslint:disable-next-line: no-any
+        levels: jasmine.any(Array) as any,
+      };
+      expect(actualConfig).toEqual(expectedConfig);
+    });
+  });
 });

libs/ngworker/lumberjack/http-driver/src/lib/http-driver.module.ts

@@ -1,10 +1,14 @@
 import { ModuleWithProviders, NgModule } from '@angular/core';
 
 import { HttpDriverConfig, HttpDriverConfigToken } from './http-driver-config.token';
+import { HttpDriverOptions } from './http-driver-options';
 import { HttpDriverRootModule } from './http-driver-root.module';
 
 @NgModule()
 export class HttpDriverModule {
+  /**
+   * Pass a full HTTP driver configuration.
+   */
   static forRoot(config: HttpDriverConfig): ModuleWithProviders<HttpDriverRootModule> {
     return {
       ngModule: HttpDriverRootModule,
@@ -17,6 +21,22 @@ export class HttpDriverModule {
     };
   }
 
+  /**
+   * Pass options exclusive to the HTTP driver configuration, but fall back on
+   * the log driver config for common options.
+   */
+  static withOptions(options: HttpDriverOptions): ModuleWithProviders<HttpDriverRootModule> {
+    return {
+      ngModule: HttpDriverRootModule,
+      providers: [
+        {
+          provide: HttpDriverConfigToken,
+          useValue: options,
+        },
+      ],
+    };
+  }
+
   constructor() {
     throw new Error('Do not import HttpDriverModule directly. Use HttpDriverModule.forRoot.');
   }

libs/ngworker/lumberjack/src/lib/configs/log-driver.config.ts

@@ -11,9 +11,9 @@ export interface LogDriverConfig {
    * If undefined or [LumberjackLogLevel.Verbose] all levels are allowed.
    *
    */
-  levels?: LumberjackLogEntryLevel[] | [LumberjackLogLevel.Verbose];
+  readonly levels: ReadonlyArray<LumberjackLogEntryLevel> | [LumberjackLogLevel.Verbose];
 }
 
-export const defaultLogDriverConfig = {
-  levels: undefined,
+export const defaultLogDriverConfig: LogDriverConfig = {
+  levels: [LumberjackLogLevel.Verbose],
 };