feat: Add backend-function runtime behavior to get the data config

Author: stocaaro

.changeset/brave-cheetahs-repeat.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-function': patch
+---
+
+feat: Add backend-function runtime behavior to get the data config

package-lock.json

@@ -27,6 +27,7 @@
   "devDependencies": {
     "@aws-amplify/backend-platform-test-stubs": "^0.3.6",
     "@aws-amplify/platform-core": "^1.1.0",
+    "@aws-sdk/client-s3": "^3.624.0",
     "@aws-sdk/client-ssm": "^3.624.0",
     "aws-sdk": "^2.1550.0",
     "uuid": "^9.0.1"

packages/backend-function/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@aws-amplify/backend-function/runtime",
+  "main": "../dist/cjs/runtime/index.js",
+  "react-native": "../src/runtime/index.ts",
+  "browser": "../dist/esm/runtime/index.mjs",
+  "module": "../dist/esm/runtime/index.mjs",
+  "typings": "../dist/esm/runtime/index.d.ts"
+}

packages/backend-function/runtime/package.json

@@ -0,0 +1,136 @@
+import { beforeEach, describe, it, mock } from 'node:test';
+import assert from 'assert';
+import { NoSuchKey, S3, S3ServiceException } from '@aws-sdk/client-s3';
+
+import {
+  getAmplifyClientsConfiguration,
+  getAmplifyClientsConfigurationRetriever,
+} from './get_amplify_clients_configuration.js';
+
+const validEnv = {
+  AMPLIFY_DATA_MODEL_INTROSPECTION_SCHEMA_BUCKET_NAME:
+    'TEST_VALUE for AMPLIFY_DATA_MODEL_INTROSPECTION_SCHEMA_BUCKET_NAME',
+  AMPLIFY_DATA_MODEL_INTROSPECTION_SCHEMA_KEY:
+    'TEST_VALUE for AMPLIFY_DATA_MODEL_INTROSPECTION_SCHEMA_KEY',
+  AWS_ACCESS_KEY_ID: 'TEST_VALUE for AWS_ACCESS_KEY_ID',
+  AWS_SECRET_ACCESS_KEY: 'TEST_VALUE for AWS_SECRET_ACCESS_KEY',
+  AWS_SESSION_TOKEN: 'TEST_VALUE for AWS_SESSION_TOKEN',
+  AWS_REGION: 'TEST_VALUE for AWS_REGION',
+  AMPLIFY_DATA_GRAPHQL_ENDPOINT: 'TEST_VALUE for AMPLIFY_DATA_GRAPHQL_ENDPOINT',
+};
+
+let mockS3Client: S3;
+
+void describe('getAmplifyClientsConfiguration', () => {
+  beforeEach(() => {
+    mockS3Client = new S3();
+  });
+
+  Object.keys(validEnv).forEach((envFieldToExclude) => {
+    void it(`returns empty config objects when ${envFieldToExclude} is not included`, async () => {
+      const env = { ...validEnv } as Record<string, string>;
+      delete env[envFieldToExclude];
+      assert.deepEqual(await getAmplifyClientsConfiguration(env), {
+        resourceConfig: {},
+        libraryOptions: {},
+      });
+    });
+
+    void it(`returns empty config objects when ${envFieldToExclude} is not a string`, async () => {
+      const env = { ...validEnv } as Record<string, unknown>;
+      env[envFieldToExclude] = 123;
+      assert.deepEqual(await getAmplifyClientsConfiguration(env), {
+        resourceConfig: {},
+        libraryOptions: {},
+      });
+    });
+  });
+
+  void it('raises a custom error message when the model introspection schema is missing from the s3 bucket', async () => {
+    const s3ClientSendMock = mock.method(mockS3Client, 'send', async () => {
+      throw new NoSuchKey({ message: 'TEST_ERROR', $metadata: {} });
+    });
+    mock.method(mockS3Client, 'send', s3ClientSendMock);
+
+    await assert.rejects(
+      async () =>
+        await getAmplifyClientsConfigurationRetriever(validEnv, mockS3Client),
+      new Error(
+        'Error retrieving the schema from S3. Please confirm that your project has a `defineData` included in the `defineBackend` definition.'
+      )
+    );
+  });
+
+  void it('raises a custom error message when there is a S3ServiceException error retrieving the model introspection schema from the s3 bucket', async () => {
+    const s3ClientSendMock = mock.method(mockS3Client, 'send', async () => {
+      throw new S3ServiceException({
+        name: 'TEST_ERROR',
+        message: 'TEST_MESSAGE',
+        $fault: 'server',
+        $metadata: {},
+      });
+    });
+    mock.method(mockS3Client, 'send', s3ClientSendMock);
+
+    await assert.rejects(
+      async () =>
+        await getAmplifyClientsConfigurationRetriever(validEnv, mockS3Client),
+      new Error(
+        'Error retrieving the schema from S3. You may need to grant this function authorization on the schema. TEST_ERROR: TEST_MESSAGE.'
+      )
+    );
+  });
+
+  void it('re-raises a non-S3 error received when retrieving the model introspection schema from the s3 bucket', async () => {
+    const s3ClientSendMock = mock.method(mockS3Client, 'send', async () => {
+      throw new Error('Test Error');
+    });
+    mock.method(mockS3Client, 'send', s3ClientSendMock);
+
+    await assert.rejects(
+      async () =>
+        await getAmplifyClientsConfigurationRetriever(validEnv, mockS3Client),
+      new Error('Test Error')
+    );
+  });
+
+  void it('returns the expected libraryOptions and resourceConfig values in the happy case', async () => {
+    const s3ClientSendMock = mock.method(mockS3Client, 'send', () => {
+      return Promise.resolve({
+        Body: {
+          transformToString: () => JSON.stringify({ testSchema: 'TESTING' }),
+        },
+      });
+    });
+    mock.method(mockS3Client, 'send', s3ClientSendMock);
+
+    const { resourceConfig, libraryOptions } =
+      await getAmplifyClientsConfigurationRetriever(validEnv, mockS3Client);
+
+    assert.deepEqual(
+      await libraryOptions.Auth.credentialsProvider.getCredentialsAndIdentityId?.(),
+      {
+        credentials: {
+          accessKeyId: 'TEST_VALUE for AWS_ACCESS_KEY_ID',
+          secretAccessKey: 'TEST_VALUE for AWS_SECRET_ACCESS_KEY',
+          sessionToken: 'TEST_VALUE for AWS_SESSION_TOKEN',
+        },
+      }
+    );
+    assert.deepEqual(
+      await libraryOptions.Auth.credentialsProvider.clearCredentialsAndIdentityId?.(),
+      undefined
+    );
+
+    assert.deepEqual(resourceConfig, {
+      API: {
+        GraphQL: {
+          endpoint: 'TEST_VALUE for AMPLIFY_DATA_GRAPHQL_ENDPOINT',
+          region: 'TEST_VALUE for AWS_REGION',
+          defaultAuthMode: 'iam',
+          modelIntrospection: { testSchema: 'TESTING' },
+        },
+      },
+    });
+  });
+});