Skip to content

feat(remix): add connection check to example page #967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 22, 2025
Merged

feat(remix): add connection check to example page #967

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bbb29a0
feat(remix): add connection check to example page
shellmayr Apr 17, 2025
64466ac
add CHANGELOG & url fix
shellmayr Apr 17, 2025
87bf51f
wip
shellmayr Apr 17, 2025
6975c2a
prevent lint warnings in useEffect
shellmayr Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- feat(nextjs): Add connectivity check to example page([#951](https://github.com/getsentry/sentry-wizard/pull/951))
- feat(nextjs): Improve error names in example page to better differentiate between frontend and API errors ([#944](https://github.com/getsentry/sentry-wizard/pull/944))
- fix(remix): linting issues in generated client init code ([#949](https://github.com/getsentry/sentry-wizard/pull/949))
- feat(remix): Add connectivity check to example page([#967](https://github.com/getsentry/sentry-wizard/pull/967))

## 4.7.0

Expand Down
31 changes: 30 additions & 1 deletion src/remix/sdk-example.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export function getSentryExamplePageContents(options: {
: `https://${options.orgSlug}.sentry.io/issues/?project=${options.projectId}`;

return `import * as Sentry from "@sentry/remix";
import { useState } from "react";
import { useState, useEffect } from "react";

export const meta = () => {
return [
Expand All @@ -62,6 +62,15 @@ export const meta = () => {

export default function SentryExamplePage() {
const [hasSentError, setHasSentError] = useState(false);
const [isConnected, setIsConnected] = useState(true);

useEffect(() => {
async function checkConnectivity() {
const result = await Sentry.diagnoseSdkConnectivity();
setIsConnected(result !== 'sentry-unreachable');
}
checkConnectivity();
}, []);
Copy link
Member

Choose a reason for hiding this comment

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

l: let's avoid potential eslint warnings about empty useEffect arrays

Suggested change
}, []);
}, [setIsConnected]);

Copy link
Member

Choose a reason for hiding this comment

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

Btw some context here (we discussed this offline already, but just if someone is interested): The set... functions have a stable reference so they won't cause useEffect to fire again. However, it's advised to always include all potential variables to the dependency array.

React docs about set... and stable identities: https://react.dev/reference/react/useState#setstate-caveats


return (
<div>
Expand Down Expand Up @@ -103,6 +112,10 @@ export default function SentryExamplePage() {
<p className="success">
Sample error was sent to Sentry.
</p>
) : !isConnected ? (
<div className="connectivity-error">
<p>The Sentry SDK is not able to reach Sentry right now - this may be due to an adblocker. For more information, see <a target="_blank" rel="noreferrer" href="https://docs.sentry.io/platforms/javascript/guides/remix/troubleshooting/#the-sdk-is-not-sending-any-data">the troubleshooting guide</a>.</p>
</div>
) : (
<div className="success_placeholder" />
)}
Expand Down Expand Up @@ -214,6 +227,22 @@ const styles = \`
.success_placeholder {
height: 46px;
}

.connectivity-error {
padding: 12px 16px;
background-color: #E50045;
border-radius: 8px;
width: 500px;
color: #FFFFFF;
border: 1px solid #A80033;
text-align: center;
margin: 0;
}

.connectivity-error a {
color: #FFFFFF;
text-decoration: underline;
}
\`;
`;
}
Loading