Skip to content

Conversation

@coodos
Copy link
Contributor

@coodos coodos commented Jan 30, 2026

Description of change

address comments by @nsergey82

Issue Number

Type of change

  • Docs (changes to the documentation)

How the change has been tested

Change checklist

  • I have ensured that the CI Checks pass locally
  • I have removed any unnecessary logic
  • My code is well documented
  • I have signed my commits
  • My code follows the pattern of the application
  • I have self reviewed my code

Summary by CodeRabbit

  • Documentation
    • Updated Registry documentation terminology and descriptions to enhance clarity and improve consistency across the guide.
    • Refined token verification explanations with more precise language to provide clearer guidance on verification procedures.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 30, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
Documentation Updates
docs/docs/Infrastructure/Registry.md
Terminology change from "W3IDs" to "eNames" and clarified token verification description to emphasize the JSON Web Key Set provided via public JWK endpoint.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • prototype#759: Includes identical documentation edits to Registry.md with the same terminology and token verification wording updates.

Poem

🐰 With ears held high and whiskers bright,
I hopped to fix the wording right,
From W3IDs to eNames we say,
And tokens verified the clearer way!

🚥 Pre-merge checks | ✅ 1 | ❌ 2
❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Title check ⚠️ Warning The title 'Docs/registry and ontology fixes' only partially aligns with the changeset, which includes feature additions (no-match notification system) alongside documentation updates. Revise the title to accurately reflect all significant changes, such as 'Add no-match notifications and update registry documentation' or split into multiple focused PRs.
Description check ⚠️ Warning The description is incomplete and misleading. It only mentions documentation changes, but the changeset contains substantial feature additions (no-match notification system) that are not documented. Update the description to include details about the new no-match notification feature, explain how it integrates with existing services, and provide testing information for both features.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/registry-and-ontology-fixes

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coodos coodos force-pushed the docs/registry-and-ontology-fixes branch from 0dae76b to a944efc Compare January 30, 2026 20:34
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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)
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 30, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
- **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).

Copy link
Contributor Author

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

Copy link
Contributor

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>
@coodos coodos merged commit 18a4049 into main Jan 30, 2026
3 checks passed
@coodos coodos deleted the docs/registry-and-ontology-fixes branch January 30, 2026 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants