fix!: use CodeBuild instead of Lambda (#4)

* use CodeBuild for build environment
* allow to set extractPath
* allow to select nodejs version

BREAKING CHANGE: the paths where assets are extracted have changed. If you use multiple assets, you may see some errors. Use new `extractPath` property to fix them.

closes #2 #3

Author: tmokmss

API.md

@@ -66,6 +66,8 @@ Then, the extracted directories will be located as the following:
 └── module1               # extracted module1 assets
 ```
 
+You can also override the path where assets are extracted by `extractPath` property for each asset.
+
 Please also check [the example directory](./example/) for a complete example. 
 
 ## Motivation - why do we need this construct?

README.md

@@ -1,7 +1,7 @@
 ## How to Deploy
 ```sh
 # Assume current directory is the example directory
-cd ../src/lambda/nodejs-build
+cd ../lambda/nodejs-build
 npm ci
 npm run build
 cd -

example/README.md

@@ -65,6 +65,7 @@ class TestStack extends Stack {
       buildEnvironment: {
         VITE_API_ENDPOINT: api.url,
       },
+      nodejsVersion: 18,
     });
 
     new CfnOutput(this, 'DistributionUrl', {

example/index.ts

@@ -1,13 +1,7 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import AdmZip from 'adm-zip';
-import extract from 'extract-zip';
-import { execSync } from 'child_process';
-import { Readable } from 'stream';
-import { S3Client, GetObjectCommand, PutObjectCommand } from '@aws-sdk/client-s3';
+import { BatchGetBuildsCommand, CodeBuildClient, StartBuildCommand } from '@aws-sdk/client-codebuild';
 import type { ResourceProperties } from '../../src/types';
 
-const s3 = new S3Client({});
+const cb = new CodeBuildClient({});
 
 type Event = {
   RequestType: 'Create' | 'Update' | 'Delete';
@@ -20,53 +14,98 @@ type Event = {
 };
 
 export const handler = async (event: Event, context: any) => {
-  let rootDir = '';
   console.log(JSON.stringify(event));
 
   try {
     if (event.RequestType == 'Create' || event.RequestType == 'Update') {
       const props = event.ResourceProperties;
-      rootDir = fs.mkdtempSync('/tmp/extract');
 
-      // set npm cache directory under /tmp since other directories are read-only in Lambda env
-      process.env.NPM_CONFIG_CACHE = '/tmp/.npm';
+      // start code build project
+      const build = await cb.send(
+        new StartBuildCommand({
+          projectName: props.codeBuildProjectName,
+          environmentVariablesOverride: [
+            {
+              name: 'input',
+              value: JSON.stringify(
+                props.sources.map((source) => ({
+                  assetUrl: `s3://${source.sourceBucketName}/${source.sourceObjectKey}`,
+                  extractPath: source.extractPath,
+                  commands: (source.commands ?? []).join(' && '),
+                }))
+              ),
+            },
+            {
+              name: 'buildCommands',
+              value: props.buildCommands.join(' && '),
+            },
+            {
+              name: 'destinationBucketName',
+              value: props.destinationBucketName,
+            },
+            {
+              name: 'destinationObjectKey',
+              value: props.destinationObjectKey,
+            },
+            {
+              name: 'workingDirectory',
+              value: props.workingDirectory,
+            },
+            {
+              name: 'outputSourceDirectory',
+              value: props.outputSourceDirectory,
+            },
+            {
+              name: 'projectName',
+              value: props.codeBuildProjectName,
+            },
+            {
+              name: 'responseURL',
+              value: event.ResponseURL,
+            },
+            {
+              name: 'stackId',
+              value: event.StackId,
+            },
+            {
+              name: 'requestId',
+              value: event.RequestId,
+            },
+            {
+              name: 'logicalResourceId',
+              value: event.LogicalResourceId,
+            },
+            ...Object.entries(props.environment ?? {}).map(([name, value]) => ({
+              name,
+              value,
+            })),
+          ],
+        })
+      );
 
-      // inject environment variables from resource properties
-      Object.entries(props.environment ?? {}).forEach(([key, value]) => (process.env[key] = value));
+      // Sometimes CodeBuild build fails before running buildspec, without calling the CFn callback.
+      // We can poll the status of a build for a few minutes and sendStatus if such errors are detected.
+      // if (build.build?.id == null) {
+      //   throw new Error('build id is null');
+      // }
 
-      // Download and extract each asset, and execute commands if any specified.
-      const promises = props.sources.map(async (p) => {
-        const dir = await extractZip(rootDir, p.directoryName, p.sourceObjectKey, p.sourceBucketName);
-        if (p.commands != null) {
-          execSync(p.commands.join(' && '), { cwd: dir, stdio: 'inherit' });
-        }
-      });
+      // for (let i=0; i< 20; i++) {
+      //   const res = await cb.send(new BatchGetBuildsCommand({ ids: [build.build.id] }));
+      //   const status = res.builds?.[0].buildStatus;
+      //   if (status == null) {
+      //     throw new Error('build status is null');
+      //   }
 
-      await Promise.all(promises);
-
-      console.log(JSON.stringify(process.env));
-      const wd = path.join(rootDir, props.workingDirectory);
-      execSync(props.buildCommands.join(' && '), {
-        cwd: wd,
-        stdio: 'inherit',
-      });
-
-      // zip the artifact directory and upload it to a S3 bucket.
-      const srcPath = path.join(rootDir, props.outputSourceDirectory);
-      await uploadDistDirectory(srcPath, props.destinationBucketName, props.destinationObjectKey);
+      //   await new Promise((resolve) => setTimeout(resolve, 5000));
+      // }
     } else {
-      // how do we process 'Delete' event?
+      // Do nothing on a DELETE event.
+      await sendStatus('SUCCESS', event, context);
     }
-    await sendStatus('SUCCESS', event, context);
   } catch (e) {
     console.log(e);
     const err = e as Error;
     await sendStatus('FAILED', event, context, err.message);
-  } finally {
-    if (rootDir != '') {
-      // remove the working directory to prevent storage leakage
-      fs.rmSync(rootDir, { recursive: true, force: true });
-    }
   }
 };
 
@@ -91,37 +130,3 @@ const sendStatus = async (status: 'SUCCESS' | 'FAILED', event: Event, context: a
     },
   });
 };
-
-const uploadDistDirectory = async (srcPath: string, dstBucket: string, dstKey: string) => {
-  const zip = new AdmZip();
-  zip.addLocalFolder(srcPath);
-  await s3.send(
-    new PutObjectCommand({
-      Body: zip.toBuffer(),
-      Bucket: dstBucket,
-      Key: dstKey,
-    })
-  );
-};
-
-const extractZip = async (rootDir: string, dirName: string, key: string, bucket: string) => {
-  const dir = path.join(rootDir, dirName);
-  fs.mkdirSync(dir, { recursive: true });
-  const zipPath = path.join(dir, 'temp.zip');
-  await downloadS3File(key, bucket, zipPath);
-  await extract(zipPath, { dir });
-  console.log(`extracted to ${dir}`);
-  return dir;
-};
-
-const downloadS3File = async (key: string, bucket: string, dst: string) => {
-  const data = await s3.send(new GetObjectCommand({ Bucket: bucket, Key: key }));
-  await new Promise((resolve, reject) => {
-    if (data.Body instanceof Readable) {
-      data.Body
-        .pipe(fs.createWriteStream(dst))
-        .on('error', (err) => reject(err))
-        .on('close', () => resolve(1));
-    }
-  });
-};