chore: remove redundant data-schema unit tests (#13659)

Author: iartemiev

.vscode/launch.json

@@ -15,7 +15,7 @@
 				"--inspect-brk",
 				"${workspaceRoot}/node_modules/.bin/jest",
 				// Optionally specify a single test file to run/debug:
-				"generateClientWithAmplifyInstance.test.ts",
+				"generateClient.test.ts",
 				"--runInBand",
 				"--testTimeout",
 				"600000", // 10 min timeout so jest doesn't error while we're stepping through code

packages/api-graphql/__tests__/fixtures/modeled/amplifyconfiguration.ts

@@ -24,219 +24,6 @@ const schema = a.schema({
 			data: a.json(),
 		})
 		.authorization(allow => [allow.publicApiKey(), allow.owner()]),
-	ThingWithCustomerOwnerField: a
-		.model({
-			id: a.id(),
-			description: a.string(),
-		})
-		.authorization(allow => [allow.ownerDefinedIn('customField', 'userPools')]),
-	ThingWithOwnerFieldSpecifiedInModel: a
-		.model({
-			id: a.id(),
-			name: a.string(),
-			owner: a.string(),
-		})
-		.authorization(allow => [allow.owner()]),
-	ThingWithAPIKeyAuth: a
-		.model({
-			id: a.id(),
-			description: a.string(),
-		})
-		.authorization(allow => [allow.publicApiKey()]),
-	ThingWithoutExplicitAuth: a.model({
-		id: a.id(),
-		description: a.string(),
-	}),
-	ThingWithCustomPk: a
-		.model({
-			cpk_cluster_key: a.string().required(),
-			cpk_sort_key: a.string().required(),
-			otherField: a.string(),
-		})
-		.identifier(['cpk_cluster_key', 'cpk_sort_key']),
-
-	CommunityPostMetadata: a.customType({
-		type: a.string().required(),
-		deleted: a.boolean(),
-	}),
-
-	CommunityPost: a.model({
-		id: a.id().required(),
-		communityPostPollId: a.id(),
-		poll: a.hasOne('CommunityPoll', 'communityPostPollId'),
-		metadata: a.ref('CommunityPostMetadata'),
-	}),
-	CommunityPoll: a.model({
-		id: a.id().required(),
-		question: a.string().required(),
-		answers: a.hasMany('CommunityPollAnswer', 'communityPollAnswersId').valueRequired()
-	}),
-	CommunityPollAnswer: a.model({
-		id: a.id().required(),
-		answer: a.string().required(),
-		communityPollAnswersId: a.id(),
-		votes: a.hasMany('CommunityPollVote', 'communityPollAnswerVotesId').valueRequired(),
-	}),
-	CommunityPollVote: a
-		.model({
-			id: a.id().required(),
-			communityPollAnswerVotesId: a.id()
-		})
-		.authorization(allow => [allow.publicApiKey(), allow.owner()]),
-	SecondaryIndexModel: a
-		.model({
-			title: a.string(),
-			description: a.string(),
-			viewCount: a.integer(),
-			status: a.enum(['draft', 'pending', 'published']),
-		})
-		.secondaryIndexes(index => [
-			index('title'),
-			index('description').sortKeys(['viewCount']),
-		]),
-	Product: a
-		.model({
-			sku: a.string().required(),
-			factoryId: a.string().required(),
-			description: a.string(),
-			warehouseProductsId: a.id(),
-			warehouse: a.belongsTo("Warehouse", 'warehouseProductsId'),
-			trackingMeta: a.customType({
-				productMeta: a.ref('ProductMeta'),
-				note: a.string(),
-			}),
-		})
-		.identifier(['sku', 'factoryId'])
-		.authorization(allow => [allow.owner(), allow.publicApiKey().to(["read"])]),
-	Warehouse: a.model({
-			name: a.string().required(),
-			products: a.hasMany("Product", 'warehouseProductsId'),
-		}).authorization(allow => [allow.owner(), allow.publicApiKey().to(["read"])]),
-	ProductMeta: a.customType({
-		releaseDate: a.date(),
-		status: a.enum(['in_production', 'discontinued']),
-		deepMeta: a.customType({
-			content: a.string(),
-		}),
-	}),
-
-	// #region Custom queries and mutations
-	EchoResult: a.customType({
-		resultContent: a.string().required(),
-	}),
-
-	// custom query returning a non-model type
-	echo: a
-		.query()
-		.arguments({
-			argumentContent: a.string().required(),
-		})
-		.returns(a.ref('EchoResult'))
-		.handler(a.handler.function('echoFunction'))
-		.authorization(allow => [allow.publicApiKey()]),
-
-	// custom query returning a primitive type
-	echoString: a
-		.query()
-		.arguments({
-			inputString: a.string().required(),
-		})
-		.returns(a.string())
-		.handler(a.handler.function('echoFunction'))
-		.authorization(allow => [allow.publicApiKey()]),
-	echoNestedCustomTypes: a
-		.query()
-		.arguments({
-			input: a.string().required(),
-		})
-		.returns(a.ref('ProductTrackingMeta'))
-		.handler(a.handler.function('echoFunction'))
-		.authorization(allow => [allow.publicApiKey()]),
-	echoModelHasNestedTypes: a
-		.query()
-		.arguments({
-			input: a.string().required(),
-		})
-		.returns(a.ref('Product'))
-		.handler(a.handler.function('echoFunction'))
-		.authorization(allow => [allow.publicApiKey()]),
-	// custom mutation returning a non-model type
-	PostLikeResult: a.customType({
-		likes: a.integer().required(),
-	}),
-	likePost: a
-		.mutation()
-		.arguments({
-			postId: a.id().required(),
-		})
-		.returns(a.ref('PostLikeResult'))
-		.handler(a.handler.function('echoFunction'))
-		.authorization(allow => [allow.guest()]),
-
-	// custom mutation returning a model type
-	Post: a
-		.model({
-			id: a.id().required(),
-			content: a.string(),
-			comments: a.hasMany('Comment', 'postCommentsId'),
-		})
-		.authorization(allow => [allow.publicApiKey(), allow.owner()]),
-	Comment: a
-		.model({
-			id: a.id().required(),
-			content: a.string().required(),
-			postCommentsId: a.id().required(),
-			post: a.belongsTo('Post', 'postCommentsId'),
-		})
-		.authorization(allow => [allow.publicApiKey(), allow.owner()]),
-	likePostReturnPost: a
-		.mutation()
-		.arguments({
-			postId: a.id().required(),
-		})
-		.returns(a.ref('Post'))
-		.handler(a.handler.function('echoFunction'))
-		.authorization(allow => [allow.guest()]),
-
-	onPostLiked: a
-		.subscription()
-		.for(a.ref('likePostReturnPost'))
-		.handler(a.handler.custom({ entry: './jsResolver_base.js' })),
-
-	onPostUpdated: a
-		.subscription()
-		.for(a.ref('Post').mutations(['update']))
-		.arguments({ postId: a.string() })
-		.handler(a.handler.custom({ entry: './jsResolver_base.js' })),
-	//#endregion
-
-	// #region implicit ownership models
-	ImplicitOwner: a
-		.model({
-			description: a.string(),
-		})
-		.authorization(allow => [allow.owner()]),
-	CustomImplicitOwner: a
-		.model({
-			description: a.string(),
-		})
-		.authorization(allow => [allow.ownerDefinedIn('customOwner')]),
-	ModelGroupDefinedIn: a
-		.model({
-			description: a.string(),
-		})
-		.authorization(allow => [allow.groupDefinedIn('groupField')]),
-	ModelGroupsDefinedIn: a
-		.model({
-			description: a.string(),
-		})
-		.authorization(allow => [allow.groupsDefinedIn('groupsField')]),
-	ModelStaticGroup: a
-		.model({
-			description: a.string(),
-		})
-		.authorization(allow => [allow.group('Admin')]),
-	// #endregion
 });
 
 export type Schema = ClientSchema<typeof schema>;

packages/api-graphql/__tests__/fixtures/modeled/schema.ts

@@ -1,36 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`server generateClient with cookies can custom query 1`] = `
-[
-  [
-    "AmplifyClassV6",
-    {
-      "abortController": AbortController {},
-      "options": {
-        "body": {
-          "query": "query ($argumentContent: String!) {
-  echo(argumentContent: $argumentContent) {
-    resultContent
-  }
-}
-",
-          "variables": {
-            "argumentContent": "echo argumentContent value",
-          },
-        },
-        "headers": {
-          "X-Api-Key": "FAKE-KEY",
-          "x-amz-user-agent": "aws-amplify/latest api/latest framework/latest",
-        },
-        "signingServiceInfo": undefined,
-        "withCredentials": undefined,
-      },
-      "url": "https://localhost/graphql",
-    },
-  ],
-]
-`;
-
 exports[`server generateClient with cookies can list 1`] = `
 [
   [
@@ -261,23 +230,3 @@ exports[`server generateClient with cookies can list with sort direction (descen
   ],
 ]
 `;
-
-exports[`server generateClient with cookies with request can custom query 1`] = `
-[
-  [
-    "AmplifyClassV6",
-    {
-      "authMode": undefined,
-      "authToken": undefined,
-      "query": "
-    query($argumentContent: String!) {
-      echo(argumentContent: $argumentContent) {resultContent}
-    }
-  ",
-      "variables": {
-        "argumentContent": "echo argumentContent value",
-      },
-    },
-  ],
-]
-`;

packages/api-graphql/__tests__/fixtures/schema-models/with-custom-primary-key/models.ts

@@ -25,6 +25,8 @@ const config: ResourcesConfig = {
 	},
 };
 
+// sanity check for CRUD model ops using server clients
+// exhaustive tests live in https://github.com/aws-amplify/amplify-api-next
 describe('server generateClient', () => {
 	beforeEach(() => {
 		jest.clearAllMocks();
@@ -266,37 +268,6 @@ describe('server generateClient', () => {
 			expect(normalizePostGraphqlCalls(spy)).toMatchSnapshot();
 		});
 
-		test('can custom query', async () => {
-			Amplify.configure(configFixture as any);
-			const config = Amplify.getConfig();
-
-			const spy = mockApiResponse({
-				data: {
-					echo: {
-						resultContent: 'echo result content',
-					},
-				},
-			});
-
-			const getAmplify = async (fn: any) => await fn(Amplify);
-
-			const client = generateClientWithAmplifyInstance<
-				Schema,
-				V6ClientSSRCookies<Schema>
-			>({
-				amplify: getAmplify,
-				config: config,
-			});
-
-			const result = await client.queries.echo({
-				argumentContent: 'echo argumentContent value',
-			});
-
-			expect(normalizePostGraphqlCalls(spy)).toMatchSnapshot();
-			expect(result?.data).toEqual({
-				resultContent: 'echo result content',
-			});
-		});
 		describe('with request', () => {
 			test('subscriptions are disabled', () => {
 				const client = generateClientWithAmplifyInstance<
@@ -344,34 +315,6 @@ describe('server generateClient', () => {
 					{},
 				);
 			});
-
-			test('can custom query', async () => {
-				Amplify.configure(configFixture as any);
-				const config = Amplify.getConfig();
-
-				const client = generateClientWithAmplifyInstance<
-					Schema,
-					V6ClientSSRRequest<Schema>
-				>({
-					amplify: null,
-					config: config,
-				});
-
-				const spy = jest
-					.spyOn(client, 'graphql')
-					.mockImplementation(async () => {
-						const result: any = {};
-						return result;
-					});
-
-				const mockContextSpec = { token: { value: Symbol('test') } };
-
-				const result = await client.queries.echo(mockContextSpec, {
-					argumentContent: 'echo argumentContent value',
-				});
-
-				expect(normalizePostGraphqlCalls(spy)).toMatchSnapshot();
-			});
 		});
 	});
 });

packages/api-graphql/__tests__/internals/__snapshots__/generateClient.test.ts.snap

@@ -194,31 +194,25 @@ export function expectSubWithHeadersFn(
  * @param spy The jest spy to check.
  * @param opName The name of the graphql operation. E.g., `onCreateTodo`.
  * @param item The item we expect to have been in the `variables`
- * @param libraryConfigHeaders TODO
+ * @param headers client/request and config-level headers
+ * @param configHeaders resolved config-level headers
  */
-export function expectSubWithlibraryConfigHeaders(
+export async function expectSubWithlibraryConfigHeaders(
 	spy: jest.SpyInstance<any, any>,
 	opName: string,
 	item: Record<string, any>,
-	headers?: CustomHeaders,
+	expectedHeaders?: CustomHeaders,
+	expectedConfigHeaders?: CustomHeaders,
 ) {
-	expect(spy).toHaveBeenCalledWith(
-		expect.objectContaining({
-			authenticationType: 'apiKey',
-			apiKey: 'FAKE-KEY',
-			appSyncGraphqlEndpoint: 'https://localhost/graphql',
-			// Code-gen'd queries have an owner param; TypeBeast queries don't:
-			query: expect.stringContaining(`${opName}(filter: $filter`),
-			variables: expect.objectContaining(item),
-			additionalHeaders: expect.objectContaining(headers),
-			// `headers` that are included in `Amplify.configure` options
-			libraryConfigHeaders: expect.any(Function),
-		}),
-		{
-			action: '1',
-			category: 'api',
-		},
-	);
+	const [[{ query, variables, additionalHeaders, libraryConfigHeaders }]] =
+		spy.mock.calls;
+
+	const configHeaders = await libraryConfigHeaders();
+
+	expect(query).toEqual(expect.stringContaining(`${opName}(filter: $filter`));
+	expect(variables).toEqual(expect.objectContaining(item));
+	expect(additionalHeaders).toEqual(expect.objectContaining(expectedHeaders));
+	expect(configHeaders).toEqual(expect.objectContaining(expectedConfigHeaders));
 }
 
 /**