feat(toolbar): add a replay panel for start/stop current replay - #75403

Merged
aliu39 merged 31 commits into
masterfrom
aliu/start-replay
Aug 8, 2024
Merged

feat(toolbar): add a replay panel for start/stop current replay#75403
aliu39 merged 31 commits into
masterfrom
aliu/start-replay

Conversation

@aliu39

@aliu39aliu39 commented Jul 31, 2024

Copy link
Copy Markdown
Member

Closes#74583
Closes#74452

getReplay returns undefined:
Screenshot 2024-08-08 at 10 28 18 AM

SentrySDK doesn't have getReplay method:
Screenshot 2024-08-08 at 10 22 25 AM

SentrySDK is falsey (failed to import the package):
Screenshot 2024-08-08 at 10 22 02 AM

If you want to checkout this branch to test it, you need to run dev-ui in getsentry and make local changes:

Notes:

  • "last recorded replay" is persisted with sessionStorage
  • stopping then starting will make a new replay
  • uses some try-catch logic to handle older SDK versions where the recording fxs throw.

Follow-ups before merging

  • Analytics context provider and start/stop button analytics (todo in this PR)
  • comment on SDK versioning
    • exact release of getReplay/public API is unknown, but it was ~2yr ago near the release of the whole product
  • test with v8.18
  • remove the debug flag
  • make the links work for dev mode (can hard-code the sentry-test/app-frontend org/proj)

Follow-ups after merging

  • test the links work in prod
  • account for minimum replay duration (so users don't stop too early)
  • add more content to the panel! Open to ideas. Can do this in a separate PR
  • keep dogfooding for bugs, w/different sample rates, sdk versions

@github-actionsgithub-actionsBot added the Scope: Frontend Automatically applied to PRs that change frontend components label Jul 31, 2024
@codecov

codecovBot commented Jul 31, 2024

Copy link
Copy Markdown

Bundle Report

Changes will increase total bundle size by 7.23kB ⬆️

Bundle nameSizeChange
app-webpack-bundle-array-push28.65MB7.23kB ⬆️

@aliu39aliu39 changed the title Aliu/start replayfeat(toolbar): add a replay panel for start/stop current replayAug 1, 2024
Comment threadpackage.json Outdated
Comment threadstatic/app/bootstrap/initializeSdk.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/panelRouter.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadyarn.lock Outdated
@aliu39

This comment was marked as resolved.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
@codecov

codecovBot commented Aug 3, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 0% with 57 lines in your changes missing coverage. Please review.

Project coverage is 78.22%. Comparing base (14c8790) to head (1fc533d).
Report is 23 commits behind head on master.

FilesPatch %Lines
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00%45 Missing ⚠️
...nents/devtoolbar/components/replay/replayPanel.tsx0.00%10 Missing ⚠️
...p/components/devtoolbar/components/panelRouter.tsx0.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## master #75403 +/- ##
==========================================
- Coverage 80.06% 78.22% -1.84% 
==========================================
Files 6996 6830 -166 Lines 312723 303280 -9443 Branches 52171 52182 +11 ==========================================
- Hits 250370 237244 -13126 + Misses 61911 59661 -2250 - Partials 442 6375 +5933 
FilesCoverage Δ
static/app/bootstrap/initializeSdk.tsx35.45% <ø> (ø)
...pp/components/devtoolbar/components/navigation.tsx0.00% <ø> (ø)
...pp/components/devtoolbar/hooks/useToolbarRoute.tsx0.00% <ø> (ø)
...p/components/devtoolbar/components/panelRouter.tsx0.00% <0.00%> (ø)
...nents/devtoolbar/components/replay/replayPanel.tsx0.00% <0.00%> (ø)
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00% <0.00%> (ø)

... and 1787 files with indirect coverage changes

@aliu39

This comment was marked as outdated.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadpackage.json Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
export default function useReplayRecorder(): ReplayRecorderState {
const {SentrySDK} = useConfiguration();
const replay =
SentrySDK && 'getReplay' in SentrySDK ? SentrySDK.getReplay() : undefined;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use SentrySDK.getIntegrationByName(), it's just a bit more annoying dealing with types

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm my VSCode can't find this method in browser or react packages..

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm it might be on the SDK client instead of the Sentry namespace... e.g. SentrySDK.getClient().getIntegrationByName

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, does this have any improvements over the current approach? Right now I'm using these conditions to get the disabledReason (see screenshots I just added in the description)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah just as a fallback if the SDK is too old to support getReplay as it was a relatively recent addition, but it's fine not to support older

Comment threadstatic/app/utils/useDevToolbar.tsx Outdated
Comment on lines +28 to +33
organizationSlug:
process.env.NODE_ENV !== 'development' ? 'sentry' : 'sentry-test',
projectId: process.env.NODE_ENV !== 'development' ? 11276 : 5270453,
projectPlatform: 'javascript',
projectSlug: 'javascript',
projectSlug:
process.env.NODE_ENV !== 'development' ? 'javascript' : 'app-frontend',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is PoC we are hard coding the org/project slugs, this allows the links to work in dev mode (assuming the replay integration is enabled)

@ryan953ryan953Aug 8, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you test by running the app with yarn dev-ui. my workflow depends on that command

@aliu39aliu39Aug 8, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works, but you need to comment out this condition in getsentry's useReplayInit: https://github.com/getsentry/getsentry/blob/2a1da081f3a9e4e4111b577d5551fa24691da374/static/getsentry/gsApp/utils/useReplayInit.tsx#L85-L87

I think it's disabled so we don't record everyone's dev-ui sessions. Maybe we could uncomment but set both sample rates to 0?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make a ticket and add it to the dev toolbar project

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably hold off on a ticket to change useReplayInit. The toolbar should support whatever env it finds itself inside of. So if sometimes there's no replayIntegration at all, that should be ok. We'll be able to test that case in dev, and on prod there will be a replayIntegration so we can test that case as well!

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't thinking about the other panels, this change would break them for dev. I'm done testing, let's just leave this panel disabled in dev.

disabled={isDisabled || buttonLoading}
onClick={async () => {
setButtonLoading(true);
isRecordingSession ? await stopRecording() : await startRecordingSession();

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not allowing users to stop buffering.


const startRecordingSession = useCallback(async () => {
let success = false;
if (replay) {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't want to try-catch here because we can already condition to make sure we're in a safe state.

@aliu39
aliu39 merged commit a055c3b into masterAug 8, 2024
@aliu39
aliu39 deleted the aliu/start-replay branch August 8, 2024 21:34
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 24, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Scope: FrontendAutomatically applied to PRs that change frontend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DevToolbar] When a replay is running, link to the Replay Details page for that replay [DevToolbar] Add 'start replay' buttons to the toolbar

4 participants

@aliu39@billyvg@ryan953@michellewzhang
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(toolbar): add a replay panel for start/stop current replay - #75403

Merged
aliu39 merged 31 commits into
masterfrom
aliu/start-replay
Aug 8, 2024
Merged

feat(toolbar): add a replay panel for start/stop current replay#75403
aliu39 merged 31 commits into
masterfrom
aliu/start-replay

Conversation

@aliu39

@aliu39aliu39 commented Jul 31, 2024

Copy link
Copy Markdown
Member

Closes#74583
Closes#74452

getReplay returns undefined:
Screenshot 2024-08-08 at 10 28 18 AM

SentrySDK doesn't have getReplay method:
Screenshot 2024-08-08 at 10 22 25 AM

SentrySDK is falsey (failed to import the package):
Screenshot 2024-08-08 at 10 22 02 AM

If you want to checkout this branch to test it, you need to run dev-ui in getsentry and make local changes:

Notes:

  • "last recorded replay" is persisted with sessionStorage
  • stopping then starting will make a new replay
  • uses some try-catch logic to handle older SDK versions where the recording fxs throw.

Follow-ups before merging

  • Analytics context provider and start/stop button analytics (todo in this PR)
  • comment on SDK versioning
    • exact release of getReplay/public API is unknown, but it was ~2yr ago near the release of the whole product
  • test with v8.18
  • remove the debug flag
  • make the links work for dev mode (can hard-code the sentry-test/app-frontend org/proj)

Follow-ups after merging

  • test the links work in prod
  • account for minimum replay duration (so users don't stop too early)
  • add more content to the panel! Open to ideas. Can do this in a separate PR
  • keep dogfooding for bugs, w/different sample rates, sdk versions

@github-actionsgithub-actionsBot added the Scope: Frontend Automatically applied to PRs that change frontend components label Jul 31, 2024
@codecov

codecovBot commented Jul 31, 2024

Copy link
Copy Markdown

Bundle Report

Changes will increase total bundle size by 7.23kB ⬆️

Bundle nameSizeChange
app-webpack-bundle-array-push28.65MB7.23kB ⬆️

@aliu39aliu39 changed the title Aliu/start replayfeat(toolbar): add a replay panel for start/stop current replayAug 1, 2024
Comment threadpackage.json Outdated
Comment threadstatic/app/bootstrap/initializeSdk.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/panelRouter.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadyarn.lock Outdated
@aliu39

This comment was marked as resolved.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
@codecov

codecovBot commented Aug 3, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 0% with 57 lines in your changes missing coverage. Please review.

Project coverage is 78.22%. Comparing base (14c8790) to head (1fc533d).
Report is 23 commits behind head on master.

FilesPatch %Lines
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00%45 Missing ⚠️
...nents/devtoolbar/components/replay/replayPanel.tsx0.00%10 Missing ⚠️
...p/components/devtoolbar/components/panelRouter.tsx0.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## master #75403 +/- ##
==========================================
- Coverage 80.06% 78.22% -1.84% 
==========================================
Files 6996 6830 -166 Lines 312723 303280 -9443 Branches 52171 52182 +11 ==========================================
- Hits 250370 237244 -13126 + Misses 61911 59661 -2250 - Partials 442 6375 +5933 
FilesCoverage Δ
static/app/bootstrap/initializeSdk.tsx35.45% <ø> (ø)
...pp/components/devtoolbar/components/navigation.tsx0.00% <ø> (ø)
...pp/components/devtoolbar/hooks/useToolbarRoute.tsx0.00% <ø> (ø)
...p/components/devtoolbar/components/panelRouter.tsx0.00% <0.00%> (ø)
...nents/devtoolbar/components/replay/replayPanel.tsx0.00% <0.00%> (ø)
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00% <0.00%> (ø)

... and 1787 files with indirect coverage changes

@aliu39

This comment was marked as outdated.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadpackage.json Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
export default function useReplayRecorder(): ReplayRecorderState {
const {SentrySDK} = useConfiguration();
const replay =
SentrySDK && 'getReplay' in SentrySDK ? SentrySDK.getReplay() : undefined;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use SentrySDK.getIntegrationByName(), it's just a bit more annoying dealing with types

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm my VSCode can't find this method in browser or react packages..

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm it might be on the SDK client instead of the Sentry namespace... e.g. SentrySDK.getClient().getIntegrationByName

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, does this have any improvements over the current approach? Right now I'm using these conditions to get the disabledReason (see screenshots I just added in the description)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah just as a fallback if the SDK is too old to support getReplay as it was a relatively recent addition, but it's fine not to support older

Comment threadstatic/app/utils/useDevToolbar.tsx Outdated
Comment on lines +28 to +33
organizationSlug:
process.env.NODE_ENV !== 'development' ? 'sentry' : 'sentry-test',
projectId: process.env.NODE_ENV !== 'development' ? 11276 : 5270453,
projectPlatform: 'javascript',
projectSlug: 'javascript',
projectSlug:
process.env.NODE_ENV !== 'development' ? 'javascript' : 'app-frontend',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is PoC we are hard coding the org/project slugs, this allows the links to work in dev mode (assuming the replay integration is enabled)

@ryan953ryan953Aug 8, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you test by running the app with yarn dev-ui. my workflow depends on that command

@aliu39aliu39Aug 8, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works, but you need to comment out this condition in getsentry's useReplayInit: https://github.com/getsentry/getsentry/blob/2a1da081f3a9e4e4111b577d5551fa24691da374/static/getsentry/gsApp/utils/useReplayInit.tsx#L85-L87

I think it's disabled so we don't record everyone's dev-ui sessions. Maybe we could uncomment but set both sample rates to 0?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make a ticket and add it to the dev toolbar project

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably hold off on a ticket to change useReplayInit. The toolbar should support whatever env it finds itself inside of. So if sometimes there's no replayIntegration at all, that should be ok. We'll be able to test that case in dev, and on prod there will be a replayIntegration so we can test that case as well!

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't thinking about the other panels, this change would break them for dev. I'm done testing, let's just leave this panel disabled in dev.

disabled={isDisabled || buttonLoading}
onClick={async () => {
setButtonLoading(true);
isRecordingSession ? await stopRecording() : await startRecordingSession();

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not allowing users to stop buffering.


const startRecordingSession = useCallback(async () => {
let success = false;
if (replay) {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't want to try-catch here because we can already condition to make sure we're in a safe state.

@aliu39
aliu39 merged commit a055c3b into masterAug 8, 2024
@aliu39
aliu39 deleted the aliu/start-replay branch August 8, 2024 21:34
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 24, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Scope: FrontendAutomatically applied to PRs that change frontend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DevToolbar] When a replay is running, link to the Replay Details page for that replay [DevToolbar] Add 'start replay' buttons to the toolbar

4 participants

@aliu39@billyvg@ryan953@michellewzhang
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(toolbar): add a replay panel for start/stop current replay - #75403

Merged
aliu39 merged 31 commits into
masterfrom
aliu/start-replay
Aug 8, 2024
Merged

feat(toolbar): add a replay panel for start/stop current replay#75403
aliu39 merged 31 commits into
masterfrom
aliu/start-replay

Conversation

@aliu39

@aliu39aliu39 commented Jul 31, 2024

Copy link
Copy Markdown
Member

Closes#74583
Closes#74452

getReplay returns undefined:
Screenshot 2024-08-08 at 10 28 18 AM

SentrySDK doesn't have getReplay method:
Screenshot 2024-08-08 at 10 22 25 AM

SentrySDK is falsey (failed to import the package):
Screenshot 2024-08-08 at 10 22 02 AM

If you want to checkout this branch to test it, you need to run dev-ui in getsentry and make local changes:

Notes:

  • "last recorded replay" is persisted with sessionStorage
  • stopping then starting will make a new replay
  • uses some try-catch logic to handle older SDK versions where the recording fxs throw.

Follow-ups before merging

  • Analytics context provider and start/stop button analytics (todo in this PR)
  • comment on SDK versioning
    • exact release of getReplay/public API is unknown, but it was ~2yr ago near the release of the whole product
  • test with v8.18
  • remove the debug flag
  • make the links work for dev mode (can hard-code the sentry-test/app-frontend org/proj)

Follow-ups after merging

  • test the links work in prod
  • account for minimum replay duration (so users don't stop too early)
  • add more content to the panel! Open to ideas. Can do this in a separate PR
  • keep dogfooding for bugs, w/different sample rates, sdk versions

@github-actionsgithub-actionsBot added the Scope: Frontend Automatically applied to PRs that change frontend components label Jul 31, 2024
@codecov

codecovBot commented Jul 31, 2024

Copy link
Copy Markdown

Bundle Report

Changes will increase total bundle size by 7.23kB ⬆️

Bundle nameSizeChange
app-webpack-bundle-array-push28.65MB7.23kB ⬆️

@aliu39aliu39 changed the title Aliu/start replayfeat(toolbar): add a replay panel for start/stop current replayAug 1, 2024
Comment threadpackage.json Outdated
Comment threadstatic/app/bootstrap/initializeSdk.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/panelRouter.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadyarn.lock Outdated
@aliu39

This comment was marked as resolved.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
@codecov

codecovBot commented Aug 3, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 0% with 57 lines in your changes missing coverage. Please review.

Project coverage is 78.22%. Comparing base (14c8790) to head (1fc533d).
Report is 23 commits behind head on master.

FilesPatch %Lines
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00%45 Missing ⚠️
...nents/devtoolbar/components/replay/replayPanel.tsx0.00%10 Missing ⚠️
...p/components/devtoolbar/components/panelRouter.tsx0.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## master #75403 +/- ##
==========================================
- Coverage 80.06% 78.22% -1.84% 
==========================================
Files 6996 6830 -166 Lines 312723 303280 -9443 Branches 52171 52182 +11 ==========================================
- Hits 250370 237244 -13126 + Misses 61911 59661 -2250 - Partials 442 6375 +5933 
FilesCoverage Δ
static/app/bootstrap/initializeSdk.tsx35.45% <ø> (ø)
...pp/components/devtoolbar/components/navigation.tsx0.00% <ø> (ø)
...pp/components/devtoolbar/hooks/useToolbarRoute.tsx0.00% <ø> (ø)
...p/components/devtoolbar/components/panelRouter.tsx0.00% <0.00%> (ø)
...nents/devtoolbar/components/replay/replayPanel.tsx0.00% <0.00%> (ø)
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00% <0.00%> (ø)

... and 1787 files with indirect coverage changes

@aliu39

This comment was marked as outdated.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadpackage.json Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
export default function useReplayRecorder(): ReplayRecorderState {
const {SentrySDK} = useConfiguration();
const replay =
SentrySDK && 'getReplay' in SentrySDK ? SentrySDK.getReplay() : undefined;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use SentrySDK.getIntegrationByName(), it's just a bit more annoying dealing with types

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm my VSCode can't find this method in browser or react packages..

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm it might be on the SDK client instead of the Sentry namespace... e.g. SentrySDK.getClient().getIntegrationByName

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, does this have any improvements over the current approach? Right now I'm using these conditions to get the disabledReason (see screenshots I just added in the description)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah just as a fallback if the SDK is too old to support getReplay as it was a relatively recent addition, but it's fine not to support older

Comment threadstatic/app/utils/useDevToolbar.tsx Outdated
Comment on lines +28 to +33
organizationSlug:
process.env.NODE_ENV !== 'development' ? 'sentry' : 'sentry-test',
projectId: process.env.NODE_ENV !== 'development' ? 11276 : 5270453,
projectPlatform: 'javascript',
projectSlug: 'javascript',
projectSlug:
process.env.NODE_ENV !== 'development' ? 'javascript' : 'app-frontend',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is PoC we are hard coding the org/project slugs, this allows the links to work in dev mode (assuming the replay integration is enabled)

@ryan953ryan953Aug 8, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you test by running the app with yarn dev-ui. my workflow depends on that command

@aliu39aliu39Aug 8, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works, but you need to comment out this condition in getsentry's useReplayInit: https://github.com/getsentry/getsentry/blob/2a1da081f3a9e4e4111b577d5551fa24691da374/static/getsentry/gsApp/utils/useReplayInit.tsx#L85-L87

I think it's disabled so we don't record everyone's dev-ui sessions. Maybe we could uncomment but set both sample rates to 0?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make a ticket and add it to the dev toolbar project

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably hold off on a ticket to change useReplayInit. The toolbar should support whatever env it finds itself inside of. So if sometimes there's no replayIntegration at all, that should be ok. We'll be able to test that case in dev, and on prod there will be a replayIntegration so we can test that case as well!

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't thinking about the other panels, this change would break them for dev. I'm done testing, let's just leave this panel disabled in dev.

disabled={isDisabled || buttonLoading}
onClick={async () => {
setButtonLoading(true);
isRecordingSession ? await stopRecording() : await startRecordingSession();

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not allowing users to stop buffering.


const startRecordingSession = useCallback(async () => {
let success = false;
if (replay) {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't want to try-catch here because we can already condition to make sure we're in a safe state.

@aliu39
aliu39 merged commit a055c3b into masterAug 8, 2024
@aliu39
aliu39 deleted the aliu/start-replay branch August 8, 2024 21:34
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 24, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Scope: FrontendAutomatically applied to PRs that change frontend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DevToolbar] When a replay is running, link to the Replay Details page for that replay [DevToolbar] Add 'start replay' buttons to the toolbar

4 participants

@aliu39@billyvg@ryan953@michellewzhang
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(toolbar): add a replay panel for start/stop current replay - #75403

Merged
aliu39 merged 31 commits into
masterfrom
aliu/start-replay
Aug 8, 2024
Merged

feat(toolbar): add a replay panel for start/stop current replay#75403
aliu39 merged 31 commits into
masterfrom
aliu/start-replay

Conversation

@aliu39

@aliu39aliu39 commented Jul 31, 2024

Copy link
Copy Markdown
Member

Closes#74583
Closes#74452

getReplay returns undefined:
Screenshot 2024-08-08 at 10 28 18 AM

SentrySDK doesn't have getReplay method:
Screenshot 2024-08-08 at 10 22 25 AM

SentrySDK is falsey (failed to import the package):
Screenshot 2024-08-08 at 10 22 02 AM

If you want to checkout this branch to test it, you need to run dev-ui in getsentry and make local changes:

Notes:

  • "last recorded replay" is persisted with sessionStorage
  • stopping then starting will make a new replay
  • uses some try-catch logic to handle older SDK versions where the recording fxs throw.

Follow-ups before merging

  • Analytics context provider and start/stop button analytics (todo in this PR)
  • comment on SDK versioning
    • exact release of getReplay/public API is unknown, but it was ~2yr ago near the release of the whole product
  • test with v8.18
  • remove the debug flag
  • make the links work for dev mode (can hard-code the sentry-test/app-frontend org/proj)

Follow-ups after merging

  • test the links work in prod
  • account for minimum replay duration (so users don't stop too early)
  • add more content to the panel! Open to ideas. Can do this in a separate PR
  • keep dogfooding for bugs, w/different sample rates, sdk versions

@github-actionsgithub-actionsBot added the Scope: Frontend Automatically applied to PRs that change frontend components label Jul 31, 2024
@codecov

codecovBot commented Jul 31, 2024

Copy link
Copy Markdown

Bundle Report

Changes will increase total bundle size by 7.23kB ⬆️

Bundle nameSizeChange
app-webpack-bundle-array-push28.65MB7.23kB ⬆️

@aliu39aliu39 changed the title Aliu/start replayfeat(toolbar): add a replay panel for start/stop current replayAug 1, 2024
Comment threadpackage.json Outdated
Comment threadstatic/app/bootstrap/initializeSdk.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/panelRouter.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadyarn.lock Outdated
@aliu39

This comment was marked as resolved.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
@codecov

codecovBot commented Aug 3, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 0% with 57 lines in your changes missing coverage. Please review.

Project coverage is 78.22%. Comparing base (14c8790) to head (1fc533d).
Report is 23 commits behind head on master.

FilesPatch %Lines
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00%45 Missing ⚠️
...nents/devtoolbar/components/replay/replayPanel.tsx0.00%10 Missing ⚠️
...p/components/devtoolbar/components/panelRouter.tsx0.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## master #75403 +/- ##
==========================================
- Coverage 80.06% 78.22% -1.84% 
==========================================
Files 6996 6830 -166 Lines 312723 303280 -9443 Branches 52171 52182 +11 ==========================================
- Hits 250370 237244 -13126 + Misses 61911 59661 -2250 - Partials 442 6375 +5933 
FilesCoverage Δ
static/app/bootstrap/initializeSdk.tsx35.45% <ø> (ø)
...pp/components/devtoolbar/components/navigation.tsx0.00% <ø> (ø)
...pp/components/devtoolbar/hooks/useToolbarRoute.tsx0.00% <ø> (ø)
...p/components/devtoolbar/components/panelRouter.tsx0.00% <0.00%> (ø)
...nents/devtoolbar/components/replay/replayPanel.tsx0.00% <0.00%> (ø)
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00% <0.00%> (ø)

... and 1787 files with indirect coverage changes

@aliu39

This comment was marked as outdated.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadpackage.json Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
export default function useReplayRecorder(): ReplayRecorderState {
const {SentrySDK} = useConfiguration();
const replay =
SentrySDK && 'getReplay' in SentrySDK ? SentrySDK.getReplay() : undefined;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use SentrySDK.getIntegrationByName(), it's just a bit more annoying dealing with types

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm my VSCode can't find this method in browser or react packages..

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm it might be on the SDK client instead of the Sentry namespace... e.g. SentrySDK.getClient().getIntegrationByName

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, does this have any improvements over the current approach? Right now I'm using these conditions to get the disabledReason (see screenshots I just added in the description)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah just as a fallback if the SDK is too old to support getReplay as it was a relatively recent addition, but it's fine not to support older

Comment threadstatic/app/utils/useDevToolbar.tsx Outdated
Comment on lines +28 to +33
organizationSlug:
process.env.NODE_ENV !== 'development' ? 'sentry' : 'sentry-test',
projectId: process.env.NODE_ENV !== 'development' ? 11276 : 5270453,
projectPlatform: 'javascript',
projectSlug: 'javascript',
projectSlug:
process.env.NODE_ENV !== 'development' ? 'javascript' : 'app-frontend',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is PoC we are hard coding the org/project slugs, this allows the links to work in dev mode (assuming the replay integration is enabled)

@ryan953ryan953Aug 8, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you test by running the app with yarn dev-ui. my workflow depends on that command

@aliu39aliu39Aug 8, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works, but you need to comment out this condition in getsentry's useReplayInit: https://github.com/getsentry/getsentry/blob/2a1da081f3a9e4e4111b577d5551fa24691da374/static/getsentry/gsApp/utils/useReplayInit.tsx#L85-L87

I think it's disabled so we don't record everyone's dev-ui sessions. Maybe we could uncomment but set both sample rates to 0?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make a ticket and add it to the dev toolbar project

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably hold off on a ticket to change useReplayInit. The toolbar should support whatever env it finds itself inside of. So if sometimes there's no replayIntegration at all, that should be ok. We'll be able to test that case in dev, and on prod there will be a replayIntegration so we can test that case as well!

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't thinking about the other panels, this change would break them for dev. I'm done testing, let's just leave this panel disabled in dev.

disabled={isDisabled || buttonLoading}
onClick={async () => {
setButtonLoading(true);
isRecordingSession ? await stopRecording() : await startRecordingSession();

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not allowing users to stop buffering.


const startRecordingSession = useCallback(async () => {
let success = false;
if (replay) {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't want to try-catch here because we can already condition to make sure we're in a safe state.

@aliu39
aliu39 merged commit a055c3b into masterAug 8, 2024
@aliu39
aliu39 deleted the aliu/start-replay branch August 8, 2024 21:34
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 24, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Scope: FrontendAutomatically applied to PRs that change frontend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DevToolbar] When a replay is running, link to the Replay Details page for that replay [DevToolbar] Add 'start replay' buttons to the toolbar

4 participants

@aliu39@billyvg@ryan953@michellewzhang
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(toolbar): add a replay panel for start/stop current replay - #75403

Merged
aliu39 merged 31 commits into
masterfrom
aliu/start-replay
Aug 8, 2024
Merged

feat(toolbar): add a replay panel for start/stop current replay#75403
aliu39 merged 31 commits into
masterfrom
aliu/start-replay

Conversation

@aliu39

@aliu39aliu39 commented Jul 31, 2024

Copy link
Copy Markdown
Member

Closes#74583
Closes#74452

getReplay returns undefined:
Screenshot 2024-08-08 at 10 28 18 AM

SentrySDK doesn't have getReplay method:
Screenshot 2024-08-08 at 10 22 25 AM

SentrySDK is falsey (failed to import the package):
Screenshot 2024-08-08 at 10 22 02 AM

If you want to checkout this branch to test it, you need to run dev-ui in getsentry and make local changes:

Notes:

  • "last recorded replay" is persisted with sessionStorage
  • stopping then starting will make a new replay
  • uses some try-catch logic to handle older SDK versions where the recording fxs throw.

Follow-ups before merging

  • Analytics context provider and start/stop button analytics (todo in this PR)
  • comment on SDK versioning
    • exact release of getReplay/public API is unknown, but it was ~2yr ago near the release of the whole product
  • test with v8.18
  • remove the debug flag
  • make the links work for dev mode (can hard-code the sentry-test/app-frontend org/proj)

Follow-ups after merging

  • test the links work in prod
  • account for minimum replay duration (so users don't stop too early)
  • add more content to the panel! Open to ideas. Can do this in a separate PR
  • keep dogfooding for bugs, w/different sample rates, sdk versions

@github-actionsgithub-actionsBot added the Scope: Frontend Automatically applied to PRs that change frontend components label Jul 31, 2024
@codecov

codecovBot commented Jul 31, 2024

Copy link
Copy Markdown

Bundle Report

Changes will increase total bundle size by 7.23kB ⬆️

Bundle nameSizeChange
app-webpack-bundle-array-push28.65MB7.23kB ⬆️

@aliu39aliu39 changed the title Aliu/start replayfeat(toolbar): add a replay panel for start/stop current replayAug 1, 2024
Comment threadpackage.json Outdated
Comment threadstatic/app/bootstrap/initializeSdk.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/panelRouter.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadyarn.lock Outdated
@aliu39

This comment was marked as resolved.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
@codecov

codecovBot commented Aug 3, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 0% with 57 lines in your changes missing coverage. Please review.

Project coverage is 78.22%. Comparing base (14c8790) to head (1fc533d).
Report is 23 commits behind head on master.

FilesPatch %Lines
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00%45 Missing ⚠️
...nents/devtoolbar/components/replay/replayPanel.tsx0.00%10 Missing ⚠️
...p/components/devtoolbar/components/panelRouter.tsx0.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## master #75403 +/- ##
==========================================
- Coverage 80.06% 78.22% -1.84% 
==========================================
Files 6996 6830 -166 Lines 312723 303280 -9443 Branches 52171 52182 +11 ==========================================
- Hits 250370 237244 -13126 + Misses 61911 59661 -2250 - Partials 442 6375 +5933 
FilesCoverage Δ
static/app/bootstrap/initializeSdk.tsx35.45% <ø> (ø)
...pp/components/devtoolbar/components/navigation.tsx0.00% <ø> (ø)
...pp/components/devtoolbar/hooks/useToolbarRoute.tsx0.00% <ø> (ø)
...p/components/devtoolbar/components/panelRouter.tsx0.00% <0.00%> (ø)
...nents/devtoolbar/components/replay/replayPanel.tsx0.00% <0.00%> (ø)
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00% <0.00%> (ø)

... and 1787 files with indirect coverage changes

@aliu39

This comment was marked as outdated.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadpackage.json Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
export default function useReplayRecorder(): ReplayRecorderState {
const {SentrySDK} = useConfiguration();
const replay =
SentrySDK && 'getReplay' in SentrySDK ? SentrySDK.getReplay() : undefined;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use SentrySDK.getIntegrationByName(), it's just a bit more annoying dealing with types

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm my VSCode can't find this method in browser or react packages..

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm it might be on the SDK client instead of the Sentry namespace... e.g. SentrySDK.getClient().getIntegrationByName

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, does this have any improvements over the current approach? Right now I'm using these conditions to get the disabledReason (see screenshots I just added in the description)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah just as a fallback if the SDK is too old to support getReplay as it was a relatively recent addition, but it's fine not to support older

Comment threadstatic/app/utils/useDevToolbar.tsx Outdated
Comment on lines +28 to +33
organizationSlug:
process.env.NODE_ENV !== 'development' ? 'sentry' : 'sentry-test',
projectId: process.env.NODE_ENV !== 'development' ? 11276 : 5270453,
projectPlatform: 'javascript',
projectSlug: 'javascript',
projectSlug:
process.env.NODE_ENV !== 'development' ? 'javascript' : 'app-frontend',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is PoC we are hard coding the org/project slugs, this allows the links to work in dev mode (assuming the replay integration is enabled)

@ryan953ryan953Aug 8, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you test by running the app with yarn dev-ui. my workflow depends on that command

@aliu39aliu39Aug 8, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works, but you need to comment out this condition in getsentry's useReplayInit: https://github.com/getsentry/getsentry/blob/2a1da081f3a9e4e4111b577d5551fa24691da374/static/getsentry/gsApp/utils/useReplayInit.tsx#L85-L87

I think it's disabled so we don't record everyone's dev-ui sessions. Maybe we could uncomment but set both sample rates to 0?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make a ticket and add it to the dev toolbar project

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably hold off on a ticket to change useReplayInit. The toolbar should support whatever env it finds itself inside of. So if sometimes there's no replayIntegration at all, that should be ok. We'll be able to test that case in dev, and on prod there will be a replayIntegration so we can test that case as well!

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't thinking about the other panels, this change would break them for dev. I'm done testing, let's just leave this panel disabled in dev.

disabled={isDisabled || buttonLoading}
onClick={async () => {
setButtonLoading(true);
isRecordingSession ? await stopRecording() : await startRecordingSession();

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not allowing users to stop buffering.


const startRecordingSession = useCallback(async () => {
let success = false;
if (replay) {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't want to try-catch here because we can already condition to make sure we're in a safe state.

@aliu39
aliu39 merged commit a055c3b into masterAug 8, 2024
@aliu39
aliu39 deleted the aliu/start-replay branch August 8, 2024 21:34
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 24, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Scope: FrontendAutomatically applied to PRs that change frontend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DevToolbar] When a replay is running, link to the Replay Details page for that replay [DevToolbar] Add 'start replay' buttons to the toolbar

4 participants

@aliu39@billyvg@ryan953@michellewzhang
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(toolbar): add a replay panel for start/stop current replay - #75403

Merged
aliu39 merged 31 commits into
masterfrom
aliu/start-replay
Aug 8, 2024
Merged

feat(toolbar): add a replay panel for start/stop current replay#75403
aliu39 merged 31 commits into
masterfrom
aliu/start-replay

Conversation

@aliu39

@aliu39aliu39 commented Jul 31, 2024

Copy link
Copy Markdown
Member

Closes#74583
Closes#74452

getReplay returns undefined:
Screenshot 2024-08-08 at 10 28 18 AM

SentrySDK doesn't have getReplay method:
Screenshot 2024-08-08 at 10 22 25 AM

SentrySDK is falsey (failed to import the package):
Screenshot 2024-08-08 at 10 22 02 AM

If you want to checkout this branch to test it, you need to run dev-ui in getsentry and make local changes:

Notes:

  • "last recorded replay" is persisted with sessionStorage
  • stopping then starting will make a new replay
  • uses some try-catch logic to handle older SDK versions where the recording fxs throw.

Follow-ups before merging

  • Analytics context provider and start/stop button analytics (todo in this PR)
  • comment on SDK versioning
    • exact release of getReplay/public API is unknown, but it was ~2yr ago near the release of the whole product
  • test with v8.18
  • remove the debug flag
  • make the links work for dev mode (can hard-code the sentry-test/app-frontend org/proj)

Follow-ups after merging

  • test the links work in prod
  • account for minimum replay duration (so users don't stop too early)
  • add more content to the panel! Open to ideas. Can do this in a separate PR
  • keep dogfooding for bugs, w/different sample rates, sdk versions

@github-actionsgithub-actionsBot added the Scope: Frontend Automatically applied to PRs that change frontend components label Jul 31, 2024
@codecov

codecovBot commented Jul 31, 2024

Copy link
Copy Markdown

Bundle Report

Changes will increase total bundle size by 7.23kB ⬆️

Bundle nameSizeChange
app-webpack-bundle-array-push28.65MB7.23kB ⬆️

@aliu39aliu39 changed the title Aliu/start replayfeat(toolbar): add a replay panel for start/stop current replayAug 1, 2024
Comment threadpackage.json Outdated
Comment threadstatic/app/bootstrap/initializeSdk.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/panelRouter.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadyarn.lock Outdated
@aliu39

This comment was marked as resolved.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
@codecov

codecovBot commented Aug 3, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 0% with 57 lines in your changes missing coverage. Please review.

Project coverage is 78.22%. Comparing base (14c8790) to head (1fc533d).
Report is 23 commits behind head on master.

FilesPatch %Lines
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00%45 Missing ⚠️
...nents/devtoolbar/components/replay/replayPanel.tsx0.00%10 Missing ⚠️
...p/components/devtoolbar/components/panelRouter.tsx0.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## master #75403 +/- ##
==========================================
- Coverage 80.06% 78.22% -1.84% 
==========================================
Files 6996 6830 -166 Lines 312723 303280 -9443 Branches 52171 52182 +11 ==========================================
- Hits 250370 237244 -13126 + Misses 61911 59661 -2250 - Partials 442 6375 +5933 
FilesCoverage Δ
static/app/bootstrap/initializeSdk.tsx35.45% <ø> (ø)
...pp/components/devtoolbar/components/navigation.tsx0.00% <ø> (ø)
...pp/components/devtoolbar/hooks/useToolbarRoute.tsx0.00% <ø> (ø)
...p/components/devtoolbar/components/panelRouter.tsx0.00% <0.00%> (ø)
...nents/devtoolbar/components/replay/replayPanel.tsx0.00% <0.00%> (ø)
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00% <0.00%> (ø)

... and 1787 files with indirect coverage changes

@aliu39

This comment was marked as outdated.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadpackage.json Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
export default function useReplayRecorder(): ReplayRecorderState {
const {SentrySDK} = useConfiguration();
const replay =
SentrySDK && 'getReplay' in SentrySDK ? SentrySDK.getReplay() : undefined;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use SentrySDK.getIntegrationByName(), it's just a bit more annoying dealing with types

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm my VSCode can't find this method in browser or react packages..

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm it might be on the SDK client instead of the Sentry namespace... e.g. SentrySDK.getClient().getIntegrationByName

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, does this have any improvements over the current approach? Right now I'm using these conditions to get the disabledReason (see screenshots I just added in the description)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah just as a fallback if the SDK is too old to support getReplay as it was a relatively recent addition, but it's fine not to support older

Comment threadstatic/app/utils/useDevToolbar.tsx Outdated
Comment on lines +28 to +33
organizationSlug:
process.env.NODE_ENV !== 'development' ? 'sentry' : 'sentry-test',
projectId: process.env.NODE_ENV !== 'development' ? 11276 : 5270453,
projectPlatform: 'javascript',
projectSlug: 'javascript',
projectSlug:
process.env.NODE_ENV !== 'development' ? 'javascript' : 'app-frontend',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is PoC we are hard coding the org/project slugs, this allows the links to work in dev mode (assuming the replay integration is enabled)

@ryan953ryan953Aug 8, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you test by running the app with yarn dev-ui. my workflow depends on that command

@aliu39aliu39Aug 8, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works, but you need to comment out this condition in getsentry's useReplayInit: https://github.com/getsentry/getsentry/blob/2a1da081f3a9e4e4111b577d5551fa24691da374/static/getsentry/gsApp/utils/useReplayInit.tsx#L85-L87

I think it's disabled so we don't record everyone's dev-ui sessions. Maybe we could uncomment but set both sample rates to 0?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make a ticket and add it to the dev toolbar project

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably hold off on a ticket to change useReplayInit. The toolbar should support whatever env it finds itself inside of. So if sometimes there's no replayIntegration at all, that should be ok. We'll be able to test that case in dev, and on prod there will be a replayIntegration so we can test that case as well!

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't thinking about the other panels, this change would break them for dev. I'm done testing, let's just leave this panel disabled in dev.

disabled={isDisabled || buttonLoading}
onClick={async () => {
setButtonLoading(true);
isRecordingSession ? await stopRecording() : await startRecordingSession();

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not allowing users to stop buffering.


const startRecordingSession = useCallback(async () => {
let success = false;
if (replay) {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't want to try-catch here because we can already condition to make sure we're in a safe state.

@aliu39
aliu39 merged commit a055c3b into masterAug 8, 2024
@aliu39
aliu39 deleted the aliu/start-replay branch August 8, 2024 21:34
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 24, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Scope: FrontendAutomatically applied to PRs that change frontend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DevToolbar] When a replay is running, link to the Replay Details page for that replay [DevToolbar] Add 'start replay' buttons to the toolbar

4 participants

@aliu39@billyvg@ryan953@michellewzhang
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(toolbar): add a replay panel for start/stop current replay - #75403

Merged
aliu39 merged 31 commits into
masterfrom
aliu/start-replay
Aug 8, 2024
Merged

feat(toolbar): add a replay panel for start/stop current replay#75403
aliu39 merged 31 commits into
masterfrom
aliu/start-replay

Conversation

@aliu39

@aliu39aliu39 commented Jul 31, 2024

Copy link
Copy Markdown
Member

Closes#74583
Closes#74452

getReplay returns undefined:
Screenshot 2024-08-08 at 10 28 18 AM

SentrySDK doesn't have getReplay method:
Screenshot 2024-08-08 at 10 22 25 AM

SentrySDK is falsey (failed to import the package):
Screenshot 2024-08-08 at 10 22 02 AM

If you want to checkout this branch to test it, you need to run dev-ui in getsentry and make local changes:

Notes:

  • "last recorded replay" is persisted with sessionStorage
  • stopping then starting will make a new replay
  • uses some try-catch logic to handle older SDK versions where the recording fxs throw.

Follow-ups before merging

  • Analytics context provider and start/stop button analytics (todo in this PR)
  • comment on SDK versioning
    • exact release of getReplay/public API is unknown, but it was ~2yr ago near the release of the whole product
  • test with v8.18
  • remove the debug flag
  • make the links work for dev mode (can hard-code the sentry-test/app-frontend org/proj)

Follow-ups after merging

  • test the links work in prod
  • account for minimum replay duration (so users don't stop too early)
  • add more content to the panel! Open to ideas. Can do this in a separate PR
  • keep dogfooding for bugs, w/different sample rates, sdk versions

@github-actionsgithub-actionsBot added the Scope: Frontend Automatically applied to PRs that change frontend components label Jul 31, 2024
@codecov

codecovBot commented Jul 31, 2024

Copy link
Copy Markdown

Bundle Report

Changes will increase total bundle size by 7.23kB ⬆️

Bundle nameSizeChange
app-webpack-bundle-array-push28.65MB7.23kB ⬆️

@aliu39aliu39 changed the title Aliu/start replayfeat(toolbar): add a replay panel for start/stop current replayAug 1, 2024
Comment threadpackage.json Outdated
Comment threadstatic/app/bootstrap/initializeSdk.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/panelRouter.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadyarn.lock Outdated
@aliu39

This comment was marked as resolved.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
@codecov

codecovBot commented Aug 3, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 0% with 57 lines in your changes missing coverage. Please review.

Project coverage is 78.22%. Comparing base (14c8790) to head (1fc533d).
Report is 23 commits behind head on master.

FilesPatch %Lines
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00%45 Missing ⚠️
...nents/devtoolbar/components/replay/replayPanel.tsx0.00%10 Missing ⚠️
...p/components/devtoolbar/components/panelRouter.tsx0.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## master #75403 +/- ##
==========================================
- Coverage 80.06% 78.22% -1.84% 
==========================================
Files 6996 6830 -166 Lines 312723 303280 -9443 Branches 52171 52182 +11 ==========================================
- Hits 250370 237244 -13126 + Misses 61911 59661 -2250 - Partials 442 6375 +5933 
FilesCoverage Δ
static/app/bootstrap/initializeSdk.tsx35.45% <ø> (ø)
...pp/components/devtoolbar/components/navigation.tsx0.00% <ø> (ø)
...pp/components/devtoolbar/hooks/useToolbarRoute.tsx0.00% <ø> (ø)
...p/components/devtoolbar/components/panelRouter.tsx0.00% <0.00%> (ø)
...nents/devtoolbar/components/replay/replayPanel.tsx0.00% <0.00%> (ø)
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00% <0.00%> (ø)

... and 1787 files with indirect coverage changes

@aliu39

This comment was marked as outdated.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadpackage.json Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
export default function useReplayRecorder(): ReplayRecorderState {
const {SentrySDK} = useConfiguration();
const replay =
SentrySDK && 'getReplay' in SentrySDK ? SentrySDK.getReplay() : undefined;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use SentrySDK.getIntegrationByName(), it's just a bit more annoying dealing with types

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm my VSCode can't find this method in browser or react packages..

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm it might be on the SDK client instead of the Sentry namespace... e.g. SentrySDK.getClient().getIntegrationByName

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, does this have any improvements over the current approach? Right now I'm using these conditions to get the disabledReason (see screenshots I just added in the description)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah just as a fallback if the SDK is too old to support getReplay as it was a relatively recent addition, but it's fine not to support older

Comment threadstatic/app/utils/useDevToolbar.tsx Outdated
Comment on lines +28 to +33
organizationSlug:
process.env.NODE_ENV !== 'development' ? 'sentry' : 'sentry-test',
projectId: process.env.NODE_ENV !== 'development' ? 11276 : 5270453,
projectPlatform: 'javascript',
projectSlug: 'javascript',
projectSlug:
process.env.NODE_ENV !== 'development' ? 'javascript' : 'app-frontend',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is PoC we are hard coding the org/project slugs, this allows the links to work in dev mode (assuming the replay integration is enabled)

@ryan953ryan953Aug 8, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you test by running the app with yarn dev-ui. my workflow depends on that command

@aliu39aliu39Aug 8, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works, but you need to comment out this condition in getsentry's useReplayInit: https://github.com/getsentry/getsentry/blob/2a1da081f3a9e4e4111b577d5551fa24691da374/static/getsentry/gsApp/utils/useReplayInit.tsx#L85-L87

I think it's disabled so we don't record everyone's dev-ui sessions. Maybe we could uncomment but set both sample rates to 0?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make a ticket and add it to the dev toolbar project

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably hold off on a ticket to change useReplayInit. The toolbar should support whatever env it finds itself inside of. So if sometimes there's no replayIntegration at all, that should be ok. We'll be able to test that case in dev, and on prod there will be a replayIntegration so we can test that case as well!

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't thinking about the other panels, this change would break them for dev. I'm done testing, let's just leave this panel disabled in dev.

disabled={isDisabled || buttonLoading}
onClick={async () => {
setButtonLoading(true);
isRecordingSession ? await stopRecording() : await startRecordingSession();

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not allowing users to stop buffering.


const startRecordingSession = useCallback(async () => {
let success = false;
if (replay) {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't want to try-catch here because we can already condition to make sure we're in a safe state.

@aliu39
aliu39 merged commit a055c3b into masterAug 8, 2024
@aliu39
aliu39 deleted the aliu/start-replay branch August 8, 2024 21:34
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 24, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Scope: FrontendAutomatically applied to PRs that change frontend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DevToolbar] When a replay is running, link to the Replay Details page for that replay [DevToolbar] Add 'start replay' buttons to the toolbar

4 participants

@aliu39@billyvg@ryan953@michellewzhang
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(toolbar): add a replay panel for start/stop current replay - #75403

Merged
aliu39 merged 31 commits into
masterfrom
aliu/start-replay
Aug 8, 2024
Merged

feat(toolbar): add a replay panel for start/stop current replay#75403
aliu39 merged 31 commits into
masterfrom
aliu/start-replay

Conversation

@aliu39

@aliu39aliu39 commented Jul 31, 2024

Copy link
Copy Markdown
Member

Closes#74583
Closes#74452

getReplay returns undefined:
Screenshot 2024-08-08 at 10 28 18 AM

SentrySDK doesn't have getReplay method:
Screenshot 2024-08-08 at 10 22 25 AM

SentrySDK is falsey (failed to import the package):
Screenshot 2024-08-08 at 10 22 02 AM

If you want to checkout this branch to test it, you need to run dev-ui in getsentry and make local changes:

Notes:

  • "last recorded replay" is persisted with sessionStorage
  • stopping then starting will make a new replay
  • uses some try-catch logic to handle older SDK versions where the recording fxs throw.

Follow-ups before merging

  • Analytics context provider and start/stop button analytics (todo in this PR)
  • comment on SDK versioning
    • exact release of getReplay/public API is unknown, but it was ~2yr ago near the release of the whole product
  • test with v8.18
  • remove the debug flag
  • make the links work for dev mode (can hard-code the sentry-test/app-frontend org/proj)

Follow-ups after merging

  • test the links work in prod
  • account for minimum replay duration (so users don't stop too early)
  • add more content to the panel! Open to ideas. Can do this in a separate PR
  • keep dogfooding for bugs, w/different sample rates, sdk versions

@github-actionsgithub-actionsBot added the Scope: Frontend Automatically applied to PRs that change frontend components label Jul 31, 2024
@codecov

codecovBot commented Jul 31, 2024

Copy link
Copy Markdown

Bundle Report

Changes will increase total bundle size by 7.23kB ⬆️

Bundle nameSizeChange
app-webpack-bundle-array-push28.65MB7.23kB ⬆️

@aliu39aliu39 changed the title Aliu/start replayfeat(toolbar): add a replay panel for start/stop current replayAug 1, 2024
Comment threadpackage.json Outdated
Comment threadstatic/app/bootstrap/initializeSdk.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/panelRouter.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadyarn.lock Outdated
@aliu39

This comment was marked as resolved.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
@codecov

codecovBot commented Aug 3, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 0% with 57 lines in your changes missing coverage. Please review.

Project coverage is 78.22%. Comparing base (14c8790) to head (1fc533d).
Report is 23 commits behind head on master.

FilesPatch %Lines
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00%45 Missing ⚠️
...nents/devtoolbar/components/replay/replayPanel.tsx0.00%10 Missing ⚠️
...p/components/devtoolbar/components/panelRouter.tsx0.00%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## master #75403 +/- ##
==========================================
- Coverage 80.06% 78.22% -1.84% 
==========================================
Files 6996 6830 -166 Lines 312723 303280 -9443 Branches 52171 52182 +11 ==========================================
- Hits 250370 237244 -13126 + Misses 61911 59661 -2250 - Partials 442 6375 +5933 
FilesCoverage Δ
static/app/bootstrap/initializeSdk.tsx35.45% <ø> (ø)
...pp/components/devtoolbar/components/navigation.tsx0.00% <ø> (ø)
...pp/components/devtoolbar/hooks/useToolbarRoute.tsx0.00% <ø> (ø)
...p/components/devtoolbar/components/panelRouter.tsx0.00% <0.00%> (ø)
...nents/devtoolbar/components/replay/replayPanel.tsx0.00% <0.00%> (ø)
.../components/devtoolbar/hooks/useReplayRecorder.tsx0.00% <0.00%> (ø)

... and 1787 files with indirect coverage changes

@aliu39

This comment was marked as outdated.

Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadstatic/app/components/devtoolbar/hooks/useReplayRecorder.tsx Outdated
Comment threadpackage.json Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
Comment threadstatic/app/components/devtoolbar/components/replay/replayPanel.tsx Outdated
export default function useReplayRecorder(): ReplayRecorderState {
const {SentrySDK} = useConfiguration();
const replay =
SentrySDK && 'getReplay' in SentrySDK ? SentrySDK.getReplay() : undefined;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can use SentrySDK.getIntegrationByName(), it's just a bit more annoying dealing with types

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm my VSCode can't find this method in browser or react packages..

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm it might be on the SDK client instead of the Sentry namespace... e.g. SentrySDK.getClient().getIntegrationByName

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, does this have any improvements over the current approach? Right now I'm using these conditions to get the disabledReason (see screenshots I just added in the description)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah just as a fallback if the SDK is too old to support getReplay as it was a relatively recent addition, but it's fine not to support older

Comment threadstatic/app/utils/useDevToolbar.tsx Outdated
Comment on lines +28 to +33
organizationSlug:
process.env.NODE_ENV !== 'development' ? 'sentry' : 'sentry-test',
projectId: process.env.NODE_ENV !== 'development' ? 11276 : 5270453,
projectPlatform: 'javascript',
projectSlug: 'javascript',
projectSlug:
process.env.NODE_ENV !== 'development' ? 'javascript' : 'app-frontend',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in here?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is PoC we are hard coding the org/project slugs, this allows the links to work in dev mode (assuming the replay integration is enabled)

@ryan953ryan953Aug 8, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you test by running the app with yarn dev-ui. my workflow depends on that command

@aliu39aliu39Aug 8, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works, but you need to comment out this condition in getsentry's useReplayInit: https://github.com/getsentry/getsentry/blob/2a1da081f3a9e4e4111b577d5551fa24691da374/static/getsentry/gsApp/utils/useReplayInit.tsx#L85-L87

I think it's disabled so we don't record everyone's dev-ui sessions. Maybe we could uncomment but set both sample rates to 0?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make a ticket and add it to the dev toolbar project

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably hold off on a ticket to change useReplayInit. The toolbar should support whatever env it finds itself inside of. So if sometimes there's no replayIntegration at all, that should be ok. We'll be able to test that case in dev, and on prod there will be a replayIntegration so we can test that case as well!

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't thinking about the other panels, this change would break them for dev. I'm done testing, let's just leave this panel disabled in dev.

disabled={isDisabled || buttonLoading}
onClick={async () => {
setButtonLoading(true);
isRecordingSession ? await stopRecording() : await startRecordingSession();

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not allowing users to stop buffering.


const startRecordingSession = useCallback(async () => {
let success = false;
if (replay) {

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't want to try-catch here because we can already condition to make sure we're in a safe state.

@aliu39
aliu39 merged commit a055c3b into masterAug 8, 2024
@aliu39
aliu39 deleted the aliu/start-replay branch August 8, 2024 21:34
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Aug 24, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Scope: FrontendAutomatically applied to PRs that change frontend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DevToolbar] When a replay is running, link to the Replay Details page for that replay [DevToolbar] Add 'start replay' buttons to the toolbar

4 participants

@aliu39@billyvg@ryan953@michellewzhang