chore: rename

Author: fmenezes

src/telemetry/telemetry.ts

@@ -19,7 +19,7 @@ export const DEVICE_ID_TIMEOUT = 3000;
 export class Telemetry {
     private isBufferingEvents: boolean = true;
     /** Resolves when the device ID is retrieved or timeout occurs */
-    public dataPromise: Promise<[string, boolean]> | undefined;
+    public setupPromise: Promise<[string, boolean]> | undefined;
     private deviceIdAbortController = new AbortController();
     private eventCache: EventCache;
     private getRawMachineId: () => Promise<string>;
@@ -49,7 +49,7 @@ export class Telemetry {
     ): Telemetry {
         const instance = new Telemetry(session, userConfig, commonProperties, { eventCache, getRawMachineId });
 
-        void instance.start();
+        void instance.setup();
         return instance;
     }
 
@@ -76,11 +76,11 @@ export class Telemetry {
         return exists.includes(true);
     }
 
-    private async start(): Promise<void> {
+    private async setup(): Promise<void> {
         if (!this.isTelemetryEnabled()) {
             return;
         }
-        this.dataPromise = Promise.all([
+        this.setupPromise = Promise.all([
             getDeviceId({
                 getMachineId: () => this.getRawMachineId(),
                 onError: (reason, error) => {
@@ -101,7 +101,7 @@ export class Telemetry {
             this.isContainerEnv(),
         ]);
 
-        const [deviceId, containerEnv] = await this.dataPromise;
+        const [deviceId, containerEnv] = await this.setupPromise;
 
         this.commonProperties.device_id = deviceId;
         this.commonProperties.is_container_env = containerEnv;

tests/integration/telemetry.test.ts

@@ -20,7 +20,7 @@ describe("Telemetry", () => {
         expect(telemetry.getCommonProperties().device_id).toBe(undefined);
         expect(telemetry["isBufferingEvents"]).toBe(true);
 
-        await telemetry.dataPromise;
+        await telemetry.setupPromise;
 
         expect(telemetry.getCommonProperties().device_id).toBe(actualHashedId);
         expect(telemetry["isBufferingEvents"]).toBe(false);

tests/unit/telemetry.test.ts

@@ -138,7 +138,7 @@ describe("Telemetry", () => {
             it("should send events successfully", async () => {
                 const testEvent = createTestEvent();
 
-                await telemetry.dataPromise;
+                await telemetry.setupPromise;
 
                 await telemetry.emitEvents([testEvent]);
 
@@ -154,7 +154,7 @@ describe("Telemetry", () => {
 
                 const testEvent = createTestEvent();
 
-                await telemetry.dataPromise;
+                await telemetry.setupPromise;
 
                 await telemetry.emitEvents([testEvent]);
 
@@ -179,7 +179,7 @@ describe("Telemetry", () => {
                 // Set up mock to return cached events
                 mockEventCache.getEvents.mockReturnValueOnce([cachedEvent]);
 
-                await telemetry.dataPromise;
+                await telemetry.setupPromise;
 
                 await telemetry.emitEvents([newEvent]);
 
@@ -191,7 +191,7 @@ describe("Telemetry", () => {
             });
 
             it("should correctly add common properties to events", async () => {
-                await telemetry.dataPromise;
+                await telemetry.setupPromise;
 
                 const commonProps = telemetry.getCommonProperties();
 
@@ -227,7 +227,7 @@ describe("Telemetry", () => {
                     expect(telemetry["isBufferingEvents"]).toBe(true);
                     expect(telemetry.getCommonProperties().device_id).toBe(undefined);
 
-                    await telemetry.dataPromise;
+                    await telemetry.setupPromise;
 
                     expect(telemetry["isBufferingEvents"]).toBe(false);
                     expect(telemetry.getCommonProperties().device_id).toBe(hashedMachineId);
@@ -243,7 +243,7 @@ describe("Telemetry", () => {
                     expect(telemetry["isBufferingEvents"]).toBe(true);
                     expect(telemetry.getCommonProperties().device_id).toBe(undefined);
 
-                    await telemetry.dataPromise;
+                    await telemetry.setupPromise;
 
                     expect(telemetry["isBufferingEvents"]).toBe(false);
                     expect(telemetry.getCommonProperties().device_id).toBe("unknown");
@@ -271,7 +271,7 @@ describe("Telemetry", () => {
 
                     jest.advanceTimersByTime(DEVICE_ID_TIMEOUT);
 
-                    await telemetry.dataPromise;
+                    await telemetry.setupPromise;
 
                     expect(telemetry.getCommonProperties().device_id).toBe("unknown");
                     expect(telemetry["isBufferingEvents"]).toBe(false);