feat(data-schema): accept null to disable queryField for secondary indexes (#567)

Co-authored-by: Aaron S. <94858815+stocaaro@users.noreply.github.com>
Co-authored-by: James Jarvis <jjarvisp@amazon.com>

Author: 3 people

.changeset/crazy-pets-sniff.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/data-schema': minor
+---
+
+Accept null to disable queryField for secondary indexes

packages/data-schema/__tests__/ModelIndex.test.ts

@@ -128,4 +128,58 @@ describe('SchemaProcessor validation against secondary indexes', () => {
       'The ref field `status` used in the secondary index of `Todo` should refer to an enum type. `TodoStatus` is not a enum type.',
     );
   });
+
+  it('creates a queryField with a default name', () => {
+    const schema = a
+      .schema({
+        Todo: a
+          .model({
+            title: a.string().required(),
+            content: a.string(),
+            status: a.enum(['open', 'in_progress', 'completed']),
+          })
+          .secondaryIndexes((index) => [
+            index('status').sortKeys(['title'])
+          ]),
+      })
+      .authorization((allow) => allow.publicApiKey());
+
+    expect(schema.transform().schema).toMatchSnapshot();
+  });
+
+  it('creates a queryField with user-defined name', () => {
+    const schema = a
+      .schema({
+        Todo: a
+          .model({
+            title: a.string().required(),
+            content: a.string(),
+            status: a.enum(['open', 'in_progress', 'completed']),
+          })
+          .secondaryIndexes((index) => [
+            index('status').sortKeys(['title']).queryField('userDefinedQueryField')
+          ]),
+      })
+      .authorization((allow) => allow.publicApiKey());
+
+    expect(schema.transform().schema).toMatchSnapshot();
+  });
+
+  it('omits the queryField if null is provided instead of a name', () => {
+    const schema = a
+      .schema({
+        Todo: a
+          .model({
+            title: a.string().required(),
+            content: a.string(),
+            status: a.enum(['open', 'in_progress', 'completed']),
+          })
+          .secondaryIndexes((index) => [
+            index('status').sortKeys(['title']).queryField(null)
+          ]),
+      })
+      .authorization((allow) => allow.publicApiKey());
+
+    expect(schema.transform().schema).toMatchSnapshot();
+  });
 });

packages/data-schema/__tests__/__snapshots__/ModelIndex.test.ts.snap

@@ -1,5 +1,50 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`SchemaProcessor validation against secondary indexes creates a queryField with a default name 1`] = `
+"type Todo @model @auth(rules: [{allow: public, provider: apiKey}])
+{
+  title: String!
+  content: String
+  status: TodoStatus @index(sortKeyFields: ["title"], queryField: "listTodoByStatusAndTitle")
+}
+
+enum TodoStatus {
+  open
+  in_progress
+  completed
+}"
+`;
+
+exports[`SchemaProcessor validation against secondary indexes creates a queryField with user-defined name 1`] = `
+"type Todo @model @auth(rules: [{allow: public, provider: apiKey}])
+{
+  title: String!
+  content: String
+  status: TodoStatus @index(sortKeyFields: ["title"], queryField: "userDefinedQueryField")
+}
+
+enum TodoStatus {
+  open
+  in_progress
+  completed
+}"
+`;
+
+exports[`SchemaProcessor validation against secondary indexes omits the queryField if null is provided instead of a name 1`] = `
+"type Todo @model @auth(rules: [{allow: public, provider: apiKey}])
+{
+  title: String!
+  content: String
+  status: TodoStatus @index(sortKeyFields: ["title"], queryField: null)
+}
+
+enum TodoStatus {
+  open
+  in_progress
+  completed
+}"
+`;
+
 exports[`secondary index schema generation generates correct schema for using a.enum() as the partition key 1`] = `
 "type Todo @model @auth(rules: [{allow: public, provider: apiKey}])
 {

packages/data-schema/src/ModelIndex.ts

@@ -6,7 +6,7 @@ export type ModelIndexData = {
   partitionKey: string;
   sortKeys: readonly unknown[];
   indexName: string;
-  queryField: string;
+  queryField: string | null;
 };
 
 export type InternalModelIndexType = ModelIndexType<any, any, any, any> & {
@@ -31,7 +31,7 @@ export type ModelIndexType<
       name: string,
     ): ModelIndexType<ModelFieldKeys, PK, SK, QueryField, K | 'name'>;
     queryField<
-      QF extends string = never,
+      QF extends string | null = never,
       MF extends ModelFieldKeys = ModelFieldKeys,
     >(
       field: QF,

packages/data-schema/src/SchemaProcessor.ts

@@ -217,7 +217,7 @@ function scalarFieldToGql(
   for (const index of secondaryIndexes) {
     field += ` ${index}`;
   }
-  
+
   // Add validation directives for each validation rule
   for (const validationRule of validation) {
     const valueStr = typeof validationRule.value === 'number' ? validationRule.value.toString() : validationRule.value;
@@ -227,7 +227,7 @@ function scalarFieldToGql(
       field += ` @validate(type: ${validationRule.type}, value: "${valueStr}")`;
     }
   }
-  
+
   return field;
 }
 
@@ -1116,7 +1116,7 @@ const transformedSecondaryIndexesForModel = (
     partitionKey: string,
     sortKeys: readonly string[],
     indexName: string,
-    queryField: string,
+    queryField: string | null,
   ): string => {
     for (const keyName of [partitionKey, ...sortKeys]) {
       const field = modelFields[keyName];
@@ -1131,7 +1131,7 @@ const transformedSecondaryIndexesForModel = (
       }
     }
 
-    if (!sortKeys.length && !indexName && !queryField) {
+    if (!sortKeys.length && !indexName && !queryField && queryField !== null) {
       return `@index(queryField: "${secondaryIndexDefaultQueryField(
         modelName,
         partitionKey,
@@ -1150,7 +1150,10 @@ const transformedSecondaryIndexesForModel = (
       );
     }
 
-    if (queryField) {
+    if(queryField === null) {
+      attributes.push(`queryField: null`);
+    }
+    else if (queryField) {
       attributes.push(`queryField: "${queryField}"`);
     } else {
       attributes.push(