[ENG-1224 & ENG-343] Replaced fuzzy with minisearch in Discourse Summoning Menu#694
Conversation
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
|
This pull request has been ignored for the connected project Preview Branches by Supabase. |
📝 WalkthroughWalkthroughRefactors the DiscourseNodeSearchMenu component to replace fuzzy-based local search with MiniSearch-based indexing. Adds minisearch as a dependency and updates the search implementation to index nodes during initial load and perform searches via MiniSearch queries, while preserving existing UI behavior. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In @apps/roam/package.json:
- Line 63: Remove the unused "fuzzy" dependency entry from package.json (the
line containing "fuzzy": "^0.1.3") since the project now uses minisearch; update
the dependencies block by deleting that dependency and run a package manager
clean/install (npm/yarn/pnpm) to update lockfile and node_modules accordingly.
In @apps/roam/src/components/DiscourseNodeSearchMenu.tsx:
- Around line 399-402: The capture call uses item.id which can be undefined
because Result only guarantees text and uid and searchWithMiniSearch maps
results without id; update the mapping in searchWithMiniSearch (and any places
mapping MiniSearch results) to include id: result.uid so items include id, or
change the posthog.capture call in DiscourseNodeSearchMenu to use item.uid (with
a fallback to item.id) — adjust the Result type if needed and update
searchNodesForType mappings to remain consistent with the new shape.
🧹 Nitpick comments (4)
apps/roam/src/components/DiscourseNodeSearchMenu.tsx (4)
168-176: Excessive type casting suggests typing mismatch.The
as unknown as MinisearchResultcasts indicate that MiniSearch's generic typing isn't being leveraged correctly. MiniSearch supports generics that should eliminate these casts.The
MiniSearch.search()method should return properly typed results when the instance is typed asMiniSearch<MinisearchResult>. Consider verifying the MiniSearch type definitions to avoid runtime type assumptions.MiniSearch typescript generics storeFields return type
195-195: Document the score threshold magic number.The
0.1score threshold is undocumented. Consider extracting this to a named constant with a comment explaining why this threshold was chosen.💡 Suggested improvement
+// Minimum relevance score threshold - filters out very weak matches +const MIN_SEARCH_SCORE = 0.1; + // In searchWithMiniSearch: -const filteredResults = rawSearchResults.filter((r) => r.score > 0.1); +const filteredResults = rawSearchResults.filter((r) => r.score > MIN_SEARCH_SCORE);
158-160: Remove or gate performance logging for production.Multiple
console.logstatements (lines 158-160, 223-225, 284-286) will output to the console in production. Consider removing them or gating behind a debug flag.💡 Suggested improvement
+const DEBUG_SEARCH = process.env.NODE_ENV === 'development'; + // Then wrap logs: -console.log( - `[MiniSearch] Empty search - ${allDocuments} total documents, ${searchDuration.toFixed(2)}ms`, -); +if (DEBUG_SEARCH) { + console.log( + `[MiniSearch] Empty search - ${allDocuments} total documents, ${searchDuration.toFixed(2)}ms`, + ); +}
111-141: Consider movingsearchNodesForTypeoutside the component.This function doesn't depend on component props or state, so it could be defined outside the component to avoid recreation on each render.
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (2)
apps/roam/package.jsonapps/roam/src/components/DiscourseNodeSearchMenu.tsx
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/main.mdc)
**/*.{ts,tsx}: Use Tailwind CSS for styling where possible
When refactoring inline styles, use tailwind classes
Prefertypeoverinterfacein TypeScript
Use explicit return types for functions
Avoidanytypes when possible
Prefer arrow functions over regular function declarations
Use named parameters (object destructuring) when a function has more than 2 parameters
Use PascalCase for components and types
Use camelCase for variables and functions
Use UPPERCASE for constants
Function names should describe their purpose clearly
Prefer early returns over nested conditionals for better readability
Files:
apps/roam/src/components/DiscourseNodeSearchMenu.tsx
apps/roam/**/*.{js,ts,tsx,jsx,json}
📄 CodeRabbit inference engine (.cursor/rules/roam.mdc)
Prefer existing dependencies from package.json when working on the Roam Research extension
Files:
apps/roam/src/components/DiscourseNodeSearchMenu.tsxapps/roam/package.json
apps/roam/**/*.{ts,tsx,jsx,js,css,scss}
📄 CodeRabbit inference engine (.cursor/rules/roam.mdc)
Use BlueprintJS 3 components and Tailwind CSS for platform-native UI in the Roam Research extension
Files:
apps/roam/src/components/DiscourseNodeSearchMenu.tsx
apps/roam/**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (.cursor/rules/roam.mdc)
apps/roam/**/*.{ts,tsx,js,jsx}: Use the roamAlphaApi docs from https://roamresearch.com/#/app/developer-documentation/page/tIaOPdXCj when implementing Roam functionality
Use Roam Depot/Extension API docs from https://roamresearch.com/#/app/developer-documentation/page/y31lhjIqU when implementing extension functionality
Files:
apps/roam/src/components/DiscourseNodeSearchMenu.tsx
apps/roam/**
📄 CodeRabbit inference engine (.cursor/rules/roam.mdc)
Implement the Discourse Graph protocol in the Roam Research extension
Files:
apps/roam/src/components/DiscourseNodeSearchMenu.tsxapps/roam/package.json
🧠 Learnings (8)
📚 Learning: 2025-06-22T10:40:52.752Z
Learnt from: sid597
Repo: DiscourseGraphs/discourse-graph PR: 232
File: apps/roam/src/utils/getAllDiscourseNodesSince.ts:18-31
Timestamp: 2025-06-22T10:40:52.752Z
Learning: In apps/roam/src/utils/getAllDiscourseNodesSince.ts, the user confirmed that querying for `?title` with `:node/title` and mapping it to the `text` field in the DiscourseGraphContent type is the correct implementation for retrieving discourse node content from Roam Research, despite it appearing to query page titles rather than block text content.
Applied to files:
apps/roam/src/components/DiscourseNodeSearchMenu.tsx
📚 Learning: 2025-08-25T15:53:21.799Z
Learnt from: sid597
Repo: DiscourseGraphs/discourse-graph PR: 372
File: apps/roam/src/components/DiscourseNodeMenu.tsx:116-116
Timestamp: 2025-08-25T15:53:21.799Z
Learning: In apps/roam/src/components/DiscourseNodeMenu.tsx, when handling tag insertion, multiple leading hashtags (like ##foo) should be preserved as they represent user intent, not normalized to a single hashtag. The current regex /^#/ is correct as it only removes one leading # before adding one back, maintaining any additional hashtags the user intended.
Applied to files:
apps/roam/src/components/DiscourseNodeSearchMenu.tsx
📚 Learning: 2025-11-25T00:52:41.934Z
Learnt from: CR
Repo: DiscourseGraphs/discourse-graph PR: 0
File: .cursor/rules/roam.mdc:0-0
Timestamp: 2025-11-25T00:52:41.934Z
Learning: Applies to apps/roam/**/*.{js,ts,tsx,jsx,json} : Prefer existing dependencies from package.json when working on the Roam Research extension
Applied to files:
apps/roam/package.json
📚 Learning: 2025-11-25T00:52:36.174Z
Learnt from: CR
Repo: DiscourseGraphs/discourse-graph PR: 0
File: .cursor/rules/obsidian.mdc:0-0
Timestamp: 2025-11-25T00:52:36.174Z
Learning: Applies to apps/obsidian/** : Prefer existing dependencies from apps/obsidian/package.json when adding dependencies to the Obsidian plugin
Applied to files:
apps/roam/package.json
📚 Learning: 2025-08-11T19:09:58.252Z
Learnt from: maparent
Repo: DiscourseGraphs/discourse-graph PR: 337
File: apps/roam/src/components/DiscourseFloatingMenu.tsx:43-43
Timestamp: 2025-08-11T19:09:58.252Z
Learning: The roam subdirectory (apps/roam) is constrained to React 17 and cannot use React 18+ features like createRoot API. ReactDOM.render should be used instead of createRoot in this subdirectory.
Applied to files:
apps/roam/package.json
📚 Learning: 2025-11-25T00:52:41.934Z
Learnt from: CR
Repo: DiscourseGraphs/discourse-graph PR: 0
File: .cursor/rules/roam.mdc:0-0
Timestamp: 2025-11-25T00:52:41.934Z
Learning: Applies to apps/roam/**/*.{ts,tsx,js,jsx} : Use the roamAlphaApi docs from https://roamresearch.com/#/app/developer-documentation/page/tIaOPdXCj when implementing Roam functionality
Applied to files:
apps/roam/package.json
📚 Learning: 2025-11-25T00:52:41.934Z
Learnt from: CR
Repo: DiscourseGraphs/discourse-graph PR: 0
File: .cursor/rules/roam.mdc:0-0
Timestamp: 2025-11-25T00:52:41.934Z
Learning: Applies to apps/roam/**/*.{ts,tsx,jsx,js,css,scss} : Use BlueprintJS 3 components and Tailwind CSS for platform-native UI in the Roam Research extension
Applied to files:
apps/roam/package.json
📚 Learning: 2025-11-25T00:52:41.934Z
Learnt from: CR
Repo: DiscourseGraphs/discourse-graph PR: 0
File: .cursor/rules/roam.mdc:0-0
Timestamp: 2025-11-25T00:52:41.934Z
Learning: Applies to apps/roam/**/*.{ts,tsx,js,jsx} : Use Roam Depot/Extension API docs from https://roamresearch.com/#/app/developer-documentation/page/y31lhjIqU when implementing extension functionality
Applied to files:
apps/roam/package.json
🧬 Code graph analysis (1)
apps/roam/src/components/DiscourseNodeSearchMenu.tsx (4)
apps/roam/src/utils/types.ts (1)
Result(42-46)apps/obsidian/src/components/canvas/TldrawView.tsx (1)
onClose(228-256)apps/obsidian/src/components/BulkIdentifyDiscourseNodesModal.tsx (1)
onClose(442-447)apps/obsidian/src/components/DiscourseContextView.tsx (1)
onClose(145-150)
🪛 GitHub Actions: CI
apps/roam/package.json
[error] 1-1: The importer resolution is broken at dependency "react": version "19.1.1" doesn't satisfy range "18.2.0"
🔇 Additional comments (4)
apps/roam/src/components/DiscourseNodeSearchMenu.tsx (4)
38-40: LGTM!The
MinisearchResulttype cleanly extendsResultwith the requiredtypefield for MiniSearch integration.
254-279: LGTM!The MiniSearch initialization is well-structured:
- Proper configuration with
fields,storeFields, andidField- Efficient bulk indexing with
addAll()- Correct storage in ref for persistence across renders
299-314: LGTM!The search effect correctly:
- Guards against loading/uninitialized state
- Filters types based on user selection
- Includes all necessary dependencies
711-723: LGTM!The use of
ReactDOM.renderandReactDOM.unmountComponentAtNodeis correct for this codebase, as the roam subdirectory is constrained to React 17. Based on learnings, this is the expected pattern.
| if (!acc[result.type]) { | ||
| acc[result.type] = []; | ||
| } | ||
| if (acc[result.type].length < MAX_ITEMS_PER_TYPE) { |
There was a problem hiding this comment.
trangdoan982
changed the title
mdroidian
left a comment
mdroidian
left a comment
There was a problem hiding this comment.
Looks like this initial task might have fallen through the cracks:
Okay, so the first round of testing should be to verify the lag time for plugin-testing-akamatsulab and plugin-testing-megacoglab, on computer (old one if possible) and phone, for current and proposed search strategy @doantrang982
Let's run the tests on larger graphs and on slower devices and record the results 👍
|
@mdroidian |
trangdoan982
force-pushed
the
eng-1224-implement-minisearch-library-for-node-summoning-menu-and
branch
from
55e38be to
a28d8b3
Compare
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
mdroidian
left a comment
mdroidian
left a comment
There was a problem hiding this comment.
Almost there, but looks like we are still missing some of the required data from the initial task :
Okay, so the first round of testing should be to verify the lag time for plugin-testing-akamatsulab and plugin-testing-megacoglab, on computer (old one if possible) and phone, for current and proposed search strategy @doantrang982
Let's run the tests on larger graphs and on slower devices and record the results 👍
RE:
it takes consistently ~200-300ms for me to index and query the megacog graph, which has ~5000 nodes. It seems like the order of magnitude scale for the number of nodes and query+index time is the same. So a graph with 10,000 nodes might take ~400-600ms to query (including fetching all the nodes -> index -> query). I think this is a good result for a large graph
What device were these tests run on? Did you run it on a phone or simulate a slower device as well?
trangdoan982
force-pushed
the
eng-1224-implement-minisearch-library-for-node-summoning-menu-and
branch
from
a28d8b3 to
0def4e0
Compare
Discourse Node Search Menu — Performance StatsSummary of indexing and search timings for the MiniSearch-based node summoning menu, from two test graphs (atkamatsulab2 ~2.8k nodes, megacog ~5.1k nodes), including iPhone Simulator runs. In conclusion I think that the indexing and querying time for minisearch will be within our range of 1-1.5s total query time for graphs up to ~20k nodes. 1. Summary
2. Estimations for other graph sizesScaling is based on the two measured graphs (2,831 and 5,128 nodes). Assumptions:
Estimated times (ms):
Rough formulas (N = number of nodes):
3. “Time to first result” (index + first search)
So for a 10k-node graph, expect about ~0.5 s until the first result (index + first search). For 50k nodes, about ~2.5 s for the index phase; typed search stays in the low single-digit ms. 4. Appendix of query time logsplugin-testing-atkamatsulab2
plugin-testing-megacoglab
iPhone Simulator (same graphs)atkamatsulab2 (2k nodes)
megacog (5k nodes)
|
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
bound search result when search term is empty Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
2 participants
https://www.loom.com/share/ed8e82e53a784c08a2befd4bd32ba98e
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.