feat(NODE-6883): allow rawData on time series collections

Author: durran

src/bulk/common.ts

@@ -852,6 +852,12 @@ export interface BulkWriteOptions extends CommandOperationOptions {
 
   /** @internal */
   timeoutContext?: TimeoutContext;
+  /**
+   * Used when the command needs to grant access to the underlying namespaces for time series collections.
+   * Only available on server versions 8.2 and above.
+   * @public
+   **/
+  rawData?: boolean;
 }
 
 /**

src/cmap/wire_protocol/constants.ts

@@ -4,6 +4,8 @@ export const MIN_SUPPORTED_WIRE_VERSION = 8;
 export const MAX_SUPPORTED_WIRE_VERSION = 25;
 export const MIN_SUPPORTED_QE_WIRE_VERSION = 21;
 export const MIN_SUPPORTED_QE_SERVER_VERSION = '7.0';
+export const MIN_SUPPORTED_RAW_DATA_WIRE_VERSION = 27;
+export const MIN_SUPPORTED_RAW_DATA_SERVER_VERSION = '8.2';
 export const OP_REPLY = 1;
 export const OP_UPDATE = 2001;
 export const OP_INSERT = 2002;

src/operations/aggregate.ts

@@ -1,12 +1,13 @@
 import type { Document } from '../bson';
+import { MIN_SUPPORTED_RAW_DATA_WIRE_VERSION } from '../cmap/wire_protocol/constants';
 import { CursorResponse, ExplainedCursorResponse } from '../cmap/wire_protocol/responses';
 import { type CursorTimeoutMode } from '../cursor/abstract_cursor';
 import { MongoInvalidArgumentError } from '../error';
 import { type ExplainOptions } from '../explain';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import { type TimeoutContext } from '../timeout';
-import { maxWireVersion, type MongoDBNamespace } from '../utils';
+import { decorateRawData, maxWireVersion, type MongoDBNamespace } from '../utils';
 import { WriteConcern } from '../write_concern';
 import { type CollationOptions, CommandOperation, type CommandOperationOptions } from './command';
 import { Aspect, defineAspects, type Hint } from './operation';
@@ -48,6 +49,12 @@ export interface AggregateOptions extends Omit<CommandOperationOptions, 'explain
   explain?: ExplainOptions['explain'];
   /** @internal */
   timeoutMode?: CursorTimeoutMode;
+  /**
+   * Used when the command needs to grant access to the underlying namespaces for time series collections.
+   * Only available on server versions 8.2 and above.
+   * @public
+   **/
+  rawData?: boolean;
 }
 
 /** @internal */
@@ -152,6 +159,12 @@ export class AggregateOperation extends CommandOperation<CursorResponse> {
       command.cursor.batchSize = options.batchSize;
     }
 
+    decorateRawData(command, !!options.rawData, serverWireVersion);
+
+    if (options.rawData != null && serverWireVersion >= MIN_SUPPORTED_RAW_DATA_WIRE_VERSION) {
+      command.rawData = options.rawData;
+    }
+
     return await super.executeCommand(
       server,
       session,

src/operations/client_bulk_write/client_bulk_write.ts

@@ -3,7 +3,7 @@ import { ClientBulkWriteCursorResponse } from '../../cmap/wire_protocol/response
 import type { Server } from '../../sdam/server';
 import type { ClientSession } from '../../sessions';
 import { type TimeoutContext } from '../../timeout';
-import { MongoDBNamespace } from '../../utils';
+import { decorateRawData, maxWireVersion, MongoDBNamespace } from '../../utils';
 import { CommandOperation } from '../command';
 import { Aspect, defineAspects } from '../operation';
 import { type ClientBulkWriteCommandBuilder } from './command_builder';
@@ -47,6 +47,7 @@ export class ClientBulkWriteOperation extends CommandOperation<ClientBulkWriteCu
     session: ClientSession | undefined,
     timeoutContext: TimeoutContext
   ): Promise<ClientBulkWriteCursorResponse> {
+    const serverWireVersion = maxWireVersion(server);
     let command;
 
     if (server.description.type === ServerType.LoadBalancer) {
@@ -95,6 +96,9 @@ export class ClientBulkWriteOperation extends CommandOperation<ClientBulkWriteCu
     if (!this.canRetryWrite) {
       this.options.willRetryWrite = false;
     }
+
+    decorateRawData(command, !!this.options.rawData, serverWireVersion);
+
     return await super.executeCommand(
       server,
       session,

src/operations/client_bulk_write/common.ts

@@ -24,6 +24,12 @@ export interface ClientBulkWriteOptions extends CommandOperationOptions {
    * BulkWriteResult.
    */
   verboseResults?: boolean;
+  /**
+   * Used when the command needs to grant access to the underlying namespaces for time series collections.
+   * Only available on server versions 8.2 and above.
+   * @public
+   **/
+  rawData?: boolean;
 }
 
 /** @public */

src/operations/count.ts

@@ -3,7 +3,7 @@ import type { Collection } from '../collection';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import { type TimeoutContext } from '../timeout';
-import type { MongoDBNamespace } from '../utils';
+import { decorateRawData, maxWireVersion, type MongoDBNamespace } from '../utils';
 import { CommandOperation, type CommandOperationOptions } from './command';
 import { Aspect, defineAspects } from './operation';
 
@@ -19,6 +19,12 @@ export interface CountOptions extends CommandOperationOptions {
   maxTimeMS?: number;
   /** An index name hint for the query. */
   hint?: string | Document;
+  /**
+   * Used when the command needs to grant access to the underlying namespaces for time series collections.
+   * Only available on server versions 8.2 and above.
+   * @public
+   **/
+  rawData?: boolean;
 }
 
 /** @internal */
@@ -45,6 +51,7 @@ export class CountOperation extends CommandOperation<number> {
     timeoutContext: TimeoutContext
   ): Promise<number> {
     const options = this.options;
+    const serverWireVersion = maxWireVersion(server);
     const cmd: Document = {
       count: this.collectionName,
       query: this.query
@@ -66,6 +73,8 @@ export class CountOperation extends CommandOperation<number> {
       cmd.maxTimeMS = options.maxTimeMS;
     }
 
+    decorateRawData(cmd, !!options.rawData, serverWireVersion);
+
     const result = await super.executeCommand(server, session, cmd, timeoutContext);
     return result ? result.n : 0;
   }

src/operations/delete.ts

@@ -5,7 +5,7 @@ import { type TODO_NODE_3286 } from '../mongo_types';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import { type TimeoutContext } from '../timeout';
-import { type MongoDBNamespace } from '../utils';
+import { decorateRawData, maxWireVersion, type MongoDBNamespace } from '../utils';
 import { type WriteConcernOptions } from '../write_concern';
 import { type CollationOptions, CommandOperation, type CommandOperationOptions } from './command';
 import { Aspect, defineAspects, type Hint } from './operation';
@@ -20,6 +20,12 @@ export interface DeleteOptions extends CommandOperationOptions, WriteConcernOpti
   hint?: string | Document;
   /** Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0). */
   let?: Document;
+  /**
+   * Used when the command needs to grant access to the underlying namespaces for time series collections.
+   * Only available on server versions 8.2 and above.
+   * @public
+   **/
+  rawData?: boolean;
 }
 
 /** @public */
@@ -71,6 +77,7 @@ export class DeleteOperation extends CommandOperation<DeleteResult> {
     session: ClientSession | undefined,
     timeoutContext: TimeoutContext
   ): Promise<DeleteResult> {
+    const serverWireVersion = maxWireVersion(server);
     const options = this.options ?? {};
     const ordered = typeof options.ordered === 'boolean' ? options.ordered : true;
     const command: Document = {
@@ -97,6 +104,8 @@ export class DeleteOperation extends CommandOperation<DeleteResult> {
       }
     }
 
+    decorateRawData(command, !!this.options.rawData, serverWireVersion);
+
     const res: TODO_NODE_3286 = await super.executeCommand(
       server,
       session,

src/operations/distinct.ts

@@ -3,7 +3,12 @@ import type { Collection } from '../collection';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import { type TimeoutContext } from '../timeout';
-import { decorateWithCollation, decorateWithReadConcern } from '../utils';
+import {
+  decorateRawData,
+  decorateWithCollation,
+  decorateWithReadConcern,
+  maxWireVersion
+} from '../utils';
 import { CommandOperation, type CommandOperationOptions } from './command';
 import { Aspect, defineAspects } from './operation';
 
@@ -21,6 +26,12 @@ export type DistinctOptions = CommandOperationOptions & {
    * See https://www.mongodb.com/docs/manual/reference/command/distinct/#command-fields.
    */
   hint?: Document | string;
+  /**
+   * Used when the command needs to grant access to the underlying namespaces for time series collections.
+   * Only available on server versions 8.2 and above.
+   * @public
+   **/
+  rawData?: boolean;
 };
 
 /**
@@ -61,6 +72,7 @@ export class DistinctOperation extends CommandOperation<any[]> {
     session: ClientSession | undefined,
     timeoutContext: TimeoutContext
   ): Promise<any[]> {
+    const serverWireVersion = maxWireVersion(server);
     const coll = this.collection;
     const key = this.key;
     const query = this.query;
@@ -94,6 +106,8 @@ export class DistinctOperation extends CommandOperation<any[]> {
     // Have we specified collation
     decorateWithCollation(cmd, coll, options);
 
+    decorateRawData(cmd, !!this.options.rawData, serverWireVersion);
+
     const result = await super.executeCommand(server, session, cmd, timeoutContext);
 
     // @ts-expect-error: Explain always returns a document

src/operations/estimated_document_count.ts

@@ -3,6 +3,7 @@ import type { Collection } from '../collection';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import { type TimeoutContext } from '../timeout';
+import { decorateRawData, maxWireVersion } from '../utils';
 import { CommandOperation, type CommandOperationOptions } from './command';
 import { Aspect, defineAspects } from './operation';
 
@@ -14,6 +15,12 @@ export interface EstimatedDocumentCountOptions extends CommandOperationOptions {
    * This option is sent only if the caller explicitly provides a value. The default is to not send a value.
    */
   maxTimeMS?: number;
+  /**
+   * Used when the command needs to grant access to the underlying namespaces for time series collections.
+   * Only available on server versions 8.2 and above.
+   * @public
+   **/
+  rawData?: boolean;
 }
 
 /** @internal */
@@ -36,6 +43,7 @@ export class EstimatedDocumentCountOperation extends CommandOperation<number> {
     session: ClientSession | undefined,
     timeoutContext: TimeoutContext
   ): Promise<number> {
+    const serverWireVersion = maxWireVersion(server);
     const cmd: Document = { count: this.collectionName };
 
     if (typeof this.options.maxTimeMS === 'number') {
@@ -48,6 +56,8 @@ export class EstimatedDocumentCountOperation extends CommandOperation<number> {
       cmd.comment = this.options.comment;
     }
 
+    decorateRawData(cmd, !!this.options.rawData, serverWireVersion);
+
     const response = await super.executeCommand(server, session, cmd, timeoutContext);
 
     return response?.n || 0;

src/operations/find.ts

@@ -12,7 +12,12 @@ import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import { formatSort, type Sort } from '../sort';
 import { type TimeoutContext } from '../timeout';
-import { type MongoDBNamespace, normalizeHintField } from '../utils';
+import {
+  decorateRawData,
+  maxWireVersion,
+  type MongoDBNamespace,
+  normalizeHintField
+} from '../utils';
 import { type CollationOptions, CommandOperation, type CommandOperationOptions } from './command';
 import { Aspect, defineAspects, type Hint } from './operation';
 
@@ -79,6 +84,12 @@ export interface FindOptions<TSchema extends Document = Document>
   explain?: ExplainOptions['explain'];
   /** @internal*/
   timeoutMode?: CursorTimeoutMode;
+  /**
+   * Used when the command needs to grant access to the underlying namespaces for time series collections.
+   * Only available on server versions 8.2 and above.
+   * @public
+   **/
+  rawData?: boolean;
 }
 
 /** @internal */
@@ -118,6 +129,7 @@ export class FindOperation extends CommandOperation<CursorResponse> {
     timeoutContext: TimeoutContext
   ): Promise<CursorResponse> {
     this.server = server;
+    const serverWireVersion = maxWireVersion(server);
 
     const options = this.options;
 
@@ -126,6 +138,7 @@ export class FindOperation extends CommandOperation<CursorResponse> {
       validateExplainTimeoutOptions(this.options, this.explain);
       findCommand = decorateWithExplain(findCommand, this.explain);
     }
+    decorateRawData(findCommand, !!this.options.rawData, serverWireVersion);
 
     return await server.command(
       this.ns,