Skip to content

feat(lsp): secret token modifier for keychain-backed env vars #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gandarfh merged 1 commit into from
Jun 14, 2026
Merged

feat(lsp): secret token modifier for keychain-backed env vars #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions bin/httui-lsp/httui_lsp.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ let compute_legend ~announced_types ~announced_modifiers =
legend_modifiers :=
List.filter
(fun m -> List.mem m announced_modifiers)
[ "declaration"; "unresolved" ]
[ "declaration"; "unresolved"; "secret" ]

let type_index (kind : Httui_lang.Semantic_tokens.kind) =
let name =
Expand Down Expand Up @@ -176,6 +176,7 @@ let modifier_bits (t : Httui_lang.Semantic_tokens.t) =
let active =
(m = "declaration" && t.declaration)
|| (m = "unresolved" && t.unresolved)
|| (m = "secret" && t.secret)
in
if active then bits lor (1 lsl i) else bits)
0
Expand Down Expand Up @@ -322,9 +323,10 @@ let encode_tokens text tokens =
in
Array.of_list data

let compute_token_data text =
let compute_token_data ~env_keys text =
encode_tokens text
(Httui_lang.Semantic_tokens.of_blocks (Httui_lang.Fence_scanner.scan text))
(Httui_lang.Semantic_tokens.of_blocks ~env_keys
(Httui_lang.Fence_scanner.scan text))

(* Last full result per document, for delta requests: uri -> (resultId,
data). Monotonic ids keep delta bookkeeping trivial. *)
Expand Down Expand Up @@ -364,7 +366,10 @@ let diff_tokens old_ new_ =
let on_semantic_tokens (r : Jsonrpc.Request.t) =
let p = T.SemanticTokensParams.t_of_yojson (params_json r.params) in
with_doc r.id p.textDocument.uri (fun text ->
let data = compute_token_data text in
let env_keys =
Env_store.keys_for ~file_path:(T.DocumentUri.to_path p.textDocument.uri)
in
let data = compute_token_data ~env_keys text in
let result_id = store_tokens p.textDocument.uri data in
respond r.id
(T.SemanticTokens.yojson_of_t
Expand All @@ -373,7 +378,10 @@ let on_semantic_tokens (r : Jsonrpc.Request.t) =
let on_semantic_tokens_delta (r : Jsonrpc.Request.t) =
let p = T.SemanticTokensDeltaParams.t_of_yojson (params_json r.params) in
with_doc r.id p.textDocument.uri (fun text ->
let data = compute_token_data text in
let env_keys =
Env_store.keys_for ~file_path:(T.DocumentUri.to_path p.textDocument.uri)
in
let data = compute_token_data ~env_keys text in
let uri_s = T.DocumentUri.to_string p.textDocument.uri in
match Hashtbl.find_opt token_results uri_s with
| Some (prev_id, old_data) when prev_id = p.previousResultId ->
Expand Down
9 changes: 8 additions & 1 deletion lib/semantic_tokens.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ type t = {
kind : kind;
unresolved : bool; (** ref with path whose alias is not in scope *)
declaration : bool; (** [alias=...] declaration site in the info string *)
secret : bool; (** env var whose value is keychain-backed (is_secret) *)
}

let plain ~start_ ~stop_ kind =
Expand All @@ -29,6 +30,7 @@ let plain ~start_ ~stop_ kind =
kind;
unresolved = false;
declaration = false;
secret = false;
}

(* Fence tokens for the info string. LSP tokens must not overlap, so the
Expand Down Expand Up @@ -83,7 +85,7 @@ let http_tokens (b : Block.t) ~ref_spans =
subtract_holes ~s:tok.start_ ~e:tok.stop_ ref_spans
|> List.map (fun (s, e) -> plain ~start_:s ~stop_:e kind))

let of_blocks blocks =
let of_blocks ?(env_keys = []) blocks =
List.concat
(List.mapi
(fun i (b : Block.t) ->
Expand All @@ -100,6 +102,7 @@ let of_blocks blocks =
kind = Alias;
unresolved = false;
declaration = true;
secret = false;
};
]
| _ -> []
Expand Down Expand Up @@ -128,6 +131,9 @@ let of_blocks blocks =
kind = name_kind;
unresolved = (is_prev || r.has_path) && not known;
declaration = false;
secret =
name_kind = Env_var
&& List.assoc_opt r.name env_keys = Some true;
}
:: List.map
(fun (s, e) ->
Expand All @@ -137,6 +143,7 @@ let of_blocks blocks =
kind = Ref_path;
unresolved = false;
declaration = false;
secret = false;
})
r.path_segments)
in
Expand Down
14 changes: 14 additions & 0 deletions test/test_httui_lang.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,20 @@ let () =
plus refs in req2: ghost (1 name + 1 segment) + req1 (1 name + 2
segments) + TOKEN (1 name) *)
check "token count" (List.length toks = 14);
(* the `secret` modifier marks env-var refs whose key is is_secret *)
check "secret env var ref carries the secret modifier"
(List.exists
(fun (t : Httui_lang.Semantic_tokens.t) ->
t.kind = Httui_lang.Semantic_tokens.Env_var && t.secret)
(Httui_lang.Semantic_tokens.of_blocks
~env_keys:[ ("TOKEN", true) ]
blocks));
check "env var ref is not secret without the is_secret flag"
(List.for_all
(fun (t : Httui_lang.Semantic_tokens.t) -> not t.secret)
(Httui_lang.Semantic_tokens.of_blocks
~env_keys:[ ("TOKEN", false) ]
blocks));
(match toks with
| first :: _ ->
check "first token is the fence lang"
Expand Down
Loading