@aws-amplify/api-graphql 0.0.0-unstable-1ca644b-20260128091132

package/src/utils/ReachabilityMonitor/index.native.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Reachability } from '@aws-amplify/core/internals/utils';
+import NetInfo from '@react-native-community/netinfo';
+
+export const ReachabilityMonitor = () =>
+	new Reachability().networkMonitor(NetInfo);

package/src/utils/ReachabilityMonitor/index.ts

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Reachability } from '@aws-amplify/core/internals/utils';
+
+export const ReachabilityMonitor = () => new Reachability().networkMonitor();

package/src/utils/ReconnectionMonitor.ts

@@ -0,0 +1,77 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Observer } from 'rxjs';
+
+import { RECONNECT_DELAY, RECONNECT_INTERVAL } from '../Providers/constants';
+
+export enum ReconnectEvent {
+	START_RECONNECT = 'START_RECONNECT',
+	HALT_RECONNECT = 'HALT_RECONNECT',
+}
+
+/**
+ * Captures the reconnect event logic used to determine when to reconnect to PubSub providers.
+ *   Reconnect attempts are delayed by 5 seconds to let the interface settle.
+ *   Attempting to reconnect only once creates unrecoverable states when the network state isn't
+ *   supported by the browser, so this keeps retrying every minute until halted.
+ */
+export class ReconnectionMonitor {
+	private reconnectObservers: Observer<void>[] = [];
+	private reconnectIntervalId?: ReturnType<typeof setInterval>;
+	private reconnectSetTimeoutId?: ReturnType<typeof setTimeout>;
+
+	/**
+	 * Add reconnect observer to the list of observers to alert on reconnect
+	 */
+	addObserver(reconnectObserver: Observer<void>) {
+		this.reconnectObservers.push(reconnectObserver);
+	}
+
+	/**
+	 * Given a reconnect event, start the appropriate behavior
+	 */
+	record(event: ReconnectEvent) {
+		if (event === ReconnectEvent.START_RECONNECT) {
+			// If the reconnection hasn't been started
+			if (
+				this.reconnectSetTimeoutId === undefined &&
+				this.reconnectIntervalId === undefined
+			) {
+				this.reconnectSetTimeoutId = setTimeout(() => {
+					// Reconnect now
+					this._triggerReconnect();
+					// Retry reconnect every periodically until it works
+					this.reconnectIntervalId = setInterval(() => {
+						this._triggerReconnect();
+					}, RECONNECT_INTERVAL);
+				}, RECONNECT_DELAY);
+			}
+		}
+
+		if (event === ReconnectEvent.HALT_RECONNECT) {
+			if (this.reconnectIntervalId) {
+				clearInterval(this.reconnectIntervalId);
+				this.reconnectIntervalId = undefined;
+			}
+			if (this.reconnectSetTimeoutId) {
+				clearTimeout(this.reconnectSetTimeoutId);
+				this.reconnectSetTimeoutId = undefined;
+			}
+		}
+	}
+
+	/**
+	 * Complete all reconnect observers
+	 */
+	close() {
+		this.reconnectObservers.forEach(reconnectObserver => {
+			reconnectObserver.complete?.();
+		});
+	}
+
+	private _triggerReconnect() {
+		this.reconnectObservers.forEach(reconnectObserver => {
+			reconnectObserver.next?.();
+		});
+	}
+}

package/src/utils/errors/GraphQLApiError.ts

@@ -0,0 +1,21 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	AmplifyError,
+	AmplifyErrorParams,
+} from '@aws-amplify/core/internals/utils';
+
+/**
+ * @internal
+ */
+export class GraphQLApiError extends AmplifyError {
+	constructor(params: AmplifyErrorParams) {
+		super(params);
+
+		// Hack for making the custom error class work when transpiled to es5
+		// TODO: Delete the following 2 lines after we change the build target to >= es2015
+		this.constructor = GraphQLApiError;
+		Object.setPrototypeOf(this, GraphQLApiError.prototype);
+	}
+}

package/src/utils/errors/assertValidationError.ts

@@ -0,0 +1,19 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { GraphQLApiError } from './GraphQLApiError';
+import { APIValidationErrorCode, validationErrorMap } from './validation';
+
+/**
+ * @internal
+ */
+export function assertValidationError(
+	assertion: boolean,
+	name: APIValidationErrorCode,
+): asserts assertion {
+	const { message, recoverySuggestion } = validationErrorMap[name];
+
+	if (!assertion) {
+		throw new GraphQLApiError({ name, message, recoverySuggestion });
+	}
+}

package/src/utils/errors/constants.ts

@@ -0,0 +1,56 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
+
+import { GraphQLAuthError } from '../../types';
+
+export const NO_API_KEY: AmplifyErrorParams = {
+	name: 'NoApiKey',
+	// ideal: No API key configured.
+	message: GraphQLAuthError.NO_API_KEY,
+	recoverySuggestion:
+		'The API request was made with `authMode: "apiKey"` but no API Key was passed into `Amplify.configure()`. Review if your API key is passed into the `Amplify.configure()` function.',
+};
+
+export const NO_VALID_CREDENTIALS: AmplifyErrorParams = {
+	name: 'NoCredentials',
+	// ideal: No auth credentials available.
+	message: GraphQLAuthError.NO_CREDENTIALS,
+	recoverySuggestion: `The API request was made with \`authMode: "iam"\` but no authentication credentials are available.
+
+If you intended to make a request using an authenticated role, review if your user is signed in before making the request.
+
+If you intend to make a request using an unauthenticated role or also known as "guest access", verify if "Auth.Cognito.allowGuestAccess" is set to "true" in the \`Amplify.configure()\` function.`,
+};
+
+export const NO_VALID_AUTH_TOKEN: AmplifyErrorParams = {
+	name: 'NoValidAuthTokens',
+	// ideal: No valid JWT auth token provided to make the API request..
+	message: GraphQLAuthError.NO_FEDERATED_JWT,
+	recoverySuggestion:
+		'If you intended to make an authenticated API request, review if the current user is signed in.',
+};
+
+export const NO_SIGNED_IN_USER: AmplifyErrorParams = {
+	name: 'NoSignedUser',
+	// ideal: Couldn't retrieve authentication credentials to make the API request.
+	message: GraphQLAuthError.NO_CURRENT_USER,
+	recoverySuggestion:
+		'Review the underlying exception field for more details. If you intended to make an authenticated API request, review if the current user is signed in.',
+};
+
+export const NO_AUTH_TOKEN_HEADER: AmplifyErrorParams = {
+	name: 'NoAuthorizationHeader',
+	// ideal: Authorization header not specified.
+	message: GraphQLAuthError.NO_AUTH_TOKEN,
+	recoverySuggestion:
+		'The API request was made with `authMode: "lambda"` but no `authToken` is set. Review if a valid authToken is passed into the request options or in the `Amplify.configure()` function.',
+};
+
+export const NO_ENDPOINT: AmplifyErrorParams = {
+	name: 'NoEndpoint',
+	message: 'No GraphQL endpoint configured in `Amplify.configure()`.',
+	recoverySuggestion:
+		'Review if the GraphQL API endpoint is set in the `Amplify.configure()` function.',
+};

package/src/utils/errors/createGraphQLResultWithError.ts

@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { GraphQLError } from 'graphql';
+
+import { GraphQLResult } from '../../types';
+
+export const createGraphQLResultWithError = <T>(
+	error: Error,
+): GraphQLResult<T> => {
+	return {
+		data: {} as T,
+		errors: [new GraphQLError(error.message, null, null, null, null, error)],
+	};
+};

package/src/utils/errors/index.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { GraphQLApiError } from './GraphQLApiError';
+export { assertValidationError } from './assertValidationError';
+export { APIValidationErrorCode, validationErrorMap } from './validation';
+export { createGraphQLResultWithError } from './createGraphQLResultWithError';

package/src/utils/errors/repackageAuthError.ts

@@ -0,0 +1,43 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { GraphQLResult } from '../../types';
+
+/**
+ * Checks to see if the given response or subscription message contains an
+ * Unauthorized error. If it does, it changes the error message to include instructions
+ * for the app developer.
+ */
+export function repackageUnauthorizedError<T extends GraphQLResult<any>>(
+	content: T,
+): T {
+	if (content.errors && Array.isArray(content.errors)) {
+		content.errors.forEach(e => {
+			if (isUnauthorizedError(e)) {
+				e.message = 'Unauthorized';
+				(e as any).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 isUnauthorizedError(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;
+}

package/src/utils/errors/validation.ts

@@ -0,0 +1,26 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
+
+export enum APIValidationErrorCode {
+	NoAuthSession = 'NoAuthSession',
+	NoRegion = 'NoRegion',
+	NoCustomEndpoint = 'NoCustomEndpoint',
+}
+
+export const validationErrorMap: AmplifyErrorMap<APIValidationErrorCode> = {
+	[APIValidationErrorCode.NoAuthSession]: {
+		message: 'Auth session should not be empty.',
+	},
+	// TODO: re-enable when working in all test environments:
+	// [APIValidationErrorCode.NoEndpoint]: {
+	// 	message: 'Missing endpoint',
+	// },
+	[APIValidationErrorCode.NoRegion]: {
+		message: 'Missing region.',
+	},
+	[APIValidationErrorCode.NoCustomEndpoint]: {
+		message: 'Custom endpoint region is present without custom endpoint.',
+	},
+};

package/src/utils/index.ts

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { resolveConfig } from './resolveConfig';
+export { resolveLibraryOptions } from './resolveLibraryOptions';

package/src/utils/resolveConfig.ts

@@ -0,0 +1,46 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyClassV6, ConsoleLogger } from '@aws-amplify/core';
+
+import { APIValidationErrorCode, assertValidationError } from './errors';
+
+const logger = new ConsoleLogger('GraphQLAPI resolveConfig');
+
+/**
+ * @internal
+ */
+export const resolveConfig = (amplify: AmplifyClassV6) => {
+	const config = amplify.getConfig();
+
+	if (!config.API?.GraphQL) {
+		logger.warn(
+			'The API configuration is missing. This is likely due to Amplify.configure() not being called prior to generateClient().',
+		);
+	}
+
+	const {
+		apiKey,
+		customEndpoint,
+		customEndpointRegion,
+		defaultAuthMode,
+		endpoint,
+		region,
+	} = config.API?.GraphQL ?? {};
+
+	// TODO: re-enable when working in all test environments:
+	// assertValidationError(!!endpoint, APIValidationErrorCode.NoEndpoint);
+	assertValidationError(
+		!(!customEndpoint && customEndpointRegion),
+		APIValidationErrorCode.NoCustomEndpoint,
+	);
+
+	return {
+		apiKey,
+		customEndpoint,
+		customEndpointRegion,
+		defaultAuthMode,
+		endpoint,
+		region,
+	};
+};

package/src/utils/resolveLibraryOptions.ts

@@ -0,0 +1,14 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyClassV6 } from '@aws-amplify/core';
+
+/**
+ * @internal
+ */
+export const resolveLibraryOptions = (amplify: AmplifyClassV6) => {
+	const headers = amplify.libraryOptions?.API?.GraphQL?.headers;
+	const withCredentials = amplify.libraryOptions?.API?.GraphQL?.withCredentials;
+
+	return { headers, withCredentials };
+};