Merge branch 'main' into dependabot/npm_and_yarn/driver-23ecce9593

.github/workflows/test-and-build-from-fork.yaml

@@ -0,0 +1,52 @@
+name: Test and Build (from fork)
+on:
+  pull_request_target:
+    branches:
+      - main
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  test-and-build:
+    name: Test and Build
+    if: github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.head.repo.full_name != github.repository
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+      fail-fast: false
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js Environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.16.0
+
+      - name: Install Dependencies
+        run: npm ci --omit=optional
+
+      - name: Run Checks
+        run: npm run check
+        # the glob here just fails
+        if: ${{ runner.os != 'Windows' }}
+
+      - name: Run Tests
+        env:
+          NODE_OPTIONS: "--max_old_space_size=4096"
+          SEGMENT_KEY: ${{ secrets.SEGMENT_KEY_DEV }}
+        run: npm run test
+
+      - name: Enable auto-merge for Dependabot PRs
+        if: github.event.pull_request.user.login == 'dependabot[bot]'
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/test-and-build.yaml

@@ -16,6 +16,7 @@ permissions:
 jobs:
   test-and-build:
     name: Test and Build
+    if: github.event.pull_request.user.login != 'dependabot[bot]' && github.event.pull_request.head.repo.full_name == github.repository
 
     strategy:
       matrix:

src/commands/launchMongoShell.ts

@@ -12,7 +12,7 @@ const launchMongoDBShellWithEnv = ({
   mdbConnectionString: string;
   envVariableString: string;
   parentHandle?: string;
-}) => {
+}): void => {
   const mongoDBShell = vscode.window.createTerminal({
     name: 'MongoDB Shell',
     env: {
@@ -29,19 +29,19 @@ const launchMongoDBShellWithEnv = ({
   mongoDBShell.show();
 };
 
-const getPowershellEnvString = () => {
+const getPowershellEnvString = (): string => {
   return '$Env:MDB_CONNECTION_STRING';
 };
 
-const getCmdEnvString = () => {
+const getCmdEnvString = (): string => {
   return '%MDB_CONNECTION_STRING%';
 };
 
-const getGitBashEnvString = () => {
+const getGitBashEnvString = (): string => {
   return '$MDB_CONNECTION_STRING';
 };
 
-const getBashEnvString = () => {
+const getBashEnvString = (): string => {
   return '$MDB_CONNECTION_STRING';
 };
 

src/editors/documentIdStore.ts

@@ -32,7 +32,7 @@ export default class DocumentIdStore {
     return newDocument.documentIdReference;
   }
 
-  get(documentIdReference: string) {
+  get(documentIdReference: string): any {
     const existingDocument = this._documents.find(
       (item) => item.documentIdReference === documentIdReference
     );

src/explorer/databaseTreeItem.ts

@@ -129,7 +129,8 @@ export default class DatabaseTreeItem
       const sortFunction = (
         collectionA: CollectionDetailsType,
         collectionB: CollectionDetailsType
-      ) => (collectionA.name || '').localeCompare(collectionB.name || '');
+      ): number =>
+        (collectionA.name || '').localeCompare(collectionB.name || '');
 
       const collectionTreeEntries = [
         ...otherCollections.sort(sortFunction),

src/featureFlags.ts

@@ -4,14 +4,14 @@ const FEATURE_FLAGS = {
 
 export type FeatureFlag = keyof typeof FEATURE_FLAGS;
 
-export const getFeatureFlag = (flag: FeatureFlag) => {
+export const getFeatureFlag = (flag: FeatureFlag): boolean => {
   if (typeof window === 'object') {
     return (window as any).MDB_FEATURE_FLAGS?.[flag];
   }
   return FEATURE_FLAGS[flag];
 };
 
-export const getFeatureFlagsScript = (nonce: string) => {
+export const getFeatureFlagsScript = (nonce: string): string => {
   return `
     <script nonce="${nonce}">window['MDB_FEATURE_FLAGS']=${JSON.stringify(
     FEATURE_FLAGS

src/logging.ts

@@ -57,7 +57,7 @@ class Logger implements ILogger {
     );
   }
 
-  private append(type: string, message: string) {
+  private append(type: string, message: string): void {
     // https://code.visualstudio.com/api/references/vscode-api#window.createOutputChannel
 
     Logger.channel.appendLine(

src/storage/storageController.ts

@@ -91,7 +91,7 @@ export default class StorageController {
     return Promise.resolve();
   }
 
-  getUserIdentity() {
+  getUserIdentity(): { anonymousId: string } {
     let anonymousId = this.get(StorageVariables.GLOBAL_ANONYMOUS_ID);
 
     // The anonymousId becomes required with analytics-node v6.

src/test/runTest.ts

@@ -8,7 +8,7 @@ import { TEST_DATABASE_PORT } from './suite/dbTestHelper';
 
 // More information on vscode specific tests: https://github.com/microsoft/vscode-test
 
-async function startTestMongoDBServer() {
+async function startTestMongoDBServer(): Promise<MongoCluster> {
   console.log('Starting MongoDB server on port', TEST_DATABASE_PORT);
   return await MongoCluster.start({
     topology: 'standalone',
@@ -19,7 +19,7 @@ async function startTestMongoDBServer() {
 
 let testMongoDBServer: MongoCluster;
 
-function cleanup() {
+function cleanup(): void {
   console.log('Stopping MongoDB server on port', TEST_DATABASE_PORT);
   void testMongoDBServer?.close();
 }

src/test/setup-webview.ts

@@ -64,9 +64,9 @@ Object.assign(global, { TextDecoder, TextEncoder });
 
 (global as any).vscodeFake = {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  postMessage: (message: unknown) => {},
+  postMessage: (message: unknown): void => {},
 };
 
-(global as any).acquireVsCodeApi = () => {
+(global as any).acquireVsCodeApi = (): any => {
   return (global as any).vscodeFake;
 };

src/test/suite/editors/editorsController.test.ts

@@ -223,7 +223,7 @@ suite('Editors Controller Test Suite', () => {
         'source=treeview',
       ].join('')
     );
-    activeTextEditor.document.getText = () => '{';
+    activeTextEditor.document.getText = (): string => '{';
     sandbox.replaceGetter(
       vscode.window,
       'activeTextEditor',

src/test/suite/explorer/collectionTreeItem.test.ts

@@ -12,7 +12,7 @@ const { contributes } = require('../../../../package.json');
 
 function getTestCollectionTreeItem(
   options?: Partial<ConstructorParameters<typeof CollectionTreeItem>[0]>
-) {
+): CollectionTreeItem {
   return new CollectionTreeItem({
     collection: {
       name: 'testColName',

src/test/suite/explorer/databaseTreeItem.test.ts

@@ -20,7 +20,7 @@ const { contributes } = require('../../../../package.json');
 
 function getTestDatabaseTreeItem(
   options?: Partial<ConstructorParameters<typeof DatabaseTreeItem>[0]>
-) {
+): DatabaseTreeItem {
   return new DatabaseTreeItem({
     databaseName: mockDatabaseNames[1],
     dataService: new DataServiceStub() as unknown as DataService,

src/test/suite/explorer/documentListTreeItem.test.ts

@@ -17,7 +17,7 @@ const dataServiceStub = new DataServiceStub() as unknown as DataService;
 
 function getTestDocumentListTreeItem(
   options?: Partial<ConstructorParameters<typeof DocumentListTreeItem>[0]>
-) {
+): DocumentListTreeItem {
   return new DocumentListTreeItem({
     collectionName: 'collectionName',
     databaseName: 'mock_db_name',

src/test/suite/explorer/documentTreeItem.test.ts

@@ -8,7 +8,7 @@ const dataServiceStub = new DataServiceStub() as unknown as DataService;
 
 function getTestDocumentTreeItem(
   options?: Partial<ConstructorParameters<typeof DocumentTreeItem>[0]>
-) {
+): DocumentTreeItem {
   return new DocumentTreeItem({
     document: {},
     namespace: 'name.space',

src/test/suite/explorer/fieldTreeItem.test.ts

@@ -24,7 +24,7 @@ const { contributes } = require('../../../../package.json');
 
 function getTestFieldTreeItem(
   options?: Partial<ConstructorParameters<typeof FieldTreeItem>[0]>
-) {
+): FieldTreeItem {
   return new FieldTreeItem({
     field: {
       name: 'test',
@@ -40,7 +40,7 @@ function getTestFieldTreeItem(
 
 function getTestSchemaTreeItem(
   options?: Partial<ConstructorParameters<typeof SchemaTreeItem>[0]>
-) {
+): SchemaTreeItem {
   return new SchemaTreeItem({
     databaseName: 'zebraWearwolf',
     collectionName: 'giraffeVampire',

src/test/suite/explorer/indexListTreeItem.test.ts

@@ -13,7 +13,7 @@ const { contributes } = require('../../../../package.json');
 
 function getTestIndexListTreeItem(
   options?: Partial<ConstructorParameters<typeof IndexListTreeItem>[0]>
-) {
+): IndexListTreeItem {
   return new IndexListTreeItem({
     collectionName: 'zebraWearwolf',
     databaseName: 'giraffeVampire',

src/test/suite/explorer/schemaTreeItem.test.ts

@@ -25,7 +25,7 @@ const { contributes } = require('../../../../package.json');
 
 function getTestSchemaTreeItem(
   options?: Partial<ConstructorParameters<typeof SchemaTreeItem>[0]>
-) {
+): SchemaTreeItem {
   return new SchemaTreeItem({
     databaseName: TEST_DB_NAME,
     collectionName: 'cheesePizza',

src/test/suite/explorer/streamProcessorTreeItem.test.ts

@@ -10,7 +10,7 @@ const { contributes } = require('../../../../package.json');
 
 function getTestTreeItem(
   options?: Partial<ConstructorParameters<typeof StreamProcessorTreeItem>[0]>
-) {
+): StreamProcessorTreeItem {
   const { name, state } = mockStreamProcessors[1];
   return new StreamProcessorTreeItem({
     streamProcessorName: name,

src/test/suite/oidc.test.ts

@@ -19,7 +19,10 @@ import { waitFor } from './waitFor';
 import { MongoCluster } from 'mongodb-runner';
 import type { MongoClusterOptions } from 'mongodb-runner';
 import { OIDCMockProvider } from '@mongodb-js/oidc-mock-provider';
-import type { OIDCMockProviderConfig } from '@mongodb-js/oidc-mock-provider';
+import type {
+  MaybePromise,
+  OIDCMockProviderConfig,
+} from '@mongodb-js/oidc-mock-provider';
 import { ConnectionString } from 'mongodb-connection-string-url';
 
 import launchMongoShell from '../../commands/launchMongoShell';
@@ -96,10 +99,12 @@ suite('OIDC Tests', function () {
 
     oidcMockProviderEndpointAccesses = {};
     oidcMockProviderConfig = {
-      getTokenPayload(metadata: Parameters<typeof getTokenPayload>[0]) {
+      getTokenPayload(
+        metadata: Parameters<typeof getTokenPayload>[0]
+      ): ReturnType<typeof oidcMockProviderConfig.getTokenPayload> {
         return getTokenPayload(metadata);
       },
-      overrideRequestHandler(url, req, res) {
+      overrideRequestHandler(url, req, res): MaybePromise<void> {
         const { pathname } = new URL(url);
         oidcMockProviderEndpointAccesses[pathname] ??= 0;
         oidcMockProviderEndpointAccesses[pathname]++;
@@ -217,7 +222,9 @@ suite('OIDC Tests', function () {
       .getConfiguration('mdb')
       .update('persistOIDCTokens', true);
     let tokenFetchCalls = 0;
-    getTokenPayload = () => {
+    getTokenPayload = (): ReturnType<
+      typeof oidcMockProviderConfig.getTokenPayload
+    > => {
       tokenFetchCalls++;
       return DEFAULT_TOKEN_PAYLOAD;
     };
@@ -247,7 +254,9 @@ suite('OIDC Tests', function () {
       .getConfiguration('mdb')
       .update('persistOIDCTokens', false);
     let tokenFetchCalls = 0;
-    getTokenPayload = () => {
+    getTokenPayload = (): ReturnType<
+      typeof oidcMockProviderConfig.getTokenPayload
+    > => {
       tokenFetchCalls++;
       return DEFAULT_TOKEN_PAYLOAD;
     };
@@ -278,7 +287,7 @@ suite('OIDC Tests', function () {
       emitter,
       'secondConnectionEstablished'
     );
-    overrideRequestHandler = async (url) => {
+    overrideRequestHandler = async (url): Promise<void> => {
       if (new URL(url).pathname === '/authorize') {
         emitter.emit('authorizeEndpointCalled');
         // This does effectively mean that our 'fake browser'
@@ -297,7 +306,7 @@ suite('OIDC Tests', function () {
       });
 
     await once(emitter, 'authorizeEndpointCalled');
-    overrideRequestHandler = () => {};
+    overrideRequestHandler = (): void => {};
     const connected =
       await testConnectionController.addNewConnectionStringAndConnect(
         connectionString
@@ -326,7 +335,9 @@ suite('OIDC Tests', function () {
       });
     let tokenFetchCalls = 0;
     let afterReauth = false;
-    getTokenPayload = () => {
+    getTokenPayload = (): ReturnType<
+      typeof oidcMockProviderConfig.getTokenPayload
+    > => {
       tokenFetchCalls++;
       return {
         ...DEFAULT_TOKEN_PAYLOAD,
@@ -373,7 +384,9 @@ suite('OIDC Tests', function () {
       });
     let tokenFetchCalls = 0;
     let afterReauth = false;
-    getTokenPayload = () => {
+    getTokenPayload = (): ReturnType<
+      typeof oidcMockProviderConfig.getTokenPayload
+    > => {
       tokenFetchCalls++;
       return {
         ...DEFAULT_TOKEN_PAYLOAD,
@@ -412,7 +425,9 @@ suite('OIDC Tests', function () {
 
   test('shares the oidc state also with the playgrounds', async function () {
     let tokenFetchCalls = 0;
-    getTokenPayload = () => {
+    getTokenPayload = (): ReturnType<
+      typeof oidcMockProviderConfig.getTokenPayload
+    > => {
       tokenFetchCalls++;
       return DEFAULT_TOKEN_PAYLOAD;
     };

src/test/suite/playground.test.ts

@@ -146,7 +146,7 @@ suite('Playground', function () {
     await vscode.workspace.applyEdit(edit);
     await vscode.commands.executeCommand('mdb.runPlayground');
 
-    const onDidChangeDiagnostics = () =>
+    const onDidChangeDiagnostics = (): Promise<unknown> =>
       new Promise((resolve) => {
         // The diagnostics are set again when the server restarts.
         vscode.languages.onDidChangeDiagnostics(resolve);