Merge pull request #233 from salesforcecli/er/updateSearchLogic

Er/update search logic

Author: WillieRuemmele

messages/agent.publish.authoring-bundle.md

@@ -4,7 +4,7 @@ Publish an Agent Authoring Bundle as a new agent
 
 # description
 
-Publishes an Agent Authoring Bundle by compiling the AF script and creating a new agent in your org.
+Publishes an Agent Authoring Bundle by compiling the .agent file and creating a new agent in your org.
 
 # examples
 
@@ -13,7 +13,7 @@ Publishes an Agent Authoring Bundle by compiling the AF script and creating a ne
 
 # flags.api-name.summary
 
-API name of the Agent Authoring Bundle to publish
+API name of the Agent Authoring Bundle to publish.
 
 # flags.api-name.prompt
 
@@ -38,7 +38,7 @@ Failed to publish agent with the following errors:
 
 # error.agentNotFound
 
-Could not find an .agent file with API name '%s' in the project.
+Could not find a .bundle-meta.xml file with API name '%s' in the project.
 
 # error.agentNotFoundAction
 

messages/agent.test.run.md

@@ -14,6 +14,10 @@ By default, this command outputs test results in human-readable tables for each
 
 API name of the agent test to run; corresponds to the name of the AiEvaluationDefinition metadata component that implements the agent test.
 
+# flags.api-name.prompt
+
+API name of the agent test to run
+
 # flags.wait.summary
 
 Number of minutes to wait for the command to complete and display results to the terminal window.

messages/agent.validate.authoring-bundle.md

@@ -4,7 +4,7 @@ Validate an Agent Authoring Bundle
 
 # description
 
-Validates an Agent Authoring Bundle by compiling the AF script and checking for errors.
+Validates an Agent Authoring Bundle by compiling the .agent file and checking for errors.
 
 # examples
 
@@ -13,7 +13,7 @@ Validates an Agent Authoring Bundle by compiling the AF script and checking for
 
 # flags.api-name.summary
 
-Path to the Agent Authoring Bundle to validate
+API name of the Agent Authoring Bundle to validate.
 
 # flags.api-name.prompt
 
@@ -29,12 +29,12 @@ Invalid bundle path. Please provide a valid path to an Agent Authoring Bundle.
 
 # error.compilationFailed
 
-AF Script compilation failed with the following errors:
+Agent compilation failed with the following errors:
 %s
 
 # error.agentNotFound
 
-Could not find an .agent file with API name '%s' in the project.
+Could not find a .bundle-meta.xml file with API name '%s' in the project.
 
 # error.agentNotFoundAction
 

package.json

@@ -9,7 +9,7 @@
     "@inquirer/prompts": "^7.8.6",
     "@oclif/core": "^4",
     "@oclif/multi-stage-output": "^0.8.23",
-    "@salesforce/agents": "^0.17.11",
+    "@salesforce/agents": "^0.18.0",
     "@salesforce/core": "^8.23.1",
     "@salesforce/kit": "^3.2.3",
     "@salesforce/sf-plugins-core": "^12.2.4",

src/commands/agent/generate/authoring-bundle.ts

@@ -134,7 +134,7 @@ export default class AgentGenerateAuthoringBundle extends SfCommand<AgentGenerat
       // Write Agent file
       const conn = targetOrg.getConnection(flags['api-version']);
       const specContents = YAML.parse(readFileSync(spec, 'utf8')) as AgentJobSpec;
-      const agent = await Agent.createAfScript(conn, specContents);
+      const agent = await Agent.createAgent(conn, specContents);
       // Create output directory if it doesn't exist
       mkdirSync(targetOutputDir, { recursive: true });
       writeFileSync(agentPath, agent);

src/commands/agent/publish/authoring-bundle.ts

@@ -22,7 +22,7 @@ import { Messages, Lifecycle, SfError } from '@salesforce/core';
 import { Agent, findAuthoringBundle } from '@salesforce/agents';
 import { RequestStatus, type ScopedPostRetrieve } from '@salesforce/source-deploy-retrieve';
 import { ensureArray } from '@salesforce/kit';
-import { FlaggablePrompt, promptForFileByExtensions } from '../../../flags.js';
+import { FlaggablePrompt, promptForAgentFiles } from '../../../flags.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.publish.authoring-bundle');
@@ -70,10 +70,11 @@ export default class AgentPublishAuthoringBundle extends SfCommand<AgentPublishA
     // If api-name is not provided, prompt user to select an .agent file from the project and extract the API name from it
     const apiName =
       flags['api-name'] ??
-      (await promptForFileByExtensions(AgentPublishAuthoringBundle.FLAGGABLE_PROMPTS['api-name'], ['.agent'], true));
-    // todo: this eslint warning can be removed once published
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-    const authoringBundleDir = findAuthoringBundle(this.project!.getPath(), apiName);
+      (await promptForAgentFiles(this.project!, AgentPublishAuthoringBundle.FLAGGABLE_PROMPTS['api-name']));
+    const authoringBundleDir = findAuthoringBundle(
+      this.project!.getPackageDirectories().map((dir) => dir.fullPath),
+      apiName
+    );
 
     if (!authoringBundleDir) {
       throw new SfError(messages.getMessage('error.agentNotFound', [apiName]), 'AgentNotFoundError', [
@@ -101,8 +102,8 @@ export default class AgentPublishAuthoringBundle extends SfCommand<AgentPublishA
       const targetOrg = flags['target-org'];
       const conn = targetOrg.getConnection(flags['api-version']);
 
-      // First compile the AF script to get the Agent JSON
-      const agentJson = await Agent.compileAfScript(
+      // First compile the .agent file to get the Agent JSON
+      const agentJson = await Agent.compileAgent(
         conn,
         readFileSync(join(authoringBundleDir, `${apiName}.agent`), 'utf8')
       );

src/commands/agent/test/run.ts

@@ -40,6 +40,7 @@ const FLAGGABLE_PROMPTS = {
     char: 'n',
     required: true,
     message: messages.getMessage('flags.api-name.summary'),
+    promptMessage: messages.getMessage('flags.api-name.prompt'),
     validate: (d: string): boolean | string => {
       if (d.length === 0) {
         return true;

src/commands/agent/validate/authoring-bundle.ts

@@ -21,7 +21,7 @@ import { MultiStageOutput } from '@oclif/multi-stage-output';
 import { Agent, findAuthoringBundle } from '@salesforce/agents';
 import { Duration, sleep } from '@salesforce/kit';
 import { colorize } from '@oclif/core/ux';
-import { FlaggablePrompt, promptForFileByExtensions } from '../../../flags.js';
+import { FlaggablePrompt, promptForAgentFiles } from '../../../flags.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.validate.authoring-bundle');
@@ -68,8 +68,11 @@ export default class AgentValidateAuthoringBundle extends SfCommand<AgentValidat
     // If api-name is not provided, prompt user to select an .agent file from the project and extract the API name from it
     const apiName =
       flags['api-name'] ??
-      (await promptForFileByExtensions(AgentValidateAuthoringBundle.FLAGGABLE_PROMPTS['api-name'], ['.agent'], true));
-    const authoringBundleDir = findAuthoringBundle(this.project!.getPath(), apiName);
+      (await promptForAgentFiles(this.project!, AgentValidateAuthoringBundle.FLAGGABLE_PROMPTS['api-name']));
+    const authoringBundleDir = findAuthoringBundle(
+      this.project!.getPackageDirectories().map((dir) => dir.fullPath),
+      apiName
+    );
     if (!authoringBundleDir) {
       throw new SfError(messages.getMessage('error.agentNotFound', [apiName]), 'AgentNotFoundError', [
         messages.getMessage('error.agentNotFoundAction'),
@@ -100,9 +103,9 @@ export default class AgentValidateAuthoringBundle extends SfCommand<AgentValidat
       mso.skipTo('Validating Authoring Bundle');
       const targetOrg = flags['target-org'];
       const conn = targetOrg.getConnection(flags['api-version']);
-      // Call Agent.compileAfScript() API
+      // Call Agent.compileAgent() API
       await sleep(Duration.seconds(2));
-      await Agent.compileAfScript(conn, readFileSync(join(authoringBundleDir, `${apiName}.agent`), 'utf8'));
+      await Agent.compileAgent(conn, readFileSync(join(authoringBundleDir, `${apiName}.agent`), 'utf8'));
       mso.updateData({ status: 'COMPLETED' });
       mso.stop('completed');
       return {

src/flags.ts

@@ -15,10 +15,11 @@
  */
 
 import { readdir } from 'node:fs/promises';
+import { readdirSync } from 'node:fs';
 import { basename, join, relative } from 'node:path';
 import { Interfaces } from '@oclif/core';
 import { Flags } from '@salesforce/sf-plugins-core';
-import { Connection, Messages, SfError } from '@salesforce/core';
+import { Connection, Messages, SfError, SfProject } from '@salesforce/core';
 import { camelCaseToTitleCase } from '@salesforce/kit';
 import { select, input as inquirerInput } from '@inquirer/prompts';
 import autocomplete from 'inquirer-autocomplete-standalone';
@@ -102,18 +103,25 @@ export async function getHiddenDirs(projectRoot?: string): Promise<string[]> {
   }
 }
 
-export async function traverseForFiles(dir: string, suffixes: string[], excludeDirs?: string[]): Promise<string[]> {
-  const files = await readdir(dir, { withFileTypes: true });
+export function traverseForFiles(dir: string, suffixes: string[], excludeDirs?: string[]): string[];
+// eslint-disable-next-line @typescript-eslint/unified-signatures
+export function traverseForFiles(dirs: string[], suffixes: string[], excludeDirs?: string[]): string[];
+
+export function traverseForFiles(dirOrDirs: string | string[], suffixes: string[], excludeDirs?: string[]): string[] {
+  const dirs = Array.isArray(dirOrDirs) ? dirOrDirs : [dirOrDirs];
   const results: string[] = [];
 
-  for (const file of files) {
-    const fullPath = join(dir, file.name);
+  for (const dir of dirs) {
+    const files = readdirSync(dir, { withFileTypes: true });
+
+    for (const file of files) {
+      const fullPath = join(dir, file.name);
 
-    if (file.isDirectory() && !excludeDirs?.includes(file.name)) {
-      // eslint-disable-next-line no-await-in-loop
-      results.push(...(await traverseForFiles(fullPath, suffixes, excludeDirs)));
-    } else if (suffixes.some((suffix) => file.name.endsWith(suffix))) {
-      results.push(fullPath);
+      if (file.isDirectory() && !excludeDirs?.includes(file.name)) {
+        results.push(...traverseForFiles(fullPath, suffixes, excludeDirs));
+      } else if (suffixes.some((suffix) => file.name.endsWith(suffix))) {
+        results.push(fullPath);
+      }
     }
   }
 
@@ -135,7 +143,7 @@ export const promptForAiEvaluationDefinitionApiName = async (
 
   return Promise.race([
     autocomplete({
-      message: flagDef.message,
+      message: flagDef.promptMessage ?? flagDef.message,
       // eslint-disable-next-line @typescript-eslint/require-await
       source: async (input) => {
         const arr = aiDefFiles.map((o) => ({ name: o.fullName, value: o.fullName }));
@@ -154,10 +162,12 @@ export const promptForAiEvaluationDefinitionApiName = async (
 export const promptForFileByExtensions = async (
   flagDef: FlaggablePrompt,
   extensions: string[],
-  fileNameOnly = false
+  fileNameOnly = false,
+  dirs?: string[]
 ): Promise<string> => {
   const hiddenDirs = await getHiddenDirs();
-  const files = await traverseForFiles(process.cwd(), extensions, ['node_modules', ...hiddenDirs]);
+  const dirsToTraverse = dirs ?? [process.cwd()];
+  const files = traverseForFiles(dirsToTraverse, extensions, ['node_modules', ...hiddenDirs]);
   return autocomplete({
     message: flagDef.promptMessage ?? flagDef.message.replace(/\.$/, ''),
     // eslint-disable-next-line @typescript-eslint/require-await
@@ -194,6 +204,11 @@ export const promptForFlag = async (flagDef: FlaggablePrompt): Promise<string> =
   });
 };
 
+export const promptForAgentFiles = (project: SfProject, flagDef: FlaggablePrompt): Promise<string> => {
+  const dirs = project.getPackageDirectories().map((dir) => dir.fullPath);
+  return promptForFileByExtensions(flagDef, ['.bundle-meta.xml'], true, dirs);
+};
+
 export const validateAgentType = (agentType?: string, required = false): string | undefined => {
   if (required && !agentType) {
     throw messages.createError('error.invalidAgentType', [agentType]);

test/flags.test.ts

@@ -47,7 +47,7 @@ describe('traverseForFiles', () => {
   });
 
   it('should find all yaml files when no excludeDirs is provided', async () => {
-    const results = await traverseForFiles(testDir, ['.yml', '.yaml']);
+    const results = traverseForFiles(testDir, ['.yml', '.yaml']);
     expect(results).to.have.lengthOf(6);
     expect(results).to.include(join(testDir, 'file1.yml'));
     expect(results).to.include(join(testDir, 'file2.yaml'));
@@ -58,7 +58,7 @@ describe('traverseForFiles', () => {
   });
 
   it('should exclude specified directories', async () => {
-    const results = await traverseForFiles(testDir, ['.yml', '.yaml'], ['node_modules', 'excluded']);
+    const results = traverseForFiles(testDir, ['.yml', '.yaml'], ['node_modules', 'excluded']);
     expect(results).to.have.lengthOf(4);
     expect(results).to.include(join(testDir, 'file1.yml'));
     expect(results).to.include(join(testDir, 'file2.yaml'));
@@ -69,7 +69,7 @@ describe('traverseForFiles', () => {
   });
 
   it('should handle empty excludeDirs array', async () => {
-    const results = await traverseForFiles(testDir, ['.yml', '.yaml'], []);
+    const results = traverseForFiles(testDir, ['.yml', '.yaml'], []);
     expect(results).to.have.lengthOf(6);
   });
 });