@aws-amplify/api-graphql 4.0.6-unstable.f2b7a8d.0 → 4.0.7-unstable.53dc717.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/api-graphql",
-	"version": "4.0.6-unstable.f2b7a8d.0+f2b7a8d",
+	"version": "4.0.7-unstable.53dc717.0+53dc717",
 	"description": "Api-graphql category of aws-amplify",
 	"main": "./dist/cjs/index.js",
 	"module": "./dist/esm/index.mjs",
@@ -79,8 +79,8 @@
 		"internals"
 	],
 	"dependencies": {
-		"@aws-amplify/api-rest": "4.0.6-unstable.f2b7a8d.0+f2b7a8d",
-		"@aws-amplify/core": "6.0.6-unstable.f2b7a8d.0+f2b7a8d",
+		"@aws-amplify/api-rest": "4.0.7-unstable.53dc717.0+53dc717",
+		"@aws-amplify/core": "6.0.7-unstable.53dc717.0+53dc717",
 		"@aws-amplify/data-schema-types": "^0.6.6",
 		"@aws-sdk/types": "3.387.0",
 		"graphql": "15.8.0",
@@ -96,55 +96,5 @@
 			"limit": "91.7 kB"
 		}
 	],
-	"jest": {
-		"globals": {
-			"ts-jest": {
-				"diagnostics": false,
-				"tsConfig": {
-					"lib": [
-						"dom",
-						"es2020"
-					],
-					"allowJs": true,
-					"noEmitOnError": false,
-					"strictNullChecks": true,
-					"types": [
-						"@types/jest"
-					]
-				}
-			}
-		},
-		"transform": {
-			"^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
-		},
-		"testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
-		"testPathIgnorePatterns": [
-			"<rootDir>/__tests__/helpers.ts",
-			"<rootDir>/__tests__/fixtures/",
-			"<rootDir>/__tests__/utils/"
-		],
-		"moduleFileExtensions": [
-			"ts",
-			"tsx",
-			"js",
-			"json",
-			"jsx"
-		],
-		"testEnvironment": "jsdom",
-		"testURL": "http://localhost/",
-		"coverageThreshold": {
-			"global": {
-				"branches": 0,
-				"functions": 0,
-				"lines": 0,
-				"statements": 0
-			}
-		},
-		"coveragePathIgnorePatterns": [
-			"<rootDir>/node_modules/",
-			"<rootDir>/dist",
-			"<rootDir>/__tests__"
-		]
-	},
-	"gitHead": "f2b7a8d78058af2e1c04f7d507525641def667c3"
+	"gitHead": "53dc71715e37198fe4c7378de3ccd993d565f8dd"
 }

package/src/GraphQLAPI.ts

@@ -29,7 +29,7 @@ export class GraphQLAPIClass extends InternalGraphQLAPIClass {
 	 * Executes a GraphQL operation
 	 *
 	 * @param options - GraphQL Options
-	 * @param [additionalHeaders] - headers to merge in after any `graphql_headers` set in the config
+	 * @param [additionalHeaders] - headers to merge in after any `libraryConfigHeaders` set in the config
 	 * @returns An Observable if the query is a subscription query, else a promise of the graphql result.
 	 */
 	graphql<T = any>(

package/src/Providers/AWSAppSyncRealTimeProvider/index.ts

@@ -97,7 +97,7 @@ export interface AWSAppSyncRealTimeProviderOptions {
 	variables?: Record<string, DocumentType>;
 	apiKey?: string;
 	region?: string;
-	graphql_headers?: () => {} | (() => Promise<{}>);
+	libraryConfigHeaders?: () => {} | (() => Promise<{}>);
 	additionalHeaders?:
 		| Record<string, string>
 		| (() => Promise<Record<string, string>>);
@@ -203,6 +203,7 @@ export class AWSAppSyncRealTimeProvider {
 			additionalHeaders,
 			apiKey,
 			authToken,
+			libraryConfigHeaders,
 		} = options || {};
 
 		return new Observable(observer => {
@@ -235,6 +236,7 @@ export class AWSAppSyncRealTimeProvider {
 									additionalHeaders,
 									apiKey,
 									authToken,
+									libraryConfigHeaders,
 								},
 								observer,
 								subscriptionId,
@@ -313,7 +315,7 @@ export class AWSAppSyncRealTimeProvider {
 			variables,
 			apiKey,
 			region,
-			graphql_headers = () => ({}),
+			libraryConfigHeaders = () => ({}),
 			additionalHeaders = {},
 			authToken,
 		} = options;
@@ -361,7 +363,7 @@ export class AWSAppSyncRealTimeProvider {
 				region,
 				additionalCustomHeaders,
 			})),
-			...(await graphql_headers()),
+			...(await libraryConfigHeaders()),
 			...additionalCustomHeaders,
 			[USER_AGENT_HEADER]: getAmplifyUserAgent(customUserAgentDetails),
 		};

package/src/internals/InternalGraphQLAPI.ts

@@ -8,7 +8,7 @@ import {
 	GraphQLError,
 	OperationTypeNode,
 } from 'graphql';
-import { Observable } from 'rxjs';
+import { Observable, catchError } from 'rxjs';
 import { AmplifyClassV6, ConsoleLogger } from '@aws-amplify/core';
 import {
 	GraphQLAuthMode,
@@ -31,6 +31,7 @@ import {
 import { AWSAppSyncRealTimeProvider } from '../Providers/AWSAppSyncRealTimeProvider';
 import { CustomHeaders } from '@aws-amplify/data-schema-types';
 import { resolveConfig, resolveLibraryOptions } from '../utils';
+import { repackageUnauthError } from '../utils/errors/repackageAuthError';
 
 const USER_AGENT_HEADER = 'x-amz-user-agent';
 
@@ -149,7 +150,7 @@ export class InternalGraphQLAPIClass {
 	 * Executes a GraphQL operation
 	 *
 	 * @param options - GraphQL Options
-	 * @param [additionalHeaders] - headers to merge in after any `graphql_headers` set in the config
+	 * @param [additionalHeaders] - headers to merge in after any `libraryConfigHeaders` set in the config
 	 * @returns An Observable if the query is a subscription query, else a promise of the graphql result.
 	 */
 	graphql<T = any>(
@@ -236,7 +237,7 @@ export class InternalGraphQLAPIClass {
 			endpoint: appSyncGraphqlEndpoint,
 			customEndpoint,
 			customEndpointRegion,
-			defaultAuthMode
+			defaultAuthMode,
 		} = resolveConfig(amplify);
 
 		const authMode = explicitAuthMode || defaultAuthMode || 'iam';
@@ -391,7 +392,7 @@ export class InternalGraphQLAPIClass {
 		const { errors } = response;
 
 		if (errors && errors.length) {
-			throw response;
+			throw repackageUnauthError(response);
 		}
 
 		return response;
@@ -424,19 +425,39 @@ export class InternalGraphQLAPIClass {
 	): Observable<any> {
 		const config = resolveConfig(amplify);
 
-		return this.appSyncRealTime.subscribe(
-			{
-				query: print(query as DocumentNode),
-				variables,
-				appSyncGraphqlEndpoint: config?.endpoint,
-				region: config?.region,
-				authenticationType: authMode || config?.defaultAuthMode,
-				apiKey: config?.apiKey,
-				additionalHeaders,
-				authToken,
-			},
-			customUserAgentDetails
-		);
+		/**
+		 * Retrieve library options from Amplify configuration.
+		 * `libraryConfigHeaders` are from the Amplify configuration options,
+		 * and will not be overwritten by other custom headers. These are *not*
+		 * the same as `additionalHeaders`, which are custom headers that are
+		 * either 1)included when configuring the API client or 2) passed along
+		 * with individual requests.
+		 */
+		const { headers: libraryConfigHeaders } = resolveLibraryOptions(amplify);
+
+		return this.appSyncRealTime
+			.subscribe(
+				{
+					query: print(query as DocumentNode),
+					variables,
+					appSyncGraphqlEndpoint: config?.endpoint,
+					region: config?.region,
+					authenticationType: authMode || config?.defaultAuthMode,
+					apiKey: config?.apiKey,
+					additionalHeaders,
+					authToken,
+					libraryConfigHeaders,
+				},
+				customUserAgentDetails
+			)
+			.pipe(
+				catchError(e => {
+					if (e.errors) {
+						throw repackageUnauthError(e);
+					}
+					throw e;
+				})
+			);
 	}
 }
 

package/src/types/index.ts

@@ -175,7 +175,7 @@ export interface AWSAppSyncRealTimeProviderOptions {
 	variables?: Record<string, unknown>;
 	apiKey?: string;
 	region?: string;
-	graphql_headers?: () => {} | (() => Promise<{}>);
+	libraryConfigHeaders?: () => {} | (() => Promise<{}>);
 	additionalHeaders?: CustomHeaders;
 }
 

package/src/utils/errors/repackageAuthError.ts

@@ -0,0 +1,46 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	AmplifyErrorParams,
+	GraphQLAuthMode,
+} from '@aws-amplify/core/internals/utils';
+
+type ErrorObject = {
+	errors: AmplifyErrorParams[];
+};
+
+/**
+ * Checks to see if the given response or subscription message contains an
+ * unauth error. If it does, it changes the error message to include instructions
+ * for the app developer.
+ */
+export function repackageUnauthError<T extends ErrorObject>(content: T): T {
+	if (content.errors && Array.isArray(content.errors)) {
+		content.errors.forEach(e => {
+			if (isUnauthError(e)) {
+				e.message = 'Unauthorized';
+				e.recoverySuggestion =
+					`If you're calling an Amplify-generated API, make sure ` +
+					`to set the "authMode" in generateClient({ authMode: '...' }) to the backend authorization ` +
+					`rule's auth provider ('apiKey', 'userPool', 'iam', 'oidc', 'lambda')`;
+			}
+		});
+	}
+	return content;
+}
+
+function isUnauthError(error: any): boolean {
+	// Error pattern corresponding to appsync calls
+	if (error?.['originalError']?.['name']?.startsWith('UnauthorizedException')) {
+		return true;
+	}
+	// Error pattern corresponding to appsync subscriptions
+	if (
+		error.message?.startsWith('Connection failed:') &&
+		error.message?.includes('Permission denied')
+	) {
+		return true;
+	}
+	return false;
+}