Enhancement in telemetry preferences flow and some telemetry maintenance changes

vscode/esbuild.js

@@ -57,6 +57,9 @@ const createTelemetryConfig = () => {
       baseUrl: null,
       baseEndpoint: "/vscode/java/sendTelemetry",
       version: "/v1"
+    },
+    metadata: {
+      consentSchemaVersion: "v1"
     }
   }
 
@@ -73,6 +76,9 @@ const createTelemetryConfig = () => {
       baseUrl: process.env.TELEMETRY_API_BASE_URL,
       baseEndpoint: process.env.TELEMETRY_API_ENDPOINT,
       version: process.env.TELEMETRY_API_VERSION
+    }, 
+    metadata: {
+      consentSchemaVersion: process.env.CONSENT_SCHEMA_VERSION
     }
   });
 

vscode/package.json

@@ -245,7 +245,10 @@
 				"jdk.telemetry.enabled": {
 					"type": "boolean",
 					"description": "%jdk.configuration.telemetry.enabled.description%",
-					"default": false
+					"default": false,
+					"tags": [
+           		 		"telemetry"
+          			]
 				}
 			}
 		},

vscode/src/telemetry/config.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -13,7 +13,7 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 */
-import { RetryConfig, TelemetryApi } from "./types";
+import { RetryConfig, TelemetryApi, TelemetryConfigMetadata } from "./types";
 import * as path from 'path';
 import * as fs from 'fs';
 import { LOGGER } from "../logger";
@@ -24,6 +24,7 @@ export class TelemetryConfiguration {
   private static instance: TelemetryConfiguration;
   private retryConfig!: RetryConfig;
   private apiConfig!: TelemetryApi;
+  private metadata!: TelemetryConfigMetadata;
 
   public constructor() {
     this.initialize();
@@ -54,6 +55,11 @@ export class TelemetryConfiguration {
         baseEndpoint: config.telemetryApi.baseEndpoint,
         version: config.telemetryApi.version
       });
+
+      this.metadata = Object.freeze({
+        consentSchemaVersion: config.metadata.consentSchemaVersion
+      });
+
     } catch (error: any) {
       LOGGER.error("Error occurred while setting up telemetry config");
       LOGGER.error(error.message);
@@ -68,4 +74,7 @@ export class TelemetryConfiguration {
     return this.apiConfig;
   }
 
+  public getTelemetryConfigMetadata(): Readonly<TelemetryConfigMetadata> {
+    return this.metadata;
+  }
 }

vscode/src/telemetry/constants.ts

@@ -0,0 +1,18 @@
+/*
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+   https://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+export const TELEMETRY_CONSENT_VERSION_SCHEMA_KEY = "telemetryConsentSchemaVersion";
+export const TELEMETRY_CONSENT_RESPONSE_TIME_KEY = "telemetryConsentResponseTime";
+export const TELEMETRY_SETTING_VALUE_KEY = "telemetrySettingValue";

vscode/src/telemetry/events/baseEvent.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -42,7 +42,7 @@ export abstract class BaseEvent<T> {
     get getPayload(): T & BaseEventPayload {
         return this._payload;
     }
-    
+
     get getData(): T {
         return this._data;
     }
@@ -58,8 +58,8 @@ export abstract class BaseEvent<T> {
     protected addEventToCache = (): void => {
         const dataString = JSON.stringify(this.getData);
         const calculatedHashVal = getHashCode(dataString);
-        const isAdded = cacheService.put(this.NAME, calculatedHashVal);
-
-        LOGGER.debug(`${this.NAME} added in cache ${isAdded ? "Successfully" : "Unsucessfully"}`);
+        cacheService.put(this.NAME, calculatedHashVal).then((isAdded: boolean) => {
+            LOGGER.debug(`${this.NAME} added in cache ${isAdded ? "Successfully" : "Unsucessfully"}`);
+        });
     }
 }

vscode/src/telemetry/events/close.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

vscode/src/telemetry/events/jdkDownload.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

vscode/src/telemetry/events/jdkFeature.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

vscode/src/telemetry/events/start.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

vscode/src/telemetry/events/workspaceChange.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

vscode/src/telemetry/impl/AnonymousIdManager.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

vscode/src/telemetry/impl/cacheServiceImpl.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -28,10 +28,11 @@ class CacheServiceImpl implements CacheService {
         }
     }
 
-    public put = (key: string, value: string): boolean => {
+    public put = async (key: string, value: string): Promise<boolean> => {
         try {
             const vscGlobalState = globalState.getExtensionContextInfo().getVscGlobalState();
-            vscGlobalState.update(key, value);
+            await vscGlobalState.update(key, value);
+            LOGGER.debug(`Updating key: ${key} to ${value}`);
             return true;
         } catch (err) {
             LOGGER.error(`Error while storing ${key} in cache: ${(err as Error).message}`);

vscode/src/telemetry/impl/enviromentDetails.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

vscode/src/telemetry/impl/postTelemetry.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

vscode/src/telemetry/impl/telemetryEventQueue.ts

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2024, Oracle and/or its affiliates.
+  Copyright (c) 2024-2025, Oracle and/or its affiliates.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -13,9 +13,10 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 */
+import { LOGGER } from "../../logger";
 import { BaseEvent } from "../events/baseEvent";
 
-export class TelemetryEventQueue { 
+export class TelemetryEventQueue {
   private events: BaseEvent<any>[] = [];
 
   public enqueue = (e: BaseEvent<any>): void => {
@@ -35,4 +36,26 @@ export class TelemetryEventQueue {
     this.events = [];
     return queue;
   }
+
+  public adjustQueueSize = (maxNumOfEventsToRetain: number) => {
+    const excess = this.size() - maxNumOfEventsToRetain;
+
+    if (excess > 0) {
+      LOGGER.debug('Decreasing size of the queue as max capacity reached');
+
+      const seen = new Set<string>();
+      const deduplicated = [];
+
+      for (let i = 0; i < excess; i++) {
+        const event = this.events[i];
+        if (!seen.has(event.NAME)) {
+          deduplicated.push(event);
+          seen.add(event.NAME);
+        }
+      }
+
+      this.events = [...deduplicated, ...this.events.slice(excess)];
+    }
+  }
+
 }