wip

Author: vdiez

packages/shared/src/helpers/progress-report.ts

@@ -17,21 +17,17 @@
 import { info } from './logging.js';
 
 /**
- * Logs the current file being analyzed every N seconds
- *
- * @param interval the interval between two logs, in milliseconds
+ * Logs the current file being analyzed every 10 seconds
  */
 
 export class ProgressReport {
-  private currentFileNumber = 0;
+  private counter = 0;
   private currentFilename = '';
+  private readonly interval = 10_000;
   private intervalId: NodeJS.Timeout | undefined = undefined;
 
-  constructor(
-    private readonly count: number,
-    private readonly interval: number = 10_000,
-  ) {
-    info(`${this.count} source ${this.pluralizeFile(this.count)} to be analyzed.`);
+  constructor(private readonly total: number) {
+    info(`${this.total} source ${this.pluralizeFile(this.total)} to be analyzed`);
   }
 
   pluralizeFile(count: number) {
@@ -41,13 +37,13 @@ export class ProgressReport {
   start() {
     this.intervalId = setInterval(() => {
       info(
-        `${this.currentFileNumber}/${this.count} ${this.pluralizeFile(this.currentFileNumber)} analyzed, current file: ${this.currentFilename}`,
+        `${this.counter}/${this.total} ${this.pluralizeFile(this.counter)} analyzed, current file: ${this.currentFilename}`,
       );
     }, this.interval);
   }
 
   nextFile(currentFilename: string) {
-    this.currentFileNumber++;
+    this.counter++;
     this.currentFilename = currentFilename;
     if (!this.intervalId) {
       this.start();
@@ -57,11 +53,7 @@ export class ProgressReport {
   stop() {
     clearInterval(this.intervalId);
     info(
-      `${this.count}/${this.count} source ${this.pluralizeFile(this.count)} ${this.count === 1 ? 'has' : 'have'} been analyzed.`,
+      `${this.total}/${this.total} source ${this.pluralizeFile(this.total)} ${this.total === 1 ? 'has' : 'have'} been analyzed`,
     );
   }
-
-  cancel() {
-    clearInterval(this.intervalId);
-  }
 }

packages/shared/tests/helpers/progress-report.test.ts

@@ -0,0 +1,54 @@
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2025 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+import { describe, it, type Mock } from 'node:test';
+import { ProgressReport } from '../../src/helpers/progress-report.js';
+import { expect } from 'expect';
+
+describe('progress-report', () => {
+  it('should report progress', async ({ mock }) => {
+    mock.timers.enable({ apis: ['setInterval'] });
+    mock.method(console, 'log');
+    const progressReport = new ProgressReport(5);
+    const consoleLogMock = (console.log as Mock<typeof console.log>).mock;
+    expect(consoleLogMock.calls[0].arguments[0]).toEqual(`5 source files to be analyzed`);
+    expect(consoleLogMock.callCount()).toEqual(1);
+    // we pass next file
+    progressReport.nextFile('file1.ts');
+    // passing next file should not trigger a console.log
+    expect(consoleLogMock.callCount()).toEqual(1);
+
+    // after 10 seconds have passed, there is a new log
+    mock.timers.tick(10000);
+    expect(consoleLogMock.calls[1].arguments[0]).toEqual(
+      `1/5 file analyzed, current file: file1.ts`,
+    );
+    expect(consoleLogMock.callCount()).toEqual(2);
+
+    // another 10 seconds, we should log next file
+    mock.timers.tick(10000);
+    expect(consoleLogMock.calls[2].arguments[0]).toEqual(
+      `1/5 file analyzed, current file: file1.ts`,
+    );
+    expect(consoleLogMock.callCount()).toEqual(3);
+
+    progressReport.stop();
+    // another 10 seconds, nothing else has been logged because we have stopped the reporter
+    mock.timers.tick(10000);
+    expect(consoleLogMock.calls[3].arguments[0]).toEqual(`5/5 source files have been analyzed`);
+    expect(consoleLogMock.callCount()).toEqual(4);
+  });
+});