Add HuJSON policy parsing and manipulation utilities#548
Open
Add HuJSON policy parsing and manipulation utilities#548
Conversation
Add comment-json dependency for parsing HuJSON (JSON with comments and trailing commas) used by Headscale ACL policies. Introduces app/utils/acl-editor.ts with typed interfaces for ACL policy entities and pure functions for parsing, serializing, and mutating policy sections (rules, groups, hosts, tags, SSH rules). Comment metadata is preserved through mutations via comment-json's assign helper. Includes 45 unit tests covering parsing, round-trips, comment preservation, trailing comma handling, and all mutation functions.
0450130 to
8fcb5c8
Compare
This was referenced May 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
app/utils/acl-editor.ts— a utility layer for parsing, mutating, and serializing Headscale ACL policies stored as HuJSON (JSON with comments and trailing commas).Uses
comment-jsonunder the hood. All mutations are immutable and preserve section-level comments throughassign(). Generic array/record helpers avoid duplication across entity types (ACL rules, SSH rules, groups, hosts, tag owners).Includes focused unit tests covering happy paths, edge cases (undefined fields, out-of-bounds indices, non-object JSON), immutability guarantees, comment preservation behavior, field isolation, and end-to-end workflows.
PR 1 of 3 for the visual ACL editor (#286):
Thanks to @simone-gasparini for the initial exploration in #404.