Skip to content

feat(callbacks): expose physical licensing identities - #59

Merged
Eli Bosley (elibosley) merged 1 commit into
mainfrom
codex/shared-callbacks-license-identities
Sep 1, 2026
Merged

feat(callbacks): expose physical licensing identities#59
Eli Bosley (elibosley) merged 1 commit into
mainfrom
codex/shared-callbacks-license-identities

Conversation

@elibosley

@elibosley Eli Bosley (elibosley) commented Sep 1, 2026

Copy link
Copy Markdown
Member

Summary

Extend the shared server callback contract so licensing flows can carry both physical identities alongside the existing guid field.

Why This Exists

A server may have both a USB flash GUID and a TPM GUID. Consumers such as Unraid API and Account need both values to support recovery, replacement, and future licensing decisions without forcing one choice at the handoff boundary.

Resolution

Add optional flashGuid and tpmGuid fields to ServerData. Existing callbacks remain valid because the fields are optional and the legacy guid field is unchanged.

Reviewer Considerations

  • guid remains the current/legacy identity; the new fields are additional context.
  • The generated declaration file is included because this package publishes dist.
  • No encryption or callback envelope behavior changes.

Behavior Changes

Callbacks include the optional physical identities when a producer supplies them; older producers and consumers continue to work unchanged.

Implementation Summary

  • Added optional flashGuid and tpmGuid fields to ServerData.
  • Added an encrypted server-callback round-trip test covering both fields.
  • Regenerated the published type declaration.

Verification

  • pnpm build
  • pnpm test --run — 38 tests passed.

Risk

Low. This is an additive, optional contract change with backward-compatible serialization.

Summary by CodeRabbit

  • New Features

    • Server data can now include optional flash and TPM identifiers.
  • Tests

    • Added round-trip coverage for server data containing flash and TPM identifiers.

@codecov

codecov Bot commented Sep 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.08%. Comparing base (8c6afd7) to head (81b33da).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #59   +/-   ##
=======================================
  Coverage   99.08%   99.08%           
=======================================
  Files           3        3           
  Lines         109      109           
  Branches       30       30           
=======================================
  Hits          108      108           
  Misses          1        1           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: a89d6ebe-7a15-4814-8758-81dfa0f9d981

📥 Commits

Reviewing files that changed from the base of the PR and between 8c6afd7 and 81b33da.

⛔ Files ignored due to path filters (1)
  • dist/types.d.ts is excluded by !**/dist/**
📒 Files selected for processing (2)
  • src/__tests__/server.test.ts
  • src/types.ts

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


📝 Walkthrough

Walkthrough

The ServerData interface now supports optional flashGuid and tpmGuid values. The server round-trip test includes both fields and verifies that generateUrl and parse preserve them.

Changes

Server GUID support

Layer / File(s) Summary
Server GUID contract and round-trip validation
src/types.ts, src/__tests__/server.test.ts
ServerData adds optional flashGuid and tpmGuid string fields. The round-trip test includes values for both fields.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 81b33

This change adds optional licensing identity fields while preserving the existing callback contract and encrypted transport behavior. No actionable merge-blocking risk remains after normal checks and review.

Poem

A rabbit checked the server’s chart
Two GUIDs hopped in at the start
The URL carried them through
The parser brought them back too
Then the rabbit nibbled a carrot heart

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title uses the required Conventional Commits format, feat(callbacks):, and accurately describes the addition of physical licensing identity fields.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 2…
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

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 2 files.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/shared-callbacks-license-identities
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch codex/shared-callbacks-license-identities

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.

@elibosley
Eli Bosley (elibosley) merged commit 4dc7007 into main Sep 1, 2026
6 checks passed
@elibosley
Eli Bosley (elibosley) deleted the codex/shared-callbacks-license-identities branch September 1, 2026 01:45
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