feat: Fix sentry source maps #2186

KaylaBrady · 2023-08-15T17:56:50Z

ticket: https://app.asana.com/0/1152340551558956/1205212771706510/f

This is largely based on Glides' setup of releases https://github.com/mbta/glides/pull/936. There are some differences in this approach in order to limit the scope of this PR based on Skate's existing setup, but I'll call those out with specific comments.

Note: It seems that Sentry may be moving towards "Artifact Bundles" using debug IDs (see What are Artifact Bundles, debug ID as mandatory and releases as optional in Uploading Source Maps). I attempted to take that approach in kb-sentry-stack-fix but was not able to get it to work: debug_meta was not present on the error event JSON when it is expected based on the troubleshooting docs across a few variations of attempts. In favor of fixing the problem at hand, I've opted to stop pursuing the debug ID approach in favor of the working releases approach, but we may want to revisit that approach down the line!

following basic structure of Glides' approach in mbta/glides#936

This will prevent duplication of the new sentry logic across each deploy action. Based on Glides' deploy actions https://github.com/mbta/glides/tree/main/.github/workflows

github-actions · 2023-08-15T18:05:06Z

Coverage of commit `764c9ec`

Summary coverage rate:
  lines......: 94.8% (2938 of 3100 lines)
  functions..: 74.5% (1221 of 1639 functions)
  branches...: no data found

Files changed coverage rate: n/a

Download coverage report

github-actions · 2023-08-15T18:08:34Z

Coverage of commit `764c9ec`

Summary coverage rate:
  lines......: 94.8% (2938 of 3100 lines)
  functions..: 74.5% (1221 of 1639 functions)
  branches...: no data found

Files changed coverage rate: n/a

Download coverage report

KaylaBrady · 2023-08-15T19:59:03Z

.github/workflows/deploy-dev-blue.yml

+    concurrency:
+      group: dev-blue
+      cancel-in-progress: true
+    if: ${{ github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'deploy-to-dev-blue') }}


In copying Glides' approach to splitting deploy actions, this also adds support for deploying a PR with the deploy-to-[env] label. That is not directly related to the task at hand though and can be removed if desired. I did find it helpful for the purposes of testing this PR!

I like this refactor, thank you!

Another thing I like about this: using labels for dev envs might mean we don't need to ask if a dev env is open, because we could filter PR's by labels, and any open PR's with these label's would be "occupying" the environment.

Like this! https://github.com/mbta/skate/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc+label%3Adeploy-to-dev-green%2Cdeploy-to-dev-blue

KaylaBrady · 2023-08-15T20:00:39Z

.github/workflows/deploy-base.yml

+      - uses: mbta/actions/build-push-ecr@v1
+        id: build-push
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          docker-repo: ${{ secrets.DOCKER_REPO }}
+          docker-additional-args: --build-arg SENTRY_RELEASE=${{steps.version-ids.outputs.sentry-release}}


Glides also adds the source maps as part of using this release action. I opted to continue uploading the source maps as part of the upload_assets step for simplicity of using the exiting Skate source map upload script.

KaylaBrady · 2023-08-15T20:02:43Z

upload_assets.sh

-SENTRY_RELEASE=$(npx @sentry/[email protected] releases propose-version)
-npx @sentry/[email protected] releases files "$SENTRY_RELEASE" upload-sourcemaps "$STATIC_DIR/js"
+SENTRY_RELEASE=${2-$(npx @sentry/[email protected] releases propose-version)}
+npx @sentry/[email protected] releases files "$SENTRY_RELEASE" upload-sourcemaps "$STATIC_DIR/js" --url-prefix "~/${APP}/js"


The --url-prefix was needed here because the abs_path of the error points to the hosted static files, so the path of the uploaded sourcemaps needs to match the path of those hosted static files.

KaylaBrady · 2023-08-15T20:03:59Z

.github/workflows/deploy-base.yml

+      - name: Get version ids
+        id: version-ids
+        run: |
+          echo "sentry-release=${{github.ref}}_${{github.sha}}" | tr / - >> "$GITHUB_OUTPUT"


Glides uses the tag as the sentry version when deploying from prod. Since we typically don't do prod deploys from tags, opting to use the ref + sha for all deploys.

KaylaBrady · 2023-08-15T20:05:11Z

.github/workflows/deploy-base.yml

+        with:
+          environment: ${{ inputs.env }}
+          version: ${{steps.version-ids.outputs.sentry-release}}
+          set_commits: "skip"


If we enable the sentry => github integration for Skate, then set_commits can be set to "auto". This can be done if desired as part of this PR, opted to "skip" for simplicity for now!

github-actions · 2023-08-15T20:18:33Z

Coverage of commit `2e51387`

Summary coverage rate:
  lines......: 94.8% (2938 of 3100 lines)
  functions..: 74.5% (1221 of 1639 functions)
  branches...: no data found

Files changed coverage rate: n/a

Download coverage report

Not sure if there will be unintended consequences of this change, and it is out of scope for solving the immediate issue at hand

github-actions · 2023-08-15T20:33:32Z

Coverage of commit `b79a567`

Summary coverage rate:
  lines......: 94.8% (2938 of 3100 lines)
  functions..: 74.5% (1221 of 1639 functions)
  branches...: no data found

Files changed coverage rate: n/a

Download coverage report

github-actions · 2023-08-15T21:06:06Z

Coverage of commit `c4b4f43`

Summary coverage rate:
  lines......: 94.8% (2938 of 3100 lines)
  functions..: 74.5% (1221 of 1639 functions)
  branches...: no data found

Files changed coverage rate: n/a

Download coverage report

This reverts commit c4b4f43.

github-actions · 2023-08-15T21:18:04Z

Coverage of commit `5de0561`

Summary coverage rate:
  lines......: 94.8% (2938 of 3100 lines)
  functions..: 74.5% (1221 of 1639 functions)
  branches...: no data found

Files changed coverage rate: n/a

Download coverage report

KaylaBrady added the deploy-to-dev-blue label Aug 15, 2023

KaylaBrady had a problem deploying to dev-blue August 15, 2023 17:57 — with GitHub Actions Error

KaylaBrady added 3 commits August 15, 2023 14:00

fix: include release in sentry config

a38a295

following basic structure of Glides' approach in mbta/glides#936

temp: trigger new test action on push

e27b613

refactor: deploy-env actions use deploy-base action

764c9ec

This will prevent duplication of the new sentry logic across each deploy action. Based on Glides' deploy actions https://github.com/mbta/glides/tree/main/.github/workflows

KaylaBrady force-pushed the kb-sentry-include-release branch from 0376392 to 764c9ec Compare August 15, 2023 18:00

KaylaBrady temporarily deployed to dev-blue August 15, 2023 18:00 — with GitHub Actions Inactive

KaylaBrady commented Aug 15, 2023

View reviewed changes

refactor: all deploy actions using deploy-base

2e51387

KaylaBrady temporarily deployed to dev-blue August 15, 2023 20:10 — with GitHub Actions Inactive

KaylaBrady changed the title ~~feat: Tag sentry events with release~~ feat: Fix sentry source maps Aug 15, 2023

fix: remove cancel-in-progress

b79a567

Not sure if there will be unintended consequences of this change, and it is out of scope for solving the immediate issue at hand

KaylaBrady temporarily deployed to dev-blue August 15, 2023 20:26 — with GitHub Actions Inactive

temp: Raise test exception

c4b4f43

KaylaBrady temporarily deployed to dev-blue August 15, 2023 20:58 — with GitHub Actions Inactive

Revert "temp: Raise test exception"

5de0561

This reverts commit c4b4f43.

KaylaBrady had a problem deploying to dev-blue August 15, 2023 21:10 — with GitHub Actions Error

KaylaBrady marked this pull request as ready for review August 15, 2023 21:11

KaylaBrady requested a review from a team August 15, 2023 21:11

firestack approved these changes Aug 16, 2023

View reviewed changes

KaylaBrady removed the deploy-to-dev-blue label Aug 16, 2023

KaylaBrady merged commit ccb185b into master Aug 16, 2023
7 of 8 checks passed

firestack deleted the kb-sentry-include-release branch March 4, 2024 19:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Fix sentry source maps #2186

feat: Fix sentry source maps #2186

KaylaBrady commented Aug 15, 2023 •

edited

Loading

github-actions bot commented Aug 15, 2023

github-actions bot commented Aug 15, 2023

KaylaBrady Aug 15, 2023 •

edited

Loading

firestack Aug 16, 2023

firestack Aug 16, 2023

KaylaBrady Aug 15, 2023 •

edited

Loading

KaylaBrady Aug 15, 2023

KaylaBrady Aug 15, 2023 •

edited

Loading

KaylaBrady Aug 15, 2023

github-actions bot commented Aug 15, 2023

github-actions bot commented Aug 15, 2023

github-actions bot commented Aug 15, 2023

github-actions bot commented Aug 15, 2023

feat: Fix sentry source maps #2186

feat: Fix sentry source maps #2186

Conversation

KaylaBrady commented Aug 15, 2023 • edited Loading

github-actions bot commented Aug 15, 2023

Coverage of commit 764c9ec

github-actions bot commented Aug 15, 2023

Coverage of commit 764c9ec

KaylaBrady Aug 15, 2023 • edited Loading

Choose a reason for hiding this comment

firestack Aug 16, 2023

Choose a reason for hiding this comment

firestack Aug 16, 2023

Choose a reason for hiding this comment

KaylaBrady Aug 15, 2023 • edited Loading

Choose a reason for hiding this comment

KaylaBrady Aug 15, 2023

Choose a reason for hiding this comment

KaylaBrady Aug 15, 2023 • edited Loading

Choose a reason for hiding this comment

KaylaBrady Aug 15, 2023

Choose a reason for hiding this comment

github-actions bot commented Aug 15, 2023

Coverage of commit 2e51387

github-actions bot commented Aug 15, 2023

Coverage of commit b79a567

github-actions bot commented Aug 15, 2023

Coverage of commit c4b4f43

github-actions bot commented Aug 15, 2023

Coverage of commit 5de0561

KaylaBrady commented Aug 15, 2023 •

edited

Loading

Coverage of commit `764c9ec`

Coverage of commit `764c9ec`

KaylaBrady Aug 15, 2023 •

edited

Loading

KaylaBrady Aug 15, 2023 •

edited

Loading

KaylaBrady Aug 15, 2023 •

edited

Loading

Coverage of commit `2e51387`

Coverage of commit `b79a567`

Coverage of commit `c4b4f43`

Coverage of commit `5de0561`