-
Notifications
You must be signed in to change notification settings - Fork 5
Docs/registry and ontology fixes #759
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
Conversation
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughDocumentation updates to the Registry.md file with two terminology clarifications: replacing "Resolve W3IDs" with "Resolve eNames" and rewording the token verification description for improved clarity. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
0dae76b to
a944efc
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/docs/Infrastructure/Registry.md`:
- Line 13: The documentation uses "W3IDs" elsewhere but the diff changed a
single instance to "eNames" ("Resolve eNames"); make terminology consistent by
either reverting this change back to "Resolve W3IDs" or systematically replacing
all occurrences of "W3IDs" with "eNames" across the document; update the line
containing "Resolve eNames" and then run a global search for "W3IDs" (and
"eNames") in this file to ensure a single chosen term is used consistently
(update any headings, bullets, and references such as the instances at lines
referenced in the review).
- Line 15: Replace the grammatically incorrect line "Verify tokens supply JSON
Web Key Set to verify JWTs via public JWK endpoint" with a clear phrasing such
as "Verify JWTs using the JSON Web Key Set from the public JWK endpoint" (or
alternately "Verify tokens using the JSON Web Key Set provided via public JWK
endpoint" / "Supply JSON Web Key Set to verify JWTs via public JWK endpoint") so
the intent and grammar are fixed in the Registry.md documentation.
🧹 Nitpick comments (1)
platforms/dreamsync-api/src/services/AIMatchingService.ts (1)
145-156: Fragile userId extraction from raw query results.Line 153 uses
Object.values(r)[0]to extract the userId, which is implicit and could break if the query structure changes. Consider using an explicit column alias for more robust code:Suggested improvement
private async getAllWishlistUserIdsForNoMatch(): Promise<string[]> { const rows = await this.wishlistRepository .createQueryBuilder("wishlist") - .select("DISTINCT wishlist.userId") + .select("DISTINCT wishlist.userId", "userId") .leftJoin("wishlist.user", "user") .where("wishlist.isActive = :isActive", { isActive: true }) .andWhere("user.isPrivate = :isPrivate", { isPrivate: false }) - .getRawMany<Record<string, string>>(); - const userIds = rows.map(r => Object.values(r)[0]).filter(Boolean) as string[]; + .getRawMany<{ userId: string }>(); + const userIds = rows.map(r => r.userId).filter(Boolean); console.log(`📋 [no-match] Found ${userIds.length} distinct users with at least one active wishlist (including empty wishlists)`); return userIds; }
| The Registry enables clients and services to: | ||
|
|
||
| - **Resolve W3IDs** to service endpoints (eVault URIs, platform URLs) | ||
| - **Resolve eNames** to service endpoints (eVault URIs, platform URLs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent terminology: eNames vs W3IDs.
The change introduces "eNames" here, but the rest of the document continues to use "W3IDs" extensively (lines 7, 59, 61, 63, 77, 141, 149, 157). This inconsistency may confuse readers about whether these are the same concept or different identifiers.
Either revert this change to maintain "W3IDs" throughout, or update all references in the document to use "eNames" consistently.
📝 Option 1: Revert to maintain consistency with rest of document
-- **Resolve eNames** to service endpoints (eVault URIs, platform URLs)
+- **Resolve W3IDs** to service endpoints (eVault URIs, platform URLs)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Resolve eNames** to service endpoints (eVault URIs, platform URLs) | |
| - **Resolve W3IDs** to service endpoints (eVault URIs, platform URLs) |
🤖 Prompt for AI Agents
In `@docs/docs/Infrastructure/Registry.md` at line 13, The documentation uses
"W3IDs" elsewhere but the diff changed a single instance to "eNames" ("Resolve
eNames"); make terminology consistent by either reverting this change back to
"Resolve W3IDs" or systematically replacing all occurrences of "W3IDs" with
"eNames" across the document; update the line containing "Resolve eNames" and
then run a global search for "W3IDs" (and "eNames") in this file to ensure a
single chosen term is used consistently (update any headings, bullets, and
references such as the instances at lines referenced in the review).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nack, eName == W3ID with @ prefix, which is globally resolvable
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@coodos, thank you for the clarification! I understand now—eNames are W3IDs with the @ prefix, so the change to "Resolve eNames" is more precise for the Registry's resolution functionality. My suggestion to revert was incorrect.
✏️ Learnings added
Learnt from: coodos
Repo: MetaState-Prototype-Project/prototype PR: 759
File: docs/docs/Infrastructure/Registry.md:13-13
Timestamp: 2026-01-30T20:36:08.155Z
Learning: In the MetaState-Prototype-Project/prototype codebase: eName is a W3ID with the `@` prefix and is globally resolvable. The Registry resolves eNames (W3IDs with @ prefix) to service endpoints.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Description of change
address comments by @nsergey82
Issue Number
Type of change
How the change has been tested
Change checklist
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.