-
Notifications
You must be signed in to change notification settings - Fork 0
feat: OR filter for project board views #9
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.
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b923af2
docs(spec): add specification and implementation plan for OR filter o…
BigLep 042ebdb
feat: implement OR filter for project board views (spec 007)
BigLep 6ab1cbf
feat: add configurable board patterns for OR filter and update README
BigLep 399744f
fix: handle initial page load with OR query in URL
BigLep 6e4aa5d
fix: address review feedback — pagination, types, config, docs
BigLep File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
267 changes: 267 additions & 0 deletions
267
extension/src/content/board-filter/board-data-injector.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,267 @@ | ||
| /** | ||
| * Main-world fetch interceptor for project board OR queries. | ||
| * | ||
| * Runs in the PAGE's main world (injected via <script src> from board-filter-main.ts). | ||
| * Monkey-patches window.fetch to intercept calls to /memexes/{id}/paginated_items. | ||
| * | ||
| * On every paginated_items fetch, reads the filter bar's current value and checks | ||
| * for OR syntax. If found, intercepts the call, runs multi-branch fetch + merge, | ||
| * and returns the merged response. If not, passes through unchanged. | ||
| * | ||
| * Strategy: clone the original intercepted URL and only replace the `q` parameter | ||
| * for each branch. This preserves all native params (sortedBy, groupedBy, sliceBy, | ||
| * fieldIds, layout, sumFields, hierarchy) exactly as the React app sends them. | ||
| */ | ||
|
|
||
| import type { GroupedItemsResponse, GroupItems } from './memex-api.js' | ||
| import { mergeResponses } from './result-merger.js' | ||
| import { parseORQuery } from './or-query-parser.js' | ||
|
|
||
| // Guard against double-injection (Turbo SPA navigation can re-run content scripts) | ||
| if ((window as unknown as Record<string, unknown>).__filozFetchInterceptorInstalled) { | ||
| // Already installed — skip | ||
| } else { | ||
| (window as unknown as Record<string, unknown>).__filozFetchInterceptorInstalled = true | ||
|
|
||
| const originalFetch = window.fetch.bind(window) | ||
|
|
||
| /** Track in-flight OR query so we can abort on supersession. */ | ||
| let activeController: AbortController | null = null | ||
|
|
||
| /** | ||
| * Fetch a single page and return the parsed JSON. | ||
| */ | ||
| async function fetchJson(url: string, signal?: AbortSignal): Promise<GroupedItemsResponse> { | ||
| const resp = await originalFetch(url, { | ||
| credentials: 'same-origin', | ||
| headers: { | ||
| Accept: 'application/json', | ||
| 'X-Requested-With': 'XMLHttpRequest', | ||
| }, | ||
| signal, | ||
| }) | ||
| if (!resp.ok) { | ||
| throw new Error(`paginated_items fetch failed: ${resp.status} ${resp.statusText}`) | ||
| } | ||
| return resp.json() | ||
| } | ||
|
|
||
| /** | ||
| * Clone a URL and replace the `q` parameter while removing pagination cursors. | ||
| */ | ||
| function cloneUrlWithQuery(originalUrl: URL, query: string): string { | ||
| const cloned = new URL(originalUrl.href) | ||
| cloned.searchParams.set('q', query) | ||
| // Remove pagination params — we want the first page for each branch | ||
| cloned.searchParams.delete('after') | ||
| // Remove group-scoped pagination (groupedBy[value]) — we want all groups | ||
| cloned.searchParams.delete('groupedBy[value]') | ||
| return cloned.href | ||
| } | ||
|
|
||
| /** | ||
| * Build a pagination URL for a specific group within a branch response. | ||
| */ | ||
| function buildPaginationUrl(originalUrl: URL, query: string, group: GroupItems, endCursor: string): string { | ||
| const cloned = new URL(originalUrl.href) | ||
| cloned.searchParams.set('q', query) | ||
| cloned.searchParams.set('after', endCursor) | ||
| // Scope pagination to the specific group | ||
| cloned.searchParams.set('groupedBy[value]', group.groupId) | ||
| return cloned.href | ||
| } | ||
|
|
||
| /** | ||
| * Fetch all items for a single branch query, following pagination cursors per group. | ||
| */ | ||
| async function fetchBranch( | ||
| originalUrl: URL, | ||
| query: string, | ||
| signal: AbortSignal, | ||
| ): Promise<GroupedItemsResponse> { | ||
| const firstUrl = cloneUrlWithQuery(originalUrl, query) | ||
| console.log('[FilOz] Branch fetch:', query, '→', firstUrl) | ||
| const first = await fetchJson(firstUrl, signal) | ||
|
|
||
| // Follow pagination within each group | ||
| const groupedItems: GroupItems[] = first.groupedItems.map((g) => ({ | ||
| ...g, | ||
| nodes: [...g.nodes], | ||
| })) | ||
|
|
||
| for (let idx = 0; idx < groupedItems.length; idx++) { | ||
| let current = groupedItems[idx] | ||
| while (current.pageInfo?.hasNextPage && current.pageInfo.endCursor) { | ||
| const nextUrl = buildPaginationUrl(originalUrl, query, current, current.pageInfo.endCursor) | ||
| const nextPage = await fetchJson(nextUrl, signal) | ||
| // When paginating with groupedBy[value], the API may return only the | ||
| // requested group (at index 0), not at the original group index. | ||
| // Find the matching group by groupId rather than assuming index alignment. | ||
| const nextGroup = nextPage.groupedItems?.find( | ||
| (g) => g.groupId === current.groupId, | ||
| ) ?? nextPage.groupedItems?.[0] | ||
| if (!nextGroup) break | ||
| groupedItems[idx].nodes.push(...nextGroup.nodes) | ||
| current = nextGroup | ||
| } | ||
| groupedItems[idx].pageInfo = { | ||
| ...groupedItems[idx].pageInfo, | ||
| hasNextPage: false, | ||
| } | ||
| } | ||
|
|
||
| return { ...first, groupedItems } | ||
| } | ||
|
|
||
| /** | ||
| * Execute multi-branch fetch and merge for an OR query. | ||
| */ | ||
| async function executeBranchFetches( | ||
| originalUrl: URL, | ||
| prefix: string, | ||
| branches: string[], | ||
| ): Promise<GroupedItemsResponse> { | ||
| // Abort any previous in-flight OR query | ||
| activeController?.abort() | ||
| const controller = new AbortController() | ||
| activeController = controller | ||
|
|
||
| const branchQueries = branches.map((branch) => | ||
| prefix ? `${prefix} ${branch}` : branch, | ||
| ) | ||
|
|
||
| console.log('[FilOz] Fetching', branchQueries.length, 'branches:', branchQueries) | ||
|
|
||
| const results = await Promise.all( | ||
| branchQueries.map((query) => fetchBranch(originalUrl, query, controller.signal)), | ||
| ) | ||
|
|
||
| activeController = null | ||
| const merged = mergeResponses(results) | ||
| console.log('[FilOz] Merged results:', merged.totalCount.value, 'items') | ||
| return merged | ||
| } | ||
|
|
||
| // Monkey-patch fetch | ||
| window.fetch = async function patchedFetch( | ||
| input: RequestInfo | URL, | ||
| init?: RequestInit, | ||
| ): Promise<Response> { | ||
| // Parse the URL from the request | ||
| let url: URL | ||
| try { | ||
| const rawUrl = typeof input === 'string' ? input : input instanceof URL ? input.href : input.url | ||
| url = new URL(rawUrl, window.location.origin) | ||
| } catch { | ||
| return originalFetch(input, init) | ||
| } | ||
|
|
||
| // Only intercept initial paginated_items requests (not pagination follow-ups) | ||
| const match = url.pathname.match(/\/memexes\/(\d+)\/paginated_items/) | ||
| if (!match) return originalFetch(input, init) | ||
|
|
||
| // Skip pagination requests (these are follow-ups we handle internally) | ||
| if (url.searchParams.has('after')) return originalFetch(input, init) | ||
|
|
||
| // Read the filter bar's current value to check for OR syntax | ||
| const filterInput = document.querySelector<HTMLInputElement>('input#filter-bar-component-input') | ||
| if (!filterInput) return originalFetch(input, init) | ||
|
|
||
| const filterText = filterInput.value | ||
| const parseResult = parseORQuery(filterText) | ||
|
|
||
| if (parseResult.kind !== 'or_query') { | ||
| if (parseResult.kind === 'invalid_or') { | ||
| console.warn('[FilOz] Invalid OR syntax, passing through:', parseResult.error.message) | ||
| } | ||
| return originalFetch(input, init) | ||
| } | ||
|
|
||
| const { prefix, branches } = parseResult.query | ||
|
|
||
| console.log('[FilOz] Intercepted paginated_items for OR query, memex', match[1]) | ||
|
|
||
| try { | ||
| const merged = await executeBranchFetches(url, prefix, branches) | ||
|
|
||
| return new Response(JSON.stringify(merged), { | ||
| status: 200, | ||
| statusText: 'OK', | ||
| headers: { 'Content-Type': 'application/json' }, | ||
| }) | ||
| } catch (err) { | ||
| if (err instanceof DOMException && err.name === 'AbortError') { | ||
| console.log('[FilOz] OR query fetch aborted (superseded)') | ||
| throw err | ||
| } | ||
| console.error('[FilOz] OR query fetch failed, falling through to native:', err) | ||
| return originalFetch(input, init) | ||
| } | ||
| } as typeof fetch | ||
|
|
||
| console.log('[FilOz] Fetch interceptor installed') | ||
|
|
||
| /** | ||
| * Handle initial page load with an OR query in the URL. | ||
| * | ||
| * On initial load, GitHub server-renders 0 results (it doesn't understand OR). | ||
| * Fix: wait for the filter bar, then append a space via execCommand. This | ||
| * creates a trusted InputEvent that React sees as a filter change. The new | ||
| * query (with trailing space) isn't in React's cache, so it fires a fresh | ||
| * paginated_items fetch — which our interceptor catches and returns merged | ||
| * data. The trailing space doesn't affect OR parsing (we trim). | ||
| * | ||
| * Important: do NOT remove the space afterward. React caches query results, | ||
| * and restoring the original text would return the cached 0-result response. | ||
| */ | ||
| function handleInitialOrQuery(): void { | ||
| const urlParams = new URLSearchParams(window.location.search) | ||
| const filterQuery = urlParams.get('filterQuery') | ||
| if (!filterQuery) return | ||
|
|
||
| const result = parseORQuery(filterQuery) | ||
| if (result.kind !== 'or_query') return | ||
|
|
||
| console.log('[FilOz] OR query in URL on initial load, will nudge filter bar') | ||
|
|
||
| function waitAndNudge(): void { | ||
| const input = document.querySelector<HTMLInputElement>('input#filter-bar-component-input') | ||
| if (input) { | ||
| nudge(input) | ||
| return | ||
| } | ||
| const observer = new MutationObserver(() => { | ||
| const el = document.querySelector<HTMLInputElement>('input#filter-bar-component-input') | ||
| if (!el) return | ||
| observer.disconnect() | ||
| nudge(el) | ||
| }) | ||
| observer.observe(document.documentElement, { childList: true, subtree: true }) | ||
| setTimeout(() => observer.disconnect(), 15_000) | ||
| } | ||
|
|
||
| function nudge(input: HTMLInputElement): void { | ||
| // Wait for React to finish mounting and the filter to be interactive | ||
| setTimeout(() => { | ||
| input.focus() | ||
| const val = input.value | ||
| if (val.endsWith(' ')) { | ||
| // Trailing space exists — remove it by selecting it and deleting | ||
| console.log('[FilOz] Nudging filter: removing trailing space to trigger re-fetch') | ||
| input.setSelectionRange(val.length - 1, val.length) | ||
| document.execCommand('delete') | ||
| } else { | ||
| // No trailing space — add one | ||
| console.log('[FilOz] Nudging filter: appending space to trigger re-fetch') | ||
| input.setSelectionRange(val.length, val.length) | ||
| document.execCommand('insertText', false, ' ') | ||
| } | ||
| }, 500) | ||
| } | ||
|
|
||
| waitAndNudge() | ||
| } | ||
|
|
||
| handleInitialOrQuery() | ||
|
|
||
| } // end guard | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /** | ||
| * Board Filter content script entry point. | ||
| * | ||
| * Architecture: content script (this file) → main-world script (board-data-injector.ts) | ||
| * → fetch interception → merge | ||
| * | ||
| * Runs at document_start to inject the main-world fetch interceptor BEFORE | ||
| * GitHub's React app initializes. This is critical so the interceptor can | ||
| * patch window.fetch before the React app makes its first API call. | ||
| * | ||
| * The config check (which boards are enabled) runs async but the injection | ||
| * must happen synchronously at startup to avoid missing the initial fetch. | ||
| * If the board doesn't match the config, the injector is a no-op (it only | ||
| * activates when OR syntax is detected in the filter bar). | ||
| */ | ||
|
|
||
| import { loadConfig, isOrFilterBoard } from '../../lib/project-config.js' | ||
|
|
||
| const LOG_PREFIX = '[FilOz:board-filter]' | ||
|
|
||
| /** Inject the main-world fetch interceptor immediately. */ | ||
| function injectMainWorldScript(): void { | ||
| const id = 'filoz-board-data-injector' | ||
| if (document.getElementById(id)) return | ||
|
|
||
| const script = document.createElement('script') | ||
| script.id = id | ||
| script.src = chrome.runtime.getURL('board-data-injector.js') | ||
| ;(document.head ?? document.documentElement).appendChild(script) | ||
| console.log(LOG_PREFIX, 'Main-world interceptor injected') | ||
| } | ||
|
|
||
| // Check the URL — if it looks like a project board, inject immediately. | ||
| // The config check runs async afterward; the injector is harmless on | ||
| // non-configured boards (only activates when OR syntax is in the filter bar). | ||
| const url = window.location.href | ||
| if (/github\.com\/orgs\/[^/]+\/projects\/\d+\/views\/\d+/.test(url)) { | ||
| console.log(LOG_PREFIX, 'Content script loaded (document_start)') | ||
| injectMainWorldScript() | ||
|
|
||
| // Async config check — if the board doesn't match, remove the injector | ||
| void loadConfig().then((cfg) => { | ||
| const baseUrl = url.replace(/\/views\/\d+.*$/, '') | ||
| if (!isOrFilterBoard(cfg, baseUrl)) { | ||
| console.log(LOG_PREFIX, 'OR filter not enabled for this board, disabling') | ||
| // Signal the injector to deactivate | ||
| document.dispatchEvent(new CustomEvent('filoz-or-filter-disabled')) | ||
| } else { | ||
| console.log(LOG_PREFIX, 'OR filter enabled for this board') | ||
| } | ||
| }) | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.