Merge branch 'master' into onur/graphql-tracing-integration

Author: rhcarvalho

.craft.yml

@@ -2,16 +2,26 @@ minVersion: '0.23.1'
 changelogPolicy: simple
 preReleaseCommand: bash scripts/craft-pre-release.sh
 targets:
-  - name: npm
-  - name: github
-    includeNames: /^sentry-.*$/
+  - name: aws-lambda-layer
+    includeNames: /^sentry-node-serverless-\d+(\.\d+)*\.zip$/
+    layerName: SentryNodeServerlessSDK
+    compatibleRuntimes:
+      - name: node
+        versions:
+          - nodejs10.x
+          - nodejs12.x
+          - nodejs14.x
+    license: MIT
   - name: gcs
     includeNames: /.*\.js.*$/
     bucket: sentry-js-sdk
     paths:
       - path: /{{version}}/
         metadata:
           cacheControl: 'public, max-age=31536000'
+  - name: github
+    includeNames: /^sentry-.*$/
+  - name: npm
   - name: registry
     sdks:
       'npm:@sentry/browser':
@@ -34,13 +44,3 @@ targets:
         onlyIfPresent: /^sentry-wasm-.*\.tgz$/
       'npm:@sentry/nextjs':
         onlyIfPresent: /^sentry-nextjs-.*\.tgz$/
-  - name: aws-lambda-layer
-    includeNames: /^sentry-node-serverless-\d+(\.\d+)*\.zip$/
-    layerName: SentryNodeServerlessSDK
-    compatibleRuntimes:
-      - name: node
-        versions:
-          - nodejs10.x
-          - nodejs12.x
-          - nodejs14.x
-    license: MIT

.eslintrc.js

@@ -0,0 +1,35 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+  extends: ['@sentry-internal/sdk'],
+  ignorePatterns: [
+    'coverage/**',
+    'build/**',
+    'dist/**',
+    'esm/**',
+    'examples/**',
+    'scripts/**',
+    'test/manual/**',
+  ],
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx', '*.d.ts'],
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+    {
+      files: ['*.tsx'],
+      rules: {
+        // Turn off jsdoc on tsx files until jsdoc is fixed for tsx files
+        // See: https://github.com/getsentry/sentry-javascript/issues/3871
+        'jsdoc/require-jsdoc': 'off',
+      },
+    },
+  ],
+};

.github/workflows/build.yml

@@ -46,7 +46,7 @@ jobs:
           key: ${{ steps.compute_lockfile_hash.outputs.hash }}
       - name: Install dependencies
         if: steps.cache_dependencies.outputs.cache-hit == ''
-        run: yarn install
+        run: yarn install --ignore-engines
     outputs:
       dependency_cache_key: ${{ steps.compute_lockfile_hash.outputs.hash }}
 
@@ -102,6 +102,8 @@ jobs:
         uses: actions/checkout@v2
       - name: Set up Node
         uses: actions/setup-node@v1
+        with:
+          node-version: '12'
       - name: Check dependency cache
         uses: actions/cache@v2
         with:

.vscode/extensions.json

@@ -1,5 +1,9 @@
 {
   // See http://go.microsoft.com/fwlink/?LinkId=827846
   // for the documentation about the extensions.json format
-  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "dbaeumer.vscode-eslint",
+    "augustocdias.tasks-shell-input"
+  ],
 }

.vscode/launch.json

@@ -3,150 +3,95 @@
   // Hover to view descriptions of existing attributes.
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
-  // TODO: these are all alike save the package, so figure out how to make that variable
+  "inputs": [
+    {
+        "id": "getPackageName",
+        "type": "command",
+        "command": "shellCommand.execute",
+        "args": {
+            "command": "echo '${file}' | sed s/'.*sentry-javascript\\/packages\\/'// | grep --extended-regexp --only-matching --max-count 1 '[^\\/]+' | head -1",
+            "cwd": "${workspaceFolder}" ,
+            // normally `input` commands bring up a selector for the user, but given that there should only be one
+            // choice here, this lets us skip the prompt
+            "useSingleResult": true
+        }
+    }
+  ],
   "configurations": [
-
-    // @sentry/core - run a specific test file in watch mode
-    // must have file in currently active tab when hitting the play button
+    // Run a specific test file in watch mode (must have file in currently active tab when hitting the play button).
+    // NOTE: If you try to run this and VSCode complains that the command `shellCommand.execute` can't be found, go
+    // install the recommended extension Tasks Shell Input.
     {
+      "name": "Debug unit tests - just open file",
       "type": "node",
+      "cwd": "${workspaceFolder}/packages/${input:getPackageName}",
       "request": "launch",
-      "cwd": "${workspaceFolder}/packages/core",
-      "name": "Debug @sentry/core tests - just open file",
       "program": "${workspaceFolder}/node_modules/.bin/jest",
       "args": [
         "--watch",
+        // this makes the output less noisy (and at some point in the past seemed necessary to fix... something)
         "--runInBand",
+        // TODO: when we unify jest config, we may need to change this
         "--config",
-        "${workspaceFolder}/packages/core/package.json",
+        "${workspaceFolder}/packages/${input:getPackageName}/package.json",
+        // coverage messes up the source maps
         "--coverage",
-        "false", // coverage messes up the source maps
-        "${relativeFile}" // remove this to run all package tests
+        "false",
+        // remove this to run all package tests
+        "${relativeFile}"
       ],
-      "disableOptimisticBPs": true,
       "sourceMaps": true,
       "smartStep": true,
-      "console": "integratedTerminal", // otherwise it goes to the VSCode debug terminal, which prints the test output or console logs (depending on "outputCapture" option here), but not both
-      "internalConsoleOptions": "neverOpen", // since we're not using it, don't automatically switch to it
+       // otherwise it goes to the VSCode debug terminal, which prints the test output or console logs (depending on
+       // "outputCapture" option here; default is to show console logs), but not both
+      "console": "integratedTerminal",
+      // since we're not using it, don't automatically switch to it
+      "internalConsoleOptions": "neverOpen",
     },
 
-    // @sentry/nextjs - run a specific test file in watch mode
-    // must have file in currently active tab when hitting the play button
-    {
-      "type": "node",
-      "request": "launch",
-      "cwd": "${workspaceFolder}/packages/nextjs",
-      "name": "Debug @sentry/nextjs tests - just open file",
-      "program": "${workspaceFolder}/node_modules/.bin/jest",
-      "args": [
-        "--watch",
-        "--runInBand",
-        "--config",
-        "${workspaceFolder}/packages/nextjs/package.json",
-        "--coverage",
-        "false", // coverage messes up the source maps
-        "${relativeFile}" // remove this to run all package tests
-      ],
-      "disableOptimisticBPs": true,
-      "sourceMaps": true,
-      "smartStep": true,
-      "console": "integratedTerminal", // otherwise it goes to the VSCode debug terminal, which prints the test output or console logs (depending on "outputCapture" option here), but not both
-      "internalConsoleOptions": "neverOpen", // since we're not using it, don't automatically switch to it
-    },
 
-    // @sentry/nextjs - run a specific integration test file
-    // must have file in currently active tab when hitting the play button
+    // @sentry/nextjs - Run a specific integration test file
+    // Must have test file in currently active tab when hitting the play button, and must already have run `yarn` in test app directory
     {
+      "name": "Debug @sentry/nextjs integration tests - just open file",
       "type": "node",
-      "request": "launch",
       "cwd": "${workspaceFolder}/packages/nextjs",
-      "name": "Debug @sentry/nextjs integration tests - just open file",
-      // TODO create a build task
-      // "preLaunchTask": "yarn build",
+      "request": "launch",
+      // since we're not using the normal test runner, we need to make sure we're using the current version of all local
+      // SDK packages and then manually rebuild the test app
+      "preLaunchTask": "Prepare nextjs integration test app for debugging",
+      // running `server.js` directly (rather than running the tests through yarn) allows us to skip having to reinstall
+      // dependencies on every new test run
       "program": "${workspaceFolder}/packages/nextjs/test/integration/test/server.js",
       "args": [
         "--debug",
         // remove these two lines to run all integration tests
         "--filter",
         "${fileBasename}"
       ],
-      "disableOptimisticBPs": true,
-      "sourceMaps": true,
-      "skipFiles": [
-        "<node_internals>/**", "**/tslib/**"
-      ],
-    },
 
-    // @sentry/node - run a specific test file in watch mode
-    // must have file in currently active tab when hitting the play button
-    {
-      "type": "node",
-      "request": "launch",
-      "cwd": "${workspaceFolder}/packages/node",
-      "name": "Debug @sentry/node tests - just open file",
-      "program": "${workspaceFolder}/node_modules/.bin/jest",
-      "args": [
-        "--watch",
-        "--runInBand",
-        "--config",
-        "${workspaceFolder}/packages/node/package.json",
-        "--coverage",
-        "false", // coverage messes up the source maps
-        "${relativeFile}" // remove this to run all package tests
+      "skipFiles": [
+        "<node_internals>/**",
+        // this prevents us from landing in a neverending cycle of TS async-polyfill functions as we're stepping through
+        // our code
+        "${workspaceFolder}/node_modules/tslib/**/*"
       ],
-      "disableOptimisticBPs": true,
       "sourceMaps": true,
-      "smartStep": true,
-      "console": "integratedTerminal", // otherwise it goes to the VSCode debug terminal, which prints the test output or console logs (depending on "outputCapture" option here), but not both
-      "internalConsoleOptions": "neverOpen", // since we're not using it, don't automatically switch to it
-    },
-
-    // @sentry/tracing - run a specific test file in watch mode
-    // must have file in currently active tab when hitting the play button
-    {
-      "type": "node",
-      "request": "launch",
-      "cwd": "${workspaceFolder}/packages/tracing",
-      "name": "Debug @sentry/tracing tests - just open file",
-      "program": "${workspaceFolder}/node_modules/.bin/jest",
-      "args": [
-        "--watch",
-        "--runInBand",
-        "--config",
-        "${workspaceFolder}/packages/tracing/package.json",
-        "--coverage",
-        "false", // coverage messes up the source maps
-        "${relativeFile}" // remove this to run all package tests
+      // this controls which files are sourcemapped
+      "outFiles": [
+        // our SDK code
+        "${workspaceFolder}/**/dist/**/*.js",
+        // the built test app
+        "${workspaceFolder}/packages/nextjs/test/integration/.next/**/*.js",
+        "!**/node_modules/**"
       ],
-      "disableOptimisticBPs": true,
-      "sourceMaps": true,
-      "smartStep": true,
-      "console": "integratedTerminal", // otherwise it goes to the VSCode debug terminal, which prints the test output or console logs (depending on "outputCapture" option here), but not both
-      "internalConsoleOptions": "neverOpen", // since we're not using it, don't automatically switch to it
-    },
-
-    // @sentry/utils - run a specific test file in watch mode
-    // must have file in currently active tab when hitting the play button
-    {
-      "type": "node",
-      "request": "launch",
-      "cwd": "${workspaceFolder}/packages/utils",
-      "name": "Debug @sentry/utils tests - just open file",
-      "program": "${workspaceFolder}/node_modules/.bin/jest",
-      "args": [
-        "--watch",
-        "--runInBand",
-        "--config",
-        "${workspaceFolder}/packages/utils/package.json",
-        "--coverage",
-        "false", // coverage messes up the source maps
-        "${relativeFile}" // remove this to run all package tests
+      "resolveSourceMapLocations": [
+        "${workspaceFolder}/**/dist/**",
+        "${workspaceFolder}/packages/nextjs/test/integration/.next/**",
+        "!**/node_modules/**"
       ],
-      "disableOptimisticBPs": true,
-      "sourceMaps": true,
-      "smartStep": true,
-      "console": "integratedTerminal", // otherwise it goes to the VSCode debug terminal, which prints the test output or console logs (depending on "outputCapture" option here), but not both
-      "internalConsoleOptions": "neverOpen", // since we're not using it, don't automatically switch to it
+      "internalConsoleOptions": "openOnSessionStart"
+
     },
   ]
 }

.vscode/tasks.json

@@ -0,0 +1,13 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558 for documentation about `tasks.json` syntax
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"label": "Prepare nextjs integration test app for VSCode debugger",
+			"type": "npm",
+			"script": "predebug",
+			"path": "packages/nextjs/test/integration/",
+			"detail": "Link the SDK (if not already linked) and build test app"
+		}
+	]
+}