cleveragents/cleveractors-core
cleveragents/cleveractors-core
0
0
Fork 0
Code Issues 15 Pull requests 4 Projects Releases Packages Wiki Activity Actions

feat(registry): implement canonicalization engine — NFC, key sorting, RFC-8785, SHA-1 #25

New issue
Open
opened 2026-06-05 17:34:02 +00:00 by CoreRasurae · 1 comment
CoreRasurae commented 2026-06-05 17:34:02 +00:00
Member
Copy link

Metadata

Commit Message: feat(registry): implement Canonicalizer with NFC normalization and SHA-1 hashing
Branch: feature/m1-registry-canonicalization

Background and context

The Package Registry Standard v1.0.0 (§6) defines a strict canonicalization process for producing deterministic SHA-1 hashes from package content. This ensures content-addressed immutability: same content always produces same PackageId. The process involves NFC normalization, lexicographic key sorting, lifecycle field stripping, dependency resolution, and RFC-8785 JSON serialization.

Part of Epic: Package Registry Client — Support Package Registry Standard v1.0.0

Current behavior

No canonicalization or SHA-1 hashing exists.

Expected behavior

  • Canonicalizer.canonicalize(content: dict) -> str produces deterministic RFC-8785 JSON
  • Canonicalizer.compute_package_id(content: dict, package_type: PackageType) -> PackageId computes SHA-1 + formats ID
  • NFC normalization applied to all string values
  • Dictionary keys sorted lexicographically
  • Lifecycle fields (version, release_date) stripped before hashing
  • Internal references resolved to concrete PackageIds in canonical form

Acceptance criteria

  • Same content always produces the same PackageId
  • Key ordering does not affect the hash
  • Lifecycle fields do not affect the hash
  • NFC normalization eliminates encoding variants
  • Test vectors from §14 produce expected SHA-1 values
  • Different content produces different PackageIds

Subtasks

  • Create src/cleveractors/registry/canonical.py with Canonicalizer class
  • Implement NFC normalization for all string values
  • Implement lexicographic key sorting
  • Implement lifecycle field stripping
  • Implement RFC-8785 JSON serialization
  • Implement SHA-1 hashing via hashlib.sha1()
  • Internal reference resolution in canonical form
  • Tests (Behave): features/registry_canonicalization.feature — test vectors, edge cases
  • Verify coverage >=97% via nox -s coverage_report
  • Run nox (all default sessions), fix any errors

Definition of Done

This issue is complete when:

  • All subtasks above are completed and checked off.
  • A Git commit is created where the first line matches the Commit Message in Metadata exactly.
  • The commit is pushed to the branch matching the Branch in Metadata exactly.
  • The commit is submitted as a PR to master, reviewed, and merged.
## Metadata Commit Message: feat(registry): implement Canonicalizer with NFC normalization and SHA-1 hashing Branch: feature/m1-registry-canonicalization ## Background and context The Package Registry Standard v1.0.0 (§6) defines a strict canonicalization process for producing deterministic SHA-1 hashes from package content. This ensures content-addressed immutability: same content always produces same PackageId. The process involves NFC normalization, lexicographic key sorting, lifecycle field stripping, dependency resolution, and RFC-8785 JSON serialization. Part of Epic: Package Registry Client — Support Package Registry Standard v1.0.0 ## Current behavior No canonicalization or SHA-1 hashing exists. ## Expected behavior - `Canonicalizer.canonicalize(content: dict) -> str` produces deterministic RFC-8785 JSON - `Canonicalizer.compute_package_id(content: dict, package_type: PackageType) -> PackageId` computes SHA-1 + formats ID - NFC normalization applied to all string values - Dictionary keys sorted lexicographically - Lifecycle fields (`version`, `release_date`) stripped before hashing - Internal references resolved to concrete PackageIds in canonical form ## Acceptance criteria - Same content always produces the same PackageId - Key ordering does not affect the hash - Lifecycle fields do not affect the hash - NFC normalization eliminates encoding variants - Test vectors from §14 produce expected SHA-1 values - Different content produces different PackageIds ## Subtasks - [ ] Create `src/cleveractors/registry/canonical.py` with `Canonicalizer` class - [ ] Implement NFC normalization for all string values - [ ] Implement lexicographic key sorting - [ ] Implement lifecycle field stripping - [ ] Implement RFC-8785 JSON serialization - [ ] Implement SHA-1 hashing via `hashlib.sha1()` - [ ] Internal reference resolution in canonical form - [ ] Tests (Behave): features/registry_canonicalization.feature — test vectors, edge cases - [ ] Verify coverage >=97% via nox -s coverage_report - [ ] Run nox (all default sessions), fix any errors ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the first line matches the Commit Message in Metadata exactly. - The commit is pushed to the branch matching the Branch in Metadata exactly. - The commit is submitted as a PR to master, reviewed, and merged.
CoreRasurae added this to the v2.1.0 milestone 2026-06-05 17:34:02 +00:00
CoreRasurae changed title from Canonicalization engine — NFC, key sorting, RFC-8785, SHA-1 to feat(registry): implement canonicalization engine — NFC, key sorting, RFC-8785, SHA-1 2026-06-05 17:47:17 +00:00
CoreRasurae commented 2026-06-07 21:06:25 +00:00
Author
Member
Copy link

Implemented in PR #36: #36

PR blocks this issue.

Implementation Summary

  • Created src/cleveractors/registry/canonical.py with Canonicalizer class
  • NFC normalization, key sorting, lifecycle stripping, RFC-8785 JSON, SHA-1 hashing
  • 23 Behave BDD scenarios passing
  • canonical.py: 100% line coverage
  • Overall: 97.04% coverage

All quality gates:

  • lint: pass
  • typecheck: pass
  • security_scan: pass
  • dead_code: pass
  • unit_tests: 1926 scenarios pass (0 failed)
  • coverage_report: 97.04% (threshold: 96.5%)
Implemented in PR #36: https://git.cleverthis.com/cleveragents/cleveractors-core/pulls/36 PR blocks this issue. ## Implementation Summary - Created `src/cleveractors/registry/canonical.py` with `Canonicalizer` class - NFC normalization, key sorting, lifecycle stripping, RFC-8785 JSON, SHA-1 hashing - 23 Behave BDD scenarios passing - canonical.py: 100% line coverage - Overall: 97.04% coverage All quality gates: - lint: pass - typecheck: pass - security_scan: pass - dead_code: pass - unit_tests: 1926 scenarios pass (0 failed) - coverage_report: 97.04% (threshold: 96.5%)
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
feature/create-executor-api
feature/m1-registry-template-alignment
feature/m1-registry-reference-resolver
feature/m1-registry-canonicalization
feature/m1-registry-http-client
master-backup
No results found.
Labels
Clear labels
  
auto/blocked-by-deps
PR blocked by an open issue dependency. Operator must close the dep (or remove the dependency link) before the merge driver can act. Auto-cleared by merge_drive when no open deps remain.

  
auto/ci-timeout
Most recent merge cycle hit CI timeout. Driver excludes this PR while last merge_cycle row is < 30 min old; label persists thereafter as visible history.

  
auto/claimed-implementer
Currently being processed by an implementer worker.

  
auto/claimed-merge
Currently being processed by the merge driver.

  
auto/claimed-reviewer
Currently being processed by a reviewer worker.

  
auto/driver-down
Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.

  
auto/invariant-violation
Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.

  
auto/last-attempt-tier-0
In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.

  
auto/last-attempt-tier-1
In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.

  
auto/last-attempt-tier-2
In-cycle escalation: most recent attempt ran at the Tier 2 slot (`tier-2`). Slot's model defined in .opencode/models/tiers.yaml. Gated behind IMPLEMENTER_ESCALATION_TIER2_ENABLED.

  
auto/last-attempt-tier-min
In-cycle escalation: most recent attempt ran at the Tier -1 slot (`tier-min`). Slot's model defined in .opencode/models/tiers.yaml. Suffix is ``-min`` (not ``--1``) so the Forgejo UI reads naturally.

  
Automation Tracking
Tracking issues used by the AI Automation system for agents to communicate and report.

  
auto/needs-conflict-resolution
Rebase conflict needs LLM conflict-resolver.

  
auto/needs-implementer
Failing CI needs implementer attention.

  
auto/postmortem
Documenting a driver incident or rollback.

  
auto/ready-to-merge
Reviewer has APPROVED this PR and no later REQUEST_CHANGES is outstanding. The merge driver requires this label to even consider a PR for merging. Set by the reviewer worker on APPROVE; cleared on REQUEST_CHANGES.

  
auto/restart-throttled
Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.

  
auto/revert
Revert PR backing out an invariant violation. Fast-tracked through the merge driver.

  
auto/sentinel
Sentinel PR duplicated from upstream into a personal fork by tools/duplicate_prs_to_fork.py for pipeline testing. Lives only in the fork; the canonical pipeline never sees it.

  
auto/stale-inactivity
No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.

  
auto/unstable
Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.

  
Blocked
A ticket in a blocked state and unable to complete until some other task is completed first.

  
Bounty
$100
 A bounty of $100 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$1000
 A bounty of $1000 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$10000
 A bounty of $10000 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$20
 A bounty of $20 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$2000
 A bounty of $2000 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$250
 A bounty of $250 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$50
 A bounty of $50 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$500
 A bounty of $500 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$5000
 A bounty of $5000 for any open-source contributor who provides a MR that solves this issue

  
Bounty
$750
 A bounty of $750 for any open-source contributor who provides a MR that solves this issue

  
MoSCoW
Could have
 Could have feature in order to satisfy the epic/legendary.

  
MoSCoW
Must have
 Must have feature in order to satisfy the epic/legendary.

  
MoSCoW
Should have
 Should have feature in order to satisfy the epic/legendary.

  
Needs Feedback
There are questions in the ticket that can not be completed until the project owner provides clarity.

  
Points
1
 1 man-hours worth of work for an expert with no learning curve.

  
Points
13
 13 man-hours worth of work for an expert with no learning curve.

  
Points
2
 2 man-hours worth of work for an expert with no learning curve.

  
Points
21
 21 man-hours worth of work for an expert with no learning curve.

  
Points
3
 3 man-hours worth of work for an expert with no learning curve.

  
Points
34
 34 man-hours worth of work for an expert with no learning curve.

  
Points
5
 5 man-hours worth of work for an expert with no learning curve.

  
Points
55
 55 man-hours worth of work for an expert with no learning curve.

  
Points
8
 8 man-hours worth of work for an expert with no learning curve.

  
Points
88
 88 man-hours worth of work for an expert with no learning curve.

  
Priority
Backlog
 This ticket has backlogged priority and is not to be worked on yet

  
Priority
CI Blocker
 Critical priority issue that blocks CI/CD pipeline and prevents PR merges

  
Priority
Critical
 The priority is critical

  
Priority
High
 The priority is high

  
Priority
Low
 The priority is low

  
Priority
Medium
 The priority is medium

  
Signed-off: Owner
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  
Signed-off: Scrum Master
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  
Signed-off: Tech Lead
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.

  
Spike
A ticket for learning a tool or technology that is needed to be able to do future planning and design.

  
State
Completed
 The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.

  
State
Duplicate
 A ticket that represents the same content as an existing ticket.

  
State
In Progress
 A ticket that is actively being developed.

  
State
In Review
 A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.

  
State
Paused
 This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.

  
State
Unverified
 All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.

  
State
Verified
 The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.

  
State
Wont Do
 This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.

  
Type
Automation
 Any edits or discussion about the AI automated coding system.

  
Type
Bug
 Something that doesnt work as intended.

  
Type
Discussion
 Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.

  
Type
Documentation
 An error or improvement needed in the documentation.

  
Type
Epic
 Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.

  
Type
Feature
 Some new functionality not present.

  
Type
Legendary
 A type of Epic which will contain other Epics.

  
Type
Refactor
 A code change that restructures existing code without changing its external behavior.

  
Type
Support
 Someone needs help using the project.

  
Type
Task
 A generic task that doesnt fit into the other type categories.

  
Type
Testing
 Work exclusively focusing on fixing or expanding testing.

No labels
auto/blocked-by-deps
auto/ci-timeout
auto/claimed-implementer
auto/claimed-merge
auto/claimed-reviewer
auto/driver-down
auto/invariant-violation
auto/last-attempt-tier-0
auto/last-attempt-tier-1
auto/last-attempt-tier-2
auto/last-attempt-tier-min
Automation Tracking
auto/needs-conflict-resolution
auto/needs-implementer
auto/postmortem
auto/ready-to-merge
auto/restart-throttled
auto/revert
auto/sentinel
auto/stale-inactivity
auto/unstable
Blocked
Bounty
$100
Bounty
$1000
Bounty
$10000
Bounty
$20
Bounty
$2000
Bounty
$250
Bounty
$50
Bounty
$500
Bounty
$5000
Bounty
$750
MoSCoW
Could have
MoSCoW
Must have
MoSCoW
Should have
Needs Feedback
Points
1
Points
13
Points
2
Points
21
Points
3
Points
34
Points
5
Points
55
Points
8
Points
88
Priority
Backlog
Priority
CI Blocker
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
State
Completed
State
Duplicate
State
In Progress
State
In Review
State
Paused
State
Unverified
State
Verified
State
Wont Do
Type
Automation
Type
Bug
Type
Discussion
Type
Documentation
Type
Epic
Type
Feature
Type
Legendary
Type
Refactor
Type
Support
Type
Task
Type
Testing
Milestone
Clear milestone
No items
No milestone
v2.1.0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
CoreRasurae
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks
#22 Epic: Package Registry Client — Support Package Registry Standard v1.0.0
cleveragents/cleveractors-core
Depends on
#36 feat(registry): implement Canonicalizer with NFC normalization and SHA-1 hashing
cleveragents/cleveractors-core
Reference
cleveragents/cleveractors-core#25
No description provided.