@mongosh/service-provider-node-driver 2.3.3

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@mongosh/service-provider-node-driver",
+  "version": "2.3.3",
+  "description": "MongoDB Shell Server Service Provider Package",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "config": {
+    "unsafe-perm": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/mongodb-js/mongosh.git"
+  },
+  "scripts": {
+    "compile": "tsc -p tsconfig.json",
+    "test": "mocha -r \"../../scripts/import-expansions.js\" --timeout 60000 -r ts-node/register --reporter \"../../configs/mocha-config-mongosh/reporter.ts\" \"./src/**/*.spec.ts\"",
+    "test-ci": "node ../../scripts/run-if-package-requested.js npm test",
+    "test-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test",
+    "test-ci-coverage": "nyc --no-clean --cwd ../.. --reporter=none npm run test-ci",
+    "prepublish": "npm run compile",
+    "eslint": "eslint",
+    "lint": "npm run eslint . && npm run prettier -- --check .",
+    "check": "npm run lint && npm run depcheck",
+    "depcheck": "depcheck",
+    "prettier": "prettier",
+    "reformat": "npm run prettier -- --write . && npm run eslint --fix"
+  },
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=14.15.1"
+  },
+  "mongosh": {
+    "ciRequiredOptionalDependencies": {
+      "mongodb-client-encryption": [
+        "darwin",
+        "linux",
+        "win32"
+      ],
+      "kerberos": [
+        "darwin",
+        "linux",
+        "win32"
+      ]
+    }
+  },
+  "dependencies": {
+    "@mongodb-js/devtools-connect": "^3.3.0",
+    "@mongodb-js/oidc-plugin": "^1.1.1",
+    "@mongosh/errors": "2.3.3",
+    "@mongosh/service-provider-core": "2.3.3",
+    "@mongosh/types": "2.3.3",
+    "aws4": "^1.12.0",
+    "kerberos": "2.1.0",
+    "mongodb": "^6.10.0",
+    "mongodb-client-encryption": "^6.1.0",
+    "mongodb-connection-string-url": "^3.0.1",
+    "socks": "^2.8.3"
+  },
+  "optionalDependencies": {
+    "kerberos": "2.1.0",
+    "mongodb-client-encryption": "^6.1.0"
+  },
+  "devDependencies": {
+    "@mongodb-js/eslint-config-mongosh": "2.3.3",
+    "@mongodb-js/prettier-config-devtools": "^1.0.1",
+    "@mongodb-js/tsconfig-mongosh": "2.3.3",
+    "@types/sinon-chai": "^3.2.4",
+    "depcheck": "^1.4.7",
+    "eslint": "^7.25.0",
+    "prettier": "^2.8.8"
+  },
+  "gitHead": "e78998f6c73b2aefa47cecd09860ff23c49d1971"
+}

package/src/compass/compass-service-provider.ts

@@ -0,0 +1,30 @@
+import type { DevtoolsConnectOptions } from '../node-driver-service-provider';
+import { NodeDriverServiceProvider } from '../node-driver-service-provider';
+import type { MongoClient } from 'mongodb';
+import type { ReplPlatform } from '@mongosh/service-provider-core';
+import type ConnectionString from 'mongodb-connection-string-url';
+import type { EventEmitter } from 'events';
+
+/**
+ * A service provider that is meant to be used in compass.
+ */
+export class CompassServiceProvider extends NodeDriverServiceProvider {
+  public readonly platform: ReplPlatform;
+  /**
+   * Instantiate a new CompassServiceProvider with the data-service's connected
+   * MongoClient instance.
+   *
+   * @param {MongoClient} mongoClient - The Node drivers' MongoClient instance.
+   * @param {MongoClientOptions} driverOptions
+   * @param {string} uri - optional URI for telemetry.
+   */
+  constructor(
+    mongoClient: MongoClient,
+    bus: EventEmitter,
+    driverOptions: DevtoolsConnectOptions,
+    uri?: ConnectionString
+  ) {
+    super(mongoClient, bus, driverOptions, uri);
+    this.platform = 'Compass';
+  }
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+import { NodeDriverServiceProvider } from './node-driver-service-provider';
+import { CompassServiceProvider } from './compass/compass-service-provider';
+export type { DevtoolsConnectOptions } from '@mongodb-js/devtools-connect';
+export { NodeDriverServiceProvider, CompassServiceProvider };

package/src/mongodb-patches.spec.ts

@@ -0,0 +1,67 @@
+import { expect } from 'chai';
+import { MongoClient } from 'mongodb';
+import {
+  skipIfServerVersion,
+  startSharedTestServer,
+} from '../../../testing/integration-testing-hooks';
+import { forceCloseMongoClient } from './mongodb-patches';
+import { promisify } from 'util';
+
+const delay = promisify(setTimeout);
+
+describe('forceCloseMongoClient [integration]', function () {
+  const testServer = startSharedTestServer();
+
+  context('for server >= 4.1', function () {
+    skipIfServerVersion(testServer, '< 4.1');
+
+    it('force-closes connections that are currently checked out', async function () {
+      if (process.env.MONGOSH_TEST_FORCE_API_STRICT) {
+        return this.skip(); // $currentOp is unversioned
+      }
+
+      let client = await MongoClient.connect(
+        await testServer.connectionString()
+      );
+      const testDbName = `test-db-${Date.now()}`;
+      const testDb = client.db(testDbName);
+
+      await testDb.collection('ctrlc').insertOne({});
+      let err: any;
+      testDb
+        .collection('ctrlc')
+        .find({
+          $where: 'while(true) { /* loop1 */ }',
+        })
+        .toArray()
+        .catch((e) => {
+          err = e;
+        });
+      await delay(100);
+      const result = await forceCloseMongoClient(client);
+      expect(result.forceClosedConnections).to.equal(1);
+      await delay(1);
+      expect(err.message).to.include('Topology is closed');
+
+      client = await MongoClient.connect(await testServer.connectionString());
+      for (let i = 0; ; i++) {
+        const [out] = await client
+          .db('admin')
+          .aggregate([
+            { $currentOp: {} },
+            { $match: { 'command.find': 'ctrlc' } },
+            { $count: 'waitingCommands' },
+          ])
+          .toArray();
+        if (i === 100 || !out?.waitingCommands) {
+          expect(out?.waitingCommands || 0).to.equal(0);
+          break;
+        }
+        await delay(100);
+      }
+
+      await client.db(testDbName).dropDatabase();
+      await client.close();
+    });
+  });
+});

package/src/mongodb-patches.ts

@@ -0,0 +1,25 @@
+import type { MongoClient } from 'mongodb';
+
+// Close a MongoClient + abort currently ongoing operations.
+export function forceCloseMongoClient(
+  client: MongoClient
+): Promise<{ forceClosedConnections: number }> {
+  let forceClosedConnections = 0;
+  for (const server of (client as any).topology?.s?.servers?.values()) {
+    const checkedOutConnections = server?.pool?.checkedOutConnections;
+    for (const connection of checkedOutConnections ?? []) {
+      forceClosedConnections++;
+      connection.destroy({ force: true });
+      // Immediately after destroying, act as if the close had happened,
+      // but *not* as an actual 'close' event on the socket itself --
+      // a close on the socket is communicated as a network error, which
+      // is considered an retryable error by operations which are currently
+      // running on this connection, but the whole point here is that these
+      // operations should *not* be retried. So, we just act as if something
+      // had happened that interrupts all ongoing operations and also is
+      // supposed to destroy the connection (which is a no-op at this point).
+      connection.onError(new Error('connection canceled by force close'));
+    }
+  }
+  return client.close(true).then(() => ({ forceClosedConnections }));
+}