@aws-amplify/api-graphql 4.4.1-events.619318.0 → 4.4.1

package/src/Providers/AWSAppSyncEventsProvider/index.ts

@@ -1,187 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import {
-	CustomUserAgentDetails,
-	DocumentType,
-	GraphQLAuthMode,
-	USER_AGENT_HEADER,
-	getAmplifyUserAgent,
-} from '@aws-amplify/core/internals/utils';
-import { CustomHeaders } from '@aws-amplify/data-schema/runtime';
-
-import { MESSAGE_TYPES } from '../constants';
-import { AWSWebSocketProvider } from '../AWSWebSocketProvider';
-import { awsRealTimeHeaderBasedAuth } from '../AWSWebSocketProvider/authHeaders';
-
-// resolved/actual AuthMode values. identityPool gets resolves to IAM upstream in InternalGraphQLAPI._graphqlSubscribe
-type ResolvedGraphQLAuthModes = Exclude<GraphQLAuthMode, 'identityPool'>;
-
-interface AWSAppSyncEventProviderOptions {
-	appSyncGraphqlEndpoint?: string;
-	authenticationType?: ResolvedGraphQLAuthModes;
-	query?: string;
-	variables?: DocumentType;
-	apiKey?: string;
-	region?: string;
-	libraryConfigHeaders?(): Promise<Record<string, unknown> | Headers>;
-	additionalHeaders?: CustomHeaders;
-	additionalCustomHeaders?: Record<string, string>;
-	authToken?: string;
-}
-
-interface DataPayload {
-	id: string;
-	event: string;
-	type: string;
-}
-
-interface DataResponse {
-	id: string;
-	payload: string;
-	type: string;
-}
-
-const PROVIDER_NAME = 'AWSAppSyncEventsProvider';
-
-class AWSAppSyncEventProvider extends AWSWebSocketProvider {
-	constructor() {
-		super(PROVIDER_NAME);
-	}
-
-	public async connect(options: AWSAppSyncEventProviderOptions) {
-		super.connect(options);
-	}
-
-	public subscribe(
-		options?: AWSAppSyncEventProviderOptions,
-		customUserAgentDetails?: CustomUserAgentDetails,
-	) {
-		return super.subscribe(options, customUserAgentDetails).pipe();
-	}
-
-	public async publish(
-		options: AWSAppSyncEventProviderOptions,
-		customUserAgentDetails?: CustomUserAgentDetails,
-	) {
-		super.publish(options, customUserAgentDetails);
-	}
-
-	protected async _prepareSubscriptionPayload({
-		options,
-		subscriptionId,
-		customUserAgentDetails,
-		additionalCustomHeaders,
-		libraryConfigHeaders,
-		publish,
-	}: {
-		options: AWSAppSyncEventProviderOptions;
-		subscriptionId: string;
-		customUserAgentDetails: CustomUserAgentDetails | undefined;
-		additionalCustomHeaders: Record<string, string>;
-		libraryConfigHeaders: Record<string, string>;
-		publish?: boolean;
-	}): Promise<string> {
-		const {
-			appSyncGraphqlEndpoint,
-			authenticationType,
-			query,
-			variables,
-			apiKey,
-			region,
-		} = options;
-
-		// This will be needed for WS publish
-		// const data = {
-		// 	events: [variables],
-		// };
-
-		const serializedData = JSON.stringify([variables]);
-
-		const headers = {
-			...(await awsRealTimeHeaderBasedAuth({
-				apiKey,
-				appSyncGraphqlEndpoint,
-				authenticationType,
-				payload: serializedData,
-				canonicalUri: '',
-				region,
-				additionalCustomHeaders,
-			})),
-			...libraryConfigHeaders,
-			...additionalCustomHeaders,
-			[USER_AGENT_HEADER]: getAmplifyUserAgent(customUserAgentDetails),
-		};
-
-		// Commented out code will be needed for WS publish
-		const subscriptionMessage = {
-			id: subscriptionId,
-			channel: query,
-			// events: [JSON.stringify(variables)],
-			authorization: {
-				...headers,
-			},
-			// payload: {
-			// 	events: serializedData,
-			// 	extensions: {
-			// 		authorization: {
-			// 			...headers,
-			// 		},
-			// 	},
-			// },
-			type: publish
-				? MESSAGE_TYPES.EVENT_PUBLISH
-				: MESSAGE_TYPES.EVENT_SUBSCRIBE,
-		};
-
-		const serializedSubscriptionMessage = JSON.stringify(subscriptionMessage);
-
-		return serializedSubscriptionMessage;
-	}
-
-	protected _handleSubscriptionData(
-		message: MessageEvent,
-	): [boolean, DataResponse] {
-		this.logger.debug(
-			`subscription message from AWS AppSync Events: ${message.data}`,
-		);
-
-		const {
-			id = '',
-			event: payload,
-			type,
-		}: DataPayload = JSON.parse(String(message.data));
-
-		const {
-			observer = null,
-			query = '',
-			variables = {},
-		} = this.subscriptionObserverMap.get(id) || {};
-
-		this.logger.debug({ id, observer, query, variables });
-
-		if (type === MESSAGE_TYPES.DATA && payload) {
-			const deserializedEvent = JSON.parse(payload);
-			if (observer) {
-				observer.next(deserializedEvent);
-			} else {
-				this.logger.debug(`observer not found for id: ${id}`);
-			}
-
-			return [true, { id, type, payload: deserializedEvent }];
-		}
-
-		return [false, { id, type, payload }];
-	}
-
-	protected _unsubscribeMessage(subscriptionId: string): {
-		id: string;
-		type: string;
-	} {
-		return {
-			id: subscriptionId,
-			type: MESSAGE_TYPES.EVENT_STOP,
-		};
-	}
-}
-
-export const AppSyncEventProvider = new AWSAppSyncEventProvider();

package/src/Providers/AWSWebSocketProvider/appsyncUrl.ts

@@ -1,151 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { RequestOptions } from '@aws-amplify/data-schema/runtime';
-import {
-	AmplifyUrl,
-	AmplifyUrlSearchParams,
-} from '@aws-amplify/core/internals/utils';
-
-import { AWSAppSyncRealTimeProviderOptions } from '../AWSAppSyncRealTimeProvider';
-
-const protocol = 'wss://';
-const standardDomainPattern =
-	/^https:\/\/\w{26}\.appsync-api\.\w{2}(?:(?:-\w{2,})+)-\d\.amazonaws.com(?:\.cn)?\/graphql$/i;
-const eventDomainPattern =
-	/^https:\/\/\w{26}\.ddpg-api\.\w{2}(?:(?:-\w{2,})+)-\d\.amazonaws.com(?:\.cn)?\/event$/i;
-const customDomainPath = '/realtime';
-
-export const isCustomDomain = (url: string): boolean => {
-	return url.match(standardDomainPattern) === null;
-};
-
-const isEventDomain = (url: string): boolean =>
-	url.match(eventDomainPattern) !== null;
-
-export const getRealtimeEndpointUrl = (
-	appSyncGraphqlEndpoint: string | undefined,
-): URL => {
-	let realtimeEndpoint = appSyncGraphqlEndpoint ?? '';
-
-	if (isEventDomain(realtimeEndpoint)) {
-		realtimeEndpoint = realtimeEndpoint
-			.concat(customDomainPath)
-			.replace('ddpg-api', 'grt-gamma');
-	} else if (isCustomDomain(realtimeEndpoint)) {
-		realtimeEndpoint = realtimeEndpoint.concat(customDomainPath);
-	} else {
-		realtimeEndpoint = realtimeEndpoint
-			.replace('appsync-api', 'appsync-realtime-api')
-			.replace('gogi-beta', 'grt-beta')
-			.replace('ddpg-api', 'grt-gamma');
-	}
-
-	realtimeEndpoint = realtimeEndpoint
-		.replace('https://', protocol)
-		.replace('http://', protocol);
-
-	return new AmplifyUrl(realtimeEndpoint);
-};
-
-/**
- * Strips out `Authorization` header if present
- */
-const extractNonAuthHeaders = (
-	headers?: AWSAppSyncRealTimeProviderOptions['additionalCustomHeaders'],
-): Record<string, string> => {
-	if (!headers) {
-		return {};
-	}
-
-	if ('Authorization' in headers) {
-		const { Authorization: _, ...nonAuthHeaders } = headers;
-
-		return nonAuthHeaders;
-	}
-
-	return headers;
-};
-
-/**
- *
- * @param headers - http headers
- * @returns uri-encoded query parameters derived from custom headers
- */
-export const queryParamsFromCustomHeaders = (
-	headers?: AWSAppSyncRealTimeProviderOptions['additionalCustomHeaders'],
-): URLSearchParams => {
-	const nonAuthHeaders = extractNonAuthHeaders(headers);
-
-	const params = new AmplifyUrlSearchParams();
-
-	Object.entries(nonAuthHeaders).forEach(([k, v]) => {
-		params.append(k, v);
-	});
-
-	return params;
-};
-
-/**
- * Normalizes AppSync realtime endpoint URL
- *
- * @param appSyncGraphqlEndpoint - AppSync endpointUri from config
- * @param urlParams - URLSearchParams
- * @returns fully resolved string realtime endpoint URL
- */
-export const realtimeUrlWithQueryString = (
-	appSyncGraphqlEndpoint: string | undefined,
-	urlParams: URLSearchParams,
-): string => {
-	const realtimeEndpointUrl = getRealtimeEndpointUrl(appSyncGraphqlEndpoint);
-
-	// preserves any query params a customer might manually set in the configuration
-	const existingParams = new AmplifyUrlSearchParams(realtimeEndpointUrl.search);
-
-	for (const [k, v] of urlParams.entries()) {
-		existingParams.append(k, v);
-	}
-
-	realtimeEndpointUrl.search = existingParams.toString();
-
-	return realtimeEndpointUrl.toString();
-};
-
-// TODO: move to separate file?
-export const additionalHeadersFromOptions = async (
-	options: AWSAppSyncRealTimeProviderOptions,
-) => {
-	const {
-		appSyncGraphqlEndpoint,
-		query,
-		libraryConfigHeaders = () => ({}),
-		additionalHeaders = {},
-		authToken,
-	} = options;
-
-	let additionalCustomHeaders = {};
-	const _libraryConfigHeaders = await libraryConfigHeaders();
-
-	if (typeof additionalHeaders === 'function') {
-		const requestOptions: RequestOptions = {
-			url: appSyncGraphqlEndpoint || '',
-			queryString: query || '',
-		};
-		additionalCustomHeaders = await additionalHeaders(requestOptions);
-	} else {
-		additionalCustomHeaders = additionalHeaders;
-	}
-
-	// if an authorization header is set, have the explicit, operation-level authToken take precedence
-	if (authToken) {
-		additionalCustomHeaders = {
-			...additionalCustomHeaders,
-			Authorization: authToken,
-		};
-	}
-
-	return {
-		additionalCustomHeaders,
-		libraryConfigHeaders: _libraryConfigHeaders,
-	};
-};

package/src/Providers/AWSWebSocketProvider/authHeaders.ts

@@ -1,146 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { ConsoleLogger, fetchAuthSession } from '@aws-amplify/core';
-import { signRequest } from '@aws-amplify/core/internals/aws-client-utils';
-import { AmplifyUrl } from '@aws-amplify/core/internals/utils';
-
-import { AWS_APPSYNC_REALTIME_HEADERS } from '../constants';
-import { AWSAppSyncRealTimeProviderOptions } from '../AWSAppSyncRealTimeProvider';
-
-const logger = new ConsoleLogger('AWSAppSyncRealTimeProvider Auth');
-
-type AWSAppSyncRealTimeAuthInput =
-	Partial<AWSAppSyncRealTimeProviderOptions> & {
-		canonicalUri: string;
-		payload: string;
-		host?: string | undefined;
-	};
-
-const awsAuthTokenHeader = async ({ host }: AWSAppSyncRealTimeAuthInput) => {
-	const session = await fetchAuthSession();
-
-	return {
-		Authorization: session?.tokens?.accessToken?.toString(),
-		host,
-	};
-};
-
-const awsRealTimeApiKeyHeader = async ({
-	apiKey,
-	host,
-}: AWSAppSyncRealTimeAuthInput) => {
-	const dt = new Date();
-	const dtStr = dt.toISOString().replace(/[:-]|\.\d{3}/g, '');
-
-	return {
-		host,
-		'x-amz-date': dtStr,
-		'x-api-key': apiKey,
-	};
-};
-
-const awsRealTimeIAMHeader = async ({
-	payload,
-	canonicalUri,
-	appSyncGraphqlEndpoint,
-	region,
-}: AWSAppSyncRealTimeAuthInput) => {
-	const endpointInfo = {
-		region,
-		service: 'appsync',
-	};
-
-	const creds = (await fetchAuthSession()).credentials;
-
-	const request = {
-		url: `${appSyncGraphqlEndpoint}${canonicalUri}`,
-		data: payload,
-		method: 'POST',
-		headers: { ...AWS_APPSYNC_REALTIME_HEADERS },
-	};
-
-	const signedParams = signRequest(
-		{
-			headers: request.headers,
-			method: request.method,
-			url: new AmplifyUrl(request.url),
-			body: request.data,
-		},
-		{
-			credentials: creds!,
-			signingRegion: endpointInfo.region!,
-			signingService: endpointInfo.service,
-		},
-	);
-
-	return signedParams.headers;
-};
-
-const customAuthHeader = async ({
-	host,
-	additionalCustomHeaders,
-}: AWSAppSyncRealTimeAuthInput) => {
-	/**
-	 * If `additionalHeaders` was provided to the subscription as a function,
-	 * the headers that are returned by that function will already have been
-	 * provided before this function is called.
-	 */
-	if (!additionalCustomHeaders?.Authorization) {
-		throw new Error('No auth token specified');
-	}
-
-	return {
-		Authorization: additionalCustomHeaders.Authorization,
-		host,
-	};
-};
-
-export const awsRealTimeHeaderBasedAuth = async ({
-	apiKey,
-	authenticationType,
-	canonicalUri,
-	appSyncGraphqlEndpoint,
-	region,
-	additionalCustomHeaders,
-	payload,
-}: AWSAppSyncRealTimeAuthInput): Promise<
-	Record<string, string | undefined> | undefined
-> => {
-	const headerHandler = {
-		apiKey: awsRealTimeApiKeyHeader,
-		iam: awsRealTimeIAMHeader,
-		oidc: awsAuthTokenHeader,
-		userPool: awsAuthTokenHeader,
-		lambda: customAuthHeader,
-		none: customAuthHeader,
-	} as const;
-
-	if (!authenticationType || !headerHandler[authenticationType]) {
-		logger.debug(`Authentication type ${authenticationType} not supported`);
-
-		return undefined;
-	} else {
-		const handler = headerHandler[authenticationType];
-
-		const host = appSyncGraphqlEndpoint
-			? new AmplifyUrl(appSyncGraphqlEndpoint).host
-			: undefined;
-
-		const resolvedApiKey = authenticationType === 'apiKey' ? apiKey : undefined;
-
-		logger.debug(`Authenticating with ${JSON.stringify(authenticationType)}`);
-
-		const result = await handler({
-			payload,
-			canonicalUri,
-			appSyncGraphqlEndpoint,
-			apiKey: resolvedApiKey,
-			region,
-			host,
-			additionalCustomHeaders,
-		});
-
-		return result;
-	}
-};