Cleanup and centralize all our "once per pageload" stuff (#61)

nedtwigg · web-flow · commit 1e0358760e4a · 2025-09-18T10:00:57.000-07:00
diff --git a/src/entrypoints/content.ts b/src/entrypoints/content.ts
@@ -1,4 +1,3 @@
-import { CONFIG } from '../lib/config'
 import type { CommentEvent, CommentSpot, StrippedLocation } from '../lib/enhancer'
 import { logger } from '../lib/logger'
 import { EnhancerRegistry, TextareaRegistry } from '../lib/registries'
@@ -98,8 +97,6 @@ function enhanceMaybe(textarea: HTMLTextAreaElement) {
     logger.debug('textarea already registered {}', textarea)
     return
   }
-
-  injectStyles()
   try {
     const location = detectLocation()
     logger.debug('[gitcasso] Calling tryToEnhance with location:', location)
@@ -118,18 +115,3 @@ function enhanceMaybe(textarea: HTMLTextAreaElement) {
     logger.error(e)
   }
 }
-
-const STYLES = `
-.${CONFIG.ADDED_OVERTYPE_CLASS} {
-  background: cyan !important;
-}
-`
-
-function injectStyles(): void {
-  if (!document.getElementById('gitcasso-styles')) {
-    const style = document.createElement('style')
-    style.textContent = STYLES
-    style.id = 'gitcasso-styles'
-    document.head.appendChild(style)
-  }
-}
diff --git a/src/lib/config.ts b/src/lib/config.ts
@@ -7,7 +7,6 @@ const LOG_LEVELS = ['DEBUG', 'INFO', 'WARN', 'ERROR'] as const
 export type LogLevel = (typeof LOG_LEVELS)[number]
 
 export const CONFIG = {
-  ADDED_OVERTYPE_CLASS: 'gitcasso-overtype',
   EXTENSION_NAME: 'gitcasso', // decorates logs
   LOG_LEVEL: 'DEBUG' satisfies LogLevel,
   MODE: 'PROD' satisfies ModeType,
diff --git a/src/lib/enhancer.ts b/src/lib/enhancer.ts
@@ -37,12 +37,8 @@ export interface CommentEnhancer<Spot extends CommentSpot = CommentSpot> {
    * If we return non-null, then we become the handler for that text area.
    */
   tryToEnhance(textarea: HTMLTextAreaElement, location: StrippedLocation): Spot | null
-  /** This gets called the first time that `tryToEnhance` returns non-null. */
-  prepareForFirstEnhancement(): void
   /**
    * If `tryToEnhance` returns non-null, then this gets called.
-   * It is guaranteed that `prepareForFirstEnhancement` has been called
-   * exactly once since pageload before this gets called.
    */
   enhance(textarea: HTMLTextAreaElement, spot: Spot): OverTypeInstance
   /** Returns a ReactNode which will be displayed in the table row. */
diff --git a/src/lib/enhancers/CommentEnhancerMissing.tsx b/src/lib/enhancers/CommentEnhancerMissing.tsx
@@ -43,9 +43,6 @@ export class CommentEnhancerMissing implements CommentEnhancer {
   tryToEnhance(_textarea: HTMLTextAreaElement, _location: StrippedLocation): CommentSpot | null {
     throw new Error('Method not implemented.')
   }
-  prepareForFirstEnhancement(): void {
-    throw new Error('Method not implemented.')
-  }
   enhance(_textarea: HTMLTextAreaElement, _spot: CommentSpot): OverTypeInstance {
     throw new Error('Method not implemented.')
   }
diff --git a/src/lib/enhancers/github/githubEditComment.tsx b/src/lib/enhancers/github/githubEditComment.tsx
@@ -4,7 +4,7 @@ import type { CommentEnhancer, CommentSpot } from '@/lib/enhancer'
 import { logger } from '@/lib/logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGithubOptions } from './ghOptions'
-import { githubHighlighter } from './githubHighlighter'
+import { prepareGitHubHighlighter } from './githubHighlighter'
 
 export interface GitHubEditCommentSpot extends CommentSpot {
   type: 'GH_EDIT_COMMENT'
@@ -48,11 +48,8 @@ export class GitHubEditCommentEnhancer implements CommentEnhancer<GitHubEditComm
     }
   }
 
-  prepareForFirstEnhancement(): void {
-    OverType.setCodeHighlighter(githubHighlighter)
-  }
-
   enhance(textArea: HTMLTextAreaElement, _spot: GitHubEditCommentSpot): OverTypeInstance {
+    prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
     return new OverType(overtypeContainer, {
       ...commonGithubOptions,
diff --git a/src/lib/enhancers/github/githubHighlighter.ts b/src/lib/enhancers/github/githubHighlighter.ts
@@ -1,6 +1,14 @@
 import hljs from 'highlight.js'
+import OverType from 'overtype'
+import { oncePerRefresh } from '@/lib/once-per-refresh'
 
-export function githubHighlighter(code: string, language?: string) {
+export function prepareGitHubHighlighter() {
+  oncePerRefresh('github-highlighter', () => {
+    OverType.setCodeHighlighter(githubHighlighter)
+  })
+}
+
+function githubHighlighter(code: string, language?: string) {
   try {
     if (language && hljs.getLanguage(language)) {
       const result = hljs.highlight(code, { language })
diff --git a/src/lib/enhancers/github/githubIssueAddComment.tsx b/src/lib/enhancers/github/githubIssueAddComment.tsx
@@ -5,7 +5,7 @@ import type { CommentEnhancer, CommentSpot, StrippedLocation } from '@/lib/enhan
 import { logger } from '@/lib/logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGithubOptions } from './ghOptions'
-import { githubHighlighter } from './githubHighlighter'
+import { prepareGitHubHighlighter } from './githubHighlighter'
 
 export interface GitHubIssueAddCommentSpot extends CommentSpot {
   type: 'GH_ISSUE_ADD_COMMENT'
@@ -53,11 +53,8 @@ export class GitHubIssueAddCommentEnhancer implements CommentEnhancer<GitHubIssu
     }
   }
 
-  prepareForFirstEnhancement(): void {
-    OverType.setCodeHighlighter(githubHighlighter)
-  }
-
   enhance(textArea: HTMLTextAreaElement, _spot: GitHubIssueAddCommentSpot): OverTypeInstance {
+    prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
     return new OverType(overtypeContainer, {
       ...commonGithubOptions,
diff --git a/src/lib/enhancers/github/githubIssueNewComment.tsx b/src/lib/enhancers/github/githubIssueNewComment.tsx
@@ -3,7 +3,7 @@ import type { CommentEnhancer, CommentSpot, StrippedLocation } from '../../enhan
 import { logger } from '../../logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGithubOptions } from './ghOptions'
-import { githubHighlighter } from './githubHighlighter'
+import { prepareGitHubHighlighter } from './githubHighlighter'
 
 interface GitHubIssueNewCommentSpot extends CommentSpot {
   type: 'GH_ISSUE_NEW_COMMENT'
@@ -42,11 +42,8 @@ export class GitHubIssueNewCommentEnhancer implements CommentEnhancer<GitHubIssu
     }
   }
 
-  prepareForFirstEnhancement(): void {
-    OverType.setCodeHighlighter(githubHighlighter)
-  }
-
   enhance(textArea: HTMLTextAreaElement, _spot: GitHubIssueNewCommentSpot): OverTypeInstance {
+    prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
     return new OverType(overtypeContainer, {
       ...commonGithubOptions,
diff --git a/src/lib/enhancers/github/githubPRAddComment.tsx b/src/lib/enhancers/github/githubPRAddComment.tsx
@@ -4,7 +4,7 @@ import type { CommentEnhancer, CommentSpot, StrippedLocation } from '@/lib/enhan
 import { logger } from '@/lib/logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGithubOptions } from './ghOptions'
-import { githubHighlighter } from './githubHighlighter'
+import { prepareGitHubHighlighter } from './githubHighlighter'
 
 export interface GitHubPRAddCommentSpot extends CommentSpot {
   type: 'GH_PR_ADD_COMMENT' // Override to narrow from string to specific union
@@ -49,11 +49,8 @@ export class GitHubPRAddCommentEnhancer implements CommentEnhancer<GitHubPRAddCo
     }
   }
 
-  prepareForFirstEnhancement(): void {
-    OverType.setCodeHighlighter(githubHighlighter)
-  }
-
   enhance(textArea: HTMLTextAreaElement, _spot: GitHubPRAddCommentSpot): OverTypeInstance {
+    prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
     return new OverType(overtypeContainer, {
       ...commonGithubOptions,
diff --git a/src/lib/enhancers/github/githubPRNewComment.tsx b/src/lib/enhancers/github/githubPRNewComment.tsx
@@ -3,7 +3,7 @@ import type { CommentEnhancer, CommentSpot, StrippedLocation } from '../../enhan
 import { logger } from '../../logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGithubOptions } from './ghOptions'
-import { githubHighlighter } from './githubHighlighter'
+import { prepareGitHubHighlighter } from './githubHighlighter'
 
 interface GitHubPRNewCommentSpot extends CommentSpot {
   type: 'GH_PR_NEW_COMMENT'
@@ -50,11 +50,8 @@ export class GitHubPRNewCommentEnhancer implements CommentEnhancer<GitHubPRNewCo
     }
   }
 
-  prepareForFirstEnhancement(): void {
-    OverType.setCodeHighlighter(githubHighlighter)
-  }
-
   enhance(textArea: HTMLTextAreaElement, _spot: GitHubPRNewCommentSpot): OverTypeInstance {
+    prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
     return new OverType(overtypeContainer, {
       ...commonGithubOptions,
diff --git a/src/lib/enhancers/github/githubSpotTypes.ts b/src/lib/enhancers/github/githubSpotTypes.ts
diff --git a/src/lib/once-per-refresh.ts b/src/lib/once-per-refresh.ts
@@ -0,0 +1,13 @@
+const hasRunSinceTheLastFullPageload = new Set<string>()
+
+/**
+ * This function helps you run a given function only once per full pageload.
+ * So this will not run again due to turbolink navigation.
+ */
+export function oncePerRefresh(key: string, fun: () => void) {
+  if (hasRunSinceTheLastFullPageload.has(key)) {
+    return
+  }
+  fun()
+  hasRunSinceTheLastFullPageload.add(key)
+}
diff --git a/src/lib/registries.ts b/src/lib/registries.ts
@@ -17,7 +17,6 @@ export interface EnhancedTextarea<T extends CommentSpot = CommentSpot> {
 
 export class EnhancerRegistry {
   private enhancers = new Set<CommentEnhancer>()
-  private preparedEnhancers = new Set<CommentEnhancer>()
   byType = new Map<string, CommentEnhancer>()
 
   constructor() {
@@ -66,11 +65,6 @@ export class EnhancerRegistry {
       try {
         const spot = enhancer.tryToEnhance(textarea, location)
         if (spot) {
-          // Prepare enhancer on first use
-          if (!this.preparedEnhancers.has(enhancer)) {
-            enhancer.prepareForFirstEnhancement()
-            this.preparedEnhancers.add(enhancer)
-          }
           const overtype = enhancer.enhance(textarea, spot)
           this.handleDelayedValueInjection(overtype)
           return { enhancer, overtype, spot, textarea }
diff --git a/tests/corpus-view.ts b/tests/corpus-view.ts
@@ -329,7 +329,7 @@ app.post('/rebuild', async (_req, res) => {
 
     // Run pnpm run build:dev
     const buildProcess = spawn('pnpm', ['run', 'build:dev'], {
-      cwd: path.join(__dirname, '..', '..'),
+      cwd: path.join(__dirname, '..'),
       stdio: ['pipe', 'pipe', 'pipe'],
     })
 

Original file line number	Diff line number	Diff line change
`@@ -43,9 +43,6 @@ export class CommentEnhancerMissing implements CommentEnhancer {`
`43`	`43`	`tryToEnhance(_textarea: HTMLTextAreaElement, _location: StrippedLocation): CommentSpot \| null {`
`44`	`44`	`throw new Error('Method not implemented.')`
`45`	`45`	`}`
`46`		`- prepareForFirstEnhancement(): void {`
`47`		`- throw new Error('Method not implemented.')`
`48`		`- }`
`49`	`46`	`enhance(_textarea: HTMLTextAreaElement, _spot: CommentSpot): OverTypeInstance {`
`50`	`47`	`throw new Error('Method not implemented.')`
`51`	`48`	`}`