feat: add projection support for @index directive (#3359)

Author: ahmedhamouda78

codebuild_specs/e2e_workflow.yml

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+import 'source-map-support/register';
+import { App, Stack, Duration } from 'aws-cdk-lib';
+// @ts-ignore
+import { AmplifyGraphqlApi, AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct';
+
+const packageJson = require('../package.json');
+
+const app = new App();
+const stack = new Stack(app, packageJson.name.replace(/_/g, '-'), {
+  env: { region: process.env.CLI_REGION || 'us-west-2' },
+});
+
+new AmplifyGraphqlApi(stack, 'GraphqlApi', {
+  apiName: 'GSIProjectionAll',
+  definition: AmplifyGraphqlDefinition.fromString(
+    /* GraphQL */ `
+      type Product @model @auth(rules: [{ allow: public }]) {
+        id: ID!
+        name: String!
+        category: String! @index(name: "byCategory", queryField: "productsByCategory", projection: { type: ALL })
+        price: Float!
+        inStock: Boolean!
+      }
+    `,
+    {
+      dbType: 'DYNAMODB',
+      provisionStrategy: 'AMPLIFY_TABLE',
+    },
+  ),
+  authorizationModes: {
+    apiKeyConfig: { expires: Duration.days(7) },
+  },
+});

packages/amplify-graphql-api-construct-tests/src/__tests__/backends/gsi-projection-type/all/app.ts

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+import 'source-map-support/register';
+import { App, Stack, Duration } from 'aws-cdk-lib';
+// @ts-ignore
+import { AmplifyGraphqlApi, AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct';
+
+const packageJson = require('../package.json');
+
+const app = new App();
+const stack = new Stack(app, packageJson.name.replace(/_/g, '-'), {
+  env: { region: process.env.CLI_REGION || 'us-west-2' },
+});
+
+new AmplifyGraphqlApi(stack, 'GraphqlApi', {
+  apiName: 'GSIProjectionInclude',
+  definition: AmplifyGraphqlDefinition.fromString(
+    /* GraphQL */ `
+      type Product @model @auth(rules: [{ allow: public }]) {
+        id: ID!
+        name: String!
+        category: String!
+          @index(name: "byCategory", queryField: "productsByCategory", projection: { type: INCLUDE, nonKeyAttributes: ["name", "price"] })
+        price: Float!
+        inStock: Boolean
+      }
+    `,
+    {
+      dbType: 'DYNAMODB',
+      provisionStrategy: 'AMPLIFY_TABLE',
+    },
+  ),
+  authorizationModes: {
+    apiKeyConfig: { expires: Duration.days(7) },
+  },
+});

packages/amplify-graphql-api-construct-tests/src/__tests__/backends/gsi-projection-type/include/app.ts

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+import 'source-map-support/register';
+import { App, Stack, Duration } from 'aws-cdk-lib';
+// @ts-ignore
+import { AmplifyGraphqlApi, AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct';
+
+const packageJson = require('../package.json');
+
+const app = new App();
+const stack = new Stack(app, packageJson.name.replace(/_/g, '-'), {
+  env: { region: process.env.CLI_REGION || 'us-west-2' },
+});
+
+new AmplifyGraphqlApi(stack, 'GraphqlApi', {
+  apiName: 'GSIProjectionKeysOnly',
+  definition: AmplifyGraphqlDefinition.fromString(
+    /* GraphQL */ `
+      type Product @model @auth(rules: [{ allow: public }]) {
+        id: ID!
+        name: String!
+        category: String! @index(name: "byCategory", queryField: "productsByCategory", projection: { type: KEYS_ONLY })
+        price: Float
+      }
+    `,
+    {
+      dbType: 'DYNAMODB',
+      provisionStrategy: 'AMPLIFY_TABLE',
+    },
+  ),
+  authorizationModes: {
+    apiKeyConfig: { expires: Duration.days(7) },
+  },
+});

packages/amplify-graphql-api-construct-tests/src/__tests__/backends/gsi-projection-type/keys-only/app.ts

@@ -0,0 +1,61 @@
+import * as path from 'path';
+import { createNewProjectDir, deleteProjectDir, getDDBTable } from 'amplify-category-api-e2e-core';
+import { cdkDestroy, initCDKProject, cdkDeploy } from '../commands';
+import { DURATION_1_HOUR } from '../utils/duration-constants';
+
+jest.setTimeout(DURATION_1_HOUR);
+
+describe('GSI Projection Type', () => {
+  let projRoot: string;
+
+  beforeEach(async () => {
+    projRoot = await createNewProjectDir('gsiprojectiontype');
+  });
+
+  afterEach(async () => {
+    try {
+      await cdkDestroy(projRoot, '--all');
+    } catch (_) {
+      /* No-op */
+    }
+    deleteProjectDir(projRoot);
+    if (global.gc) global.gc();
+  });
+
+  test.each([
+    [
+      'KEYS_ONLY',
+      'keys-only',
+      (gsi: any) => {
+        expect(gsi.Projection.ProjectionType).toBe('KEYS_ONLY');
+      },
+    ],
+    [
+      'INCLUDE',
+      'include',
+      (gsi: any) => {
+        expect(gsi.Projection.ProjectionType).toBe('INCLUDE');
+        expect(gsi.Projection.NonKeyAttributes).toEqual(expect.arrayContaining(['name', 'price']));
+      },
+    ],
+    [
+      'ALL',
+      'all',
+      (gsi: any) => {
+        expect(gsi.Projection.ProjectionType).toBe('ALL');
+      },
+    ],
+  ])('creates GSI with %s projection', async (_projectionType, templateDir, validator) => {
+    const templatePath = path.resolve(path.join(__dirname, 'backends', 'gsi-projection-type', templateDir));
+    const name = await initCDKProject(projRoot, templatePath);
+    const outputs = await cdkDeploy(projRoot, '--all');
+    const { awsAppsyncApiId: apiId, awsAppsyncRegion: region } = outputs[name];
+    const table = await getDDBTable(`Product-${apiId}-NONE`, region);
+    const gsi = table.Table.GlobalSecondaryIndexes[0];
+
+    expect(table.Table.GlobalSecondaryIndexes).toBeDefined();
+    expect(table.Table.GlobalSecondaryIndexes.length).toBe(1);
+    expect(gsi.IndexName).toBe('byCategory');
+    validator(gsi);
+  });
+});