-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
asset-staging.ts
620 lines (539 loc) · 20.8 KB
/
asset-staging.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
import * as crypto from 'crypto';
import * as os from 'os';
import * as path from 'path';
import * as cxapi from '@aws-cdk/cx-api';
import { Construct } from 'constructs';
import * as fs from 'fs-extra';
import { AssetHashType, AssetOptions, FileAssetPackaging } from './assets';
import { BundlingOptions, BundlingOutput } from './bundling';
import { FileSystem, FingerprintOptions } from './fs';
import { Names } from './names';
import { Cache } from './private/cache';
import { Stack } from './stack';
import { Stage } from './stage';
// v2 - keep this import as a separate section to reduce merge conflict when forward merging with the v2 branch.
// eslint-disable-next-line
import { Construct as CoreConstruct } from './construct-compat';
const ARCHIVE_EXTENSIONS = ['.zip', '.jar'];
/**
* A previously staged asset
*/
interface StagedAsset {
/**
* The path where we wrote this asset previously
*/
readonly stagedPath: string;
/**
* The hash we used previously
*/
readonly assetHash: string;
/**
* The packaging of the asset
*/
readonly packaging: FileAssetPackaging,
/**
* Whether this asset is an archive
*/
readonly isArchive: boolean;
}
/**
* Initialization properties for `AssetStaging`.
*/
export interface AssetStagingProps extends FingerprintOptions, AssetOptions {
/**
* The source file or directory to copy from.
*/
readonly sourcePath: string;
}
/**
* Stages a file or directory from a location on the file system into a staging
* directory.
*
* This is controlled by the context key 'aws:cdk:asset-staging' and enabled
* by the CLI by default in order to ensure that when the CDK app exists, all
* assets are available for deployment. Otherwise, if an app references assets
* in temporary locations, those will not be available when it exists (see
* https://github.com/aws/aws-cdk/issues/1716).
*
* The `stagedPath` property is a stringified token that represents the location
* of the file or directory after staging. It will be resolved only during the
* "prepare" stage and may be either the original path or the staged path
* depending on the context setting.
*
* The file/directory are staged based on their content hash (fingerprint). This
* means that only if content was changed, copy will happen.
*/
export class AssetStaging extends CoreConstruct {
/**
* The directory inside the bundling container into which the asset sources will be mounted.
*/
public static readonly BUNDLING_INPUT_DIR = '/asset-input';
/**
* The directory inside the bundling container into which the bundled output should be written.
*/
public static readonly BUNDLING_OUTPUT_DIR = '/asset-output';
/**
* Clears the asset hash cache
*/
public static clearAssetHashCache() {
this.assetCache.clear();
}
/**
* Cache of asset hashes based on asset configuration to avoid repeated file
* system and bundling operations.
*/
private static assetCache = new Cache<StagedAsset>();
/**
* Absolute path to the asset data.
*
* If asset staging is disabled, this will just be the source path or
* a temporary directory used for bundling.
*
* If asset staging is enabled it will be the staged path.
*
* IMPORTANT: If you are going to call `addFileAsset()`, use
* `relativeStagedPath()` instead.
*
* @deprecated - Use `absoluteStagedPath` instead.
*/
public readonly stagedPath: string;
/**
* Absolute path to the asset data.
*
* If asset staging is disabled, this will just be the source path or
* a temporary directory used for bundling.
*
* If asset staging is enabled it will be the staged path.
*
* IMPORTANT: If you are going to call `addFileAsset()`, use
* `relativeStagedPath()` instead.
*/
public readonly absoluteStagedPath: string;
/**
* The absolute path of the asset as it was referenced by the user.
*/
public readonly sourcePath: string;
/**
* A cryptographic hash of the asset.
*/
public readonly assetHash: string;
/**
* How this asset should be packaged.
*/
public readonly packaging: FileAssetPackaging;
/**
* Whether this asset is an archive (zip or jar).
*/
public readonly isArchive: boolean;
private readonly fingerprintOptions: FingerprintOptions;
private readonly hashType: AssetHashType;
private readonly assetOutdir: string;
/**
* A custom source fingerprint given by the user
*
* Will not be used literally, always hashed later on.
*/
private customSourceFingerprint?: string;
private readonly cacheKey: string;
private readonly sourceStats: fs.Stats;
constructor(scope: Construct, id: string, props: AssetStagingProps) {
super(scope, id);
this.sourcePath = path.resolve(props.sourcePath);
this.fingerprintOptions = props;
if (!fs.existsSync(this.sourcePath)) {
throw new Error(`Cannot find asset at ${this.sourcePath}`);
}
this.sourceStats = fs.statSync(this.sourcePath);
const outdir = Stage.of(this)?.assetOutdir;
if (!outdir) {
throw new Error('unable to determine cloud assembly asset output directory. Assets must be defined indirectly within a "Stage" or an "App" scope');
}
this.assetOutdir = outdir;
// Determine the hash type based on the props as props.assetHashType is
// optional from a caller perspective.
this.customSourceFingerprint = props.assetHash;
this.hashType = determineHashType(props.assetHashType, this.customSourceFingerprint);
// Decide what we're going to do, without actually doing it yet
let stageThisAsset: () => StagedAsset;
let skip = false;
if (props.bundling) {
// Check if we actually have to bundle for this stack
skip = !Stack.of(this).bundlingRequired;
const bundling = props.bundling;
stageThisAsset = () => this.stageByBundling(bundling, skip);
} else {
stageThisAsset = () => this.stageByCopying();
}
// Calculate a cache key from the props. This way we can check if we already
// staged this asset and reuse the result (e.g. the same asset with the same
// configuration is used in multiple stacks). In this case we can completely
// skip file system and bundling operations.
//
// The output directory and whether this asset is skipped or not should also be
// part of the cache key to make sure we don't accidentally return the wrong
// staged asset from the cache.
this.cacheKey = calculateCacheKey({
outdir: this.assetOutdir,
sourcePath: path.resolve(props.sourcePath),
bundling: props.bundling,
assetHashType: this.hashType,
customFingerprint: this.customSourceFingerprint,
extraHash: props.extraHash,
exclude: props.exclude,
ignoreMode: props.ignoreMode,
skip,
});
const staged = AssetStaging.assetCache.obtain(this.cacheKey, stageThisAsset);
this.stagedPath = staged.stagedPath;
this.absoluteStagedPath = staged.stagedPath;
this.assetHash = staged.assetHash;
this.packaging = staged.packaging;
this.isArchive = staged.isArchive;
}
/**
* A cryptographic hash of the asset.
*
* @deprecated see `assetHash`.
*/
public get sourceHash(): string {
return this.assetHash;
}
/**
* Return the path to the staged asset, relative to the Cloud Assembly (manifest) directory of the given stack
*
* Only returns a relative path if the asset was staged, returns an absolute path if
* it was not staged.
*
* A bundled asset might end up in the outDir and still not count as
* "staged"; if asset staging is disabled we're technically expected to
* reference source directories, but we don't have a source directory for the
* bundled outputs (as the bundle output is written to a temporary
* directory). Nevertheless, we will still return an absolute path.
*
* A non-obvious directory layout may look like this:
*
* ```
* CLOUD ASSEMBLY ROOT
* +-- asset.12345abcdef/
* +-- assembly-Stage
* +-- MyStack.template.json
* +-- MyStack.assets.json <- will contain { "path": "../asset.12345abcdef" }
* ```
*/
public relativeStagedPath(stack: Stack) {
const asmManifestDir = Stage.of(stack)?.outdir;
if (!asmManifestDir) { return this.stagedPath; }
const isOutsideAssetDir = path.relative(this.assetOutdir, this.stagedPath).startsWith('..');
if (isOutsideAssetDir || this.stagingDisabled) {
return this.stagedPath;
}
return path.relative(asmManifestDir, this.stagedPath);
}
/**
* Stage the source to the target by copying
*
* Optionally skip if staging is disabled, in which case we pretend we did something but we don't really.
*/
private stageByCopying(): StagedAsset {
const assetHash = this.calculateHash(this.hashType);
const stagedPath = this.stagingDisabled
? this.sourcePath
: path.resolve(this.assetOutdir, renderAssetFilename(assetHash, path.extname(this.sourcePath)));
if (!this.sourceStats.isDirectory() && !this.sourceStats.isFile()) {
throw new Error(`Asset ${this.sourcePath} is expected to be either a directory or a regular file`);
}
this.stageAsset(this.sourcePath, stagedPath, 'copy');
return {
assetHash,
stagedPath,
packaging: this.sourceStats.isDirectory() ? FileAssetPackaging.ZIP_DIRECTORY : FileAssetPackaging.FILE,
isArchive: this.sourceStats.isDirectory() || ARCHIVE_EXTENSIONS.includes(path.extname(this.sourcePath).toLowerCase()),
};
}
/**
* Stage the source to the target by bundling
*
* Optionally skip, in which case we pretend we did something but we don't really.
*/
private stageByBundling(bundling: BundlingOptions, skip: boolean): StagedAsset {
if (!this.sourceStats.isDirectory()) {
throw new Error(`Asset ${this.sourcePath} is expected to be a directory when bundling`);
}
if (skip) {
// We should have bundled, but didn't to save time. Still pretend to have a hash.
// If the asset uses OUTPUT or BUNDLE, we use a CUSTOM hash to avoid fingerprinting
// a potentially very large source directory. Other hash types are kept the same.
let hashType = this.hashType;
if (hashType === AssetHashType.OUTPUT || hashType === AssetHashType.BUNDLE) {
this.customSourceFingerprint = Names.uniqueId(this);
hashType = AssetHashType.CUSTOM;
}
return {
assetHash: this.calculateHash(hashType, bundling),
stagedPath: this.sourcePath,
packaging: FileAssetPackaging.ZIP_DIRECTORY,
isArchive: true,
};
}
// Try to calculate assetHash beforehand (if we can)
let assetHash = this.hashType === AssetHashType.SOURCE || this.hashType === AssetHashType.CUSTOM
? this.calculateHash(this.hashType, bundling)
: undefined;
const bundleDir = this.determineBundleDir(this.assetOutdir, assetHash);
this.bundle(bundling, bundleDir);
// Check bundling output content and determine if we will need to archive
const bundlingOutputType = bundling.outputType ?? BundlingOutput.AUTO_DISCOVER;
const bundledAsset = determineBundledAsset(bundleDir, bundlingOutputType);
// Calculate assetHash afterwards if we still must
assetHash = assetHash ?? this.calculateHash(this.hashType, bundling, bundledAsset.path);
const stagedPath = path.resolve(this.assetOutdir, renderAssetFilename(assetHash, bundledAsset.extension));
this.stageAsset(bundledAsset.path, stagedPath, 'move');
// If bundling produced a single archive file we "touch" this file in the bundling
// directory after it has been moved to the staging directory. This way if bundling
// is skipped because the bundling directory already exists we can still determine
// the correct packaging type.
if (bundledAsset.packaging === FileAssetPackaging.FILE) {
fs.closeSync(fs.openSync(bundledAsset.path, 'w'));
}
return {
assetHash,
stagedPath,
packaging: bundledAsset.packaging,
isArchive: true, // bundling always produces an archive
};
}
/**
* Whether staging has been disabled
*/
private get stagingDisabled() {
return !!this.node.tryGetContext(cxapi.DISABLE_ASSET_STAGING_CONTEXT);
}
/**
* Copies or moves the files from sourcePath to targetPath.
*
* Moving implies the source directory is temporary and can be trashed.
*
* Will not do anything if source and target are the same.
*/
private stageAsset(sourcePath: string, targetPath: string, style: 'move' | 'copy') {
// Is the work already done?
const isAlreadyStaged = fs.existsSync(targetPath);
if (isAlreadyStaged) {
if (style === 'move' && sourcePath !== targetPath) {
fs.removeSync(sourcePath);
}
return;
}
// Moving can be done quickly
if (style == 'move') {
fs.renameSync(sourcePath, targetPath);
return;
}
// Copy file/directory to staging directory
if (this.sourceStats.isFile()) {
fs.copyFileSync(sourcePath, targetPath);
} else if (this.sourceStats.isDirectory()) {
fs.mkdirSync(targetPath);
FileSystem.copyDirectory(sourcePath, targetPath, this.fingerprintOptions);
} else {
throw new Error(`Unknown file type: ${sourcePath}`);
}
}
/**
* Determine the directory where we're going to write the bundling output
*
* This is the target directory where we're going to write the staged output
* files if we can (if the hash is fully known), or a temporary directory
* otherwise.
*/
private determineBundleDir(outdir: string, sourceHash?: string) {
if (sourceHash) {
return path.resolve(outdir, renderAssetFilename(sourceHash));
}
// When the asset hash isn't known in advance, bundler outputs to an
// intermediate directory named after the asset's cache key
return path.resolve(outdir, `bundling-temp-${this.cacheKey}`);
}
/**
* Bundles an asset to the given directory
*
* If the given directory already exists, assume that everything's already
* in order and don't do anything.
*
* @param options Bundling options
* @param bundleDir Where to create the bundle directory
* @returns The fully resolved bundle output directory.
*/
private bundle(options: BundlingOptions, bundleDir: string) {
if (fs.existsSync(bundleDir)) { return; }
fs.ensureDirSync(bundleDir);
// Chmod the bundleDir to full access.
fs.chmodSync(bundleDir, 0o777);
// Always mount input and output dir
const volumes = [
{
hostPath: this.sourcePath,
containerPath: AssetStaging.BUNDLING_INPUT_DIR,
},
{
hostPath: bundleDir,
containerPath: AssetStaging.BUNDLING_OUTPUT_DIR,
},
...options.volumes ?? [],
];
let localBundling: boolean | undefined;
try {
process.stderr.write(`Bundling asset ${this.node.path}...\n`);
localBundling = options.local?.tryBundle(bundleDir, options);
if (!localBundling) {
let user: string;
if (options.user) {
user = options.user;
} else { // Default to current user
const userInfo = os.userInfo();
user = userInfo.uid !== -1 // uid is -1 on Windows
? `${userInfo.uid}:${userInfo.gid}`
: '1000:1000';
}
options.image.run({
command: options.command,
user,
volumes,
environment: options.environment,
workingDirectory: options.workingDirectory ?? AssetStaging.BUNDLING_INPUT_DIR,
securityOpt: options.securityOpt ?? '',
});
}
} catch (err) {
// When bundling fails, keep the bundle output for diagnosability, but
// rename it out of the way so that the next run doesn't assume it has a
// valid bundleDir.
const bundleErrorDir = bundleDir + '-error';
if (fs.existsSync(bundleErrorDir)) {
// Remove the last bundleErrorDir.
fs.removeSync(bundleErrorDir);
}
fs.renameSync(bundleDir, bundleErrorDir);
throw new Error(`Failed to bundle asset ${this.node.path}, bundle output is located at ${bundleErrorDir}: ${err}`);
}
if (FileSystem.isEmpty(bundleDir)) {
const outputDir = localBundling ? bundleDir : AssetStaging.BUNDLING_OUTPUT_DIR;
throw new Error(`Bundling did not produce any output. Check that content is written to ${outputDir}.`);
}
}
private calculateHash(hashType: AssetHashType, bundling?: BundlingOptions, outputDir?: string): string {
// When bundling a CUSTOM or SOURCE asset hash type, we want the hash to include
// the bundling configuration. We handle CUSTOM and bundled SOURCE hash types
// as a special case to preserve existing user asset hashes in all other cases.
if (hashType == AssetHashType.CUSTOM || (hashType == AssetHashType.SOURCE && bundling)) {
const hash = crypto.createHash('sha256');
// if asset hash is provided by user, use it, otherwise fingerprint the source.
hash.update(this.customSourceFingerprint ?? FileSystem.fingerprint(this.sourcePath, this.fingerprintOptions));
// If we're bundling an asset, include the bundling configuration in the hash
if (bundling) {
hash.update(JSON.stringify(bundling));
}
return hash.digest('hex');
}
switch (hashType) {
case AssetHashType.SOURCE:
return FileSystem.fingerprint(this.sourcePath, this.fingerprintOptions);
case AssetHashType.BUNDLE:
case AssetHashType.OUTPUT:
if (!outputDir) {
throw new Error(`Cannot use \`${hashType}\` hash type when \`bundling\` is not specified.`);
}
return FileSystem.fingerprint(outputDir, this.fingerprintOptions);
default:
throw new Error('Unknown asset hash type.');
}
}
}
function renderAssetFilename(assetHash: string, extension = '') {
return `asset.${assetHash}${extension}`;
}
/**
* Determines the hash type from user-given prop values.
*
* @param assetHashType Asset hash type construct prop
* @param customSourceFingerprint Asset hash seed given in the construct props
*/
function determineHashType(assetHashType?: AssetHashType, customSourceFingerprint?: string) {
const hashType = customSourceFingerprint
? (assetHashType ?? AssetHashType.CUSTOM)
: (assetHashType ?? AssetHashType.SOURCE);
if (customSourceFingerprint && hashType !== AssetHashType.CUSTOM) {
throw new Error(`Cannot specify \`${assetHashType}\` for \`assetHashType\` when \`assetHash\` is specified. Use \`CUSTOM\` or leave \`undefined\`.`);
}
if (hashType === AssetHashType.CUSTOM && !customSourceFingerprint) {
throw new Error('`assetHash` must be specified when `assetHashType` is set to `AssetHashType.CUSTOM`.');
}
return hashType;
}
/**
* Calculates a cache key from the props. Normalize by sorting keys.
*/
function calculateCacheKey<A extends object>(props: A): string {
return crypto.createHash('sha256')
.update(JSON.stringify(sortObject(props)))
.digest('hex');
}
/**
* Recursively sort object keys
*/
function sortObject(object: { [key: string]: any }): { [key: string]: any } {
if (typeof object !== 'object' || object instanceof Array) {
return object;
}
const ret: { [key: string]: any } = {};
for (const key of Object.keys(object).sort()) {
ret[key] = sortObject(object[key]);
}
return ret;
}
/**
* Returns the single archive file of a directory or undefined
*/
function singleArchiveFile(directory: string): string | undefined {
if (!fs.existsSync(directory)) {
throw new Error(`Directory ${directory} does not exist.`);
}
if (!fs.statSync(directory).isDirectory()) {
throw new Error(`${directory} is not a directory.`);
}
const content = fs.readdirSync(directory);
if (content.length === 1) {
const file = path.join(directory, content[0]);
const extension = path.extname(content[0]).toLowerCase();
if (fs.statSync(file).isFile() && ARCHIVE_EXTENSIONS.includes(extension)) {
return file;
}
}
return undefined;
}
interface BundledAsset {
path: string,
packaging: FileAssetPackaging,
extension?: string
}
/**
* Returns the bundled asset to use based on the content of the bundle directory
* and the type of output.
*/
function determineBundledAsset(bundleDir: string, outputType: BundlingOutput): BundledAsset {
const archiveFile = singleArchiveFile(bundleDir);
// auto-discover means that if there is an archive file, we take it as the
// bundle, otherwise, we will archive here.
if (outputType === BundlingOutput.AUTO_DISCOVER) {
outputType = archiveFile ? BundlingOutput.ARCHIVED : BundlingOutput.NOT_ARCHIVED;
}
switch (outputType) {
case BundlingOutput.NOT_ARCHIVED:
return { path: bundleDir, packaging: FileAssetPackaging.ZIP_DIRECTORY };
case BundlingOutput.ARCHIVED:
if (!archiveFile) {
throw new Error('Bundling output directory is expected to include only a single .zip or .jar file when `output` is set to `ARCHIVED`');
}
return { path: archiveFile, packaging: FileAssetPackaging.FILE, extension: path.extname(archiveFile) };
}
}