Merge branch 'main' of github.com:mongodb-js/mongosh into gagik/individual-publishing

gagik · gagik · commit 5513ad79861d · 2025-01-13T16:03:58.000+01:00
diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md
@@ -1,5 +1,5 @@
 The following third-party software is used by and included in **mongosh**.
-This document was automatically generated on Wed Jan 08 2025.
+This document was automatically generated on Sun Jan 12 2025.
 
 ## List of dependencies
 
@@ -311,7 +311,6 @@ Package|Version|License
 **[jsonfile](#1504ddbe5031429f6d90bb02373b4629ff5da9ef4e869d5015ff42f685817e74)**|6.1.0|MIT
 **[kerberos](#05c7d2f17faccacb505a07f79ccba22ce089aa668a8bef64de84cf5dcd4f585e)**|2.1.0|Apache-2.0
 **[lodash.merge](#996e40d63a94f1b8693d7c81e0cdfb874c6432d6bbd675976fc1b6b13652c8db)**|4.6.2|MIT
-**[lodash](#adaac4144887ebc2c1b682380ff385210f681fc58b4bc1ef3986148cf8dcd28a)**|4.17.21|MIT
 **[lowlight](#6efc5090c0eda3b461d933d6b79bddcdf8165a10aea9f39ac76620ce5fb05bf5)**|1.17.0|MIT
 **[lru-cache](#4ffd8f3438230331a92ccdb6752beda91852dc2a361669f3b26ef0b8829e9b26)**|11.0.2|ISC
 **[lru-cache](#fe7f0a2f2cf4c92f13c3a2a63f14f80f20f6919979306dc054e4f947c1234651)**|5.1.1|ISC
@@ -341,7 +340,7 @@ Package|Version|License
 **[mongodb-connection-string-url](#2e1146256a89ebd24e3398881e03807fe363d58444e6b7952ea50bd6108707bc)**|3.0.1|Apache-2.0
 **[mongodb-crypt-library-version](#003bd2892d6f6fdac0613ba8f9a2fbb054ddd1c26901e1d2fc7e83861b21cf4d)**|1.0.5|Apache-2.0
 **[mongodb-log-writer](#c4945018f8490fc8e56e1414e262fcf1b802800e05cd15f2bd6b7a9d0b94af85)**|1.4.2|Apache-2.0
-**[mongodb-redact](#d246d19a773f4cc2f2d0431d018a38295c9f9b1b45cfbe7ee16230056b667453)**|1.1.2|Apache-2.0
+**[mongodb-redact](#6fe8cef9beca5f3e1e3e999f47975ae99dcf4488419b28fc6d5eafc436081623)**|1.1.5|Apache-2.0
 **[mongodb](#cb726cf7a5329fc15d51574a4bc2e29682afe46afb788a94370b09643ab98a72)**|6.12.0|Apache-2.0
 **[ms](#484b814b85d5028e34246147c8fc901d33570202bd7cdc3703c0ed1078eba0aa)**|2.0.0|MIT
 **[ms](#0a987b2f79ff37005e452a5afa7dacd3042061a7077054d2ba9cabacd88506d2)**|2.1.2|MIT
@@ -25988,63 +25987,6 @@ License files:
       
 
 
-<a id="adaac4144887ebc2c1b682380ff385210f681fc58b4bc1ef3986148cf8dcd28a"></a>
-### [lodash](https://www.npmjs.com/package/lodash) (version 4.17.21)
-License tags: MIT
-
-License files:
-* LICENSE:
-
-      Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
-      
-      Based on Underscore.js, copyright Jeremy Ashkenas,
-      DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>
-      
-      This software consists of voluntary contributions made by many
-      individuals. For exact contribution history, see the revision history
-      available at https://github.com/lodash/lodash
-      
-      The following license applies to all parts of this software except as
-      documented below:
-      
-      ====
-      
-      Permission is hereby granted, free of charge, to any person obtaining
-      a copy of this software and associated documentation files (the
-      "Software"), to deal in the Software without restriction, including
-      without limitation the rights to use, copy, modify, merge, publish,
-      distribute, sublicense, and/or sell copies of the Software, and to
-      permit persons to whom the Software is furnished to do so, subject to
-      the following conditions:
-      
-      The above copyright notice and this permission notice shall be
-      included in all copies or substantial portions of the Software.
-      
-      THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-      EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-      MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-      NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-      LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-      OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-      WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-      
-      ====
-      
-      Copyright and related rights for sample code are waived via CC0. Sample
-      code is defined as all source code displayed within the prose of the
-      documentation.
-      
-      CC0: http://creativecommons.org/publicdomain/zero/1.0/
-      
-      ====
-      
-      Files located in the node_modules and vendor directories are externally
-      maintained libraries used by this software which have their own
-      licenses; we recommend you read them, as their terms may differ from the
-      terms above.
-      
-
-
 <a id="6efc5090c0eda3b461d933d6b79bddcdf8165a10aea9f39ac76620ce5fb05bf5"></a>
 ### [lowlight](https://www.npmjs.com/package/lowlight) (version 1.17.0)
 License tags: MIT
@@ -27758,8 +27700,8 @@ License files:
       
 
 
-<a id="d246d19a773f4cc2f2d0431d018a38295c9f9b1b45cfbe7ee16230056b667453"></a>
-### [mongodb-redact](https://www.npmjs.com/package/mongodb-redact) (version 1.1.2)
+<a id="6fe8cef9beca5f3e1e3e999f47975ae99dcf4488419b28fc6d5eafc436081623"></a>
+### [mongodb-redact](https://www.npmjs.com/package/mongodb-redact) (version 1.1.5)
 License tags: Apache-2.0
 
 License files:
diff --git a/docs/mongosh-architecture-jan2025.jam b/docs/mongosh-architecture-jan2025.jam
diff --git a/docs/mongosh-architecture-jan2025.png b/docs/mongosh-architecture-jan2025.png
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/history/package.json b/packages/history/package.json
@@ -36,7 +36,7 @@
   },
   "dependencies": {
     "mongodb-connection-string-url": "^3.0.1",
-    "mongodb-redact": "^1.1.2"
+    "mongodb-redact": "^1.1.5"
   },
   "devDependencies": {
     "@mongodb-js/eslint-config-mongosh": "^1.0.0",
diff --git a/packages/logging/package.json b/packages/logging/package.json
@@ -22,7 +22,7 @@
     "@mongosh/history": "2.3.8",
     "@mongosh/types": "2.3.8",
     "mongodb-log-writer": "^1.4.2",
-    "mongodb-redact": "^1.1.2"
+    "mongodb-redact": "^1.1.5"
   },
   "devDependencies": {
     "@mongodb-js/eslint-config-mongosh": "^1.0.0",
diff --git a/packages/service-provider-core/src/textencoder-polyfill.ts b/packages/service-provider-core/src/textencoder-polyfill.ts
@@ -10,8 +10,13 @@ if (
   // @ts-ignore
   typeof TextEncoder !== 'function'
 ) {
-  // eslint-disable-next-line @typescript-eslint/no-implied-eval
-  Object.assign(Function('return this')(), textEncodingPolyfill());
+  const global =
+    (typeof globalThis === 'object' &&
+      globalThis?.Object === Object &&
+      globalThis) ||
+    // eslint-disable-next-line @typescript-eslint/no-implied-eval
+    Function('return this')();
+  Object.assign(global, textEncodingPolyfill());
 }
 
 // Basic encoder/decoder polyfill for java-shell environment (see above)
diff --git a/packages/shell-api/README.md b/packages/shell-api/README.md
@@ -0,0 +1,5 @@
+# @mongosh/shell-api
+
+Provides the runtime-independent classes that make up the MongoDB Shell API,
+such as `Database`, `Collection`, etc., and the global objects and APIs
+available to shell users, such as `db`, `rs`, `sh`, `console`, `print()`, etc.
diff --git a/packages/shell-api/package.json b/packages/shell-api/package.json
@@ -45,7 +45,7 @@
     "@mongosh/history": "2.3.8",
     "@mongosh/i18n": "2.3.8",
     "@mongosh/service-provider-core": "2.3.8",
-    "mongodb-redact": "^1.1.2"
+    "mongodb-redact": "^1.1.5"
   },
   "devDependencies": {
     "@mongodb-js/eslint-config-mongosh": "^1.0.0",
diff --git a/packages/shell-api/src/decorators.ts b/packages/shell-api/src/decorators.ts
@@ -397,11 +397,11 @@ interface Signatures {
 // object instead of a global list, or even more radical changes
 // such as removing the concept of signatures altogether.
 const signaturesGlobalIdentifier = '@@@mdb.signatures@@@';
-if (!(global as any)[signaturesGlobalIdentifier]) {
-  (global as any)[signaturesGlobalIdentifier] = {};
+if (!(globalThis as any)[signaturesGlobalIdentifier]) {
+  (globalThis as any)[signaturesGlobalIdentifier] = {};
 }
 
-const signatures: Signatures = (global as any)[signaturesGlobalIdentifier];
+const signatures: Signatures = (globalThis as any)[signaturesGlobalIdentifier];
 signatures.Document = { type: 'Document', attributes: {} };
 export { signatures };
 
diff --git a/packages/shell-api/src/runtime-independence.spec.ts b/packages/shell-api/src/runtime-independence.spec.ts
@@ -0,0 +1,86 @@
+// This test verifies that shell-api only uses standard JS features.
+import fsSync from 'fs';
+import vm from 'vm';
+import { createRequire } from 'module';
+import { expect } from 'chai';
+import sinon from 'ts-sinon';
+
+describe('Runtime independence', function () {
+  it('Can run using exclusively JS standard features', async function () {
+    const entryPoint = require.resolve('../');
+
+    const context = vm.createContext(Object.create(null), {
+      codeGeneration: {
+        strings: false,
+        wasm: false,
+      },
+    });
+
+    // These are all used Node.js modules that are somewhat easily polyfill-able
+    // for other environments, but which we should still ideally remove in the
+    // long run (and definitely not add anything here).
+    // Guaranteed bonusly for anyone who removes a package from this list!
+    const allowedNodeBuiltins = ['crypto', 'util', 'events', 'path'];
+    // Our TextDecoder/TextEncoder polyfills require this, unfortunately.
+    context.Buffer = Buffer;
+
+    // Small CJS implementation, without __dirname or __filename
+    const cache = Object.create(null);
+    const absolutePathRequire = (absolutePath: string) => {
+      absolutePath = fsSync.realpathSync(absolutePath);
+      if (cache[absolutePath]) return cache[absolutePath];
+      const module = (cache[absolutePath] = { exports: {} });
+      const localRequire = (specifier: string) => {
+        if (allowedNodeBuiltins.includes(specifier)) return require(specifier);
+        return absolutePathRequire(
+          createRequire(absolutePath).resolve(specifier)
+        ).exports;
+      };
+      const source = fsSync.readFileSync(absolutePath, 'utf8');
+      const fn = vm.runInContext(
+        `(function(module, exports, require) {\n${source}\n})`,
+        context,
+        {
+          filename: `IN_CONTEXT:${absolutePath}`,
+        }
+      );
+      fn(module, module.exports, localRequire);
+      return module;
+    };
+
+    // service-provider-core injects a dummy polyfill for TextDecoder/TextEncoder
+    absolutePathRequire(require.resolve('@mongosh/service-provider-core'));
+    const shellApi =
+      // eslint-disable-next-line @typescript-eslint/consistent-type-imports
+      absolutePathRequire(entryPoint).exports as typeof import('./');
+
+    // Verify that `shellApi` is generally usable.
+    const sp = { platform: 'CLI', close: sinon.spy() };
+    const evaluationListener = { onExit: sinon.spy() };
+    const instanceState = new shellApi.ShellInstanceState(sp as any);
+    instanceState.setEvaluationListener(evaluationListener);
+    expect(instanceState.initialServiceProvider).to.equal(sp);
+    const bsonObj = instanceState.shellBson.ISODate(
+      '2025-01-09T20:43:51+01:00'
+    );
+    expect(bsonObj.toISOString()).to.equal('2025-01-09T19:43:51.000Z');
+    expect(bsonObj instanceof Date).to.equal(false);
+    expect(Object.prototype.toString.call(bsonObj)).to.equal(
+      Object.prototype.toString.call(new Date())
+    );
+
+    try {
+      await instanceState.shellApi.exit();
+      expect.fail('missed exception');
+    } catch (err: any) {
+      expect(err.message).to.include('.onExit listener returned');
+      expect(err.stack).to.include('IN_CONTEXT');
+      expect(err instanceof Error).to.equal(false);
+      expect(Object.prototype.toString.call(err)).to.equal(
+        Object.prototype.toString.call(new Error())
+      );
+    }
+    expect(sp.close).to.have.been.calledOnce;
+    expect(evaluationListener.onExit).to.have.been.calledOnce;
+  });
+});
