Issue #80: Make LogId a string

This is easier to make proper identifiers for every type of logging provider.

Author: mreuvers

core/src/typescript/main/core/api/LogId.ts

@@ -0,0 +1 @@
+export type LogId = string;

core/src/typescript/main/core/api/Logger.ts

@@ -10,14 +10,16 @@ import {ArgumentsType} from "./type/ArgumentsType";
 export interface Logger {
 
   /**
+   * Id by which this logger is identified (not relevant for an end user).
+   */
+  readonly id: LogId;
+
    * Returns current log level of this Logger instance.
    */
   readonly logLevel: LogLevel;
 
   /**
-   * Number by which this logger is identified (not relevant for an end user).
    */
-  readonly id: number;
 
   trace(message: LogMessageType, args?: ArgumentsType): void;
 

core/src/typescript/main/core/api/runtime/LogRuntime.ts

@@ -11,7 +11,7 @@ import {LogProvider} from "../LogProvider";
  * Represents runtime settings that are created for a {@link LogProvider} instance.
  */
 export interface LogRuntime {
-  readonly id: number;
+  readonly id: LogId;
   readonly name: LoggerNameType;
   readonly level: LogLevel;
   readonly channel: LogChannel | RawLogChannel;

core/src/typescript/main/core/impl/LoggerImpl.ts

@@ -18,12 +18,14 @@ export class LoggerImpl implements Logger {
     this._runtime = runtime;
   }
 
+  public get id() {
+    return this._runtime.id;
+  }
+
   public get logLevel() {
     return this._runtime.level;
   }
 
-  public get id() {
-    return this._runtime.id;
   }
 
   public trace(message: LogMessageType, exceptionOrArgs?: ExceptionType | ArgumentsType, args?: ArgumentsType): void {

core/src/typescript/main/core/index.ts

@@ -9,6 +9,7 @@ import {LogChannel} from "./api/LogChannel";
 /* Export the API */
 export {LogChannel} from "./api/LogChannel";
 export {Logger} from "./api/Logger";
+export {LogId} from "./api/LogId";
 export {LogLevel} from "./api/LogLevel";
 export {LogMessage} from "./api/LogMessage";
 export {LogProvider} from "./api/LogProvider";

core/src/typescript/test/TestCoreLogger.spec.ts

@@ -4,7 +4,7 @@ import {ArrayLogChannel, ArrayRawLogChannel} from "./TestClasses";
 
 describe("Test core logger", () => {
 
-  test ("Test logger level", () => {
+  test("Test logger level", () => {
     assertLogLevels(LogLevel.Trace);
     assertLogLevels(LogLevel.Debug);
     assertLogLevels(LogLevel.Info);
@@ -13,11 +13,12 @@ describe("Test core logger", () => {
     assertLogLevels(LogLevel.Fatal);
   });
 
-  test ("Test formatting", () => {
+  test("Test formatting", () => {
     const channel = new ArrayRawLogChannel();
     const log = new LoggerImpl({
       level: LogLevel.Debug,
-      id: 1, channel,
+      id: "A",
+      channel,
       name: "Main",
       dateFormatter: millis => formatDate(millis),
       argumentFormatter: arg => formatArgument(arg),
@@ -40,11 +41,11 @@ describe("Test core logger", () => {
     // Formatting with too many args, unused args are ignored.
     log.debug(fmt => fmt("Dance: {}", ["Friend", "Foe"]));
 
-    expect(channel.messages).toEqual(["Hello", "Dance1",  "Hello 2!", `Dance: '2'`, `Dance: '1000' and '2000'`, "Dance: {}", "Dance: {} and {}", `Dance: 'Friend'`]);
+    expect(channel.messages).toEqual(["Hello", "Dance1", "Hello 2!", `Dance: '2'`, `Dance: '1000' and '2000'`, "Dance: {}", "Dance: {} and {}", `Dance: 'Friend'`]);
     expect(channel.errors).toEqual([undefined, new Error("X"), undefined, undefined, undefined, undefined, new Error("y"), undefined]);
   });
 
-  test ("Test arguments formatting",() => {
+  test("Test arguments formatting", () => {
     const [log, channel] = createDefaultLogger(LogLevel.Debug);
 
     log.debug("Hello!", ["A"]);
@@ -60,7 +61,7 @@ describe("Test core logger", () => {
   });
 
   function assertLogLevels(logLevel: LogLevel) {
-    const input = ["trace","debug","info","warn","error","fatal"];
+    const input = ["trace", "debug", "info", "warn", "error", "fatal"];
     const [log, channel] = createDefaultLogger(logLevel);
     log.trace(input[0]);
     log.debug(input[1]);
@@ -79,7 +80,7 @@ function createDefaultLogger(level: LogLevel): [logger: LoggerImpl, channel: Arr
   const channel = new ArrayLogChannel();
   return [new LoggerImpl({
     level,
-    id: 1,
+    id: "B",
     channel,
     name: "Main",
     dateFormatter: _ => "XXX",