Skip to content

contributor-information: add contributor-information queries - #21

Merged
Kzoeps merged 12 commits into
mainfrom
queries/contributor-information
Oct 6, 2026
Merged

Kzoeps merged 12 commits into
mainfrom
queries/contributor-information

Conversation

@Kzoeps

@Kzoeps Kzoeps commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

Scope

Adds public org.hypercerts.claim.getContributorInformation and org.hypercerts.claim.listContributorInformation endpoints with repeated-author filters, cursor pagination, full records, nullable publisher sidecars, and runtime-test fixtures.

Validation

  • Offline pnpm test:unit: 105/105 tests passed; pnpm check and pnpm build passed locally.
  • Local pnpm test:http was not run. Unit tests use local fixtures/fake adapters and do not install handlers, seed PostgreSQL, or contact HappyView. CI HTTP coverage exercises real XRPC over HTTP against the installed HappyView + PostgreSQL test environment; its result is pending from PR creation.

Summary by CodeRabbit

  • New Features
    • Added API endpoints to retrieve a contributor-information record by URI or list records with optional author filtering, sorting, and pagination.
    • Responses include contributor records and available publisher profile and organization details.
  • Documentation
    • Added endpoint usage, query behavior, and local testing guidance to the API documentation.

@changeset-bot

changeset-bot Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3bc9fc9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@hypercerts-org/hypercerts-api Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel

vercel Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
api-endpoints Ready Ready Preview Oct 6, 2026 2:58pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 44 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: a4d065b5-e4b7-417c-bd3f-b68cf428fbc9
📥 Commits

Reviewing files that changed from the base of the PR and between 66d6e80 and 3bc9fc9.

📒 Files selected for processing (21)
  • .changeset/contributor-information-view-ref.md
  • CONTRIBUTING.md
  • README.md
  • api/README.md
  • api/lexicons/org.hypercerts.claim.getContributorInformation.json
  • api/lexicons/org.hypercerts.claim.listContributorInformation.json
  • api/lua/endpoints/getContributorInformation.lua
  • api/lua/endpoints/listContributorInformation.lua
  • api/lua/shared/contributorInformationValidation.lua
  • api/lua/src/getContributorInformation.lua
  • api/lua/src/listContributorInformation.lua
  • api/manifest.json
  • api/modules/contributor-information/manifest.json
  • api/tests/http/fixtures/contributor-information.fixture.js
  • api/tests/http/getContributorInformation.http.test.js
  • api/tests/http/listContributorInformation.http.test.js
  • api/tests/unit/fixtures/http-fixtures.test.js
  • api/tests/unit/tooling/getContributorInformation.test.js
  • api/tests/unit/tooling/lexicons.test.js
  • api/tests/unit/tooling/listContributorInformation.test.js
  • api/tests/unit/tooling/seed.test.js

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c09233a7-dc26-4a05-83d0-fd12e982bac8
📥 Commits

Reviewing files that changed from the base of the PR and between 02f4c8f and 66d6e80.

📒 Files selected for processing (20)
  • .changeset/contributor-information-view-ref.md
  • CONTRIBUTING.md
  • README.md
  • api/README.md
  • api/lexicons/org.hypercerts.claim.getContributorInformation.json
  • api/lexicons/org.hypercerts.claim.listContributorInformation.json
  • api/lua/endpoints/getContributorInformation.lua
  • api/lua/endpoints/listContributorInformation.lua
  • api/lua/shared/contributorInformationValidation.lua
  • api/lua/src/getContributorInformation.lua
  • api/lua/src/listContributorInformation.lua
  • api/manifest.json
  • api/modules/contributor-information/manifest.json
  • api/tests/http/fixtures/contributor-information.fixture.js
  • api/tests/http/getContributorInformation.http.test.js
  • api/tests/http/listContributorInformation.http.test.js
  • api/tests/unit/fixtures/http-fixtures.test.js
  • api/tests/unit/tooling/getContributorInformation.test.js
  • api/tests/unit/tooling/lexicons.test.js
  • api/tests/unit/tooling/listContributorInformation.test.js

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Adds registered queries to retrieve one contributor-information record or list records by author. The endpoints validate requests, query PostgreSQL, hydrate author profile and organization views, and support cursor pagination for listing.

Changes

Contributor information queries

Layer / File(s) Summary
Query contracts and registration
api/lexicons/org.hypercerts.claim.*ContributorInformation.json, api/lua/shared/contributorInformationValidation.lua, api/manifest.json, api/modules/contributor-information/manifest.json, api/tests/unit/tooling/lexicons.test.js, .changeset/*
Defines the get and list query inputs, outputs, and errors. Registers the lexicons and Lua scripts, and tests shared view ownership.
Single-record retrieval
api/lua/endpoints/getContributorInformation.lua, api/lua/src/getContributorInformation.lua, api/tests/http/getContributorInformation.http.test.js, api/tests/unit/tooling/getContributorInformation.test.js, api/tests/http/fixtures/contributor-information.fixture.js, api/tests/unit/fixtures/http-fixtures.test.js
Adds exact-URI record lookup, request validation, author-sidecar hydration, and missing-record and query-failure handling. Tests cover returned views, errors, and fixture identity checks.
Filtered listing and cursor pagination
api/lua/endpoints/listContributorInformation.lua, api/lua/src/listContributorInformation.lua, api/tests/http/listContributorInformation.http.test.js, api/tests/unit/tooling/listContributorInformation.test.js
Adds author filtering, sort and limit validation, cursor decoding, stable timestamp-and-URI ordering, and optional next-page cursors. Tests cover filtering, pagination, hydration, and invalid inputs.
Test and operator guidance
README.md, CONTRIBUTING.md, api/README.md
Updates repository and HTTP test descriptions, documents local test commands and fixture constraints, and describes query parameters, responses, errors, and listing behavior.

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant listContributorInformation
  participant PostgreSQL
  Client->>listContributorInformation: authors, sort direction, limit, cursor
  listContributorInformation->>PostgreSQL: Filtered and cursor-paginated query
  PostgreSQL-->>listContributorInformation: Contributor rows
  listContributorInformation->>PostgreSQL: Load author profile and organization records
  PostgreSQL-->>listContributorInformation: Author sidecar records
  listContributorInformation-->>Client: Contributor views and optional next cursor
Loading

Merge Risk: ⚪ Minimal · up to 66d6e

No merge-blocking issue is established for the new contributor-information queries. Complete the normal checks before merging.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 57 functions across 12 files. (8 skipped: … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the addition of contributor-information queries, the main change in the pull request.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 57 functions across 12 files. (8 skipped: 8 unsupported.)

✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

…contributor-information

# Conflicts:
#	CONTRIBUTING.md
#	api/manifest.json
#	api/tests/unit/fixtures/http-fixtures.test.js
@Kzoeps
Kzoeps marked this pull request as ready for review October 6, 2026 13:05
@sonarqubecloud

sonarqubecloud Bot commented Oct 6, 2026

Copy link
Copy Markdown

❌ The last analysis has failed.

See analysis details on SonarQube Cloud

@Kzoeps
Kzoeps merged commit f65669d into main Oct 6, 2026
7 of 8 checks passed
@Kzoeps
Kzoeps deleted the queries/contributor-information branch October 6, 2026 15:10
@github-actions github-actions Bot mentioned this pull request Oct 6, 2026

This branch was successfully deployed

1 active deployment
Preview — 3bc9fc92 Deployed Oct 6, 2026 by vercel[bot]
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.

1 participant