feat(logs): enhance the logs and add a prefix with the issue number (#222)

* feat(logs): enhance the logs and add a prefix with the issue number

* chore: use camelCase for constants

use the new logger for the new code due to the rebase

src/classes/issue-logger.spec.ts

@@ -0,0 +1,78 @@
+import {Issue} from '../IssueProcessor';
+import {IssueLogger} from './issue-logger';
+import * as core from '@actions/core';
+
+describe('IssueLogger', (): void => {
+  let issue: Issue;
+  let issueLogger: IssueLogger;
+
+  beforeEach((): void => {
+    issue = {
+      number: 8
+    } as Issue;
+    issueLogger = new IssueLogger(issue);
+  });
+
+  describe('warning()', (): void => {
+    let message: string;
+
+    let coreWarningSpy: jest.SpyInstance;
+
+    beforeEach((): void => {
+      message = 'dummy-message';
+
+      coreWarningSpy = jest.spyOn(core, 'warning').mockImplementation();
+    });
+
+    it('should log a warning with the given message and with the issue number as prefix', (): void => {
+      expect.assertions(2);
+
+      issueLogger.warning(message);
+
+      expect(coreWarningSpy).toHaveBeenCalledTimes(1);
+      expect(coreWarningSpy).toHaveBeenCalledWith('[#8] dummy-message');
+    });
+  });
+
+  describe('info()', (): void => {
+    let message: string;
+
+    let coreInfoSpy: jest.SpyInstance;
+
+    beforeEach((): void => {
+      message = 'dummy-message';
+
+      coreInfoSpy = jest.spyOn(core, 'info').mockImplementation();
+    });
+
+    it('should log an information with the given message and with the issue number as prefix', (): void => {
+      expect.assertions(2);
+
+      issueLogger.info(message);
+
+      expect(coreInfoSpy).toHaveBeenCalledTimes(1);
+      expect(coreInfoSpy).toHaveBeenCalledWith('[#8] dummy-message');
+    });
+  });
+
+  describe('error()', (): void => {
+    let message: string;
+
+    let coreErrorSpy: jest.SpyInstance;
+
+    beforeEach((): void => {
+      message = 'dummy-message';
+
+      coreErrorSpy = jest.spyOn(core, 'error').mockImplementation();
+    });
+
+    it('should log an error with the given message and with the issue number as prefix', (): void => {
+      expect.assertions(2);
+
+      issueLogger.error(message);
+
+      expect(coreErrorSpy).toHaveBeenCalledTimes(1);
+      expect(coreErrorSpy).toHaveBeenCalledWith('[#8] dummy-message');
+    });
+  });
+});

src/classes/issue-logger.ts

@@ -0,0 +1,31 @@
+import * as core from '@actions/core';
+import {Issue} from '../IssueProcessor';
+import {Logger} from './logger';
+
+export class IssueLogger implements Logger {
+  private readonly _issue: Issue;
+
+  constructor(issue: Readonly<Issue>) {
+    this._issue = issue;
+  }
+
+  warning(message: Readonly<string>): void {
+    core.warning(this._prefixWithIssueNumber(message));
+  }
+
+  info(message: Readonly<string>): void {
+    core.info(this._prefixWithIssueNumber(message));
+  }
+
+  error(message: Readonly<string>): void {
+    core.error(this._prefixWithIssueNumber(message));
+  }
+
+  private _prefixWithIssueNumber(message: Readonly<string>): string {
+    return `[#${this._getIssueNumber()}] ${message}`;
+  }
+
+  private _getIssueNumber(): number {
+    return this._issue.number;
+  }
+}

src/classes/logger.spec.ts

@@ -0,0 +1,73 @@
+import {Logger} from './logger';
+import * as core from '@actions/core';
+
+describe('Logger', (): void => {
+  let logger: Logger;
+
+  beforeEach((): void => {
+    logger = new Logger();
+  });
+
+  describe('warning()', (): void => {
+    let message: string;
+
+    let coreWarningSpy: jest.SpyInstance;
+
+    beforeEach((): void => {
+      message = 'dummy-message';
+
+      coreWarningSpy = jest.spyOn(core, 'warning').mockImplementation();
+    });
+
+    it('should log a warning with the given message', (): void => {
+      expect.assertions(2);
+
+      logger.warning(message);
+
+      expect(coreWarningSpy).toHaveBeenCalledTimes(1);
+      expect(coreWarningSpy).toHaveBeenCalledWith('dummy-message');
+    });
+  });
+
+  describe('info()', (): void => {
+    let message: string;
+
+    let coreInfoSpy: jest.SpyInstance;
+
+    beforeEach((): void => {
+      message = 'dummy-message';
+
+      coreInfoSpy = jest.spyOn(core, 'info').mockImplementation();
+    });
+
+    it('should log an information with the given message', (): void => {
+      expect.assertions(2);
+
+      logger.info(message);
+
+      expect(coreInfoSpy).toHaveBeenCalledTimes(1);
+      expect(coreInfoSpy).toHaveBeenCalledWith('dummy-message');
+    });
+  });
+
+  describe('error()', (): void => {
+    let message: string;
+
+    let coreErrorSpy: jest.SpyInstance;
+
+    beforeEach((): void => {
+      message = 'dummy-message';
+
+      coreErrorSpy = jest.spyOn(core, 'error').mockImplementation();
+    });
+
+    it('should log an error with the given message', (): void => {
+      expect.assertions(2);
+
+      logger.error(message);
+
+      expect(coreErrorSpy).toHaveBeenCalledTimes(1);
+      expect(coreErrorSpy).toHaveBeenCalledWith('dummy-message');
+    });
+  });
+});

src/classes/logger.ts

@@ -0,0 +1,15 @@
+import * as core from '@actions/core';
+
+export class Logger {
+  warning(message: Readonly<string>): void {
+    core.warning(message);
+  }
+
+  info(message: Readonly<string>): void {
+    core.info(message);
+  }
+
+  error(message: Readonly<string>): void {
+    core.error(message);
+  }
+}