Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(transformer): sort resolvers to avoid circular dependency #797

Merged
merged 1 commit into from
Oct 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
type Member @model @auth(rules: [{ allow: owner }])
{
owner: String! @primaryKey
secondaryIndex: String @index(name: "bySecondaryIndex", queryField: "memberBySecondaryIndex")
washCarTasks: [WashCarTask] @hasMany(indexName: "byOwner", fields: ["owner"])
}

type WashCarTask @model @auth(rules: [{ allow: owner }]) {
id: ID! @primaryKey
owner: String! @index(name: "byOwner", queryField: "washCarTaskByOwner")
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import { addApi, addApiWithoutSchema, amplifyPush, cancelAmplifyMockApi, createNewProjectDir, deleteProject, deleteProjectDir, initJSProjectWithProfile, updateApiSchema } from "amplify-category-api-e2e-core";
import { existsSync } from "fs-extra";
import path from 'path';
import { addCodegen } from "../../codegen/add";

describe('Circurlar dependency tests', () => {
let projRoot: string;
let projFolderName: string;
beforeEach(async () => {
projFolderName = 'circulardependency';
projRoot = await createNewProjectDir(projFolderName);
});

afterEach(async () => {
const metaFilePath = path.join(projRoot, 'amplify', '#current-cloud-backend', 'amplify-meta.json');
if (existsSync(metaFilePath)) {
await deleteProject(projRoot);
}
deleteProjectDir(projRoot);
});
it('should not have circular dependency error when mocking api with a specific GraphQL schema', async () => {
const projName = 'circulardependency';
await initJSProjectWithProfile(projRoot, { name: projName });
await addApi(projRoot, {
'Amazon Cognito User Pool': {},
transformerVersion: 2,
});
await updateApiSchema(projRoot, projName, 'circular_dependency_model.graphql');
await addCodegen(projRoot, {});
await expect(cancelAmplifyMockApi(projRoot, {})).resolves.not.toThrow();
});
it('should not have circular dependency error when pushing api with a specific GraphQL schema', async () => {
const projName = 'circulardependency';
await initJSProjectWithProfile(projRoot, { name: projName });
await addApi(projRoot, {
'Amazon Cognito User Pool': {},
transformerVersion: 2,
});
await updateApiSchema(projRoot, projName, 'circular_dependency_model.graphql');
await expect(amplifyPush(projRoot)).resolves.not.toThrow();
});
})
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import * as vm from 'vm2';
import { ResolverConfig, TransformConfig } from '../config/transformer-config';
import { InvalidTransformerError, SchemaValidationError, UnknownDirectiveError } from '../errors';
import { GraphQLApi } from '../graphql-api';
import { TransformerContext } from '../transformer-context';
import { TransformerContext, TransformerResolver } from '../transformer-context';
import { TransformerOutput } from '../transformer-context/output';
import { StackManager } from '../transformer-context/stack-manager';
import { ConstructResourceMeta } from '../types/types';
Expand Down Expand Up @@ -493,9 +493,20 @@ export class GraphQLTransform {
}

private collectResolvers(context: TransformerContext, api: GraphQLAPIProvider): void {
const resolverEntries = context.resolvers.collectResolvers();

for (const [resolverName, resolver] of resolverEntries) {
const resolverEntries = context.resolvers.collectResolvers() as Map<string, TransformerResolver>;
//Sort resolvers by stack name to group each resolver before synthesis to avoid circular dependency
const sortedResolverEntries = new Map([...resolverEntries].sort((a,b) => {
const left = a[1].getStackName();
const right = b[1].getStackName();
if (left > right) {
return 1;
}
if (left === right) {
return 0
}
return -1;
}));
for (const [resolverName, resolver] of sortedResolverEntries) {
const userSlots = this.userDefinedSlots[resolverName] || [];

userSlots.forEach(slot => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ export class TransformerResolver implements TransformerResolverProvider {
private readonly slotMap: Map<string, Slot[]> = new Map();
private readonly slotNames: Set<string>;
private stack?: Stack;
private stackName?: string;
constructor(
private typeName: string,
private fieldName: string,
Expand Down Expand Up @@ -154,6 +155,11 @@ export class TransformerResolver implements TransformerResolverProvider {

mapToStack = (stack: Stack) => {
this.stack = stack;
this.stackName = stack.stackName;
};

getStackName = () => {
return this.stackName ?? '';
};

addToSlot = (
Expand Down