Uh oh!
There was an error while loading. Please reload this page.
feat: idiomatic graphql api - #769
Conversation
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThis pull request refactors the GraphQL API to follow idiomatic conventions: query names shift from REST-style (getMetaEnvelopeById, findMetaEnvelopesByOntology) to noun-based patterns (metaEnvelope, metaEnvelopes); list queries now support Relay-style cursor pagination with filtering and search; mutation payloads are restructured with explicit error blocks; envelope field ontology is renamed to fieldKey; X-ENAME header becomes required; legacy endpoints are preserved for backward compatibility. Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant GraphQLServer as GraphQL Server
participant DbService as DB Service
participant Registry as Platform Registry
participant WebhookTarget as Webhook Platform
Client->>GraphQLServer: createMetaEnvelope(input, X-ENAME)
GraphQLServer->>GraphQLServer: Validate X-ENAME header
GraphQLServer->>DbService: Store envelope data
DbService-->>GraphQLServer: Envelope created
GraphQLServer->>GraphQLServer: Compute envelopeHash
GraphQLServer->>GraphQLServer: Construct payload with envelopes + errors
GraphQLServer->>Registry: getActivePlatforms()
Registry-->>GraphQLServer: Platform URLs
GraphQLServer->>WebhookTarget: deliverWebhooks(POST)
WebhookTarget-->>GraphQLServer: Success/Error (async)
GraphQLServer-->>Client: CreateMetaEnvelopePayload {metaEnvelope, errors}
sequenceDiagram
participant Client
participant GraphQLServer as GraphQL Server
participant DbService as DB Service
Client->>GraphQLServer: metaEnvelopes(filter, first, after, X-ENAME)
GraphQLServer->>GraphQLServer: Validate X-ENAME header
GraphQLServer->>DbService: findMetaEnvelopesPaginated(eName, options)
DbService->>DbService: Execute count query
DbService->>DbService: Apply filter (ontologyId)
DbService->>DbService: Apply search (term, caseSensitive, fields, mode)
DbService->>DbService: Decode cursor (after/before)
DbService->>DbService: Fetch edges + compute cursors
DbService->>DbService: Build PageInfo (hasNextPage, hasPreviousPage)
DbService-->>GraphQLServer: MetaEnvelopeConnection {edges, pageInfo, totalCount}
GraphQLServer-->>Client: Connection with paginated results
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@infrastructure/evault-core/src/core/db/db.service.ts`:
- Around line 1068-1255: Add validation to reject mixed-direction cursors and
fix pageInfo backward-flag checks: extend the existing pagination validation
that currently checks "first & last" and "after & before" to also throw when
first is provided with before and when last is provided with after (refer to the
variables first, last, before, after and the validation block at the top of the
function). Then update the pageInfo construction so backward pagination
(isBackward) uses before for hasNextPage and hasExtraRecord for hasPreviousPage,
i.e. set hasNextPage = isBackward ? (before !== undefined) : hasExtraRecord and
hasPreviousPage = isBackward ? hasExtraRecord : (after !== undefined) (refer to
isBackward and pageInfo).
🧹 Nitpick comments (2)
infrastructure/evault-core/src/core/protocol/typedefs.ts (2)
15-21: Minor: Consider usingID!forMetaEnvelope.idfor consistency.The new idiomatic queries/mutations use
ID!for identifier parameters (e.g.,metaEnvelope(id: ID!),DeleteMetaEnvelopePayload.deletedId: ID!), but the type definition usesString!. While they serialize identically, usingID!throughout communicates identifier semantics more clearly and improves schema consistency.♻️ Suggested change
type MetaEnvelope { - id: String!+ id: ID! "The ontology schema ID (W3ID)" ontology: String! envelopes: [Envelope!]! parsed: JSON }Same applies to
Envelope.idon line 6.
96-108: Consider using non-nullable empty array forerrorsfield.Currently
errors: [UserError!]is nullable, meaning clients must distinguish betweennull(no errors) and[](empty array). Using[UserError!]!(non-nullable, possibly empty) simplifies client handling—an empty array always means success.This is a stylistic choice; the current pattern (null = no errors) is also valid and commonly used.
Uh oh!
There was an error while loading. Please reload this page.
Description of change
adds idiomatic graphql methods
Issue Number
Closes#724
Type of change
How the change has been tested
n/a
Change checklist
Summary by CodeRabbit
Release Notes
New Features
API Changes
ontologytofieldKeyDocumentation