fix(conversation): model list tool query name infinite recursion (#3037)

Author: atierian

packages/amplify-graphql-conversation-transformer/src/__tests__/__snapshots__/amplify-graphql-conversation-transformer.test.ts.snap

@@ -1545,7 +1545,7 @@ export function request(ctx) {
   const clientTools = args.toolConfiguration?.tools?.map((tool) => {
     return { ...tool.toolSpec };
   });
-  const dataTools = [{"name":"list_customers","description":"Provides data about the customer sending a message","inputSchema":{"json":{"type":"object","properties":{},"required":[]}},"graphqlRequestInputDescriptor":{"selectionSet":"items { name email activeCart { products { name price } customerId id createdAt updatedAt owner } orderHistory { items { products { name price } customerId id createdAt updatedAt owner } nextToken } id createdAt updatedAt owner } nextToken","propertyTypes":{},"queryName":"listCustomers"}}];
+  const dataTools = [{"name":"random_name","description":"Provides data about the customer sending a message","inputSchema":{"json":{"type":"object","properties":{},"required":[]}},"graphqlRequestInputDescriptor":{"selectionSet":"items { name email activeCart { products { name price } customerId id createdAt updatedAt owner } orderHistory { items { products { name price } customerId id createdAt updatedAt owner } nextToken } id createdAt updatedAt owner } nextToken","propertyTypes":{},"queryName":"listCustomers"}}];
   const toolsConfiguration = { dataTools, clientTools };
 
   const messageHistoryQuery = {

packages/amplify-graphql-conversation-transformer/src/__tests__/schemas/conversation-route-model-query-tool-with-relationships.graphql

@@ -34,7 +34,7 @@ type Mutation {
     systemPrompt: "You are a helpful chatbot. Answer questions to the best of your ability.",
     tools: [
       {
-        name: "list_customers",
+        name: "random_name",
         description: "Provides data about the customer sending a message",
         modelName: "Customer",
         modelOperation: list,

packages/amplify-graphql-conversation-transformer/src/tools/process-tools.ts

@@ -56,15 +56,16 @@ export const processTools = (toolDefinitions: ToolDefinition[], ctx: Transformer
 
   // Process each tool definition
   const tools: Tool[] = toolDefinitions.map((toolDefinition) => {
-    const { name: toolName, description } = toolDefinition;
     const queryName = isModelOperationToolPredicate(toolDefinition) ? modelListQueryName(toolDefinition, ctx) : toolDefinition.queryName;
     const queryField = queryType.fields?.find((field) => field.name.value === queryName);
 
     if (!queryField) {
-      throw new InvalidDirectiveError(`Tool "${toolName}" defined in @conversation directive has no matching Query field definition`);
+      throw new InvalidDirectiveError(
+        `Tool "${toolDefinition.name}" defined in @conversation directive has no matching Query field definition`,
+      );
     }
 
-    return createTool({ toolName, description, queryField, ctx });
+    return createTool({ toolDefinition, queryField, ctx });
   });
 
   return tools;
@@ -150,23 +151,19 @@ const getObjectTypeFromName = (name: string, ctx: TransformerContextProvider): O
  * @param {TransformerContextProvider} ctx - The transformer context provider.
  * @returns {Tool} A Tool object.
  */
-const createTool = (input: {
-  toolName: string;
-  description: string;
-  queryField: FieldDefinitionNode;
-  ctx: TransformerContextProvider;
-}): Tool => {
-  const { toolName, description, queryField, ctx } = input;
+const createTool = (input: { toolDefinition: ToolDefinition; queryField: FieldDefinitionNode; ctx: TransformerContextProvider }): Tool => {
+  const { toolDefinition, queryField, ctx } = input;
+  const { name: toolName, description } = toolDefinition;
   const { type: returnType, arguments: fieldArguments } = queryField;
 
   // Generate tool properties and required fields
-  const { properties, required } = generateToolProperties(fieldArguments, ctx, toolName, returnType);
+  const { properties, required } = generateToolProperties(fieldArguments, ctx, toolDefinition);
 
   // Generate selection set for the return type
   const selectionSet = generateSelectionSet(returnType, ctx).trim();
 
   // Generate property types for GraphQL request input
-  const propertyTypes = generatePropertyTypes(fieldArguments, toolName, returnType);
+  const propertyTypes = generatePropertyTypes(fieldArguments, toolDefinition);
 
   // Create GraphQL request input descriptor
   const graphqlRequestInputDescriptor: GraphQLRequestInputDescriptor = {
@@ -199,14 +196,13 @@ const createTool = (input: {
 const generateToolProperties = (
   fieldArguments: readonly InputValueDefinitionNode[] | undefined,
   ctx: TransformerContextProvider,
-  toolName: string,
-  returnType: TypeNode,
+  toolDefinition: ToolDefinition,
 ): { properties: Record<string, JSONSchema>; required: string[] } => {
   if (!fieldArguments || fieldArguments.length === 0) {
     return { properties: {}, required: [] };
   }
 
-  if (isModelListOperation(toolName, returnType)) {
+  if (isModelOperationToolPredicate(toolDefinition)) {
     return { properties: {}, required: [] };
   }
 
@@ -233,14 +229,13 @@ const generateToolProperties = (
  */
 const generatePropertyTypes = (
   fieldArguments: readonly InputValueDefinitionNode[] | undefined,
-  toolName: string,
-  returnType: TypeNode,
+  toolDefinition: ToolDefinition,
 ): Record<string, string> => {
   if (!fieldArguments || fieldArguments.length === 0) {
     return {};
   }
 
-  if (isModelListOperation(toolName, returnType)) {
+  if (isModelOperationToolPredicate(toolDefinition)) {
     return {};
   }
 
@@ -252,10 +247,6 @@ const generatePropertyTypes = (
   }, {} as Record<string, string>);
 };
 
-const isModelListOperation = (toolName: string, responseType: TypeNode): boolean => {
-  return getBaseType(responseType).startsWith('Model') && toolName.startsWith('list');
-};
-
 const modelListQueryName = (modelTool: ModelOperationTool, ctx: TransformerContextProvider): string => {
   const { modelName } = modelTool;
   const model = getObjectTypeFromName(modelName, ctx);