Removed logSkippedOptions since properly typed client + python doesnt do it

Author: toptobes

src/api/data-api-http-client.ts

@@ -29,17 +29,7 @@ export class DataApiHttpClient extends HttpClient {
   public collection?: string;
   public namespace?: string;
 
-  public async executeCommand(command: Record<string, any>, options?: BaseOptions & { collection?: string, namespace?: string }, optionsToRetain?: Set<string>) {
-    const commandName = Object.keys(command)[0];
-
-    if (optionsToRetain) {
-      const [options, dirty] = cleanupOptions(command, commandName, optionsToRetain, this.logSkippedOptions);
-
-      if (dirty) {
-        command = { [commandName]: { ...command[commandName], options } };
-      }
-    }
-
+  public async executeCommand(command: Record<string, any>, options?: BaseOptions & { collection?: string, namespace?: string }) {
     const response = await this._requestDataApi({
       url: this.baseUrl,
       timeout: options?.maxTimeMS,
@@ -104,29 +94,6 @@ export class DataApiHttpClient extends HttpClient {
   }
 }
 
-function cleanupOptions(data: Record<string, any>, commandName: string, optionsToRetain: Set<string>, logSkippedOptions: boolean) {
-  const command = data[commandName];
-
-  if (!command.options) {
-    return [undefined, false];
-  }
-
-  const options = { ...command.options };
-  let dirty = false;
-
-  Object.keys(options).forEach((key) => {
-    if (!optionsToRetain.has(key)) {
-      if (logSkippedOptions) {
-        logger.warn(`'${commandName}' does not support option '${key}'`);
-      }
-      delete options[key];
-      dirty = true;
-    }
-  });
-
-  return [options, dirty];
-}
-
 export function replacer(this: any, key: string, value: any): any {
   if (typeof value === 'bigint') {
     return Number(value);

src/api/http-client.ts

@@ -26,7 +26,6 @@ import { Caller } from '@/src/client';
 
 export class HttpClient {
   public readonly baseUrl: string;
-  public readonly logSkippedOptions: boolean;
   public readonly userAgent: string;
   public requestStrategy: HTTPRequestStrategy;
   #applicationToken: string;
@@ -47,7 +46,6 @@ export class HttpClient {
     this.#applicationToken = options.applicationToken;
 
     this.baseUrl = options.baseUrl;
-    this.logSkippedOptions = options.logSkippedOptions ?? false;
 
     this.requestStrategy =
       (options.requestStrategy)
@@ -79,7 +77,6 @@ export class HttpClient {
     const clone = new cls({
       baseUrl: this.baseUrl,
       applicationToken: this.#applicationToken,
-      logSkippedOptions: this.logSkippedOptions,
       requestStrategy: this.requestStrategy,
       userAgent: this.userAgent,
     });

src/api/types.ts

@@ -26,7 +26,6 @@ export interface HTTPClientOptions {
   useHttp2?: boolean;
   requestStrategy?: HTTPRequestStrategy;
   userAgent?: string;
-  logSkippedOptions?: boolean;
 }
 
 export interface RawDataApiResponse {

src/client/types.ts

@@ -153,22 +153,6 @@ export interface DbSpawnOptions {
    * @defaultValue true
    */
   useHttp2?: boolean,
-  /**
-   * Whether to log skipped options (logs as 'warn')
-   *
-   * Logs when a command is executed with options that are not supported by the client
-   *
-   * Defaults to `false`.
-   *
-   * @example
-   * ```typescript
-   * // Logs a warning 'findOne' does not support option 'unknownOption'
-   * await findOne({}, { unknownOption: 'value' });
-   * ```
-   *
-   * @defaultValue false
-   */
-  logSkippedOptions?: boolean,
   /**
    * The path to the Data API, which is going to be `api/json/v1` for all Astra instances. However, it may vary
    * if you're using a different Data API-compatible endpoint.

src/data-api/collection.ts

@@ -43,19 +43,15 @@ import {
   FindOneAndDeleteOptions,
   FindOneAndReplaceCommand,
   FindOneAndReplaceOptions,
-  findOneAndReplaceOptionsKeys,
   FindOneAndUpdateCommand,
   FindOneAndUpdateOptions,
-  findOneAndUpdateOptionsKeys,
   FindOneCommand,
   FindOneOptions,
-  findOneOptionsKeys,
   FindOptions,
   Flatten,
   FoundDoc,
   IdOf,
   InsertManyCommand,
-  insertManyOptionKeys,
   InsertManyOptions,
   InsertManyResult,
   InsertOneCommand,
@@ -73,7 +69,6 @@ import {
   UpdateManyOptions,
   UpdateManyResult,
   UpdateOneCommand,
-  updateOneOptionKeys,
   UpdateOneOptions,
   UpdateOneResult,
   WithId,
@@ -373,7 +368,7 @@ export class Collection<Schema extends SomeDoc = SomeDoc> {
       command.updateOne.sort = options.sort;
     }
 
-    const resp = await this._httpClient.executeCommand(command, options, updateOneOptionKeys);
+    const resp = await this._httpClient.executeCommand(command, options);
 
     const commonResult = {
       modifiedCount: resp.status?.modifiedCount,
@@ -555,7 +550,7 @@ export class Collection<Schema extends SomeDoc = SomeDoc> {
       command.findOneAndReplace.sort = options.sort;
     }
 
-    const resp = await this._httpClient.executeCommand(command, options, findOneAndReplaceOptionsKeys);
+    const resp = await this._httpClient.executeCommand(command, options);
 
     const commonResult = {
       modifiedCount: resp.status?.modifiedCount,
@@ -937,7 +932,7 @@ export class Collection<Schema extends SomeDoc = SomeDoc> {
       command.findOne.projection = options.projection;
     }
 
-    const resp = await this._httpClient.executeCommand(command, options, findOneOptionsKeys);
+    const resp = await this._httpClient.executeCommand(command, options);
     return resp.data?.document;
   }
 
@@ -1114,7 +1109,7 @@ export class Collection<Schema extends SomeDoc = SomeDoc> {
       command.findOneAndReplace.projection = options.projection;
     }
 
-    const resp = await this._httpClient.executeCommand(command, options, findOneAndReplaceOptionsKeys);
+    const resp = await this._httpClient.executeCommand(command, options);
     const document = resp.data?.document;
 
     return (options.includeResultMetadata)
@@ -1329,7 +1324,7 @@ export class Collection<Schema extends SomeDoc = SomeDoc> {
       command.findOneAndUpdate.projection = options.projection;
     }
 
-    const resp = await this._httpClient.executeCommand(command, options, findOneAndUpdateOptionsKeys);
+    const resp = await this._httpClient.executeCommand(command, options);
     const document = resp.data?.document;
 
     return (options.includeResultMetadata)
@@ -1572,7 +1567,7 @@ const insertMany = async <Schema>(httpClient: DataApiHttpClient, documents: unkn
     }
   }
 
-  const resp = await httpClient.executeCommand(command, {}, insertManyOptionKeys);
+  const resp = await httpClient.executeCommand(command, {});
   return resp.status?.insertedIds ?? [];
 }
 

src/data-api/cursor.ts

@@ -16,7 +16,6 @@ import {
   Filter,
   FindOptions,
   InternalFindOptions,
-  internalFindOptionsKeys,
   InternalGetMoreCommand,
   ProjectionOption,
   SortOption,
@@ -500,7 +499,7 @@ export class FindCursor<T, TRaw extends SomeDoc = SomeDoc> {
       command.find.options = options;
     }
 
-    const resp = await this._httpClient.executeCommand(command, {}, internalFindOptionsKeys);
+    const resp = await this._httpClient.executeCommand(command, {});
 
     this._nextPageState = resp.data!.nextPageState || null;
     this._buffer = resp.data!.documents as TRaw[];

src/data-api/db.ts

@@ -19,12 +19,10 @@ import {
   CollectionName,
   CreateCollectionCommand,
   CreateCollectionOptions,
-  createCollectionOptionsKeys,
   FullCollectionInfo,
-  listCollectionOptionsKeys,
   ListCollectionsCommand,
   ListCollectionsOptions,
-  WithNamespace
+  WithNamespace,
 } from '@/src/data-api/types';
 import { DatabaseInfo } from '@/src/devops/types/admin/database-info';
 import { AstraDbAdmin, mkDbAdmin } from '@/src/devops/astra-db-admin';
@@ -132,7 +130,6 @@ export class Db implements Disposable {
         applicationToken: dbOpts.token,
         baseApiPath: dbOpts?.dataApiPath || DEFAULT_DATA_API_PATH,
         caller: options.caller,
-        logSkippedOptions: dbOpts.logSkippedOptions,
         useHttp2: dbOpts.useHttp2,
       }),
       enumerable: false,
@@ -313,7 +310,7 @@ export class Db implements Disposable {
       },
     };
 
-    await this._httpClient.executeCommand(command, options, createCollectionOptionsKeys);
+    await this._httpClient.executeCommand(command, options);
 
     return this.collection(collectionName, options);
   }
@@ -405,7 +402,7 @@ export class Db implements Disposable {
       },
     }
 
-    const resp = await this._httpClient.executeCommand(command, options, listCollectionOptionsKeys);
+    const resp = await this._httpClient.executeCommand(command, options);
 
     return (options?.nameOnly !== false)
       ? resp.status!.collections.map((name: string) => ({ name }))

src/data-api/types/collections/create-collection.ts

@@ -35,6 +35,3 @@ export interface CreateCollectionCommand {
  * @see Db.createCollection
  */
 export interface CreateCollectionOptions<Schema extends SomeDoc> extends BaseOptions, CollectionOptions<Schema>, WithNamespace {}
-
-/** @internal */
-export const createCollectionOptionsKeys = new Set(['vector', 'indexing', 'defaultId']);

src/data-api/types/collections/list-collection.ts

@@ -89,6 +89,3 @@ export interface FullCollectionInfo {
    */
   options: CollectionOptions<SomeDoc>,
 }
-
-/** @internal */
-export const listCollectionOptionsKeys = new Set(['explain']);

src/data-api/types/find/find-one-replace.ts

@@ -133,6 +133,3 @@ export interface FindOneAndReplaceOptions<Schema extends SomeDoc> extends BaseOp
    */
   includeResultMetadata?: boolean,
 }
-
-/** @internal */
-export const findOneAndReplaceOptionsKeys = new Set(['upsert', 'returnDocument', 'sort', 'projection']);