fix(NODE-3150): allow retrieving PCRE-style RegExp

Author: andymina

src/bson.ts

@@ -48,7 +48,6 @@ export interface BSONSerializeOptions
  | 'evalFunctions'
  | 'cacheFunctions'
  | 'cacheFunctionsCrc32'
- | 'bsonRegExp'
  | 'allowObjectSmallerThanBufferSize'
  | 'index'
  > {
@@ -64,6 +63,7 @@ export function pluckBSONSerializeOptions(options: BSONSerializeOptions): BSONSe
  promoteLongs,
  serializeFunctions,
  ignoreUndefined,
+ bsonRegExp,
  raw
  } = options;
  return {
@@ -73,6 +73,7 @@ export function pluckBSONSerializeOptions(options: BSONSerializeOptions): BSONSe
  promoteLongs,
  serializeFunctions,
  ignoreUndefined,
+ bsonRegExp,
  raw
  };
 }
@@ -94,6 +95,7 @@ export function resolveBSONOptions(
  promoteValues: options?.promoteValues ?? parentOptions?.promoteValues ?? true,
  promoteBuffers: options?.promoteBuffers ?? parentOptions?.promoteBuffers ?? false,
  ignoreUndefined: options?.ignoreUndefined ?? parentOptions?.ignoreUndefined ?? false,
+ bsonRegExp: options?.bsonRegExp ?? parentOptions?.bsonRegExp ?? false,
  serializeFunctions: options?.serializeFunctions ?? parentOptions?.serializeFunctions ?? false,
  fieldsAsRaw: options?.fieldsAsRaw ?? parentOptions?.fieldsAsRaw ?? {}
  };

src/cmap/auth/mongodb_aws.ts

@@ -18,7 +18,8 @@ const AWS_EC2_PATH = '/latest/meta-data/iam/security-credentials';
 const bsonOptions: BSONSerializeOptions = {
  promoteLongs: true,
  promoteValues: true,
- promoteBuffers: false
+ promoteBuffers: false,
+ bsonRegExp: false
 };
 
 interface AWSSaslContinuePayload {

src/cmap/commands.ts

@@ -491,6 +491,7 @@ export class Response {
  promoteLongs: boolean;
  promoteValues: boolean;
  promoteBuffers: boolean;
+ bsonRegExp?: boolean;
  index?: number;
 
  constructor(
@@ -502,7 +503,12 @@ export class Response {
  this.parsed = false;
  this.raw = message;
  this.data = msgBody;
- this.opts = opts ?? { promoteLongs: true, promoteValues: true, promoteBuffers: false };
+ this.opts = opts ?? {
+ promoteLongs: true,
+ promoteValues: true,
+ promoteBuffers: false,
+ bsonRegExp: false
+ };
 
  // Read the message header
  this.length = msgHeader.length;
@@ -530,6 +536,7 @@ export class Response {
  typeof this.opts.promoteValues === 'boolean' ? this.opts.promoteValues : true;
  this.promoteBuffers =
  typeof this.opts.promoteBuffers === 'boolean' ? this.opts.promoteBuffers : false;
+ this.bsonRegExp = typeof this.opts.bsonRegExp === 'boolean' ? this.opts.bsonRegExp : false;
  }
 
  isParsed(): boolean {
@@ -547,13 +554,15 @@ export class Response {
  const promoteLongs = options.promoteLongs ?? this.opts.promoteLongs;
  const promoteValues = options.promoteValues ?? this.opts.promoteValues;
  const promoteBuffers = options.promoteBuffers ?? this.opts.promoteBuffers;
+ const bsonRegExp = options.bsonRegExp ?? this.opts.bsonRegExp;
  let bsonSize;
 
  // Set up the options
  const _options: BSONSerializeOptions = {
- promoteLongs: promoteLongs,
- promoteValues: promoteValues,
- promoteBuffers: promoteBuffers
+ promoteLongs,
+ promoteValues,
+ promoteBuffers,
+ bsonRegExp
  };
 
  // Position within OP_REPLY at which documents start
@@ -765,6 +774,7 @@ export class BinMsg {
  promoteLongs: boolean;
  promoteValues: boolean;
  promoteBuffers: boolean;
+ bsonRegExp: boolean;
  documents: (Document | Buffer)[];
  index?: number;
 
@@ -777,7 +787,12 @@ export class BinMsg {
  this.parsed = false;
  this.raw = message;
  this.data = msgBody;
- this.opts = opts ?? { promoteLongs: true, promoteValues: true, promoteBuffers: false };
+ this.opts = opts ?? {
+ promoteLongs: true,
+ promoteValues: true,
+ promoteBuffers: false,
+ bsonRegExp: false
+ };
 
  // Read the message header
  this.length = msgHeader.length;
@@ -796,6 +811,7 @@ export class BinMsg {
  typeof this.opts.promoteValues === 'boolean' ? this.opts.promoteValues : true;
  this.promoteBuffers =
  typeof this.opts.promoteBuffers === 'boolean' ? this.opts.promoteBuffers : false;
+ this.bsonRegExp = typeof this.opts.bsonRegExp === 'boolean' ? this.opts.bsonRegExp : false;
 
  this.documents = [];
  }
@@ -816,12 +832,14 @@ export class BinMsg {
  const promoteLongs = options.promoteLongs ?? this.opts.promoteLongs;
  const promoteValues = options.promoteValues ?? this.opts.promoteValues;
  const promoteBuffers = options.promoteBuffers ?? this.opts.promoteBuffers;
+ const bsonRegExp = options.bsonRegExp ?? this.opts.bsonRegExp;
 
  // Set up the options
  const _options: BSONSerializeOptions = {
- promoteLongs: promoteLongs,
- promoteValues: promoteValues,
- promoteBuffers: promoteBuffers
+ promoteLongs,
+ promoteValues,
+ promoteBuffers,
+ bsonRegExp
  };
 
  while (this.index < this.data.length) {

src/cmap/connection.ts

@@ -792,6 +792,7 @@ function write(
  promoteLongs: typeof options.promoteLongs === 'boolean' ? options.promoteLongs : true,
  promoteValues: typeof options.promoteValues === 'boolean' ? options.promoteValues : true,
  promoteBuffers: typeof options.promoteBuffers === 'boolean' ? options.promoteBuffers : false,
+ bsonRegExp: typeof options.bsonRegExp === 'boolean' ? options.bsonRegExp : false,
  raw: typeof options.raw === 'boolean' ? options.raw : false,
  started: 0
  };

src/cmap/wire_protocol/shared.ts

@@ -42,7 +42,8 @@ export function applyCommonQueryOptions(
  raw: typeof options.raw === 'boolean' ? options.raw : false,
  promoteLongs: typeof options.promoteLongs === 'boolean' ? options.promoteLongs : true,
  promoteValues: typeof options.promoteValues === 'boolean' ? options.promoteValues : true,
- promoteBuffers: typeof options.promoteBuffers === 'boolean' ? options.promoteBuffers : false
+ promoteBuffers: typeof options.promoteBuffers === 'boolean' ? options.promoteBuffers : false,
+ bsonRegExp: typeof options.bsonRegExp === 'boolean' ? options.bsonRegExp : false
  });
 
  if (options.session) {

src/connection_string.ts

@@ -588,6 +588,9 @@ export const OPTIONS = {
  autoEncryption: {
  type: 'record'
  },
+ bsonRegExp: {
+ type: 'boolean'
+ },
  serverApi: {
  target: 'serverApi',
  transform({ values: [version] }): ServerApi {

src/db.ts

@@ -61,14 +61,14 @@ const DB_OPTIONS_ALLOW_LIST = [
  'raw',
  'authSource',
  'ignoreUndefined',
- 'promoteLongs',
  'readConcern',
  'retryMiliSeconds',
  'numberOfRetries',
  'loggerLevel',
  'logger',
  'promoteBuffers',
  'promoteLongs',
+ 'bsonRegExp',
  'promoteValues',
  'compression',
  'retryWrites'

src/operations/create_collection.ts

@@ -25,6 +25,7 @@ const ILLEGAL_COMMAND_FIELDS = new Set([
  'promoteLongs',
  'promoteValues',
  'promoteBuffers',
+ 'bsonRegExp',
  'serializeFunctions',
  'ignoreUndefined'
 ]);

src/operations/map_reduce.ts

@@ -30,6 +30,7 @@ const exclusionList = [
  'promoteLongs',
  'promoteValues',
  'promoteBuffers',
+ 'bsonRegExp',
  'serializeFunctions',
  'ignoreUndefined',
  'scope' // this option is reformatted thus exclude the original

test/types/bson.test-d.ts

@@ -9,6 +9,7 @@ expectType<boolean | undefined>(options.ignoreUndefined);
 expectType<boolean | undefined>(options.promoteLongs);
 expectType<boolean | undefined>(options.promoteBuffers);
 expectType<boolean | undefined>(options.promoteValues);
+expectType<boolean | undefined>(options.bsonRegExp);
 expectType<Document | undefined>(options.fieldsAsRaw);
 
 type PermittedBSONOptionKeys =
@@ -18,6 +19,7 @@ type PermittedBSONOptionKeys =
  | 'promoteLongs'
  | 'promoteBuffers'
  | 'promoteValues'
+ | 'bsonRegExp'
  | 'fieldsAsRaw'
  | 'raw';