feat(v8): Add @sentry/aws-serverless package (#11052)

This change renames the `@sentry/serverless` SDK to be
`@sentry/aws-serverless` and removes all GCP related code. It also adds
a migration note detailing the changes we made.

It also updates the package to only emit CJS, because it relies on
monkeypatching via `require` calls. We can add back ESM at a later
point, will create follow up issue for it.

This PR does not touch any of the lambda layer code, I will come back
and refactor it afterwards (too scary to think about right now)

We will rename the `@sentry/google-cloud` package to
`@sentry/google-cloud-serverless` in a follow up PR

Author: AbhiPrasad

.craft.yml

@@ -89,8 +89,8 @@ targets:
 
   ## 5. Node-based Packages
   - name: npm
-    id: '@sentry/serverless'
-    includeNames: /^sentry-serverless-\d.*\.tgz$/
+    id: '@sentry/aws-serverless'
+    includeNames: /^sentry-aws-serverless-\d.*\.tgz$/
   - name: npm
     id: '@sentry/google-cloud'
     includeNames: /^sentry-google-cloud-\d.*\.tgz$/

.github/ISSUE_TEMPLATE/bug.yml

@@ -34,6 +34,7 @@ body:
         - '@sentry/astro'
         - '@sentry/angular'
         - '@sentry/angular-ivy'
+        - '@sentry/aws-serverless'
         - '@sentry/bun'
         - '@sentry/deno'
         - '@sentry/ember'
@@ -42,7 +43,6 @@ body:
         - '@sentry/node'
         - '@sentry/react'
         - '@sentry/remix'
-        - '@sentry/serverless'
         - '@sentry/google-cloud'
         - '@sentry/svelte'
         - '@sentry/sveltekit'

MIGRATION.md

@@ -48,6 +48,7 @@ We've removed the following packages:
 - [@sentry/hub](./MIGRATION.md#sentryhub)
 - [@sentry/tracing](./MIGRATION.md#sentrytracing)
 - [@sentry/integrations](./MIGRATION.md#sentryintegrations)
+- [@sentry/serverless](./MIGRATION.md#sentryserverless)
 
 #### @sentry/hub
 
@@ -167,6 +168,55 @@ Integrations that are now exported from `@sentry/node` and `@sentry/browser` (or
 
 The `Transaction` integration has been removed from `@sentry/integrations`. There is no replacement API.
 
+#### @sentry/serverless
+
+`@sentry/serverless` has been removed and will no longer be published. The serverless package has been split into two
+different packages, `@sentry/aws-serverless` and `@sentry/google-cloud`. These new packages have smaller bundle size
+than `@sentry/serverless`, which should improve your serverless cold-start times.
+
+`@sentry/aws-serverless` and `@sentry/google-cloud` has also been changed to only emit CJS builds. The ESM build for the
+`@sentry/serverless` package was always broken and we decided to remove it entirely. ESM support will be re-added at a
+later date.
+
+In `@sentry/serverless` you had to use a namespace import to initialize the SDK. This has been removed so that you can
+directly import from the SDK instead.
+
+```js
+// v7
+const Sentry = require('@sentry/serverless');
+
+Sentry.AWSLambda.init({
+  dsn: '__DSN__',
+  tracesSampleRate: 1.0,
+});
+
+// v8
+const Sentry = require('@sentry/aws-serverless');
+
+Sentry.init({
+  dsn: '__DSN__',
+  tracesSampleRate: 1.0,
+});
+```
+
+```js
+// v7
+const Sentry = require('@sentry/serverless');
+
+Sentry.GCPFunction.init({
+  dsn: '__DSN__',
+  tracesSampleRate: 1.0,
+});
+
+// v8
+const Sentry = require('@sentry/google-cloud');
+
+Sentry.init({
+  dsn: '__DSN__',
+  tracesSampleRate: 1.0,
+});
+```
+
 ## 3. Performance Monitoring Changes
 
 - [Performance Monitoring API](./MIGRATION.md#performance-monitoring-api)

README.md

@@ -57,8 +57,10 @@ package. Please refer to the README and instructions of those SDKs for more deta
 - [`@sentry/gatsby`](https://github.com/getsentry/sentry-javascript/tree/master/packages/gatsby): SDK for Gatsby
 - [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
 - [`@sentry/remix`](https://github.com/getsentry/sentry-javascript/tree/master/packages/remix): SDK for Remix
-- [`@sentry/serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/serverless): SDK for
-  Serverless Platforms (AWS, GCP)
+- [`@sentry/aws-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/aws-serverless): SDK
+  for AWS Lambda Functions
+- [`@sentry/google-cloud`](https://github.com/getsentry/sentry-javascript/tree/master/packages/google-cloud): SDK for
+  Google Cloud Functions
 - [`@sentry/electron`](https://github.com/getsentry/sentry-electron): SDK for Electron with support for native crashes
 - [`@sentry/react-native`](https://github.com/getsentry/sentry-react-native): SDK for React Native with support for
   native crashes

dev-packages/e2e-tests/test-applications/node-exports-test-app/package.json

@@ -18,7 +18,7 @@
     "@sentry/remix": "latest || *",
     "@sentry/astro": "latest || *",
     "@sentry/nextjs": "latest || *",
-    "@sentry/serverless": "latest || *",
+    "@sentry/aws-serverless": "latest || *",
     "@sentry/google-cloud": "latest || *",
     "@sentry/bun": "latest || *",
     "@sentry/types": "latest || *",

dev-packages/e2e-tests/test-applications/node-exports-test-app/scripts/consistentExports.ts

@@ -5,9 +5,11 @@ import * as SentryNextJs from '@sentry/nextjs';
 import * as SentryNode from '@sentry/node';
 import * as SentryNodeExperimental from '@sentry/node-experimental';
 import * as SentryRemix from '@sentry/remix';
-import * as SentryServerless from '@sentry/serverless';
 import * as SentrySvelteKit from '@sentry/sveltekit';
 
+// SentryAWS is CJS only
+const SentryAWS = require('@sentry/aws-serverless');
+
 /* List of exports that are safe to ignore / we don't require in any depending package */
 const NODE_EXPERIMENTAL_EXPORTS_IGNORE = [
   'default',
@@ -77,10 +79,10 @@ const DEPENDENTS: Dependent[] = [
     exports: Object.keys(SentryRemix),
   },
   {
-    package: '@sentry/serverless',
-    compareWith: nodeExperimentalExports,
-    exports: Object.keys(SentryServerless),
-    ignoreExports: ['cron', 'hapiErrorPlugin'],
+    package: '@sentry/aws-serverless',
+    compareWith: nodeExports,
+    exports: Object.keys(SentryAWS),
+    ignoreExports: ['makeMain'],
   },
   {
     package: '@sentry/google-cloud',

dev-packages/e2e-tests/verdaccio-config/config.yaml

@@ -134,7 +134,7 @@ packages:
     unpublish: $all
     # proxy: npmjs # Don't proxy for E2E tests!
 
-  '@sentry/serverless':
+  '@sentry/aws-serverless':
     access: $all
     publish: $all
     unpublish: $all

dev-packages/rollup-utils/bundleHelpers.mjs

@@ -11,6 +11,7 @@ import {
   makeCleanupPlugin,
   makeCommonJSPlugin,
   makeIsDebugBuildPlugin,
+  makeJsonPlugin,
   makeLicensePlugin,
   makeNodeResolvePlugin,
   makeRrwebBuildPlugin,
@@ -40,6 +41,8 @@ export function makeBaseBundleConfig(options) {
   // at all, and without `transformMixedEsModules`, they're only included if they're imported, not if they're required.)
   const commonJSPlugin = makeCommonJSPlugin({ transformMixedEsModules: true });
 
+  const jsonPlugin = makeJsonPlugin();
+
   // used by `@sentry/browser`
   const standAloneBundleConfig = {
     output: {
@@ -84,12 +87,12 @@ export function makeBaseBundleConfig(options) {
     plugins: [rrwebBuildPlugin, markAsBrowserBuildPlugin],
   };
 
-  // used by `@sentry/serverless`, when creating the lambda layer
+  // used by `@sentry/aws-serverless`, when creating the lambda layer
   const nodeBundleConfig = {
     output: {
       format: 'cjs',
     },
-    plugins: [commonJSPlugin],
+    plugins: [jsonPlugin, commonJSPlugin],
     // Don't bundle any of Node's core modules
     external: builtinModules,
   };

dev-packages/rollup-utils/npmHelpers.mjs

@@ -120,11 +120,16 @@ export function makeBaseNPMConfig(options = {}) {
   });
 }
 
-export function makeNPMConfigVariants(baseConfig) {
-  const variantSpecificConfigs = [
-    { output: { format: 'cjs', dir: path.join(baseConfig.output.dir, 'cjs') } },
-    { output: { format: 'esm', dir: path.join(baseConfig.output.dir, 'esm'), plugins: [makePackageNodeEsm()] } },
-  ];
+export function makeNPMConfigVariants(baseConfig, options = {}) {
+  const { emitEsm = true } = options;
+
+  const variantSpecificConfigs = [{ output: { format: 'cjs', dir: path.join(baseConfig.output.dir, 'cjs') } }];
+
+  if (emitEsm) {
+    variantSpecificConfigs.push({
+      output: { format: 'esm', dir: path.join(baseConfig.output.dir, 'esm'), plugins: [makePackageNodeEsm()] },
+    });
+  }
 
   return variantSpecificConfigs.map(variant => deepMerge(baseConfig, variant));
 }

dev-packages/rollup-utils/plugins/npmPlugins.mjs

@@ -7,6 +7,7 @@
  * Sucrase plugin docs: https://github.com/rollup/plugins/tree/master/packages/sucrase
  */
 
+import json from '@rollup/plugin-json';
 import replace from '@rollup/plugin-replace';
 import sucrase from '@rollup/plugin-sucrase';
 import cleanup from 'rollup-plugin-cleanup';
@@ -18,11 +19,17 @@ import cleanup from 'rollup-plugin-cleanup';
  */
 export function makeSucrasePlugin(options = {}) {
   return sucrase({
+    // Required for bundling OTEL code properly
+    exclude: ['**/*.json'],
     transforms: ['typescript', 'jsx'],
     ...options,
   });
 }
 
+export function makeJsonPlugin() {
+  return json();
+}
+
 /**
  * Create a plugin which can be used to pause the build process at the given hook.
  *