Update and fix Sentry and Algolia Search#1060

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
NiallJoeMaher merged 1 commit into from
Oct 3, 2024
Merged

Update and fix Sentry and Algolia Search #1060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions components/ui/Search.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ import {
type AutocompleteCollection,
} from "@algolia/autocomplete-core";
import { getAlgoliaResults } from "@algolia/autocomplete-preset-algolia";
import algoliasearch from "algoliasearch/lite";
import { liteClient as algoliasearch } from "algoliasearch/lite";
import {
Dialog,
DialogPanel,
Expand DownExpand Up@@ -113,8 +113,8 @@ function useAutocomplete({
queries: [
{
indexName: ALGOLIA_SOURCE_IDX,
query,
params: {
query,
hitsPerPage: 6,
},
},
Expand Down
26 changes: 26 additions & 0 deletions instrumentation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
import * as Sentry from "@sentry/nextjs";

const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
const SENTRY_ENVIRONMENT = process.env.SENTRY_ENVIRONMENT;
Comment on lines +1 to +4

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider improving environment variable handling

The current implementation has a few potential issues:

  1. Using both SENTRY_DSN and NEXT_PUBLIC_SENTRY_DSN might lead to confusion. Consider using only one of them consistently.
  2. SENTRY_ENVIRONMENT is not checked for existence, which might lead to undefined behavior if the environment variable is not set.

Consider refactoring the environment variable handling as follows:

import*asSentryfrom"@sentry/nextjs";constSENTRY_DSN=process.env.NEXT_PUBLIC_SENTRY_DSN;constSENTRY_ENVIRONMENT=process.env.SENTRY_ENVIRONMENT||'development';if(!SENTRY_DSN){console.warn('NEXT_PUBLIC_SENTRY_DSN is not set. Sentry will not be initialized.');}

This approach:

  • Uses only NEXT_PUBLIC_SENTRY_DSN for consistency
  • Provides a default value for SENTRY_ENVIRONMENT
  • Adds a warning if SENTRY_DSN is not set


export function register() {
if (process.env.NEXT_RUNTIME === "nodejs") {
// this is your Sentry.init call from `sentry.server.config.js|ts`
Sentry.init({
dsn: SENTRY_DSN,
// Adjust this value in production, or use tracesSampler for greater control
tracesSampleRate: 1,
environment: SENTRY_ENVIRONMENT,
});
}
Comment on lines +7 to +15

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Improve Sentry initialization for Node.js runtime

The Sentry initialization for Node.js looks generally correct, but there are a few points to consider:

  1. Setting tracesSampleRate to 1 might be too high for production, as it samples 100% of transactions.
  2. There's no error handling if SENTRY_DSN is undefined.

Consider refactoring the Node.js initialization as follows:

if(process.env.NEXT_RUNTIME==="nodejs"){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn('Sentry DSN not provided. Skipping Sentry initialization for Node.js runtime.');}}

This approach:

  • Adjusts tracesSampleRate based on the environment
  • Adds error handling for missing SENTRY_DSN
  • Uses the SENTRY_ENVIRONMENT variable we defined earlier


// This is your Sentry.init call from `sentry.edge.config.js|ts`
if (process.env.NEXT_RUNTIME === "edge") {
Sentry.init({
dsn: SENTRY_DSN,
// Adjust this value in production, or use tracesSampler for greater control
tracesSampleRate: 1,
environment: SENTRY_ENVIRONMENT,
});
}
Comment on lines +18 to +25

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Refactor Edge runtime initialization to reduce duplication

The Sentry initialization for Edge runtime is identical to the Node.js runtime, which leads to code duplication and the same potential issues we identified earlier.

Consider refactoring to reduce duplication and improve both initializations:

functioninitSentry(runtime: string){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn(`Sentry DSN not provided. Skipping Sentry initialization for ${runtime} runtime.`);}}exportfunctionregister(){switch(process.env.NEXT_RUNTIME){case"nodejs":
initSentry("Node.js");break;case"edge":
initSentry("Edge");break;default:
console.warn(`Unexpected NEXT_RUNTIME value: ${process.env.NEXT_RUNTIME}`);}}

This refactored version:

  • Reduces code duplication
  • Improves error handling
  • Adjusts tracesSampleRate based on the environment
  • Provides more informative logging

}
2 changes: 1 addition & 1 deletion next-env.d.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.
20 changes: 9 additions & 11 deletions next.config.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,20 +39,18 @@ const config = {
// Temporary to check pipelines due to weird error I can only get on CodePipeline
ignoreBuildErrors: true,
},
experimental: {
instrumentationHook: true,
},
};

// Injected content via Sentry wizard below

const { withSentryConfig } = require("@sentry/nextjs");

module.exports = withSentryConfig(
withMDX(withBundleAnalyzer(config)),
{
silent: true,
org: "codu",
project: "codu",
},
{
hideSourceMaps: true,
},
);
module.exports = withSentryConfig(withMDX(withBundleAnalyzer(config)), {
silent: true,
org: "codu",
project: "codu",
hideSourceMaps: true,
});
Loading
, '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
Update and fix Sentry and Algolia Search#1060

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

NiallJoeMaher
merged 1 commit into

from

Oct 3, 2024
 Merged


Update and fix Sentry and Algolia Search
#1060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
components/ui/Search.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ import {
 type AutocompleteCollection,
} from "@algolia/autocomplete-core";
import { getAlgoliaResults } from "@algolia/autocomplete-preset-algolia";
import algoliasearch from "algoliasearch/lite";
import { liteClient as algoliasearch } from "algoliasearch/lite";
import {
 Dialog,
 DialogPanel,
Expand DownExpand Up@@ -113,8 +113,8 @@ function useAutocomplete({
 queries: [
 {
 indexName: ALGOLIA_SOURCE_IDX,
 query,
 params: {
 query,
 hitsPerPage: 6,
 },
 },
Expand Down

26 changes: 26 additions & 0 deletions
instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
import * as Sentry from "@sentry/nextjs";

const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
const SENTRY_ENVIRONMENT = process.env.SENTRY_ENVIRONMENT;

Comment on lines

+1
 to 
+4

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Consider improving environment variable handling
The current implementation has a few potential issues:
  1. Using both SENTRY_DSN and NEXT_PUBLIC_SENTRY_DSN might lead to confusion. Consider using only one of them consistently.
  2. SENTRY_ENVIRONMENT is not checked for existence, which might lead to undefined behavior if the environment variable is not set.
Consider refactoring the environment variable handling as follows:
import*asSentryfrom"@sentry/nextjs";constSENTRY_DSN=process.env.NEXT_PUBLIC_SENTRY_DSN;constSENTRY_ENVIRONMENT=process.env.SENTRY_ENVIRONMENT||'development';if(!SENTRY_DSN){console.warn('NEXT_PUBLIC_SENTRY_DSN is not set. Sentry will not be initialized.');}
This approach:
  • Uses only NEXT_PUBLIC_SENTRY_DSN for consistency
  • Provides a default value for SENTRY_ENVIRONMENT
  • Adds a warning if SENTRY_DSN is not set

export function register() {
 if (process.env.NEXT_RUNTIME === "nodejs") {
 // this is your Sentry.init call from `sentry.server.config.js|ts`
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+7
 to 
+15

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Improve Sentry initialization for Node.js runtime
The Sentry initialization for Node.js looks generally correct, but there are a few points to consider:
  1. Setting tracesSampleRate to 1 might be too high for production, as it samples 100% of transactions.
  2. There's no error handling if SENTRY_DSN is undefined.
Consider refactoring the Node.js initialization as follows:
if(process.env.NEXT_RUNTIME==="nodejs"){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn('Sentry DSN not provided. Skipping Sentry initialization for Node.js runtime.');}}
This approach:
  • Adjusts tracesSampleRate based on the environment
  • Adds error handling for missing SENTRY_DSN
  • Uses the SENTRY_ENVIRONMENT variable we defined earlier

 // This is your Sentry.init call from `sentry.edge.config.js|ts`
 if (process.env.NEXT_RUNTIME === "edge") {
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+18
 to 
+25

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Refactor Edge runtime initialization to reduce duplication
The Sentry initialization for Edge runtime is identical to the Node.js runtime, which leads to code duplication and the same potential issues we identified earlier.
Consider refactoring to reduce duplication and improve both initializations:
functioninitSentry(runtime: string){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn(`Sentry DSN not provided. Skipping Sentry initialization for ${runtime} runtime.`);}}exportfunctionregister(){switch(process.env.NEXT_RUNTIME){case"nodejs":
initSentry("Node.js");break;case"edge":
initSentry("Edge");break;default:
console.warn(`Unexpected NEXT_RUNTIME value: ${process.env.NEXT_RUNTIME}`);}}
This refactored version:
  • Reduces code duplication
  • Improves error handling
  • Adjusts tracesSampleRate based on the environment
  • Provides more informative logging
}

2 changes: 1 addition & 1 deletion
next-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

20 changes: 9 additions & 11 deletions
next.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,20 +39,18 @@ const config = {
 // Temporary to check pipelines due to weird error I can only get on CodePipeline
 ignoreBuildErrors: true,
 },
 experimental: {
 instrumentationHook: true,
 },
};

// Injected content via Sentry wizard below

const { withSentryConfig } = require("@sentry/nextjs");

module.exports = withSentryConfig(
 withMDX(withBundleAnalyzer(config)),
 {
 silent: true,
 org: "codu",
 project: "codu",
 },
 {
 hideSourceMaps: true,
 },
);
module.exports = withSentryConfig(withMDX(withBundleAnalyzer(config)), {
 silent: true,
 org: "codu",
 project: "codu",
 hideSourceMaps: true,
});
Loading

, '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
Update and fix Sentry and Algolia Search#1060

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

NiallJoeMaher
merged 1 commit into

from

Oct 3, 2024
 Merged


Update and fix Sentry and Algolia Search
#1060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
components/ui/Search.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ import {
 type AutocompleteCollection,
} from "@algolia/autocomplete-core";
import { getAlgoliaResults } from "@algolia/autocomplete-preset-algolia";
import algoliasearch from "algoliasearch/lite";
import { liteClient as algoliasearch } from "algoliasearch/lite";
import {
 Dialog,
 DialogPanel,
Expand DownExpand Up@@ -113,8 +113,8 @@ function useAutocomplete({
 queries: [
 {
 indexName: ALGOLIA_SOURCE_IDX,
 query,
 params: {
 query,
 hitsPerPage: 6,
 },
 },
Expand Down

26 changes: 26 additions & 0 deletions
instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
import * as Sentry from "@sentry/nextjs";

const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
const SENTRY_ENVIRONMENT = process.env.SENTRY_ENVIRONMENT;

Comment on lines

+1
 to 
+4

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Consider improving environment variable handling
The current implementation has a few potential issues:
  1. Using both SENTRY_DSN and NEXT_PUBLIC_SENTRY_DSN might lead to confusion. Consider using only one of them consistently.
  2. SENTRY_ENVIRONMENT is not checked for existence, which might lead to undefined behavior if the environment variable is not set.
Consider refactoring the environment variable handling as follows:
import*asSentryfrom"@sentry/nextjs";constSENTRY_DSN=process.env.NEXT_PUBLIC_SENTRY_DSN;constSENTRY_ENVIRONMENT=process.env.SENTRY_ENVIRONMENT||'development';if(!SENTRY_DSN){console.warn('NEXT_PUBLIC_SENTRY_DSN is not set. Sentry will not be initialized.');}
This approach:
  • Uses only NEXT_PUBLIC_SENTRY_DSN for consistency
  • Provides a default value for SENTRY_ENVIRONMENT
  • Adds a warning if SENTRY_DSN is not set

export function register() {
 if (process.env.NEXT_RUNTIME === "nodejs") {
 // this is your Sentry.init call from `sentry.server.config.js|ts`
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+7
 to 
+15

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Improve Sentry initialization for Node.js runtime
The Sentry initialization for Node.js looks generally correct, but there are a few points to consider:
  1. Setting tracesSampleRate to 1 might be too high for production, as it samples 100% of transactions.
  2. There's no error handling if SENTRY_DSN is undefined.
Consider refactoring the Node.js initialization as follows:
if(process.env.NEXT_RUNTIME==="nodejs"){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn('Sentry DSN not provided. Skipping Sentry initialization for Node.js runtime.');}}
This approach:
  • Adjusts tracesSampleRate based on the environment
  • Adds error handling for missing SENTRY_DSN
  • Uses the SENTRY_ENVIRONMENT variable we defined earlier

 // This is your Sentry.init call from `sentry.edge.config.js|ts`
 if (process.env.NEXT_RUNTIME === "edge") {
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+18
 to 
+25

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Refactor Edge runtime initialization to reduce duplication
The Sentry initialization for Edge runtime is identical to the Node.js runtime, which leads to code duplication and the same potential issues we identified earlier.
Consider refactoring to reduce duplication and improve both initializations:
functioninitSentry(runtime: string){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn(`Sentry DSN not provided. Skipping Sentry initialization for ${runtime} runtime.`);}}exportfunctionregister(){switch(process.env.NEXT_RUNTIME){case"nodejs":
initSentry("Node.js");break;case"edge":
initSentry("Edge");break;default:
console.warn(`Unexpected NEXT_RUNTIME value: ${process.env.NEXT_RUNTIME}`);}}
This refactored version:
  • Reduces code duplication
  • Improves error handling
  • Adjusts tracesSampleRate based on the environment
  • Provides more informative logging
}

2 changes: 1 addition & 1 deletion
next-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

20 changes: 9 additions & 11 deletions
next.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,20 +39,18 @@ const config = {
 // Temporary to check pipelines due to weird error I can only get on CodePipeline
 ignoreBuildErrors: true,
 },
 experimental: {
 instrumentationHook: true,
 },
};

// Injected content via Sentry wizard below

const { withSentryConfig } = require("@sentry/nextjs");

module.exports = withSentryConfig(
 withMDX(withBundleAnalyzer(config)),
 {
 silent: true,
 org: "codu",
 project: "codu",
 },
 {
 hideSourceMaps: true,
 },
);
module.exports = withSentryConfig(withMDX(withBundleAnalyzer(config)), {
 silent: true,
 org: "codu",
 project: "codu",
 hideSourceMaps: true,
});
Loading

, '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
Update and fix Sentry and Algolia Search#1060

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

NiallJoeMaher
merged 1 commit into

from

Oct 3, 2024
 Merged


Update and fix Sentry and Algolia Search
#1060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
components/ui/Search.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ import {
 type AutocompleteCollection,
} from "@algolia/autocomplete-core";
import { getAlgoliaResults } from "@algolia/autocomplete-preset-algolia";
import algoliasearch from "algoliasearch/lite";
import { liteClient as algoliasearch } from "algoliasearch/lite";
import {
 Dialog,
 DialogPanel,
Expand DownExpand Up@@ -113,8 +113,8 @@ function useAutocomplete({
 queries: [
 {
 indexName: ALGOLIA_SOURCE_IDX,
 query,
 params: {
 query,
 hitsPerPage: 6,
 },
 },
Expand Down

26 changes: 26 additions & 0 deletions
instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
import * as Sentry from "@sentry/nextjs";

const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
const SENTRY_ENVIRONMENT = process.env.SENTRY_ENVIRONMENT;

Comment on lines

+1
 to 
+4

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Consider improving environment variable handling
The current implementation has a few potential issues:
  1. Using both SENTRY_DSN and NEXT_PUBLIC_SENTRY_DSN might lead to confusion. Consider using only one of them consistently.
  2. SENTRY_ENVIRONMENT is not checked for existence, which might lead to undefined behavior if the environment variable is not set.
Consider refactoring the environment variable handling as follows:
import*asSentryfrom"@sentry/nextjs";constSENTRY_DSN=process.env.NEXT_PUBLIC_SENTRY_DSN;constSENTRY_ENVIRONMENT=process.env.SENTRY_ENVIRONMENT||'development';if(!SENTRY_DSN){console.warn('NEXT_PUBLIC_SENTRY_DSN is not set. Sentry will not be initialized.');}
This approach:
  • Uses only NEXT_PUBLIC_SENTRY_DSN for consistency
  • Provides a default value for SENTRY_ENVIRONMENT
  • Adds a warning if SENTRY_DSN is not set

export function register() {
 if (process.env.NEXT_RUNTIME === "nodejs") {
 // this is your Sentry.init call from `sentry.server.config.js|ts`
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+7
 to 
+15

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Improve Sentry initialization for Node.js runtime
The Sentry initialization for Node.js looks generally correct, but there are a few points to consider:
  1. Setting tracesSampleRate to 1 might be too high for production, as it samples 100% of transactions.
  2. There's no error handling if SENTRY_DSN is undefined.
Consider refactoring the Node.js initialization as follows:
if(process.env.NEXT_RUNTIME==="nodejs"){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn('Sentry DSN not provided. Skipping Sentry initialization for Node.js runtime.');}}
This approach:
  • Adjusts tracesSampleRate based on the environment
  • Adds error handling for missing SENTRY_DSN
  • Uses the SENTRY_ENVIRONMENT variable we defined earlier

 // This is your Sentry.init call from `sentry.edge.config.js|ts`
 if (process.env.NEXT_RUNTIME === "edge") {
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+18
 to 
+25

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Refactor Edge runtime initialization to reduce duplication
The Sentry initialization for Edge runtime is identical to the Node.js runtime, which leads to code duplication and the same potential issues we identified earlier.
Consider refactoring to reduce duplication and improve both initializations:
functioninitSentry(runtime: string){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn(`Sentry DSN not provided. Skipping Sentry initialization for ${runtime} runtime.`);}}exportfunctionregister(){switch(process.env.NEXT_RUNTIME){case"nodejs":
initSentry("Node.js");break;case"edge":
initSentry("Edge");break;default:
console.warn(`Unexpected NEXT_RUNTIME value: ${process.env.NEXT_RUNTIME}`);}}
This refactored version:
  • Reduces code duplication
  • Improves error handling
  • Adjusts tracesSampleRate based on the environment
  • Provides more informative logging
}

2 changes: 1 addition & 1 deletion
next-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

20 changes: 9 additions & 11 deletions
next.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,20 +39,18 @@ const config = {
 // Temporary to check pipelines due to weird error I can only get on CodePipeline
 ignoreBuildErrors: true,
 },
 experimental: {
 instrumentationHook: true,
 },
};

// Injected content via Sentry wizard below

const { withSentryConfig } = require("@sentry/nextjs");

module.exports = withSentryConfig(
 withMDX(withBundleAnalyzer(config)),
 {
 silent: true,
 org: "codu",
 project: "codu",
 },
 {
 hideSourceMaps: true,
 },
);
module.exports = withSentryConfig(withMDX(withBundleAnalyzer(config)), {
 silent: true,
 org: "codu",
 project: "codu",
 hideSourceMaps: true,
});
Loading

, '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
Update and fix Sentry and Algolia Search#1060

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

NiallJoeMaher
merged 1 commit into

from

Oct 3, 2024
 Merged


Update and fix Sentry and Algolia Search
#1060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
components/ui/Search.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ import {
 type AutocompleteCollection,
} from "@algolia/autocomplete-core";
import { getAlgoliaResults } from "@algolia/autocomplete-preset-algolia";
import algoliasearch from "algoliasearch/lite";
import { liteClient as algoliasearch } from "algoliasearch/lite";
import {
 Dialog,
 DialogPanel,
Expand DownExpand Up@@ -113,8 +113,8 @@ function useAutocomplete({
 queries: [
 {
 indexName: ALGOLIA_SOURCE_IDX,
 query,
 params: {
 query,
 hitsPerPage: 6,
 },
 },
Expand Down

26 changes: 26 additions & 0 deletions
instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
import * as Sentry from "@sentry/nextjs";

const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
const SENTRY_ENVIRONMENT = process.env.SENTRY_ENVIRONMENT;

Comment on lines

+1
 to 
+4

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Consider improving environment variable handling
The current implementation has a few potential issues:
  1. Using both SENTRY_DSN and NEXT_PUBLIC_SENTRY_DSN might lead to confusion. Consider using only one of them consistently.
  2. SENTRY_ENVIRONMENT is not checked for existence, which might lead to undefined behavior if the environment variable is not set.
Consider refactoring the environment variable handling as follows:
import*asSentryfrom"@sentry/nextjs";constSENTRY_DSN=process.env.NEXT_PUBLIC_SENTRY_DSN;constSENTRY_ENVIRONMENT=process.env.SENTRY_ENVIRONMENT||'development';if(!SENTRY_DSN){console.warn('NEXT_PUBLIC_SENTRY_DSN is not set. Sentry will not be initialized.');}
This approach:
  • Uses only NEXT_PUBLIC_SENTRY_DSN for consistency
  • Provides a default value for SENTRY_ENVIRONMENT
  • Adds a warning if SENTRY_DSN is not set

export function register() {
 if (process.env.NEXT_RUNTIME === "nodejs") {
 // this is your Sentry.init call from `sentry.server.config.js|ts`
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+7
 to 
+15

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Improve Sentry initialization for Node.js runtime
The Sentry initialization for Node.js looks generally correct, but there are a few points to consider:
  1. Setting tracesSampleRate to 1 might be too high for production, as it samples 100% of transactions.
  2. There's no error handling if SENTRY_DSN is undefined.
Consider refactoring the Node.js initialization as follows:
if(process.env.NEXT_RUNTIME==="nodejs"){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn('Sentry DSN not provided. Skipping Sentry initialization for Node.js runtime.');}}
This approach:
  • Adjusts tracesSampleRate based on the environment
  • Adds error handling for missing SENTRY_DSN
  • Uses the SENTRY_ENVIRONMENT variable we defined earlier

 // This is your Sentry.init call from `sentry.edge.config.js|ts`
 if (process.env.NEXT_RUNTIME === "edge") {
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+18
 to 
+25

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Refactor Edge runtime initialization to reduce duplication
The Sentry initialization for Edge runtime is identical to the Node.js runtime, which leads to code duplication and the same potential issues we identified earlier.
Consider refactoring to reduce duplication and improve both initializations:
functioninitSentry(runtime: string){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn(`Sentry DSN not provided. Skipping Sentry initialization for ${runtime} runtime.`);}}exportfunctionregister(){switch(process.env.NEXT_RUNTIME){case"nodejs":
initSentry("Node.js");break;case"edge":
initSentry("Edge");break;default:
console.warn(`Unexpected NEXT_RUNTIME value: ${process.env.NEXT_RUNTIME}`);}}
This refactored version:
  • Reduces code duplication
  • Improves error handling
  • Adjusts tracesSampleRate based on the environment
  • Provides more informative logging
}

2 changes: 1 addition & 1 deletion
next-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

20 changes: 9 additions & 11 deletions
next.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,20 +39,18 @@ const config = {
 // Temporary to check pipelines due to weird error I can only get on CodePipeline
 ignoreBuildErrors: true,
 },
 experimental: {
 instrumentationHook: true,
 },
};

// Injected content via Sentry wizard below

const { withSentryConfig } = require("@sentry/nextjs");

module.exports = withSentryConfig(
 withMDX(withBundleAnalyzer(config)),
 {
 silent: true,
 org: "codu",
 project: "codu",
 },
 {
 hideSourceMaps: true,
 },
);
module.exports = withSentryConfig(withMDX(withBundleAnalyzer(config)), {
 silent: true,
 org: "codu",
 project: "codu",
 hideSourceMaps: true,
});
Loading

, '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
Update and fix Sentry and Algolia Search#1060

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

NiallJoeMaher
merged 1 commit into

from

Oct 3, 2024
 Merged


Update and fix Sentry and Algolia Search
#1060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
components/ui/Search.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ import {
 type AutocompleteCollection,
} from "@algolia/autocomplete-core";
import { getAlgoliaResults } from "@algolia/autocomplete-preset-algolia";
import algoliasearch from "algoliasearch/lite";
import { liteClient as algoliasearch } from "algoliasearch/lite";
import {
 Dialog,
 DialogPanel,
Expand DownExpand Up@@ -113,8 +113,8 @@ function useAutocomplete({
 queries: [
 {
 indexName: ALGOLIA_SOURCE_IDX,
 query,
 params: {
 query,
 hitsPerPage: 6,
 },
 },
Expand Down

26 changes: 26 additions & 0 deletions
instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
import * as Sentry from "@sentry/nextjs";

const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
const SENTRY_ENVIRONMENT = process.env.SENTRY_ENVIRONMENT;

Comment on lines

+1
 to 
+4

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Consider improving environment variable handling
The current implementation has a few potential issues:
  1. Using both SENTRY_DSN and NEXT_PUBLIC_SENTRY_DSN might lead to confusion. Consider using only one of them consistently.
  2. SENTRY_ENVIRONMENT is not checked for existence, which might lead to undefined behavior if the environment variable is not set.
Consider refactoring the environment variable handling as follows:
import*asSentryfrom"@sentry/nextjs";constSENTRY_DSN=process.env.NEXT_PUBLIC_SENTRY_DSN;constSENTRY_ENVIRONMENT=process.env.SENTRY_ENVIRONMENT||'development';if(!SENTRY_DSN){console.warn('NEXT_PUBLIC_SENTRY_DSN is not set. Sentry will not be initialized.');}
This approach:
  • Uses only NEXT_PUBLIC_SENTRY_DSN for consistency
  • Provides a default value for SENTRY_ENVIRONMENT
  • Adds a warning if SENTRY_DSN is not set

export function register() {
 if (process.env.NEXT_RUNTIME === "nodejs") {
 // this is your Sentry.init call from `sentry.server.config.js|ts`
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+7
 to 
+15

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Improve Sentry initialization for Node.js runtime
The Sentry initialization for Node.js looks generally correct, but there are a few points to consider:
  1. Setting tracesSampleRate to 1 might be too high for production, as it samples 100% of transactions.
  2. There's no error handling if SENTRY_DSN is undefined.
Consider refactoring the Node.js initialization as follows:
if(process.env.NEXT_RUNTIME==="nodejs"){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn('Sentry DSN not provided. Skipping Sentry initialization for Node.js runtime.');}}
This approach:
  • Adjusts tracesSampleRate based on the environment
  • Adds error handling for missing SENTRY_DSN
  • Uses the SENTRY_ENVIRONMENT variable we defined earlier

 // This is your Sentry.init call from `sentry.edge.config.js|ts`
 if (process.env.NEXT_RUNTIME === "edge") {
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+18
 to 
+25

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Refactor Edge runtime initialization to reduce duplication
The Sentry initialization for Edge runtime is identical to the Node.js runtime, which leads to code duplication and the same potential issues we identified earlier.
Consider refactoring to reduce duplication and improve both initializations:
functioninitSentry(runtime: string){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn(`Sentry DSN not provided. Skipping Sentry initialization for ${runtime} runtime.`);}}exportfunctionregister(){switch(process.env.NEXT_RUNTIME){case"nodejs":
initSentry("Node.js");break;case"edge":
initSentry("Edge");break;default:
console.warn(`Unexpected NEXT_RUNTIME value: ${process.env.NEXT_RUNTIME}`);}}
This refactored version:
  • Reduces code duplication
  • Improves error handling
  • Adjusts tracesSampleRate based on the environment
  • Provides more informative logging
}

2 changes: 1 addition & 1 deletion
next-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

20 changes: 9 additions & 11 deletions
next.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,20 +39,18 @@ const config = {
 // Temporary to check pipelines due to weird error I can only get on CodePipeline
 ignoreBuildErrors: true,
 },
 experimental: {
 instrumentationHook: true,
 },
};

// Injected content via Sentry wizard below

const { withSentryConfig } = require("@sentry/nextjs");

module.exports = withSentryConfig(
 withMDX(withBundleAnalyzer(config)),
 {
 silent: true,
 org: "codu",
 project: "codu",
 },
 {
 hideSourceMaps: true,
 },
);
module.exports = withSentryConfig(withMDX(withBundleAnalyzer(config)), {
 silent: true,
 org: "codu",
 project: "codu",
 hideSourceMaps: true,
});
Loading

, '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
Update and fix Sentry and Algolia Search#1060

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

NiallJoeMaher
merged 1 commit into

from

Oct 3, 2024
 Merged


Update and fix Sentry and Algolia Search
#1060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
components/ui/Search.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ import {
 type AutocompleteCollection,
} from "@algolia/autocomplete-core";
import { getAlgoliaResults } from "@algolia/autocomplete-preset-algolia";
import algoliasearch from "algoliasearch/lite";
import { liteClient as algoliasearch } from "algoliasearch/lite";
import {
 Dialog,
 DialogPanel,
Expand DownExpand Up@@ -113,8 +113,8 @@ function useAutocomplete({
 queries: [
 {
 indexName: ALGOLIA_SOURCE_IDX,
 query,
 params: {
 query,
 hitsPerPage: 6,
 },
 },
Expand Down

26 changes: 26 additions & 0 deletions
instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
import * as Sentry from "@sentry/nextjs";

const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
const SENTRY_ENVIRONMENT = process.env.SENTRY_ENVIRONMENT;

Comment on lines

+1
 to 
+4

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Consider improving environment variable handling
The current implementation has a few potential issues:
  1. Using both SENTRY_DSN and NEXT_PUBLIC_SENTRY_DSN might lead to confusion. Consider using only one of them consistently.
  2. SENTRY_ENVIRONMENT is not checked for existence, which might lead to undefined behavior if the environment variable is not set.
Consider refactoring the environment variable handling as follows:
import*asSentryfrom"@sentry/nextjs";constSENTRY_DSN=process.env.NEXT_PUBLIC_SENTRY_DSN;constSENTRY_ENVIRONMENT=process.env.SENTRY_ENVIRONMENT||'development';if(!SENTRY_DSN){console.warn('NEXT_PUBLIC_SENTRY_DSN is not set. Sentry will not be initialized.');}
This approach:
  • Uses only NEXT_PUBLIC_SENTRY_DSN for consistency
  • Provides a default value for SENTRY_ENVIRONMENT
  • Adds a warning if SENTRY_DSN is not set

export function register() {
 if (process.env.NEXT_RUNTIME === "nodejs") {
 // this is your Sentry.init call from `sentry.server.config.js|ts`
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+7
 to 
+15

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Improve Sentry initialization for Node.js runtime
The Sentry initialization for Node.js looks generally correct, but there are a few points to consider:
  1. Setting tracesSampleRate to 1 might be too high for production, as it samples 100% of transactions.
  2. There's no error handling if SENTRY_DSN is undefined.
Consider refactoring the Node.js initialization as follows:
if(process.env.NEXT_RUNTIME==="nodejs"){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn('Sentry DSN not provided. Skipping Sentry initialization for Node.js runtime.');}}
This approach:
  • Adjusts tracesSampleRate based on the environment
  • Adds error handling for missing SENTRY_DSN
  • Uses the SENTRY_ENVIRONMENT variable we defined earlier

 // This is your Sentry.init call from `sentry.edge.config.js|ts`
 if (process.env.NEXT_RUNTIME === "edge") {
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+18
 to 
+25

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Refactor Edge runtime initialization to reduce duplication
The Sentry initialization for Edge runtime is identical to the Node.js runtime, which leads to code duplication and the same potential issues we identified earlier.
Consider refactoring to reduce duplication and improve both initializations:
functioninitSentry(runtime: string){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn(`Sentry DSN not provided. Skipping Sentry initialization for ${runtime} runtime.`);}}exportfunctionregister(){switch(process.env.NEXT_RUNTIME){case"nodejs":
initSentry("Node.js");break;case"edge":
initSentry("Edge");break;default:
console.warn(`Unexpected NEXT_RUNTIME value: ${process.env.NEXT_RUNTIME}`);}}
This refactored version:
  • Reduces code duplication
  • Improves error handling
  • Adjusts tracesSampleRate based on the environment
  • Provides more informative logging
}

2 changes: 1 addition & 1 deletion
next-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

20 changes: 9 additions & 11 deletions
next.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,20 +39,18 @@ const config = {
 // Temporary to check pipelines due to weird error I can only get on CodePipeline
 ignoreBuildErrors: true,
 },
 experimental: {
 instrumentationHook: true,
 },
};

// Injected content via Sentry wizard below

const { withSentryConfig } = require("@sentry/nextjs");

module.exports = withSentryConfig(
 withMDX(withBundleAnalyzer(config)),
 {
 silent: true,
 org: "codu",
 project: "codu",
 },
 {
 hideSourceMaps: true,
 },
);
module.exports = withSentryConfig(withMDX(withBundleAnalyzer(config)), {
 silent: true,
 org: "codu",
 project: "codu",
 hideSourceMaps: true,
});
Loading

, '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
Update and fix Sentry and Algolia Search#1060

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

NiallJoeMaher
merged 1 commit into

from

Oct 3, 2024
 Merged


Update and fix Sentry and Algolia Search
#1060
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


4 changes: 2 additions & 2 deletions
components/ui/Search.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ import {
 type AutocompleteCollection,
} from "@algolia/autocomplete-core";
import { getAlgoliaResults } from "@algolia/autocomplete-preset-algolia";
import algoliasearch from "algoliasearch/lite";
import { liteClient as algoliasearch } from "algoliasearch/lite";
import {
 Dialog,
 DialogPanel,
Expand DownExpand Up@@ -113,8 +113,8 @@ function useAutocomplete({
 queries: [
 {
 indexName: ALGOLIA_SOURCE_IDX,
 query,
 params: {
 query,
 hitsPerPage: 6,
 },
 },
Expand Down

26 changes: 26 additions & 0 deletions
instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
import * as Sentry from "@sentry/nextjs";

const SENTRY_DSN = process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
const SENTRY_ENVIRONMENT = process.env.SENTRY_ENVIRONMENT;

Comment on lines

+1
 to 
+4

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Consider improving environment variable handling
The current implementation has a few potential issues:
  1. Using both SENTRY_DSN and NEXT_PUBLIC_SENTRY_DSN might lead to confusion. Consider using only one of them consistently.
  2. SENTRY_ENVIRONMENT is not checked for existence, which might lead to undefined behavior if the environment variable is not set.
Consider refactoring the environment variable handling as follows:
import*asSentryfrom"@sentry/nextjs";constSENTRY_DSN=process.env.NEXT_PUBLIC_SENTRY_DSN;constSENTRY_ENVIRONMENT=process.env.SENTRY_ENVIRONMENT||'development';if(!SENTRY_DSN){console.warn('NEXT_PUBLIC_SENTRY_DSN is not set. Sentry will not be initialized.');}
This approach:
  • Uses only NEXT_PUBLIC_SENTRY_DSN for consistency
  • Provides a default value for SENTRY_ENVIRONMENT
  • Adds a warning if SENTRY_DSN is not set

export function register() {
 if (process.env.NEXT_RUNTIME === "nodejs") {
 // this is your Sentry.init call from `sentry.server.config.js|ts`
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+7
 to 
+15

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Improve Sentry initialization for Node.js runtime
The Sentry initialization for Node.js looks generally correct, but there are a few points to consider:
  1. Setting tracesSampleRate to 1 might be too high for production, as it samples 100% of transactions.
  2. There's no error handling if SENTRY_DSN is undefined.
Consider refactoring the Node.js initialization as follows:
if(process.env.NEXT_RUNTIME==="nodejs"){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn('Sentry DSN not provided. Skipping Sentry initialization for Node.js runtime.');}}
This approach:
  • Adjusts tracesSampleRate based on the environment
  • Adds error handling for missing SENTRY_DSN
  • Uses the SENTRY_ENVIRONMENT variable we defined earlier

 // This is your Sentry.init call from `sentry.edge.config.js|ts`
 if (process.env.NEXT_RUNTIME === "edge") {
 Sentry.init({
 dsn: SENTRY_DSN,
 // Adjust this value in production, or use tracesSampler for greater control
 tracesSampleRate: 1,
 environment: SENTRY_ENVIRONMENT,
 });
 }

Comment on lines

+18
 to 
+25

@coderabbitaicoderabbitaiBotOct 3, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

🛠️ Refactor suggestion
Refactor Edge runtime initialization to reduce duplication
The Sentry initialization for Edge runtime is identical to the Node.js runtime, which leads to code duplication and the same potential issues we identified earlier.
Consider refactoring to reduce duplication and improve both initializations:
functioninitSentry(runtime: string){if(SENTRY_DSN){Sentry.init({dsn: SENTRY_DSN,tracesSampleRate: process.env.NODE_ENV==='production' ? 0.1 : 1,environment: SENTRY_ENVIRONMENT,});}else{console.warn(`Sentry DSN not provided. Skipping Sentry initialization for ${runtime} runtime.`);}}exportfunctionregister(){switch(process.env.NEXT_RUNTIME){case"nodejs":
initSentry("Node.js");break;case"edge":
initSentry("Edge");break;default:
console.warn(`Unexpected NEXT_RUNTIME value: ${process.env.NEXT_RUNTIME}`);}}
This refactored version:
  • Reduces code duplication
  • Improves error handling
  • Adjusts tracesSampleRate based on the environment
  • Provides more informative logging
}

2 changes: 1 addition & 1 deletion
next-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

20 changes: 9 additions & 11 deletions
next.config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -39,20 +39,18 @@ const config = {
 // Temporary to check pipelines due to weird error I can only get on CodePipeline
 ignoreBuildErrors: true,
 },
 experimental: {
 instrumentationHook: true,
 },
};

// Injected content via Sentry wizard below

const { withSentryConfig } = require("@sentry/nextjs");

module.exports = withSentryConfig(
 withMDX(withBundleAnalyzer(config)),
 {
 silent: true,
 org: "codu",
 project: "codu",
 },
 {
 hideSourceMaps: true,
 },
);
module.exports = withSentryConfig(withMDX(withBundleAnalyzer(config)), {
 silent: true,
 org: "codu",
 project: "codu",
 hideSourceMaps: true,
});
Loading