Retrieve Replay URL via API

[kpujjigit]

Problem Statement

Relevant Issues:

• Recommended way to capture a replayId sentry-javascript#7794
• feat(replay): Add getReplayId() method sentry-javascript#7822 (comment)

Currently we can fetch the ReplayID; the request here is to return a full-built URL to take you to the Org/Replay.

Solution Brainstorm

Per Fullstory's workaround a few years ago (getsentry/sentry-javascript#7794), the URL structure seems straightforward, might just need the org slug and replayID to build and return it as part of the response schema. I'm aware it might be easier said than done though.

Product Area

Replay

[getsantry]

Assigning to @getsentry/support for routing ⏲️

[ryan953]

@kpujjigit I think this is going to actually be full of trouble.

The current url is basically https://<org-slug>.sentry.io/explore/replays/<replay-id>/
The trouble spots are:

• The SDK doesn't know the org slug, only the DSN. To overcome this the method could accept an org-slug param, and be like getReplayUrl("my-org") but that leads into another problem...
• We don't know for sure if the user is on SaaS or maybe self-hosted. In the self-hosted case the url is basically <my-domain><optional-prefix>/explore/replays/<replay-id>/ and then we're not really adding much value with a method.
  • The path part at the end, /explore/replays/<replay-id>/ also just recently changed (because of the new navbar design) from /replays/<replay-id>/ so even if we hard-coded that kind of thing into the SDK, it would be stale. We do have to keep support for the old urls on the server basically forever so it wouldn't break... but it's not great to bake it into the SDK imo.

If there are more details to this ask lmk, but on the surface it seems like calling getReplayId() and the plugging it into the url is the easiest. Here's a snippet that should do everything:

const orgSlug = 'my-org-slug';

const replayIntegration = Sentry.getClient()?.getIntegrationByName<Sentry.ReplayIntegration>('Replay');
if (!replayIntegration) {
  // Replay isn't setup yet. 
  // Call `Sentry.getClient()?.addIntegration(Sentry.replayIntegration())` first.
  return;
}

const replayId = replayIntegration?.getReplayId();
if (!replayId) {
  // There is no replay being recorded right now.
  // Call `replayIntegration.start()` first.
  return;
}
const url = `https://${orgSlug}.sentry.io/explore/replays/${replayId}/`
return url;