Uh oh!
There was an error while loading. Please reload this page.
feat: ontology viewer - #748
Conversation
📝 WalkthroughWalkthroughAdds an Ontology viewer service (EJS UI + routes), five new JSON Schema files, removes userProfile schema, updates two web3 mapping schemaId values, expands pnpm workspace to include services/*, adds ejs dependency, removes a package manifest, and updates .gitignore. Changes
Sequence Diagram(s)sequenceDiagram
participant Client as Client (Browser)
participant Service as Ontology Service (Express)
participant SchemaFS as Schema Files (disk)
participant ViewEngine as EJS (renderer)
Client->>Service: GET /?q={query}
Service->>SchemaFS: Read schema files list
SchemaFS-->>Service: Return list of schemas
Service->>ViewEngine: Render index.ejs with list (and optional selected)
ViewEngine-->>Client: HTML page (list + drawer)
Client->>Service: GET /schemas/:uuid
Service->>SchemaFS: Read schema file :uuid
SchemaFS-->>Service: Return schema JSON
Service-->>Client: JSON schema
Client->>Client: Render drawer with schema details
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 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 |
| export const npm_config_verify_deps_before_run: string; | ||
| export const npm_config__jsr_registry: string; | ||
| export const CLOJURE_HOME: string; | ||
| export const MEMORY_PRESSURE_WRITE: string; |
There was a problem hiding this comment.
delete these and add a gitignore fr
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@services/ontology/schemas/vote.json`:
- Around line 32-55: Add a "required": ["mode"] entry to the "data" object
schema in services/ontology/schemas/vote.json so that data.mode is required and
must match the existing enum; specifically, inside the "data" property's object
(which contains "type": "object", "properties": { "mode": ... }), add the
required array to enforce the presence of "mode".
In `@services/ontology/src/index.js`:
- Around line 48-61: The getSchemaList function can throw when a schema lacks
title; make the mapping and filtering defensive by normalizing titles to strings
before using toLowerCase: when building list from schemaIndex in getSchemaList,
ensure each item's title is set to (schema.title || '') or String(schema.title
|| '') so title is never undefined, and in the filter reference the normalized
s.title (or guard with (s.title || '').toLowerCase()) when checking includes;
this ensures s.title.toLowerCase() cannot throw while preserving search
behavior.
🧹 Nitpick comments (4)
services/ontology/views/index.ejs (3)
155-161: Consider addingaria-modal="true"and focus trap for better accessibility.The drawer has good ARIA attributes (
role="dialog",aria-label), but for modal dialogs,aria-modal="true"should be added to indicate that content behind the drawer is inert. Additionally, there's no focus trap to prevent keyboard users from tabbing outside the open drawer.♿ Suggested accessibility improvement
- <div class="drawer-panel" id="drawerPanel" role="dialog" aria-label="Schema detail">+ <div class="drawer-panel" id="drawerPanel" role="dialog" aria-modal="true" aria-label="Schema detail">Consider also implementing a focus trap in JavaScript to keep keyboard focus within the drawer while it's open.
220-248: Good XSS prevention withescapeHtml, but consider URL encoding for the href.The
escapeHtmlfunction properly prevents XSS when building innerHTML. However, at line 225,escapeHtml(schema.schemaId)is used in the href attribute. WhileescapeHtmlhandles HTML entity encoding, it doesn't URL-encode special characters. Since schema IDs appear to be UUIDs (which only contain safe characters), this works, but for robustness, consider usingencodeURIComponentfor the URL path:🛡️ Suggested improvement for URL safety
- html += '<div class="raw-link"><a href="/schemas/' + escapeHtml(schema.schemaId) + '" target="_blank" rel="noopener">Raw JSON</a></div>';+ html += '<div class="raw-link"><a href="/schemas/' + encodeURIComponent(schema.schemaId) + '" target="_blank" rel="noopener">Raw JSON</a></div>';
245-248: Consider providing more specific error feedback to users.The catch block displays a generic "Failed to load schema" message. For better user experience, consider differentiating between network errors and "not found" responses.
💡 Suggested improvement
- .catch(function() {- content.innerHTML = '<p>Failed to load schema.</p>';+ .catch(function(err) {+ var msg = err && err.message === 'Not found' ? 'Schema not found.' : 'Failed to load schema.';+ content.innerHTML = '<p>' + msg + '</p>'; openDrawer(); });services/ontology/src/index.js (1)
93-111: Consider URL pattern consistency.The UI route uses
/schema/:uuid(singular) while the JSON API uses/schemas/:uuid(plural). This is a minor inconsistency that could confuse users. If intentional for distinguishing UI from API, consider documenting this convention.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Description of change
add ontology viewer
Issue Number
closes#747 (I love this number)
Type of change
How the change has been tested
Change checklist
Summary by CodeRabbit
New Features
Bug Fixes / Changes
Chores
✏️ Tip: You can customize this high-level summary in your review settings.