fix(shell): launch shell does not work with SSH VSCODE-327 (#402)

Author: alenakhineika

package-lock.json

@@ -61,7 +61,7 @@
     "release-draft": "node ./scripts/release-draft.js"
   },
   "engines": {
-    "vscode": "^1.58.1",
+    "vscode": "^1.65.2",
     "node": "^14.17.5",
     "npm": "^8.3.1"
   },
@@ -901,7 +901,7 @@
     }
   },
   "dependencies": {
-    "@babel/parser": "^7.17.3",
+    "@babel/parser": "^7.17.7",
     "@babel/traverse": "^7.17.3",
     "@fortawesome/fontawesome-svg-core": "^1.3.0",
     "@fortawesome/free-solid-svg-icons": "^6.0.0",
@@ -910,21 +910,21 @@
     "@iconify/react": "^1.1.4",
     "@leafygreen-ui/logo": "^6.1.0",
     "@leafygreen-ui/toggle": "^7.0.5",
-    "@mongosh/browser-runtime-electron": "^1.2.2",
-    "@mongosh/i18n": "^1.2.2",
-    "@mongosh/service-provider-server": "^1.2.2",
-    "@mongosh/shell-api": "^1.2.2",
+    "@mongosh/browser-runtime-electron": "^1.2.3",
+    "@mongosh/i18n": "^1.2.3",
+    "@mongosh/service-provider-server": "^1.2.3",
+    "@mongosh/shell-api": "^1.2.3",
     "analytics-node": "^5.1.2",
     "bson": "^4.6.1",
-    "bson-transpilers": "^1.6.0",
+    "bson-transpilers": "^1.7.0",
     "classnames": "^2.3.1",
     "debug": "^4.3.3",
     "dotenv": "^8.6.0",
     "micromatch": "^4.0.4",
-    "mongodb": "^4.4.0",
+    "mongodb": "^4.4.1",
     "mongodb-cloud-info": "^1.1.3",
     "mongodb-connection-string-url": "^2.5.2",
-    "mongodb-data-service": "^21.17.0",
+    "mongodb-data-service": "^21.18.0",
     "mongodb-ns": "^2.3.0",
     "mongodb-schema": "^9.0.0",
     "numeral": "^2.0.6",
@@ -951,11 +951,11 @@
     "@types/jest": "^26.0.24",
     "@types/mocha": "^8.2.3",
     "@types/node": "^14.18.12",
-    "@types/react": "^17.0.39",
-    "@types/react-dom": "^17.0.11",
+    "@types/react": "^17.0.40",
+    "@types/react-dom": "^17.0.13",
     "@types/sinon": "^9.0.11",
     "@types/uuid": "^8.3.4",
-    "@types/vscode": "^1.58.1",
+    "@types/vscode": "^1.65.0",
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "^4.33.0",
     "autoprefixer": "^9.8.8",
@@ -1002,7 +1002,7 @@
     "ts-jest": "^26.5.6",
     "ts-loader": "^8.3.0",
     "ts-node": "^9.1.1",
-    "typescript": "^4.5.5",
+    "typescript": "^4.6.2",
     "vsce": "^1.103.1",
     "vscode-test": "^1.6.1",
     "webpack": "^4.46.0",

package.json

@@ -131,6 +131,29 @@
     ],
     "description": "Allows for multiple parellel aggregations to be specified."
   },
+  "MongoDB Aggregations $fill": {
+    "prefix": "$fill",
+    "body": [
+      "/**",
+      " * sortBy: Syntax is the same as \\$sort, required if \"method\" is used in at least one output spec otherwise optional",
+      " * partitionBy: Optional, default is a single partition. Specification is the same as _id in \\$group (same as partitionBy in window functions).",
+      " * partitionByFields: Optional, set of fields that acts as a compound key to define each partition.",
+      " * output - Required, object for each field to fill in. For a single field, can be a single object.",
+      " * output.<field> - A field to be filled with value, if missing or null in the current document.",
+      " */",
+      "\\$fill: {",
+      "  sortBy: ${1:sortSpec},",
+      "  partitionBy: ${2:expression},",
+      "  partitionByFields: [${3:string}, ${4:string}, ...],",
+      "  output: {",
+      "    field1: {value: ${5:expression}},",
+      "    field2: {method: ${6:string}},",
+      "    ...",
+      "  }",
+      "}"
+    ],
+    "description": "Populates null and missing field values within documents."
+  },
   "MongoDB Aggregations $geoNear": {
     "prefix": "$geoNear",
     "body": [

snippets/stage-autocompleter.json

@@ -77,17 +77,7 @@ const openMongoDBShell = (connectionController: ConnectionController): Promise<b
     return Promise.resolve(false);
   }
 
-  const activeMongoClientOptions = connectionController.getMongoClientConnectionOptions();
-
-  if (!activeMongoClientOptions) {
-    void vscode.window.showErrorMessage(
-      'No active connection found.'
-    );
-
-    return Promise.resolve(false);
-  }
-
-  const mdbConnectionString = activeMongoClientOptions.url || '';
+  const mdbConnectionString = connectionController.getActiveConnectionString();
 
   if (userShell.includes('powershell.exe')) {
     launchMongoDBShellOnPowershell(shellCommand, mdbConnectionString);

src/commands/launchMongoShell.ts

@@ -713,6 +713,43 @@ export default class ConnectionController {
       : '';
   }
 
+  _getConnectionStringWithProxy(mongoClientConnectionOptions: { url: string; options: MongoClientOptions; }): string {
+    const connectionStringData = new ConnectionString(mongoClientConnectionOptions.url);
+
+    if (mongoClientConnectionOptions.options.proxyHost) {
+      connectionStringData.searchParams.set('proxyHost', mongoClientConnectionOptions.options.proxyHost);
+    }
+
+    if (mongoClientConnectionOptions.options.proxyPassword) {
+      connectionStringData.searchParams.set('proxyPassword', mongoClientConnectionOptions.options.proxyPassword);
+    }
+
+    if (mongoClientConnectionOptions.options.proxyPort) {
+      connectionStringData.searchParams.set('proxyPort', `${mongoClientConnectionOptions.options.proxyPort}`);
+    }
+
+    if (mongoClientConnectionOptions.options.proxyUsername) {
+      connectionStringData.searchParams.set('proxyUsername', mongoClientConnectionOptions.options.proxyUsername);
+    }
+
+    return connectionStringData.toString();
+  }
+
+  getActiveConnectionString(): string {
+    const mongoClientConnectionOptions = this.getMongoClientConnectionOptions();
+    const connectionString = mongoClientConnectionOptions?.url;
+
+    if (!connectionString) {
+      throw new Error('Connection string not found.');
+    }
+
+    if (mongoClientConnectionOptions?.options.proxyHost) {
+      return this._getConnectionStringWithProxy(mongoClientConnectionOptions);
+    }
+
+    return connectionString;
+  }
+
   getActiveDataService(): DataService | null {
     return this._activeDataService;
   }
@@ -730,7 +767,6 @@ export default class ConnectionController {
     }
 
     const url = new ConnectionString(connectionOptions.connectionString);
-
     url.searchParams.delete('appname');
     return url.toString();
   }

src/connectionController.ts

@@ -101,8 +101,8 @@ export default class HelpTree implements vscode.TreeDataProvider<vscode.TreeItem
         'report'
       );
 
-      const segmentAnonymousId = this._telemetryService?.getSegmentAnonymousId();
-      const ajsAid = segmentAnonymousId ? `&ajs_aid=${segmentAnonymousId}` : '';
+      const telemetryUserIdentity = this._telemetryService?.getTelemetryUserIdentity();
+      const ajsAid = telemetryUserIdentity ? `&ajs_aid=${telemetryUserIdentity[0]}` : '';
       const atlas = new HelpLinkTreeItem(
         'Create Free Atlas Cluster',
         `https://mongodb.com/products/vs-code/vs-code-atlas-signup?utm_campaign=vs-code-extension&utm_source=visual-studio&utm_medium=product${ajsAid}`,

src/explorer/helpTree.ts

@@ -67,34 +67,27 @@ export default class StorageController {
   }
 
   getUserIdentity() {
-    return {
-      userId: this.getUserId(),
-      anonymousId: this.getAnonymousId()
-    };
-  }
-
-  getAnonymousId() {
-    let globalAnonymousId = this.get(StorageVariables.GLOBAL_ANONYMOUS_ID);
-
-    if (globalAnonymousId && typeof globalAnonymousId === 'string') {
-      return globalAnonymousId;
-    }
-
+    const globalAnonymousId = this.get(StorageVariables.GLOBAL_ANONYMOUS_ID);
     const globalUserId = this.get(StorageVariables.GLOBAL_USER_ID);
 
+    // Initially, we used `userId` as Segment user identifier, but this usage is being deprecated.
+    // The `anonymousId` should be used instead.
+    // We keep sending `userId` to Segment for old users though to preserve their analytics.
     if (globalUserId && typeof globalUserId === 'string') {
-      globalAnonymousId = globalUserId;
-    } else {
-      globalAnonymousId = uuidv4();
+      return {
+        userId: globalUserId
+      };
     }
 
-    void this.update(StorageVariables.GLOBAL_ANONYMOUS_ID, globalAnonymousId);
-
-    return globalAnonymousId;
-  }
+    if (globalAnonymousId && typeof globalAnonymousId === 'string') {
+      return {
+        anonymousId: globalAnonymousId
+      };
+    }
 
-  getUserId(): string | undefined {
-    return this.get(StorageVariables.GLOBAL_USER_ID);
+    const anonymousId = uuidv4();
+    void this.update(StorageVariables.GLOBAL_ANONYMOUS_ID, anonymousId);
+    return { anonymousId };
   }
 
   async saveConnectionToStore(storeConnectionInfo: StoreConnectionInfo): Promise<void> {

src/storage/storageController.ts

@@ -18,11 +18,6 @@ import { StorageController } from '../storage';
 const log = createLogger('telemetry');
 const { version } = require('../../package.json');
 
-interface AnalyticsNodeIdentity {
-  userId?: string;
-  anonymousId: string;
-}
-
 type PlaygroundTelemetryEventProperties = {
   type: string | null;
   partial: boolean;
@@ -32,7 +27,7 @@ type PlaygroundTelemetryEventProperties = {
 export type SegmentProperties = {
   event: string;
   userId?: string;
-  anonymousId: string;
+  anonymousId?: string;
   properties: unknown;
 };
 
@@ -91,8 +86,8 @@ export enum TelemetryEventTypes {
  */
 export default class TelemetryService {
   _segmentAnalytics?: SegmentAnalytics;
-  _segmentUserId?: string; // Should exist only for users prior v0.9.0.
-  _segmentAnonymousId: string; // The randomly generated uuid.
+  _segmentUserId?: string;
+  _segmentAnonymousId?: string;
   _segmentKey?: string; // The segment API write key.
 
   private _context: vscode.ExtensionContext;
@@ -162,13 +157,9 @@ export default class TelemetryService {
         flushInterval: 10000 // 10 seconds is the default libraries' value.
       });
 
-      const identity: AnalyticsNodeIdentity = {
-        anonymousId: this._segmentAnonymousId
-      };
-      if (this._segmentUserId) {
-        identity.userId = this._segmentUserId;
-      }
-      this._segmentAnalytics.identify(identity);
+      const segmentProperties = this.getTelemetryUserIdentity();
+      this._segmentAnalytics.identify(segmentProperties);
+      log.info('TELEMETRY identify', segmentProperties);
     }
   }
 
@@ -204,9 +195,8 @@ export default class TelemetryService {
   ): void {
     if (this._isTelemetryFeatureEnabled()) {
       const segmentProperties: SegmentProperties = {
+        ...this.getTelemetryUserIdentity(),
         event: eventType,
-        userId: this._segmentUserId,
-        anonymousId: this._segmentAnonymousId,
         properties: {
           ...properties,
           extension_version: `${version}`
@@ -276,8 +266,16 @@ export default class TelemetryService {
     return 'other';
   }
 
-  getSegmentAnonymousId(): string {
-    return this._segmentAnonymousId;
+  getTelemetryUserIdentity() {
+    if (this._segmentUserId) {
+      return {
+        userId: this._segmentUserId
+      };
+    }
+
+    return {
+      anonymousId: this._segmentAnonymousId
+    };
   }
 
   trackPlaygroundCodeExecuted(

src/telemetry/telemetryService.ts

@@ -1038,4 +1038,18 @@ suite('Connection Controller Test Suite', function () {
       }
     );
   });
+
+  test('_getConnectionStringWithProxy returns string with proxy options', () => {
+    const expectedConnectionStringWithProxy = 'mongodb://localhost:27018/?appname=mongodb-vscode+0.0.0-dev.0&proxyHost=localhost&proxyPassword=gwce7tr8733ujbr&proxyPort=3378&proxyUsername=test';
+    const connectionString = testConnectionController._getConnectionStringWithProxy({
+      url: 'mongodb://localhost:27018/?appname=mongodb-vscode+0.0.0-dev.0',
+      options: {
+        proxyHost: 'localhost',
+        proxyPassword: 'gwce7tr8733ujbr',
+        proxyPort: 3378,
+        proxyUsername: 'test',
+      }
+    });
+    assert.strictEqual(connectionString, expectedConnectionStringWithProxy);
+  });
 });

src/test/suite/connectionController.test.ts

@@ -42,9 +42,10 @@ suite('Help Explorer Test Suite', function () {
     const atlasHelpItem = helpTreeItems[5];
 
     assert.strictEqual(atlasHelpItem.label, 'Create Free Atlas Cluster');
+    const telemetryUserIdentity = mdbTestExtension.testExtensionController._telemetryService.getTelemetryUserIdentity();
     assert.strictEqual(
       atlasHelpItem.url,
-      `https://mongodb.com/products/vs-code/vs-code-atlas-signup?utm_campaign=vs-code-extension&utm_source=visual-studio&utm_medium=product&ajs_aid=${mdbTestExtension.testExtensionController._telemetryService.getSegmentAnonymousId()}`
+      `https://mongodb.com/products/vs-code/vs-code-atlas-signup?utm_campaign=vs-code-extension&utm_source=visual-studio&utm_medium=product&ajs_aid=${telemetryUserIdentity[0]}`
     );
     assert.strictEqual(atlasHelpItem.iconName, 'atlas');
     assert.strictEqual(atlasHelpItem.linkId, 'freeClusterCTA');