refactor: rename ApiTransport to ApiLogsTransport

Author: MartinKolarik

src/lib/api-transport.ts renamed to src/lib/api-logs-transport.ts

@@ -17,7 +17,7 @@ type Info = {
 	scope: string;
 };
 
-class ApiTransport extends Transport {
+class ApiLogsTransport extends Transport {
 	private logger: Logger | undefined;
 	private socket: Socket | undefined;
 	private isActive: boolean;
@@ -119,4 +119,4 @@ class ApiTransport extends Transport {
 	}
 }
 
-export default ApiTransport;
+export default ApiLogsTransport;

src/lib/logger.ts

@@ -2,9 +2,9 @@
 import process from 'node:process';
 import { inspect } from 'node:util';
 import * as winston from 'winston';
-import ApiTransport from './api-transport.js';
+import ApiLogsTransport from './api-logs-transport.js';
 
-export const apiTransport = new ApiTransport();
+export const apiLogsTransport = new ApiLogsTransport();
 
 const objectFormatter = (object: Record<string, any>) => {
 	const entries = Object.entries(object).map(([ key, value ]) => {
@@ -43,10 +43,10 @@ const logger = winston.createLogger({
 	),
 	transports: [
 		new winston.transports.Console(),
-		apiTransport,
+		apiLogsTransport,
 	],
 });
 
 export const scopedLogger = (scope: string): winston.Logger => logger.child({ scope });
 
-apiTransport.setLogger(scopedLogger('api-transport'));
+apiLogsTransport.setLogger(scopedLogger('api-logs-transport'));

src/probe.ts

@@ -10,8 +10,8 @@ import physicalCpuCount from 'physical-cpu-count';
 import { getFakeIp } from './lib/fake-ip.js';
 import type { CommandInterface, MeasurementRequest } from './types.js';
 import { loadAll as loadAllDeps } from './lib/dependencies.js';
-import { apiTransport, scopedLogger } from './lib/logger.js';
-import { ApiTransportSettings } from './lib/api-transport.js';
+import { apiLogsTransport, scopedLogger } from './lib/logger.js';
+import { ApiTransportSettings } from './lib/api-logs-transport.js';
 import { initErrorHandler } from './helper/api-error-handler.js';
 import { handleTestError } from './helper/test-error-handler.js';
 import { apiConnectLocationHandler } from './helper/api-connect-handler.js';
@@ -104,7 +104,7 @@ function connect (workerId?: number) {
 	});
 
 	runStatsAgent(socket, worker);
-	apiTransport.setSocket(socket);
+	apiLogsTransport.setSocket(socket);
 
 	const statusManager = initStatusManager(socket, pingCmd);
 	const errorHandler = initErrorHandler(socket);
@@ -154,7 +154,7 @@ function connect (workerId?: number) {
 			});
 		})
 		.on('probe:adoption:code', logAdoptionCode)
-		.on('api:logging:set', (data: ApiTransportSettings) => apiTransport.updateSettings(data));
+		.on('api:logging:set', (data: ApiTransportSettings) => apiLogsTransport.updateSettings(data));
 
 	process.on('SIGTERM', () => {
 		logger.debug('SIGTERM received.');

test/unit/lib/api-transport.test.ts

@@ -1,11 +1,11 @@
 import { expect } from 'chai';
 import * as sinon from 'sinon';
 import * as winston from 'winston';
-import ApiTransport, { type ApiTransportOptions } from '../../../src/lib/api-transport.js';
+import ApiLogsTransport, { type ApiTransportOptions } from '../../../src/lib/api-logs-transport.js';
 import { Socket } from 'socket.io-client';
 import { useSandboxWithFakeTimers } from '../../utils.js';
 
-describe('ApiTransport', () => {
+describe('ApiLogsTransport', () => {
 	let sandbox: sinon.SinonSandbox;
 	let socket: sinon.SinonStubbedInstance<Socket>;
 	const ACK_DELAY = 50;
@@ -19,7 +19,7 @@ describe('ApiTransport', () => {
 	};
 
 	const createTransportAndLogger = (options: ApiTransportOptions) => {
-		const transport = new ApiTransport({ ...options, socket });
+		const transport = new ApiLogsTransport({ ...options, socket });
 		const logger = winston.createLogger({ transports: [ transport ] });
 
 		return { transport, logger };
@@ -38,7 +38,7 @@ describe('ApiTransport', () => {
 
 	describe('constructor', () => {
 		it('should set default options if none are provided', () => {
-			const transport = new ApiTransport();
+			const transport = new ApiLogsTransport();
 			const { sendingEnabled, bufferSize, sendInterval } = transport.getCurrentSettings();
 
 			expect(sendingEnabled).to.be.false;
@@ -52,7 +52,7 @@ describe('ApiTransport', () => {
 				bufferSize: 50,
 				sendInterval: 5000,
 			};
-			const transport = new ApiTransport(options);
+			const transport = new ApiLogsTransport(options);
 			const { sendingEnabled, bufferSize, sendInterval } = transport.getCurrentSettings();
 
 			expect(sendingEnabled).to.be.true;
@@ -286,7 +286,7 @@ describe('ApiTransport', () => {
 		});
 
 		it('should only update provided settings', () => {
-			const transport = new ApiTransport({ sendingEnabled: false, maxBufferSize: 100, sendInterval: 10000 });
+			const transport = new ApiLogsTransport({ sendingEnabled: false, maxBufferSize: 100, sendInterval: 10000 });
 
 			transport.updateSettings({ sendingEnabled: true });
 			const { sendingEnabled, bufferSize, sendInterval } = transport.getCurrentSettings();