Add HaTS Survey prompt (#2590)

---------

Co-authored-by: Tomasz Naumowicz <tnaumowicz@microsoft.com>

Author: sevoku

package-lock.json

@@ -83,6 +83,7 @@
         "@types/pg": "^8.11.11",
         "@types/react": "^18.3.18",
         "@types/react-dom": "^18.3.5",
+        "@types/semver": "^7.3.12",
         "@types/uuid": "^10.0.0",
         "@types/vscode": "1.90.0",
         "@types/vscode-webview": "^1.57.5",

package.json

@@ -6,10 +6,13 @@
 import { type IActionContext } from '@microsoft/vscode-azext-utils';
 import { AzExtResourceType } from '@microsoft/vscode-azureresources-api';
 import { ViewColumn } from 'vscode';
+import { API } from '../../AzureDBExperiences';
 import { DocumentFileDescriptor } from '../../docdb/fs/DocumentFileDescriptor';
 import { ext } from '../../extensionVariables';
 import { type DocumentDBItemResourceItem } from '../../tree/docdb/DocumentDBItemResourceItem';
 import { pickAppResource } from '../../utils/pickItem/pickAppResource';
+import { countExperienceUsageForSurvey } from '../../utils/survey';
+import { ExperienceKind, UsageImpact } from '../../utils/surveyTypes';
 import { DocumentsViewController } from '../../webviews/mongoClusters/documentView/documentsViewController';
 
 export async function openDocumentDBItem(context: IActionContext, node?: DocumentDBItemResourceItem): Promise<void> {
@@ -30,6 +33,11 @@ export async function openDocumentDBItem(context: IActionContext, node?: Documen
     // Clear un-uploaded local changes to the document before opening https://github.com/microsoft/vscode-cosmosdb/issues/1619
     ext.fileSystem.fireChangedEvent(fsNode);
     await ext.fileSystem.showTextDocument(fsNode);
+
+    const experienceKind = [API.MongoDB, API.MongoClusters].includes(node.experience.api)
+        ? ExperienceKind.Mongo
+        : ExperienceKind.NoSQL;
+    countExperienceUsageForSurvey(experienceKind, UsageImpact.Low);
 }
 
 export function openMongoDocumentView(

src/commands/openDocument/openDocument.ts

@@ -10,6 +10,8 @@ import { DocumentDBHiddenFields } from '../../constants';
 import { type EditableFileSystemItem } from '../../DatabasesFileSystem';
 import { type DocumentDBItemModel } from '../../tree/docdb/models/DocumentDBItemModel';
 import { extractPartitionKey } from '../../utils/document';
+import { promptAfterActionEventually } from '../../utils/survey';
+import { ExperienceKind, UsageImpact } from '../../utils/surveyTypes';
 import { getDocumentTreeItemLabel } from '../../utils/vscodeUtils';
 import { getCosmosClient } from '../getCosmosClient';
 
@@ -74,6 +76,7 @@ export class DocumentFileDescriptor implements EditableFileSystemItem {
 
         if (response.resource) {
             this.model.item = response.resource;
+            void promptAfterActionEventually(ExperienceKind.NoSQL, UsageImpact.Medium, 'writeFile');
         } else {
             throw new Error('Failed to update the document');
         }

src/docdb/fs/DocumentFileDescriptor.ts

@@ -9,6 +9,8 @@ import vscode from 'vscode';
 import { type NoSqlQueryConnection } from '../docdb/NoSqlCodeLensProvider';
 import { DocumentSession } from '../docdb/session/DocumentSession';
 import { type CosmosDbRecordIdentifier } from '../docdb/types/queryResult';
+import { promptAfterActionEventually } from '../utils/survey';
+import { ExperienceKind, UsageImpact } from '../utils/surveyTypes';
 import { BaseTab, type CommandPayload } from './BaseTab';
 
 type DocumentTabMode = 'add' | 'edit' | 'view';
@@ -169,7 +171,8 @@ export class DocumentTab extends BaseTab {
     }
 
     private async saveDocument(documentText: string): Promise<void> {
-        await callWithTelemetryAndErrorHandling('cosmosDB.nosql.document.saveDocument', async (context) => {
+        const callbackId = 'cosmosDB.nosql.document.saveDocument';
+        await callWithTelemetryAndErrorHandling(callbackId, async (context) => {
             const documentContent: JSONValue = JSON.parse(documentText) as JSONValue;
 
             if (!this.isCosmosDbItemDefinition(documentContent)) {
@@ -190,6 +193,7 @@ export class DocumentTab extends BaseTab {
 
             this.panel.title = `${this.documentId.id}.json`;
         });
+        void promptAfterActionEventually(ExperienceKind.NoSQL, UsageImpact.High, callbackId);
     }
 
     private isCosmosDbItemDefinition(documentContent: unknown): documentContent is ItemDefinition {

src/panels/DocumentTab.ts

@@ -14,6 +14,8 @@ import { DocumentSession } from '../docdb/session/DocumentSession';
 import { QuerySession } from '../docdb/session/QuerySession';
 import { type CosmosDbRecordIdentifier, type ResultViewMetadata } from '../docdb/types/queryResult';
 import { getNoSqlQueryConnection } from '../docdb/utils/NoSqlQueryConnection';
+import { promptAfterActionEventually } from '../utils/survey';
+import { ExperienceKind, UsageImpact } from '../utils/surveyTypes';
 import * as vscodeUtil from '../utils/vscodeUtils';
 import { BaseTab, type CommandPayload } from './BaseTab';
 import { DocumentTab } from './DocumentTab';
@@ -258,7 +260,8 @@ export class QueryEditorTab extends BaseTab {
     }
 
     private async runQuery(query: string, options: ResultViewMetadata): Promise<void> {
-        await callWithTelemetryAndErrorHandling('cosmosDB.nosql.queryEditor.runQuery', async (context) => {
+        const callbackId = 'cosmosDB.nosql.queryEditor.runQuery';
+        await callWithTelemetryAndErrorHandling(callbackId, async (context) => {
             if (!this.connection) {
                 throw new Error('No connection');
             }
@@ -271,6 +274,7 @@ export class QueryEditorTab extends BaseTab {
 
             await session.run();
         });
+        void promptAfterActionEventually(ExperienceKind.NoSQL, UsageImpact.High, callbackId);
     }
 
     private async stopQuery(executionId: string): Promise<void> {
@@ -288,7 +292,8 @@ export class QueryEditorTab extends BaseTab {
     }
 
     private async nextPage(executionId: string): Promise<void> {
-        await callWithTelemetryAndErrorHandling('cosmosDB.nosql.queryEditor.nextPage', async (context) => {
+        const callbackId = 'cosmosDB.nosql.queryEditor.nextPage';
+        await callWithTelemetryAndErrorHandling(callbackId, async (context) => {
             context.telemetry.properties.executionId = executionId;
 
             if (!this.connection) {
@@ -302,10 +307,12 @@ export class QueryEditorTab extends BaseTab {
 
             await session.nextPage();
         });
+        void promptAfterActionEventually(ExperienceKind.NoSQL, UsageImpact.Medium, callbackId);
     }
 
     private async prevPage(executionId: string): Promise<void> {
-        await callWithTelemetryAndErrorHandling('cosmosDB.nosql.queryEditor.prevPage', async (context) => {
+        const callbackId = 'cosmosDB.nosql.queryEditor.prevPage';
+        await callWithTelemetryAndErrorHandling(callbackId, async (context) => {
             context.telemetry.properties.executionId = executionId;
 
             if (!this.connection) {
@@ -319,10 +326,12 @@ export class QueryEditorTab extends BaseTab {
 
             await session.prevPage();
         });
+        void promptAfterActionEventually(ExperienceKind.NoSQL, UsageImpact.Medium, callbackId);
     }
 
     private async firstPage(executionId: string): Promise<void> {
-        await callWithTelemetryAndErrorHandling('cosmosDB.nosql.queryEditor.firstPage', async (context) => {
+        const callbackId = 'cosmosDB.nosql.queryEditor.firstPage';
+        await callWithTelemetryAndErrorHandling(callbackId, async (context) => {
             context.telemetry.properties.executionId = executionId;
 
             if (!this.connection) {
@@ -336,10 +345,12 @@ export class QueryEditorTab extends BaseTab {
 
             await session.firstPage();
         });
+        void promptAfterActionEventually(ExperienceKind.NoSQL, UsageImpact.Medium, callbackId);
     }
 
     private async openDocument(mode: string, documentId?: CosmosDbRecordIdentifier): Promise<void> {
-        await callWithTelemetryAndErrorHandling('cosmosDB.nosql.queryEditor.openDocument', () => {
+        const callbackId = 'cosmosDB.nosql.queryEditor.openDocument';
+        await callWithTelemetryAndErrorHandling(callbackId, () => {
             if (!this.connection) {
                 throw new Error('No connection');
             }
@@ -354,10 +365,12 @@ export class QueryEditorTab extends BaseTab {
 
             DocumentTab.render(this.connection, mode, documentId, this.getNextViewColumn());
         });
+        void promptAfterActionEventually(ExperienceKind.NoSQL, UsageImpact.Medium, callbackId);
     }
 
     private async deleteDocument(documentId: CosmosDbRecordIdentifier): Promise<void> {
-        await callWithTelemetryAndErrorHandling('cosmosDB.nosql.queryEditor.deleteDocument', async () => {
+        const callbackId = 'cosmosDB.nosql.queryEditor.deleteDocument';
+        await callWithTelemetryAndErrorHandling(callbackId, async () => {
             if (!this.connection) {
                 throw new Error('No connection');
             }
@@ -369,6 +382,7 @@ export class QueryEditorTab extends BaseTab {
             const session = new DocumentSession(this.connection, this.channel);
             await session.delete(documentId);
         });
+        void promptAfterActionEventually(ExperienceKind.NoSQL, UsageImpact.Medium, callbackId);
     }
 
     private getNextViewColumn(): vscode.ViewColumn {

src/panels/QueryEditorTab.ts

@@ -8,6 +8,8 @@ import { createContextValue } from '@microsoft/vscode-azext-utils';
 import vscode, { type TreeItem } from 'vscode';
 import { type Experience } from '../../AzureDBExperiences';
 import { getCosmosClient } from '../../docdb/getCosmosClient';
+import { countExperienceUsageForSurvey } from '../../utils/survey';
+import { ExperienceKind, UsageImpact } from '../../utils/surveyTypes';
 import { type CosmosDBTreeElement } from '../CosmosDBTreeElement';
 import { type TreeElementWithContextValue } from '../TreeElementWithContextValue';
 import { type TreeElementWithExperience } from '../TreeElementWithExperience';
@@ -32,6 +34,7 @@ export abstract class DocumentDBDatabaseResourceItem
         const cosmosClient = getCosmosClient(endpoint, credentials, isEmulator);
         const containers = await this.getContainers(cosmosClient);
 
+        countExperienceUsageForSurvey(ExperienceKind.NoSQL, UsageImpact.Low);
         return this.getChildrenImpl(containers);
     }
 

src/tree/docdb/DocumentDBDatabaseResourceItem.ts

@@ -8,6 +8,8 @@ import { createContextValue, createGenericElement, type IActionContext } from '@
 import vscode, { type TreeItem } from 'vscode';
 import { type Experience } from '../../AzureDBExperiences';
 import { getCosmosClient } from '../../docdb/getCosmosClient';
+import { countExperienceUsageForSurvey } from '../../utils/survey';
+import { ExperienceKind, UsageImpact } from '../../utils/surveyTypes';
 import { getBatchSizeSetting } from '../../utils/workspacUtils';
 import { type CosmosDBTreeElement } from '../CosmosDBTreeElement';
 import { type TreeElementWithContextValue } from '../TreeElementWithContextValue';
@@ -55,12 +57,14 @@ export abstract class DocumentDBItemsResourceItem
                             context.telemetry.properties.parentContext = this.contextValue;
 
                             this.batchSize *= 2;
+                            countExperienceUsageForSurvey(ExperienceKind.NoSQL, UsageImpact.Medium);
                         },
                     ],
                 }) as CosmosDBTreeElement,
             );
         }
 
+        countExperienceUsageForSurvey(ExperienceKind.NoSQL, UsageImpact.Low);
         return result;
     }