@aws-amplify/amplify-category-api/src/commands/api/override.ts

Amplify CLI API Category Plugin

import * as path from 'path';
import {
  $TSContext,
  AmplifyCategories,
  AmplifySupportedService,
  ApiCategoryFacade,
  generateOverrideSkeleton,
  pathManager,
  stateManager,
} from '@aws-amplify/amplify-cli-core';
import { printer, prompter } from '@aws-amplify/amplify-prompts';
import { ADMIN_QUERIES_NAME } from '../../category-constants';
import { AdminQueriesProps, ApigwInputState } from '../../provider-utils/awscloudformation/apigw-input-state';
import { ApigwStackTransform } from '../../provider-utils/awscloudformation/cdk-stack-builder';
import { checkAppsyncApiResourceMigration } from '../../provider-utils/awscloudformation/utils/check-appsync-api-migration';

export const name = 'override';

export const run = async (context: $TSContext) => {
  const amplifyMeta = stateManager.getMeta();
  const apiResources: string[] = [];

  if (amplifyMeta[AmplifyCategories.API]) {
    Object.keys(amplifyMeta[AmplifyCategories.API]).forEach((resourceName) => {
      apiResources.push(resourceName);
    });
  }

  if (apiResources.length === 0) {
    const errMessage = 'No resources to override. You need to add a resource.';
    printer.error(errMessage);
    return;
  }

  let selectedResourceName: string = apiResources[0];

  if (apiResources.length > 1) {
    selectedResourceName = await prompter.pick('Which resource would you like to add overrides for?', apiResources);
  }

  const { service }: { service: string } = amplifyMeta[AmplifyCategories.API][selectedResourceName];
  const destPath = pathManager.getResourceDirectoryPath(undefined, AmplifyCategories.API, selectedResourceName);

  const srcPath = path.join(
    __dirname,
    '..',
    '..',
    '..',
    'resources',
    'awscloudformation',
    'overrides-resource',
    service === AmplifySupportedService.APIGW ? 'APIGW' : service, // avoid space in filename
  );

  // Make sure to migrate first
  if (service === AmplifySupportedService.APPSYNC) {
    /**
     * Below steps checks for TransformerV1 app and updates the FF { useexperimentalpipelinedtransformer , transformerversion}
     */
    const transformerVersion = await ApiCategoryFacade.getTransformerVersion(context);
    if (transformerVersion === 2 && (await checkAppsyncApiResourceMigration(context, selectedResourceName, false))) {
      await context.amplify.invokePluginMethod(context, 'awscloudformation', undefined, 'compileSchema', [context, { forceCompile: true }]);
      await generateOverrideSkeleton(context, srcPath, destPath);
    } else {
      printer.warn(
        'The GraphQL API is using transformer version 1. Run `amplify migrate api` to upgrade to transformer version 2 and rerun amplify override api to enable override functionality for API',
      );
    }
  } else if (service === AmplifySupportedService.APIGW) {
    // Migration logic goes in here
    const apigwInputState = new ApigwInputState(context, selectedResourceName);
    if (!apigwInputState.cliInputsFileExists()) {
      if (selectedResourceName === ADMIN_QUERIES_NAME) {
        const { dependsOn }: { dependsOn: Record<string, any>[] } = amplifyMeta[AmplifyCategories.API][selectedResourceName];
        if (!Array.isArray(dependsOn) || dependsOn.length === 0) {
          throw new Error(`Invalid dependsOn entry found in amplify-meta.json for "${ADMIN_QUERIES_NAME}"`);
        }

        const getResourceNameFromDependsOn = (categoryName: string, dependsOn: Record<string, any>[]) =>
          dependsOn.filter((entry) => entry.category === categoryName)[0].resourceName;

        const props: AdminQueriesProps = {
          apiName: selectedResourceName,
          authResourceName: getResourceNameFromDependsOn(AmplifyCategories.AUTH, dependsOn),
          functionName: getResourceNameFromDependsOn(AmplifyCategories.FUNCTION, dependsOn),
          dependsOn: dependsOn,
        };
        await apigwInputState.migrateAdminQueries(props);
      } else {
        await apigwInputState.migrateApigwResource(selectedResourceName);
        const stackGenerator = new ApigwStackTransform(context, selectedResourceName);
        await stackGenerator.transform();
      }
    }
    await generateOverrideSkeleton(context, srcPath, destPath);
  }
};