set logger default type and add pino integration test (#103)

Author: copperlight

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nflx-spectator",
-  "version": "3.0.11",
+  "version": "3.0.12",
   "license": "Apache-2.0",
   "homepage": "https://github.com/Netflix/spectator-js",
   "author": "Netflix Telemetry Engineering <netflix-atlas@googlegroups.com>",
@@ -40,6 +40,8 @@
     "chai": "^5.2.0",
     "eslint": "^9.22.0",
     "mocha": "^10.8.2",
+    "pino": "^8.8.0",
+    "pino-test": "^1.1.0",
     "ts-node": "^10.9.2",
     "tsx": "^4.19.3",
     "typescript": "^5.8.2"

src/config.ts

@@ -39,9 +39,9 @@ export class Config {
 
     location: string;
     extra_common_tags: Tags;
-    logger: Logger<string>;
+    logger: Logger;
 
-    constructor(location: string = "udp", extra_common_tags: Tags = {}, logger: Logger<string> = get_logger()) {
+    constructor(location: string = "udp", extra_common_tags: Tags = {}, logger: Logger = get_logger()) {
         this.location = this.calculate_location(location);
         this.extra_common_tags = this.calculate_extra_common_tags(extra_common_tags);
         this.logger = logger;

src/logger/logger.ts

@@ -7,25 +7,25 @@ const levels: Record<string, number> = {
     fatal: 60
 };
 
-export type Logger<T extends string | number | symbol> = {
-    trace: (message: T) => void;
-    debug: (message: T) => void;
-    info: (message: T) => void;
-    warn: (message: T) => void;
-    error: (message: T) => void;
-    fatal: (message: T) => void;
+export type Logger<T extends string | never = string> = {
+    trace: (message: string) => void;
+    debug: (message: string) => void;
+    info: (message: string) => void;
+    warn: (message: string) => void;
+    error: (message: string) => void;
+    fatal: (message: string) => void;
     [key: string]: (message: T) => void;
 };
 
-export function get_logger(level_name?: string): Logger<string> {
+export function get_logger(level_name?: string): Logger {
     let level_filter: number;
     if (level_name == undefined || !(level_name in levels)) {
         level_filter = levels.info;
     } else {
         level_filter = levels[level_name];
     }
 
-    const logger: Logger<string> = {
+    const logger: Logger = {
         is_level_enabled: (name: string) => levels[name] >= level_filter,
         trace: function (): void {
             throw new Error("Function not implemented.");

src/meter/id.ts

@@ -25,12 +25,12 @@ export class Id {
 
     private INVALID_CHARS: RegExp = new RegExp(/[^-._A-Za-z0-9~^]/g);
 
-    private readonly _logger: Logger<string>;
+    private readonly _logger: Logger;
     private readonly _name: string;
     private readonly _tags: Tags;
     public spectatord_id: string;
 
-    constructor(name: string, tags?: Tags, logger?: Logger<string>) {
+    constructor(name: string, tags?: Tags, logger?: Logger) {
         // initialization order in this constructor matters, for logging and testing purposes
         if (logger == undefined) {
             this._logger = get_logger();

src/registry.ts

@@ -20,7 +20,7 @@ export class Registry {
      * Registry is the main entry point for interacting with the Spectator library.
      */
 
-    public logger: Logger<string>;
+    public logger: Logger;
 
     private _config: Config;
     private readonly _writer: WriterUnion;

src/writer/file_writer.ts

@@ -10,7 +10,7 @@ export class FileWriter extends Writer {
 
     private readonly _location: string;
 
-    constructor(location: string, logger: Logger<string> = get_logger()) {
+    constructor(location: string, logger: Logger = get_logger()) {
         super(logger);
         // convert from URL string to PathLike string
         this._location = fileURLToPath(location);

src/writer/memory_writer.ts

@@ -13,7 +13,7 @@ export class MemoryWriter extends Writer {
 
     private _messages: string[];
 
-    constructor(logger: Logger<string> = get_logger()) {
+    constructor(logger: Logger = get_logger()) {
         super(logger);
         this._logger.debug("initialize MemoryWriter");
         this._messages = [];

src/writer/new_writer.ts

@@ -15,7 +15,7 @@ export function is_valid_output_location(location: string): boolean {
         location.startsWith("udp://");
 }
 
-export function new_writer(location: string, logger?: Logger<string>): WriterUnion {
+export function new_writer(location: string, logger?: Logger): WriterUnion {
     /**
      * Create a new Writer based on an output location.
      */

src/writer/noop_writer.ts

@@ -6,7 +6,7 @@ export class NoopWriter extends Writer {
      * Writer that does nothing. Used to disable output.
      */
 
-    constructor(logger: Logger<string> = get_logger()) {
+    constructor(logger: Logger = get_logger()) {
         super(logger);
         this._logger.debug("initialize NoopWriter");
     }

src/writer/stderr_writer.ts

@@ -6,7 +6,7 @@ export class StderrWriter extends Writer {
      * Writer that outputs data to stderr.
      */
 
-    constructor(logger: Logger<string> = get_logger()) {
+    constructor(logger: Logger = get_logger()) {
         super(logger);
         this._logger.debug("initialize StderrWriter");
     }