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

chore: experimental cdk migrate command #25859

Merged
merged 31 commits into from
Jun 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
b53855e
experimental cdk migrate command
Jun 5, 2023
b3dc8e1
fix typescript erroring
Jun 5, 2023
1801196
add helpful import message
Jun 5, 2023
e71d63e
fix aliases to make it work
RomainMuller Jun 6, 2023
483c431
bring in some automation to avoid manual operations
RomainMuller Jun 6, 2023
5b5afee
Leverage list of supported languages
RomainMuller Jun 6, 2023
ad081a0
add warning to command
Jun 12, 2023
089df4f
Merge branch 'main' into experimental/migrate
HBobertz Jun 12, 2023
d57c47c
better warning messages
Jun 12, 2023
8060c44
Merge branch 'main' into experimental/migrate
HBobertz Jun 14, 2023
e50a4ef
modified how we get nocti for cdk migrate
Jun 16, 2023
84b10c4
Merge branch 'main' into experimental/migrate
HBobertz Jun 16, 2023
a2a26f3
remove mkdir as it was having idempotency issues
Jun 16, 2023
0bdd473
update readme to reflect new nocti consumption flow
Jun 16, 2023
94687d8
git fixes for submodule stuff
Jun 16, 2023
d51b074
modify generate to delete the generated package json
Jun 16, 2023
2a85864
Update warning wording to be more professional
HBobertz Jun 19, 2023
dbde5b7
Merge branch 'main' into experimental/migrate
HBobertz Jun 19, 2023
00eeede
update third party licensces
Jun 19, 2023
4ca5d2e
fix alpha gen script
Jun 19, 2023
95cf39c
change default input path
Jun 19, 2023
7444399
Merge branch 'main' into experimental/migrate
HBobertz Jun 19, 2023
a8665cd
Merge branch 'main' into experimental/migrate
HBobertz Jun 20, 2023
b3ab9f8
Merge branch 'main' into experimental/migrate
HBobertz Jun 20, 2023
a2fd134
add npx so ts-node can be called correctly
MrArnoldPalmer Jun 20, 2023
1727e02
Merge branch 'main' into experimental/migrate
HBobertz Jun 20, 2023
afbe3b3
fix irrelevant bug
Jun 20, 2023
da4280b
use yarn --silent instead of npx
RomainMuller Jun 23, 2023
2efd438
Hoist ts-node to root package.json + uniformize typescript deps
RomainMuller Jun 23, 2023
e15f084
adjust esbuild packaging to correctly bundle WASM resource
RomainMuller Jun 23, 2023
6e06664
Merge branch 'main' into experimental/migrate
HBobertz Jun 23, 2023
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
Empty file added .gitmodules
Empty file.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@
"patch-package": "^6.5.1",
"semver": "^7.5.2",
"standard-version": "^9.5.0",
"typescript": "~4.9.5"
"ts-node": "^10.9.1",
"typescript": "~5.1.3"
},
"resolutions": {
"colors": "1.4.0",
Expand Down
3 changes: 2 additions & 1 deletion packages/@aws-cdk-testing/cli-integ/lib/corking.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ export class MemoryStream extends stream.Writable {
this.parts.splice(0, this.parts.length);
}

public async flushTo(strm: NodeJS.WritableStream) {
public async flushTo(strm: NodeJS.WritableStream): Promise<void> {
const flushed = strm.write(this.buffer());
if (!flushed) {
return new Promise(ok => strm.once('drain', ok));
}
return;
}

public toString() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
"inlineSourceMap": true,
"inlineSources": true,
"alwaysStrict": true,
"charset": "utf8",
"declaration": true,
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
"inlineSourceMap": true,
"inlineSources": true,
"alwaysStrict": true,
"charset": "utf8",
"declaration": true,
"experimentalDecorators": true,
"incremental": true,
Expand Down
16 changes: 16 additions & 0 deletions packages/@aws-cdk/cli-lib-alpha/generate.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#!/bin/bash
set -euo pipefail

commit=${CODEBUILD_RESOLVED_SOURCE_VERSION:-}
# CODEBUILD_RESOLVED_SOURCE_VERSION is not defined (i.e. local build or CodePipeline build),
# use the HEAD commit hash
if [ -z "${commit}" ]; then
commit="$(git rev-parse --verify HEAD)"
fi

cat > build-info.json <<HERE
{
"comment": "Generated at $(date -u +"%Y-%m-%dT%H:%M:%SZ") by generate.sh",
"commit": "${commit:0:7}"
}
HERE
2 changes: 1 addition & 1 deletion packages/@aws-cdk/cli-lib-alpha/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
"build+test+package": "yarn build+test && yarn package",
"bundle": "esbuild --bundle lib/index.ts --target=node14 --platform=node --external:fsevents --minify-whitespace --outfile=lib/main.js",
"compat": "cdk-compat",
"gen": "../../../packages/aws-cdk/generate.sh",
"gen": "./generate.sh",
"lint": "cdk-lint",
"package": "cdk-package",
"pkglint": "pkglint -f",
Expand Down
1 change: 0 additions & 1 deletion packages/aws-cdk-lib/aws-lambda-nodejs/lib/bundling.ts
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,6 @@ export class Bundling implements cdk.BundlingOptions {
...this.props.metafile ? [`--metafile=${pathJoin(options.outputDir, 'index.meta.json')}`] : [],
...this.props.banner ? [`--banner:js=${JSON.stringify(this.props.banner)}`] : [],
...this.props.footer ? [`--footer:js=${JSON.stringify(this.props.footer)}`] : [],
...this.props.charset ? [`--charset=${this.props.charset}`] : [],
...this.props.mainFields ? [`--main-fields=${this.props.mainFields.join(',')}`] : [],
...this.props.inject ? this.props.inject.map(i => `--inject:${i}`) : [],
...this.props.esbuildArgs ? [toCliArgs(this.props.esbuildArgs)] : [],
Expand Down
1 change: 1 addition & 0 deletions packages/aws-cdk-lib/aws-lambda-nodejs/lib/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ export function getTsconfigCompilerOptions(tsconfigPath: string): string {
const compilerOptions = extractTsConfig(tsconfigPath);
const excludedCompilerOptions = [
'composite',
'charset',
'noEmit',
'tsBuildInfoFile',
];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ test('esbuild bundling with esbuild options', () => {
defineInstructions,
'--log-level=silent --keep-names --tsconfig=/asset-input/lib/custom-tsconfig.ts',
'--metafile=/asset-output/index.meta.json --banner:js="/* comments */" --footer:js="/* comments */"',
'--charset=utf8 --main-fields=module,main --inject:./my-shim.js',
'--main-fields=module,main --inject:./my-shim.js',
'--log-limit="0" --resolve-extensions=".ts,.js" --splitting --keep-names',
].join(' '),
],
Expand Down
2 changes: 0 additions & 2 deletions packages/aws-cdk-lib/aws-lambda-nodejs/test/util.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,6 @@ describe('getTsconfigCompilerOptions', () => {
const compilerOptions = getTsconfigCompilerOptions(tsconfig);
expect(compilerOptions).toEqual([
'--alwaysStrict',
'--charset utf8',
'--declaration',
'--declarationMap false',
'--experimentalDecorators',
Expand Down Expand Up @@ -219,7 +218,6 @@ describe('getTsconfigCompilerOptions', () => {
const compilerOptions = getTsconfigCompilerOptions(tsconfig);
expect(compilerOptions).toEqual([
'--alwaysStrict',
'--charset utf8',
'--declaration',
'--declarationMap false',
'--experimentalDecorators',
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"stripDeprecated": true,
"compressAssembly": true,
"pre": [
"npx ts-node -P tsconfig.dev.json region-info/build-tools/generate-static-data.ts",
"ts-node -P tsconfig.dev.json region-info/build-tools/generate-static-data.ts",
"(cp -f $(node -p 'require.resolve(\"aws-sdk/apis/metadata.json\")') custom-resources/lib/aws-custom-resource/sdk-api-metadata.json && rm -rf custom-resources/test/aws-custom-resource/cdk.out)",
"(rm -rf core/test/fs/fixtures && cd core/test/fs && tar -xzf fixtures.tar.gz)",
"(rm -rf assets/test/fs/fixtures && cd assets/test/fs && tar -xzvf fixtures.tar.gz)",
Expand Down Expand Up @@ -162,7 +162,7 @@
"ts-mock-imports": "^1.3.8",
"ts-node": "^10.9.1",
"sinon": "^9.2.4",
"typescript": "~5.0.4",
"typescript": "~5.1.3",
"typescript-json-schema": "^0.56.0"
},
"peerDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-migration/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"license": "Apache-2.0",
"dependencies": {
"glob": "^7.2.3",
"typescript": "~4.9.5"
"typescript": "~5.1.3"
},
"devDependencies": {
"@types/glob": "^7.2.0",
Expand Down
1 change: 1 addition & 0 deletions packages/aws-cdk/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const baseConfig = require('@aws-cdk/cdk-build-tools/config/eslintrc');
baseConfig.ignorePatterns.push('lib/init-templates/**/typescript/**/*.ts');
baseConfig.ignorePatterns.push('test/integ/cli/sam_cdk_integ_app/**/*.ts');
baseConfig.ignorePatterns.push('vendor/noctilucent/**/*.ts');
baseConfig.parserOptions.project = __dirname + '/tsconfig.json';
module.exports = baseConfig;
3 changes: 3 additions & 0 deletions packages/aws-cdk/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,6 @@ test/integ/cli/*.d.ts
.DS_Store

junit.xml

# Exclude the noctilucent WASM package
lib/vendor/noctilucent/
3 changes: 3 additions & 0 deletions packages/aws-cdk/.npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ tsconfig.json
# exclude cdk artifacts
**/cdk.out
junit.xml

# exclude noctilucent source
/vendor/noctilucent/
30 changes: 29 additions & 1 deletion packages/aws-cdk/generate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,32 @@ cat > build-info.json <<HERE
"comment": "Generated at $(date -u +"%Y-%m-%dT%H:%M:%SZ") by generate.sh",
"commit": "${commit:0:7}"
}
HERE
HERE

# Build noctilucent package
(
# Check out the submodule if it's not there already
if [ ! -f "vendor/noctilucent/Cargo.toml" ]; then
git -C ./vendor clone https://github.com/iph/noctilucent.git
fi

# update the package to the pinned commit hash
git -C vendor/noctilucent reset --hard HEAD
git -C vendor/noctilucent fetch && git -C vendor/noctilucent checkout 6da7c9fade55f8443bba7b8fdfcd4ebfe5208fb1

# Install wasm-pack if it's not there already
if ! command -v wasm-pack >/dev/null 2>/dev/null; then
echo "installing wasm-pack, this may take a while..."
cargo install wasm-pack
fi

pkgroot=$(cd $(dirname -- "$0") && pwd)

cd vendor/noctilucent
wasm-pack build --target nodejs \
--out-dir="${pkgroot}/lib/vendor/noctilucent" \
--out-name=index

cd ../../lib/vendor/noctilucent
rm package.json
)
11 changes: 10 additions & 1 deletion packages/aws-cdk/lib/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { CdkToolkit, AssetBuildTime } from '../lib/cdk-toolkit';
import { realHandler as context } from '../lib/commands/context';
import { realHandler as docs } from '../lib/commands/docs';
import { realHandler as doctor } from '../lib/commands/doctor';
import { MIGRATE_SUPPORTED_LANGUAGES, cliMigrate } from '../lib/commands/migrate';
import { RequireApproval } from '../lib/diff';
import { availableInitLanguages, cliInit, printAvailableTemplates } from '../lib/init';
import { data, debug, error, print, setLogLevel, setCI } from '../lib/logging';
Expand Down Expand Up @@ -269,6 +270,12 @@ async function parseCommandLineArguments(args: string[]) {
.option('list', { type: 'boolean', desc: 'List the available templates' })
.option('generate-only', { type: 'boolean', default: false, desc: 'If true, only generates project files, without executing additional operations such as setting up a git repo, installing dependencies or compiling the project' }),
)
.command('migrate', false /* hidden from "cdk --help" */, (yargs: Argv) => yargs
.option('language', { type: 'string', alias: 'l', desc: 'The language to be used for the new project (default can be configured in ~/.cdk.json)', choices: MIGRATE_SUPPORTED_LANGUAGES })
.option('input-path', { type: 'string', alias: 'inputpath', desc: 'The path to the CloudFormation template to migrate' })
.option('output-path', { type: 'string', alias: 'outputpath', desc: 'The output path for the migrated cdk code' })
.option('generate-only', { type: 'boolean', default: false, desc: 'If true, only generates project files, without executing additional operations such as setting up a git repo, installing dependencies or compiling the project' }),
)
.command('context', 'Manage cached context values', (yargs: Argv) => yargs
.option('reset', { alias: 'e', desc: 'The context key (or its index) to reset', type: 'string', requiresArg: true })
.option('force', { alias: 'f', desc: 'Ignore missing key error', type: 'boolean', default: false })
Expand Down Expand Up @@ -649,14 +656,16 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
} else {
return cliInit(args.TEMPLATE, language, undefined, args.generateOnly);
}
case 'migrate':
const migrateLanguage = configuration.settings.get(['language']);
return cliMigrate(args.inputpath, migrateLanguage, args.generateOnly, args.outputpath);
case 'version':
return data(version.DISPLAY_VERSION);

default:
throw new Error('Unknown command: ' + command);
}
}

}

/**
Expand Down
71 changes: 71 additions & 0 deletions packages/aws-cdk/lib/commands/migrate.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import * as fs from 'fs';
import * as path from 'path';
import { initializeProject, availableInitTemplates } from '../../lib/init';
import { warning } from '../logging';
import * as nocti from '../vendor/noctilucent';

/** The list of languages supported by the built-in noctilucent binary. */
export const MIGRATE_SUPPORTED_LANGUAGES: readonly string[] = nocti.supported_languages();

export async function cliMigrate(
inputpath: string = process.cwd() + '/../template.txt',
language = MIGRATE_SUPPORTED_LANGUAGES[0],
generateOnly = false,
outputpath = process.cwd(),
) {
warning('This is an experimental feature. We make no guarantees about the outcome or stability of the functionality.');
const type = 'default'; // "default" is the default type (and maps to 'app')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to double-take: why is this an option here, but not exposed as an argument?
Even if right now it has a single value, it can be expanded in the future (based on the comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah so this is basically just to get the init funcitonality to work. I'm happy to just pass the hardcoded string into the initliazeproject but I thought I'd be explicit about wat the default meant.

const template = (await availableInitTemplates()).find(t => t.hasName(type!));
if (!template) {
throw new Error(`couldn't find template for ${type} app type, this should never happen`);
}

if (!MIGRATE_SUPPORTED_LANGUAGES.includes(language)) {
throw new Error(`Unsupported language for cdk migrate: ${language}. Supported languages are: ${MIGRATE_SUPPORTED_LANGUAGES.join(', ')}`);
}

await initializeProject(template, language, true, generateOnly, outputpath);
const template_file = fs.readFileSync(inputpath, 'utf8');
const generated_app = nocti.transmute(template_file, language);

// clear out the init'd bin/lib files to replace with our own
delete_files(outputpath + '/lib/');

// we hardcode everything to be called noctstack still so this works for now.
// Will change this to be much smarter once we can change stack name in noct
const bin_app = `#!/usr/bin/env node
import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';
import { NoctStack } from '../lib/generated_stack';

const app = new cdk.App();
new NoctStack(app, 'NoctStack', {
/* If you don't specify 'env', this stack will be environment-agnostic.
* Account/Region-dependent features and context lookups will not work,
* but a single synthesized template can be deployed anywhere. */

/* Uncomment the next line to specialize this stack for the AWS Account
* and Region that are implied by the current CLI configuration. */
// env: { account: process.env.CDK_DEFAULT_ACCOUNT, region: process.env.CDK_DEFAULT_REGION },

/* Uncomment the next line if you know exactly what Account and Region you
* want to deploy the stack to. */
// env: { account: '123456789012', region: 'us-east-1' },

/* For more information, see https://docs.aws.amazon.com/cdk/latest/guide/environments.html */
});`;
const myname = path.basename(outputpath);
fs.writeFileSync(outputpath + '/lib/' + 'generated_stack.ts', generated_app);
fs.writeFileSync(outputpath + '/bin/' + `${myname}.ts`, bin_app);
}

function delete_files(filepath: string) {
fs.readdir(filepath, (err, files) => {
if (err) throw err;
for (const file of files) {
fs.unlink(filepath + file, (cause) => {
if (cause) throw cause;
});
}
});
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"ts-jest": "^29.1.0",
"aws-cdk": "%cdk-version%",
"ts-node": "^10.9.1",
"typescript": "~5.0.4"
"typescript": "~5.1.3"
},
"dependencies": {
"aws-cdk-lib": "%cdk-version%",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"constructs": "%constructs-version%",
"jest": "^29.5.0",
"ts-jest": "^29.1.0",
"typescript": "~5.0.4"
"typescript": "~5.1.3"
},
"peerDependencies": {
"aws-cdk-lib": "%cdk-version%",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"ts-jest": "^29.1.0",
"aws-cdk": "%cdk-version%",
"ts-node": "^10.9.1",
"typescript": "~5.0.4"
"typescript": "~5.1.3"
},
"dependencies": {
"aws-cdk-lib": "%cdk-version%",
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk/lib/init.ts
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ export async function printAvailableTemplates(language?: string) {
}
}

async function initializeProject(template: InitTemplate, language: string, canUseNetwork: boolean, generateOnly: boolean, workDir: string) {
export async function initializeProject(template: InitTemplate, language: string, canUseNetwork: boolean, generateOnly: boolean, workDir: string) {
await assertIsEmptyDirectory(workDir);
print(`Applying project template ${chalk.green(template.name)} for ${chalk.blue(language)}`);
await template.install(language, workDir);
Expand Down
3 changes: 2 additions & 1 deletion packages/aws-cdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@
},
"resources": {
"../../node_modules/vm2/lib/bridge.js": "lib/bridge.js",
"../../node_modules/vm2/lib/setup-sandbox.js": "lib/setup-sandbox.js"
"../../node_modules/vm2/lib/setup-sandbox.js": "lib/setup-sandbox.js",
"lib/vendor/noctilucent/index_bg.wasm": "lib/index_bg.wasm"
},
"allowedLicenses": [
"Apache-2.0",
Expand Down
9 changes: 7 additions & 2 deletions packages/aws-cdk/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"lib": ["es2019", "es2020", "dom"],
"lib": [
"es2019",
"es2020",
"dom"
],
"strict": true,
"alwaysStrict": true,
"skipLibCheck": true,
Expand All @@ -25,7 +29,8 @@
],
"exclude": [
"lib/init-templates/**/typescript/*/*.ts",
"test/integ/cli/sam_cdk_integ_app/**/*"
"test/integ/cli/sam_cdk_integ_app/**/*",
"vendor/**/*",
],
"references": [
{
Expand Down
13 changes: 13 additions & 0 deletions packages/aws-cdk/vendor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Vendored-in dependencies

The dependencies in this directory are checked out using the `gen` script.
This will fetch and clone the noctilucent crate and generate the wasm code if
that has not been done already, ensuring the dependencies are adequately
checked out.

In order to update the notcilucent crate, run the ./generate.sh script. If you wish
to update to a different noctilucent commit hash instead of the one provided, modify
the hash in the generate.sh script and then rerun ./generate.sh

The `THIRD_PARTY_LICENSES` file might need updating accordingly, which can be
automatically done by running `yarn pkglint`.
2 changes: 1 addition & 1 deletion packages/awslint/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"@types/jest": "^29.5.1",
"@types/yargs": "^15.0.15",
"@aws-cdk/pkglint": "0.0.0",
"typescript": "~4.9.5",
"typescript": "~5.1.3",
"@typescript-eslint/eslint-plugin": "^4.33.0",
"@typescript-eslint/parser": "^4.33.0",
"eslint": "^7.32.0",
Expand Down
Loading