@aws-amplify/data-schema 1.3.10 → 1.4.0

package/src/runtime/internals/clientUtils.ts

@@ -1,11 +1,12 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-
 import type {
   ModelAttribute,
   SchemaModel,
   SecondaryIndexAttribute,
+  ModelIntrospectionSchema,
 } from '../bridge-types';
+import { graphQLOperationsInfo } from './APIClient';
 
 const attributeIsSecondaryIndex = (
   attr: ModelAttribute,
@@ -35,3 +36,62 @@ export const getSecondaryIndexesFromSchemaModel = (model: SchemaModel) => {
 
   return idxs || [];
 };
+
+/**
+ * returns graphQLOperationsInfo, but filters out operations that were disabled via model().disableOperations([...])
+ */
+export const excludeDisabledOps = (
+  mis: ModelIntrospectionSchema,
+  modelName: string,
+) => {
+  /* Example model attributes in MIS {
+    "type": "model",
+    "properties": {
+      "subscriptions": null,
+      "mutations": { "delete": null }
+    } }*/
+  const modelAttrs = mis.models[modelName].attributes?.find(
+    (attr) => attr.type === 'model',
+  );
+
+  const coarseToFineDict: Record<string, string[]> = {
+    queries: ['list', 'get', 'observeQuery'],
+    mutations: ['create', 'update', 'delete'],
+    subscriptions: ['onCreate', 'onUpdate', 'onDelete'],
+  };
+
+  const disabledOps: string[] = [];
+
+  if (!modelAttrs) {
+    return graphQLOperationsInfo;
+  }
+
+  if (modelAttrs.properties) {
+    for (const [key, value] of Object.entries(modelAttrs.properties)) {
+      if (value === null) {
+        // coarse-grained disable, e.g. "subscriptions": null,
+        disabledOps.push(...coarseToFineDict[key]);
+      } else if (value instanceof Object) {
+        // fine-grained, e.g. "mutations": { "delete": null }
+        disabledOps.push(...Object.keys(value));
+      }
+    }
+  }
+
+  // observeQuery only exists on the client side, so can't be explicitly disabled via schema builder.
+  // It's unusable without `list`
+  if (disabledOps.includes('list')) {
+    disabledOps.push('observeQuery');
+  }
+
+  // graphQLOperationsInfo keys are in caps
+  const disabledOpsUpper = disabledOps.map((op) => op.toUpperCase());
+
+  const filteredGraphQLOperations = Object.fromEntries(
+    Object.entries(graphQLOperationsInfo).filter(
+      ([key]) => !disabledOpsUpper.includes(key),
+    ),
+  );
+
+  return filteredGraphQLOperations;
+};

package/src/runtime/internals/index.ts

@@ -10,3 +10,4 @@ export { generateModelsProperty } from './utils/clientProperties/generateModelsP
 export { isGraphQLResponseWithErrors } from './utils/runtimeTypeGuards/isGraphQLResponseWithErrors';
 export { isApiGraphQLConfig } from './utils/runtimeTypeGuards/isApiGraphQLProviderConfig';
 export { isConfigureEventWithResourceConfig } from './utils/runtimeTypeGuards/isConfigureEventWithResourceConfig';
+export { upgradeClientCancellation } from './cancellation';

package/src/runtime/internals/operations/custom.ts

@@ -27,6 +27,9 @@ import {
 } from '../APIClient';
 
 import { handleSingularGraphQlError } from './utils';
+import { selfAwareAsync } from '../../utils';
+
+import { extendCancellability } from '../cancellation';
 
 type CustomOperationOptions = AuthModeParams & ListArgs;
 
@@ -360,7 +363,7 @@ function operationVariables(
  * @param context SSR context if relevant.
  * @returns Result from the graphql request, model-instantiated when relevant.
  */
-async function _op(
+function _op(
   client: BaseClient,
   modelIntrospection: ModelIntrospectionSchema,
   operationType: 'query' | 'mutation',
@@ -370,114 +373,63 @@ async function _op(
   options?: AuthModeParams & ListArgs,
   context?: AmplifyServer.ContextSpec,
 ) {
-  const { name: operationName } = operation;
-  const auth = authModeParams(client, getInternals, options);
-  const headers = getCustomHeaders(client, getInternals, options?.headers);
-  const outerArgsString = outerArguments(operation);
-  const innerArgsString = innerArguments(operation);
-  const selectionSet = operationSelectionSet(modelIntrospection, operation);
-
-  const returnTypeModelName = hasStringField(operation.type, 'model')
-    ? operation.type.model
-    : undefined;
-
-  const query = `
+  return selfAwareAsync(async (resultPromise) => {
+    const { name: operationName } = operation;
+    const auth = authModeParams(client, getInternals, options);
+    const headers = getCustomHeaders(client, getInternals, options?.headers);
+    const outerArgsString = outerArguments(operation);
+    const innerArgsString = innerArguments(operation);
+    const selectionSet = operationSelectionSet(modelIntrospection, operation);
+
+    const returnTypeModelName = hasStringField(operation.type, 'model')
+      ? operation.type.model
+      : undefined;
+
+    const query = `
     ${operationType.toLocaleLowerCase()}${outerArgsString} {
       ${operationName}${innerArgsString} ${selectionSet}
     }
   `;
 
-  const variables = operationVariables(operation, args);
+    const variables = operationVariables(operation, args);
+
+    try {
+      const basePromise = context
+        ? ((client as BaseSSRClient).graphql(
+            context,
+            {
+              ...auth,
+              query,
+              variables,
+            },
+            headers,
+          ) as Promise<GraphQLResult>)
+        : ((client as BaseBrowserClient).graphql(
+            {
+              ...auth,
+              query,
+              variables,
+            },
+            headers,
+          ) as Promise<GraphQLResult>);
+
+      const extendedPromise = extendCancellability(basePromise, resultPromise);
+      const { data, extensions } = await extendedPromise;
+
+      // flatten response
+      if (data) {
+        const [key] = Object.keys(data);
+
+        const isArrayResult = Array.isArray(data[key]);
+
+        // TODO: when adding support for custom selection set, flattening will need
+        // to occur recursively. For now, it's expected that related models are not
+        // present in the result. Only FK's are present. Any related model properties
+        // should be replaced with lazy loaders under the current implementation.
+        const flattenedResult = isArrayResult
+          ? data[key].filter((x: any) => x)
+          : data[key];
 
-  try {
-    const { data, extensions } = context
-      ? ((await (client as BaseSSRClient).graphql(
-          context,
-          {
-            ...auth,
-            query,
-            variables,
-          },
-          headers,
-        )) as GraphQLResult)
-      : ((await (client as BaseBrowserClient).graphql(
-          {
-            ...auth,
-            query,
-            variables,
-          },
-          headers,
-        )) as GraphQLResult);
-
-    // flatten response
-    if (data) {
-      const [key] = Object.keys(data);
-
-      const isArrayResult = Array.isArray(data[key]);
-
-      // TODO: when adding support for custom selection set, flattening will need
-      // to occur recursively. For now, it's expected that related models are not
-      // present in the result. Only FK's are present. Any related model properties
-      // should be replaced with lazy loaders under the current implementation.
-      const flattenedResult = isArrayResult
-        ? data[key].filter((x: any) => x)
-        : data[key];
-
-      // TODO: custom selection set. current selection set is default selection set only
-      // custom selection set requires data-schema-type + runtime updates above.
-      const initialized = returnTypeModelName
-        ? initializeModel(
-            client,
-            returnTypeModelName,
-            isArrayResult ? flattenedResult : [flattenedResult],
-            modelIntrospection,
-            auth.authMode,
-            auth.authToken,
-            !!context,
-          )
-        : flattenedResult;
-
-      return {
-        data:
-          !isArrayResult && Array.isArray(initialized)
-            ? initialized.shift()
-            : initialized,
-        extensions,
-      };
-    } else {
-      return { data: null, extensions };
-    }
-  } catch (error: any) {
-    /**
-     * The `data` type returned by `error` here could be:
-     * 1) `null`
-     * 2) an empty object
-     * 3) "populated" but with a `null` value `{ getPost: null }`
-     * 4) an actual record `{ getPost: { id: '1', title: 'Hello, World!' } }`
-     */
-    const { data, errors } = error;
-
-    /**
-     * `data` is not `null`, and is not an empty object:
-     */
-    if (data && Object.keys(data).length !== 0 && errors) {
-      const [key] = Object.keys(data);
-
-      const isArrayResult = Array.isArray(data[key]);
-
-      // TODO: when adding support for custom selection set, flattening will need
-      // to occur recursively. For now, it's expected that related models are not
-      // present in the result. Only FK's are present. Any related model properties
-      // should be replaced with lazy loaders under the current implementation.
-      const flattenedResult = isArrayResult
-        ? data[key].filter((x: any) => x)
-        : data[key];
-
-      /**
-       * `flattenedResult` could be `null` here (e.g. `data: { getPost: null }`)
-       * if `flattenedResult`, result is an actual record:
-       */
-      if (flattenedResult) {
         // TODO: custom selection set. current selection set is default selection set only
         // custom selection set requires data-schema-type + runtime updates above.
         const initialized = returnTypeModelName
@@ -497,17 +449,73 @@ async function _op(
             !isArrayResult && Array.isArray(initialized)
               ? initialized.shift()
               : initialized,
-          errors,
+          extensions,
         };
       } else {
-        // was `data: { getPost: null }`)
+        return { data: null, extensions };
+      }
+    } catch (error: any) {
+      /**
+       * The `data` type returned by `error` here could be:
+       * 1) `null`
+       * 2) an empty object
+       * 3) "populated" but with a `null` value `{ getPost: null }`
+       * 4) an actual record `{ getPost: { id: '1', title: 'Hello, World!' } }`
+       */
+      const { data, errors } = error;
+
+      /**
+       * `data` is not `null`, and is not an empty object:
+       */
+      if (data && Object.keys(data).length !== 0 && errors) {
+        const [key] = Object.keys(data);
+
+        const isArrayResult = Array.isArray(data[key]);
+
+        // TODO: when adding support for custom selection set, flattening will need
+        // to occur recursively. For now, it's expected that related models are not
+        // present in the result. Only FK's are present. Any related model properties
+        // should be replaced with lazy loaders under the current implementation.
+        const flattenedResult = isArrayResult
+          ? data[key].filter((x: any) => x)
+          : data[key];
+
+        /**
+         * `flattenedResult` could be `null` here (e.g. `data: { getPost: null }`)
+         * if `flattenedResult`, result is an actual record:
+         */
+        if (flattenedResult) {
+          // TODO: custom selection set. current selection set is default selection set only
+          // custom selection set requires data-schema-type + runtime updates above.
+          const initialized = returnTypeModelName
+            ? initializeModel(
+                client,
+                returnTypeModelName,
+                isArrayResult ? flattenedResult : [flattenedResult],
+                modelIntrospection,
+                auth.authMode,
+                auth.authToken,
+                !!context,
+              )
+            : flattenedResult;
+
+          return {
+            data:
+              !isArrayResult && Array.isArray(initialized)
+                ? initialized.shift()
+                : initialized,
+            errors,
+          };
+        } else {
+          // was `data: { getPost: null }`)
+          return handleSingularGraphQlError(error);
+        }
+      } else {
+        // `data` is `null`:
         return handleSingularGraphQlError(error);
       }
-    } else {
-      // `data` is `null`:
-      return handleSingularGraphQlError(error);
     }
-  }
+  });
 }
 
 /**

package/src/runtime/internals/operations/get.ts

@@ -26,6 +26,9 @@ import {
 } from '../APIClient';
 
 import { handleSingularGraphQlError } from './utils';
+import { selfAwareAsync } from '../../utils';
+
+import { extendCancellability } from '../cancellation';
 
 export function getFactory(
   client: BaseClient,
@@ -35,7 +38,7 @@ export function getFactory(
   getInternals: ClientInternalsGetter,
   useContext = false,
 ) {
-  const getWithContext = async (
+  const getWithContext = (
     contextSpec: AmplifyServer.ContextSpec & GraphQLOptions,
     arg?: any,
     options?: any,
@@ -52,7 +55,7 @@ export function getFactory(
     );
   };
 
-  const get = async (arg?: any, options?: any) => {
+  const get = (arg?: any, options?: any) => {
     return _get(
       client,
       modelIntrospection,
@@ -67,7 +70,7 @@ export function getFactory(
   return useContext ? getWithContext : get;
 }
 
-async function _get(
+function _get(
   client: BaseClient,
   modelIntrospection: ModelIntrospectionSchema,
   model: SchemaModel,
@@ -77,95 +80,62 @@ async function _get(
   getInternals: ClientInternalsGetter,
   context?: AmplifyServer.ContextSpec,
 ) {
-  const { name } = model;
-
-  const query = generateGraphQLDocument(
-    modelIntrospection,
-    name,
-    operation,
-    options,
-  );
-  const variables = buildGraphQLVariables(
-    model,
-    operation,
-    arg,
-    modelIntrospection,
-  );
-
-  const auth = authModeParams(client, getInternals, options);
-
-  try {
-    const headers = getCustomHeaders(client, getInternals, options?.headers);
-
-    const { data, extensions } = context
-      ? ((await (client as BaseSSRClient).graphql(
-          context,
-          {
-            ...auth,
-            query,
-            variables,
-          },
-          headers,
-        )) as GraphQLResult)
-      : ((await (client as BaseBrowserClient).graphql(
-          {
-            ...auth,
-            query,
-            variables,
-          },
-          headers,
-        )) as GraphQLResult);
-
-    // flatten response
-    if (data) {
-      const [key] = Object.keys(data);
-      const flattenedResult = flattenItems(modelIntrospection, name, data[key]);
-
-      if (flattenedResult === null) {
-        return { data: null, extensions };
-      } else if (options?.selectionSet) {
-        return { data: flattenedResult, extensions };
-      } else {
-        // TODO: refactor to avoid destructuring here
-        const [initialized] = initializeModel(
-          client,
-          name,
-          [flattenedResult],
+  return selfAwareAsync(async (resultPromise) => {
+    const { name } = model;
+
+    const query = generateGraphQLDocument(
+      modelIntrospection,
+      name,
+      operation,
+      options,
+    );
+    const variables = buildGraphQLVariables(
+      model,
+      operation,
+      arg,
+      modelIntrospection,
+    );
+
+    const auth = authModeParams(client, getInternals, options);
+
+    try {
+      const headers = getCustomHeaders(client, getInternals, options?.headers);
+
+      const basePromise = context
+        ? ((client as BaseSSRClient).graphql(
+            context,
+            {
+              ...auth,
+              query,
+              variables,
+            },
+            headers,
+          ) as Promise<GraphQLResult>)
+        : ((client as BaseBrowserClient).graphql(
+            {
+              ...auth,
+              query,
+              variables,
+            },
+            headers,
+          ) as Promise<GraphQLResult>);
+
+      const extendedPromise = extendCancellability(basePromise, resultPromise);
+      const { data, extensions } = await extendedPromise;
+
+      // flatten response
+      if (data) {
+        const [key] = Object.keys(data);
+        const flattenedResult = flattenItems(
           modelIntrospection,
-          auth.authMode,
-          auth.authToken,
-          !!context,
+          name,
+          data[key],
         );
 
-        return { data: initialized, extensions };
-      }
-    } else {
-      return { data: null, extensions };
-    }
-  } catch (error: any) {
-    /**
-     * The `data` type returned by `error` here could be:
-     * 1) `null`
-     * 2) an empty object
-     * 3) "populated" but with a `null` value `{ getPost: null }`
-     * 4) an actual record `{ getPost: { id: '1', title: 'Hello, World!' } }`
-     */
-    const { data, errors } = error;
-
-    /**
-     * `data` is not `null`, and is not an empty object:
-     */
-    if (data && Object.keys(data).length !== 0 && errors) {
-      const [key] = Object.keys(data);
-      const flattenedResult = flattenItems(modelIntrospection, name, data[key]);
-
-      /**
-       * `flattenedResult` could be `null` here (e.g. `data: { getPost: null }`)
-       * if `flattenedResult`, result is an actual record:
-       */
-      if (flattenedResult) {
-        if (options?.selectionSet) {
-          return { data: flattenedResult, errors };
+        if (flattenedResult === null) {
+          return { data: null, extensions };
+        } else if (options?.selectionSet) {
+          return { data: flattenedResult, extensions };
         } else {
           // TODO: refactor to avoid destructuring here
           const [initialized] = initializeModel(
@@ -178,15 +148,61 @@ async function _get(
             !!context,
           );
 
-          return { data: initialized, errors };
+          return { data: initialized, extensions };
+        }
+      } else {
+        return { data: null, extensions };
+      }
+    } catch (error: any) {
+      /**
+       * The `data` type returned by `error` here could be:
+       * 1) `null`
+       * 2) an empty object
+       * 3) "populated" but with a `null` value `{ getPost: null }`
+       * 4) an actual record `{ getPost: { id: '1', title: 'Hello, World!' } }`
+       */
+      const { data, errors } = error;
+
+      /**
+       * `data` is not `null`, and is not an empty object:
+       */
+      if (data && Object.keys(data).length !== 0 && errors) {
+        const [key] = Object.keys(data);
+        const flattenedResult = flattenItems(
+          modelIntrospection,
+          name,
+          data[key],
+        );
+
+        /**
+         * `flattenedResult` could be `null` here (e.g. `data: { getPost: null }`)
+         * if `flattenedResult`, result is an actual record:
+         */
+        if (flattenedResult) {
+          if (options?.selectionSet) {
+            return { data: flattenedResult, errors };
+          } else {
+            // TODO: refactor to avoid destructuring here
+            const [initialized] = initializeModel(
+              client,
+              name,
+              [flattenedResult],
+              modelIntrospection,
+              auth.authMode,
+              auth.authToken,
+              !!context,
+            );
+
+            return { data: initialized, errors };
+          }
+        } else {
+          // was `data: { getPost: null }`)
+          return handleSingularGraphQlError(error);
         }
       } else {
-        // was `data: { getPost: null }`)
+        // `data` is `null`:
         return handleSingularGraphQlError(error);
       }
-    } else {
-      // `data` is `null`:
-      return handleSingularGraphQlError(error);
     }
-  }
+  });
 }