feat(shell-api): warn users when using background option in aggregate M…

…ONGOSH-1766 (#1964) * warn users when using background option in aggregate * text change
mongodb-js · May 2, 2024 · 16cbc95 · 16cbc95
1 parent 6d9162c
commit 16cbc95
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/packages/shell-api/src/collection.ts b/packages/shell-api/src/collection.ts
@@ -41,6 +41,7 @@ import {
   coerceToJSNumber,
   buildConfigChunksCollectionMatch,
   onlyShardedCollectionsInConfigFilter,
+  aggregateBackgroundOptionNotSupportedHelp,
 } from './helpers';
 import type {
   AnyBulkWriteOperation,
@@ -177,6 +178,11 @@ export default class Collection extends ShellApiWithMongoClass {
       options = {};
       pipeline = args || [];
     }
+    if ('background' in options) {
+      this._instanceState.printWarning(
+        aggregateBackgroundOptionNotSupportedHelp
+      );
+    }
     this._emitCollectionApiCall('aggregate', { options, pipeline });
     const { aggOptions, dbOptions, explain } = adaptAggregateOptions(options);
 

diff --git a/packages/shell-api/src/database.ts b/packages/shell-api/src/database.ts
@@ -24,6 +24,7 @@ import {
   shouldRunAggregationImmediately,
   adjustRunCommand,
   getBadge,
+  aggregateBackgroundOptionNotSupportedHelp,
 } from './helpers';
 
 import {
@@ -421,6 +422,11 @@ export default class Database extends ShellApiWithMongoClass {
     pipeline: Document[],
     options?: Document
   ): Promise<AggregationCursor> {
+    if ('background' in (options ?? {})) {
+      this._instanceState.printWarning(
+        aggregateBackgroundOptionNotSupportedHelp
+      );
+    }
     assertArgsDefinedType([pipeline], [true], 'Database.aggregate');
     this._emitDatabaseApiCall('aggregate', { options, pipeline });
 

diff --git a/packages/shell-api/src/helpers.ts b/packages/shell-api/src/helpers.ts
@@ -1187,3 +1187,7 @@ export function buildConfigChunksCollectionMatch(
     ? { uuid: configCollectionsInfo.uuid } // new format
     : { ns: configCollectionsInfo._id }; // old format
 }
+
+export const aggregateBackgroundOptionNotSupportedHelp =
+  'the background option is not supported by the aggregate method and will be ignored, ' +
+  'use runCommand to use { background: true } with Atlas Data Federation';