in packages/amplify-provider-awscloudformation/src/transform-graphql-schema.ts [332:547]
export async function transformGraphQLSchema(context, options) {
const transformerVersion = await getTransformerVersion(context);
if (transformerVersion === 2) {
return transformGraphQLSchemaV6(context, options);
}
const backEndDir = context.amplify.pathManager.getBackendDirPath();
const flags = context.parameters.options;
if (flags['no-gql-override']) {
return;
}
let { resourceDir, parameters } = options;
const { forceCompile } = options;
// Compilation during the push step
const { resourcesToBeCreated, resourcesToBeUpdated, allResources } = await context.amplify.getResourceStatus(apiCategory);
let resources = resourcesToBeCreated.concat(resourcesToBeUpdated);
// When build folder is missing include the API
// to be compiled without the backend/api/<api-name>/build
// cloud formation push will fail even if there is no changes in the GraphQL API
// https://github.com/aws-amplify/amplify-console/issues/10
const resourceNeedCompile = allResources
.filter(r => !resources.includes(r))
.filter(r => {
const buildDir = path.normalize(path.join(backEndDir, apiCategory, r.resourceName, 'build'));
return !fs.existsSync(buildDir);
});
resources = resources.concat(resourceNeedCompile);
if (forceCompile) {
resources = resources.concat(allResources);
}
resources = resources.filter(resource => resource.service === 'AppSync');
// check if api is in update status or create status
const isNewAppSyncAPI: boolean = resourcesToBeCreated.filter(resource => resource.service === 'AppSync').length === 0 ? false : true;
if (!resourceDir) {
// There can only be one appsync resource
if (resources.length > 0) {
const resource = resources[0];
if (resource.providerPlugin !== providerName) {
return;
}
const { category, resourceName } = resource;
resourceDir = path.normalize(path.join(backEndDir, category, resourceName));
} else {
// No appsync resource to update/add
return;
}
}
let previouslyDeployedBackendDir = options.cloudBackendDirectory;
if (!previouslyDeployedBackendDir) {
if (resources.length > 0) {
const resource = resources[0];
if (resource.providerPlugin !== providerName) {
return;
}
const { category, resourceName } = resource;
const cloudBackendRootDir = context.amplify.pathManager.getCurrentCloudBackendDirPath();
/* eslint-disable */
previouslyDeployedBackendDir = path.normalize(path.join(cloudBackendRootDir, category, resourceName));
/* eslint-enable */
}
}
const parametersFilePath = path.join(resourceDir, parametersFileName);
if (!parameters && fs.existsSync(parametersFilePath)) {
try {
parameters = JSONUtilities.readJson(parametersFilePath);
} catch (e) {
parameters = {};
}
}
const isCLIMigration = options.migrate;
const isOldApiVersion = apiProjectIsFromOldVersion(previouslyDeployedBackendDir, resourcesToBeCreated);
const migrateOptions = {
...options,
resourceDir,
migrate: false,
isCLIMigration,
cloudBackendDirectory: previouslyDeployedBackendDir,
};
if (isCLIMigration && isOldApiVersion) {
return await migrateProject(context, migrateOptions);
} else if (isOldApiVersion) {
let IsOldApiProject;
if (context.exeInfo && context.exeInfo.inputParams && context.exeInfo.inputParams.yes) {
IsOldApiProject = context.exeInfo.inputParams.yes;
} else {
const migrateMessage =
`${chalk.bold('The CLI is going to take the following actions during the migration step:')}\n` +
'\n1. If you have a GraphQL API, we will update the corresponding Cloudformation stack to support larger annotated schemas and custom resolvers.\n' +
'In this process, we will be making Cloudformation API calls to update your GraphQL API Cloudformation stack. This operation will result in deletion of your AppSync resolvers and then the creation of new ones and for a brief while your AppSync API will be unavailable until the migration finishes\n' +
'\n2. We will be updating your local Cloudformation files present inside the ‘amplify/‘ directory of your app project, for the GraphQL API service\n' +
'\n3. If for any reason the migration fails, the CLI will rollback your cloud and local changes and you can take a look at https://aws-amplify.github.io/docs/cli/migrate?sdk=js for manually migrating your project so that it’s compatible with the latest version of the CLI\n' +
'\n4. ALL THE ABOVE MENTIONED OPERATIONS WILL NOT DELETE ANY DATA FROM ANY OF YOUR DATA STORES\n' +
`\n${chalk.bold('Before the migration, please be aware of the following things:')}\n` +
'\n1. Make sure to have an internet connection through the migration process\n' +
'\n2. Make sure to not exit/terminate the migration process (by interrupting it explicitly in the middle of migration), as this will lead to inconsistency within your project\n' +
'\n3. Make sure to take a backup of your entire project (including the amplify related config files)\n' +
'\nDo you want to continue?\n';
({ IsOldApiProject } = await inquirer.prompt({
name: 'IsOldApiProject',
type: 'confirm',
message: migrateMessage,
default: true,
}));
}
if (!IsOldApiProject) {
throw new Error('Migration cancelled. Please downgrade to a older version of the Amplify CLI or migrate your API project.');
}
return await migrateProject(context, migrateOptions);
}
let { authConfig } = options;
//
// If we don't have an authConfig from the caller, use it from the
// already read resources[0], which is an AppSync API.
//
if (!authConfig) {
if (resources[0].output.securityType) {
// Convert to multi-auth format if needed.
authConfig = {
defaultAuthentication: {
authenticationType: resources[0].output.securityType,
},
additionalAuthenticationProviders: [],
};
} else {
({ authConfig } = resources[0].output);
}
}
// for the predictions directive get storage config
const s3ResourceName = await invokeS3GetResourceName(context);
const storageConfig = {
bucketName: s3ResourceName ? await getBucketName(context, s3ResourceName) : undefined,
};
const buildDir = path.normalize(path.join(resourceDir, 'build'));
const schemaFilePath = path.normalize(path.join(resourceDir, schemaFileName));
const schemaDirPath = path.normalize(path.join(resourceDir, schemaDirName));
let deploymentRootKey = await getPreviousDeploymentRootKey(previouslyDeployedBackendDir);
if (!deploymentRootKey) {
const deploymentSubKey = await hashDirectory(resourceDir);
deploymentRootKey = `${ROOT_APPSYNC_S3_KEY}/${deploymentSubKey}`;
}
const projectBucket = options.dryRun ? 'fake-bucket' : getProjectBucket(context);
const buildParameters = {
...parameters,
S3DeploymentBucket: projectBucket,
S3DeploymentRootKey: deploymentRootKey,
};
// If it is a dry run, don't create the build folder as it could make a follow-up command
// to not to trigger a build, hence a corrupt deployment.
if (!options.dryRun) {
fs.ensureDirSync(buildDir);
}
// Transformer compiler code
// const schemaText = await readProjectSchema(resourceDir);
const project = await readProjectConfiguration(resourceDir);
// Check for common errors
const directiveMap = collectDirectivesByTypeNames(project.schema);
await warnOnAuth(context, directiveMap.types);
await searchablePushChecks(context, directiveMap.types, parameters[ResourceConstants.PARAMETERS.AppSyncApiName]);
await transformerVersionCheck(context, resourceDir, previouslyDeployedBackendDir, resourcesToBeUpdated, directiveMap.directives);
const transformerListFactory = getTransformerFactory(context, resourceDir, authConfig);
let searchableTransformerFlag = false;
if (directiveMap.directives.includes('searchable')) {
searchableTransformerFlag = true;
}
const ff = new AmplifyCLIFeatureFlagAdapter();
const allowDestructiveUpdates = context?.input?.options?.[destructiveUpdatesFlag] || context?.input?.options?.force;
const sanityCheckRulesList = getSanityCheckRules(isNewAppSyncAPI, ff, allowDestructiveUpdates);
const buildConfig = {
...options,
buildParameters,
projectDirectory: resourceDir,
transformersFactory: transformerListFactory,
transformersFactoryArgs: [searchableTransformerFlag, storageConfig],
rootStackFileName: 'cloudformation-template.json',
currentCloudBackendDirectory: previouslyDeployedBackendDir,
minify: options.minify,
featureFlags: ff,
sanityCheckRules: sanityCheckRulesList,
};
const transformerOutput = await buildAPIProject(buildConfig);
context.print.success(`GraphQL schema compiled successfully.\n\nEdit your schema at ${schemaFilePath} or \
place .graphql files in a directory at ${schemaDirPath}`);
if (isAuthModeUpdated(options)) {
parameters.AuthModeLastUpdated = new Date();
}
if (!options.dryRun) {
JSONUtilities.writeJson(parametersFilePath, parameters);
}
return transformerOutput;
}