fix: review update

Author: cdcabrera

src/__tests__/options.context.test.ts

@@ -15,21 +15,21 @@ const MockStdioServerTransport = StdioServerTransport as jest.MockedClass<typeof
 
 describe('setOptions', () => {
   it('should populate the experimental array when a registered option differs from default', () => {
-    const registry = new Set<any>(['pluginIsolation']);
+    const experimentalOptions = new Set<any>(['pluginIsolation']);
     const options = setOptions({
       pluginIsolation: 'none',
       experimental: ['pluginIsolation']
-    }, registry);
+    }, { experimentalOptions });
 
     expect(options.experimental).toContain('pluginIsolation');
   });
 
   it('should not populate the experimental array when options match defaults', () => {
-    const registry = new Set<any>(['pluginIsolation']);
+    const experimentalOptions = new Set<any>(['pluginIsolation']);
     const options = setOptions({
       pluginIsolation: DEFAULT_OPTIONS.pluginIsolation,
       experimental: ['pluginIsolation']
-    }, registry);
+    }, { experimentalOptions });
 
     expect(options.experimental).not.toContain('pluginIsolation');
   });

src/__tests__/options.parser.test.ts

@@ -1,5 +1,5 @@
 import { type ExperimentalOptionKey } from '../options';
-import { parseCliOptions, parseProgrammaticOptions } from '../options.parser';
+import { parseCliOptions, parseProgrammaticOptions, pickProgrammaticOptions } from '../options.parser';
 
 describe('parseCliOptions', () => {
   const originalArgv = process.argv;
@@ -395,3 +395,38 @@ describe('parseProgrammaticOptions', () => {
     }
   });
 });
+
+describe('pickProgrammaticOptions', () => {
+  it.each([
+    {
+      description: 'filter out non-programmatic options',
+      source: { name: 'test-server', invalidKey: 'should-be-removed' },
+      expected: { name: 'test-server' }
+    },
+    {
+      description: 'include all valid programmatic options',
+      source: { name: 'test-server', pluginIsolation: 'none', logging: { level: 'debug' } },
+      expected: { name: 'test-server', pluginIsolation: 'none', logging: { level: 'debug' } }
+    },
+    {
+      description: 'return an empty object when no valid keys are present',
+      source: { unknown: 'value', anotherUnknown: 123 },
+      expected: {}
+    },
+    {
+      description: 'handle custom baseOptions',
+      source: { name: 'test-server', custom: 'value' },
+      settings: { baseOptions: ['custom'] },
+      expected: { custom: 'value' }
+    },
+    {
+      description: 'handle empty source object',
+      source: {},
+      expected: {}
+    }
+  ])('should $description', ({ source, settings, expected }) => {
+    const result = pickProgrammaticOptions(source as any, settings as any);
+
+    expect(result).toEqual(expected);
+  });
+});

src/index.ts

@@ -1,5 +1,4 @@
 import {
-  EXPERIMENTAL_OPTIONS,
   type CliOptions,
   type ExperimentalOptions,
   type ProgrammaticOptions
@@ -236,7 +235,7 @@ const main = async (
       ...progOptions,
       experimental: [...new Set([...cliExp, ...progExp])],
       mode: cliOptions.mode ?? programmaticMode
-    }, EXPERIMENTAL_OPTIONS);
+    });
 
     // Finalize exit policy after merging options
     updatedAllowProcessExit = allowProcessExit ?? mergedOptions.mode !== 'test';

src/options.context.ts

@@ -1,6 +1,7 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
 import { randomUUID } from 'node:crypto';
 import {
+  EXPERIMENTAL_OPTIONS,
   type AppSession,
   type ExperimentalOptionKey,
   type GlobalOptions,
@@ -103,13 +104,16 @@ const optionsContext = new AsyncLocalStorage<GlobalOptions>();
  * @note In the future, look at adding a re-validation helper here, and potentially in `runWithOptions`,
  * that aligns with CLI options parsing. We need to account for both CLI and programmatic use.
  *
- * @param {ProgrammaticOptions & { experimental?: string[] }} [options] - Optional overrides merged with DEFAULT_OPTIONS.
- * @param [experimentalOptions] - The available experimental options list.
+ * @param [options] - Consumer optional overrides to be merged with DEFAULT_OPTIONS.
+ * @param [settings] - Function settings
+ * @param [settings.experimentalOptions] - Available experimental options list for comparison and filtering.
  * @returns {GlobalOptions} Cloned frozen default options object with session.
  */
 const setOptions = (
   options?: ProgrammaticOptions & { experimental?: string[] },
-  experimentalOptions: Set<ExperimentalOptionKey> = new Set()
+  {
+    experimentalOptions = EXPERIMENTAL_OPTIONS
+  }: { experimentalOptions?: Set<ExperimentalOptionKey> } = {}
 ): GlobalOptions => {
   const base = mergeObjects(DEFAULT_OPTIONS as GlobalOptions, options, { allowNullValues: false, allowUndefinedValues: false });
 

src/options.parser.ts

@@ -4,7 +4,8 @@ import {
   PROGRAMMATIC_OPTIONS,
   type CliOptions,
   type ExperimentalOptionKey,
-  type ProgrammaticOptions
+  type ProgrammaticOptions,
+  type ProgrammaticOptionsKey
 } from './options';
 import {
   DEFAULT_OPTIONS,
@@ -253,14 +254,21 @@ const parseCliOptions = (
 /**
  * Filter programmatic options to keys that exist in base options.
  *
- * @param {ProgrammaticOptions} source - Complete set of programmatic options provided as input.
+ * @param {ProgrammaticOptions} source - Input provided programmatic options.
+ * @param [settings] - Function settings
+ * @param [settings.baseOptions] - Base programmatic options set used for comparison/filtering.
  * @returns {ProgrammaticOptions} New object containing only the filtered programmatic options found in base options.
  */
-const pickProgrammaticOptions = (source: ProgrammaticOptions): ProgrammaticOptions => {
+const pickProgrammaticOptions = (
+  source: ProgrammaticOptions,
+  {
+    baseOptions = PROGRAMMATIC_OPTIONS
+  }: { baseOptions?: ReadonlyArray<ProgrammaticOptionsKey> } = {}
+): ProgrammaticOptions => {
   const picked: Record<string, unknown> = {};
 
   for (const key of Object.keys(source)) {
-    if ((PROGRAMMATIC_OPTIONS as readonly string[]).includes(key)) {
+    if ((baseOptions as readonly string[]).includes(key)) {
       picked[key] = source[key as keyof ProgrammaticOptions];
     }
   }

src/options.ts

@@ -94,18 +94,23 @@ const SET_OPTIONS = {
  */
 type SetOptions = typeof SET_OPTIONS;
 
+/**
+ * See {@link SET_OPTIONS}
+ */
+type ProgrammaticOptionsKey = keyof SetOptions;
+
 /**
  * See {@link SET_OPTIONS}
  */
 type ProgrammaticOptionsBase = {
-  -readonly [K in keyof SetOptions]?: SetOptions[K]['_type'] | undefined;
+  -readonly [K in ProgrammaticOptionsKey]?: SetOptions[K]['_type'] | undefined;
 };
 
 /**
  * See {@link SET_OPTIONS}
  */
 type CliOptionsBase = {
-  -readonly [K in keyof SetOptions as SetOptions[K]['cli'] extends true ? K : never]?:
+  -readonly [K in ProgrammaticOptionsKey as SetOptions[K]['cli'] extends true ? K : never]?:
   K extends 'toolModules' ? string[] | undefined : SetOptions[K]['_type'] | undefined
 };
 
@@ -122,7 +127,7 @@ type MakeExperimental<T, K extends string = never> = T & {
  * See {@link SET_OPTIONS}
  */
 type ExperimentalOptions = keyof {
-  [K in keyof SetOptions as SetOptions[K]['experimental'] extends true ? K : never]: unknown
+  [K in ProgrammaticOptionsKey as SetOptions[K]['experimental'] extends true ? K : never]: unknown
 } & string;
 
 /**
@@ -138,7 +143,7 @@ type ProgrammaticOptions = MakeExperimental<ProgrammaticOptionsBase, Experimenta
 /**
  * See {@link SET_OPTIONS}
  */
-type ExperimentalOptionKey = keyof SetOptions & string;
+type ExperimentalOptionKey = ProgrammaticOptionsKey & string;
 
 /**
  * Experimental options list.
@@ -167,7 +172,7 @@ const EXPERIMENTAL_CLI_OPTIONS = new Set<ExperimentalOptionKey>(
  *
  * See {@link SET_OPTIONS}
  */
-const PROGRAMMATIC_OPTIONS = Object.keys(SET_OPTIONS) as ReadonlyArray<keyof SetOptions>;
+const PROGRAMMATIC_OPTIONS = Object.keys(SET_OPTIONS) as ReadonlyArray<ProgrammaticOptionsKey>;
 
 export {
   EXPERIMENTAL_CLI_OPTIONS,
@@ -184,5 +189,6 @@ export {
   type MakeExperimental,
   type ProgrammaticOptions,
   type ProgrammaticOptionsBase,
+  type ProgrammaticOptionsKey,
   type SetOptions
 };