add build script for lambda layer

lobsterkatie · lobsterkatie · commit 47d44f12e643 · 2022-05-24T06:28:48.000-07:00
diff --git a/packages/serverless/.eslintrc.js b/packages/serverless/.eslintrc.js
@@ -6,4 +6,18 @@ module.exports = {
   rules: {
     '@sentry-internal/sdk/no-async-await': 'off',
   },
+  overrides: [
+    {
+      files: ['scripts/**/*.ts'],
+      parserOptions: {
+        project: ['../../tsconfig.dev.json'],
+      },
+    },
+    {
+      files: ['test/**'],
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
+  ],
 };
diff --git a/packages/serverless/scripts/buildLambdaLayer.ts b/packages/serverless/scripts/buildLambdaLayer.ts
@@ -0,0 +1,62 @@
+/* eslint-disable no-console */
+import * as childProcess from 'child_process';
+import * as fs from 'fs';
+import * as rimraf from 'rimraf';
+
+import { ensureBundleBuildPrereqs } from '../../../scripts/ensure-bundle-deps';
+
+/**
+ * Run the given shell command, piping the shell process's `stdin`, `stdout`, and `stderr` to that of the current
+ * process. Returns contents of `stdout`.
+ */
+function run(cmd: string, options?: childProcess.ExecSyncOptions): string {
+  return String(childProcess.execSync(cmd, { stdio: 'inherit', ...options }));
+}
+
+async function buildLambdaLayer(): Promise<void> {
+  // Create the main SDK bundle
+  await ensureBundleBuildPrereqs({
+    dependencies: ['@sentry/utils', '@sentry/hub', '@sentry/core', '@sentry/tracing', '@sentry/node'],
+  });
+  run('yarn rollup --config rollup.aws.config.js');
+
+  // We build a minified bundle, but it's standing in for the regular `index.js` file listed in `package.json`'s `main`
+  // property, so we have to rename it so it's findable.
+  fs.renameSync(
+    'build/aws/dist-serverless/nodejs/node_modules/@sentry/serverless/build/npm/cjs/index.min.js',
+    'build/aws/dist-serverless/nodejs/node_modules/@sentry/serverless/build/npm/cjs/index.js',
+  );
+
+  // We're creating a bundle for the SDK, but still using it in a Node context, so we need to copy in `package.json`,
+  // purely for its `main` property.
+  console.log('Copying `package.json` into lambda layer.');
+  fs.copyFileSync('package.json', 'build/aws/dist-serverless/nodejs/node_modules/@sentry/serverless/package.json');
+
+  // The layer also includes `awslambda-auto.js`, a helper file which calls `Sentry.init()` and wraps the lambda
+  // handler. It gets run when Node is launched inside the lambda, using the environment variable
+  //
+  //   `NODE_OPTIONS="-r @sentry/serverless/dist/awslambda-auto"`.
+  //
+  // (The`-r` is what runs the script on startup.) The `dist` directory is no longer where we emit our built code, so
+  // for backwards compatibility, we create a symlink.
+  console.log('Creating symlink for `awslambda-auto.js` in legacy `dist` directory.');
+  fsForceMkdirSync('build/aws/dist-serverless/nodejs/node_modules/@sentry/serverless/dist');
+  fs.symlinkSync(
+    '../build/npm/cjs/awslambda-auto.js',
+    'build/aws/dist-serverless/nodejs/node_modules/@sentry/serverless/dist/awslambda-auto.js',
+  );
+}
+
+void buildLambdaLayer();
+
+/**
+ * Make a directory synchronously, overwriting the old directory if necessary.
+ *
+ * This is what `fs.mkdirSync(path, { force: true })` would be, if it existed. Primarily useful for local building and
+ * testing, where scripts are often run more than once (and so the directory you're trying to create may already be
+ * there), but also harmless when used in CI.
+ */
+function fsForceMkdirSync(path: string): void {
+  rimraf.sync(path);
+  fs.mkdirSync(path);
+}
diff --git a/scripts/ensure-bundle-deps.ts b/scripts/ensure-bundle-deps.ts
@@ -7,7 +7,10 @@ import * as util from 'util';
 /**
  * Ensure that `build:bundle` has all of the dependencies it needs to run. Works at both the repo and package level.
  */
-async function ensureBundleBuildPrereqs(options: { dependencies: string[]; maxRetries?: number }): Promise<void> {
+export async function ensureBundleBuildPrereqs(options: {
+  dependencies: string[];
+  maxRetries?: number;
+}): Promise<void> {
   const { maxRetries = 12, dependencies } = options;
 
   const {
