Skip to content

feat: rate-limit activity printing #12

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
mosteo merged 3 commits into from
Feb 1, 2026
Merged

feat: rate-limit activity printing #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54ecf8c
feat: rate-limit Activity printing
mosteo Feb 1, 2026
ac224cc
self-review
mosteo Feb 1, 2026
f668e5a
fix improbable corner case
mosteo Feb 1, 2026
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
16 changes: 15 additions & 1 deletion src/simple_logging.adb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ package body Simple_Logging is
Statuses : Status_Sets.Set;

Last_Status_Line : Unbounded_String; -- Used for cleanup
Last_Update : Duration := -1.0;
Last_Spin : Duration := 0.0;
Spinner : Spinner_Holders.Holder;
Spinner_Pos : Integer := 0;
Expand Down Expand Up @@ -168,6 +169,7 @@ package body Simple_Logging is
Data => (Level => Level,
Start => Internal_Clock,
Text => To_Unbounded_String (Text)),
Period => <>,
Text_Autocomplete =>
To_Unbounded_String (Autocomplete_Text))
do
Expand Down Expand Up @@ -296,7 +298,8 @@ package body Simple_Logging is

procedure Step (This : in out Ongoing;
New_Text : String := "";
Clear : Boolean := False) is
Clear : Boolean := False;
Keyframe : Boolean := False) is
Old_Line : constant String := This.Build_Status_Line;
begin
-- Update status if needed
Expand All @@ -306,6 +309,17 @@ package body Simple_Logging is
Statuses.Insert (This.Data);
end if;

-- Early exit if rate-limited.
if This.Period > 0.0
and then Internal_Clock - Last_Update < This.Period
and then not Keyframe
and then not Clear
then
return;
end if;

Last_Update := Internal_Clock;

declare
New_Line : constant String := This.Build_Status_Line;
New_Len : constant Natural := Visible_Length (New_Line);
Expand Down
17 changes: 15 additions & 2 deletions src/simple_logging.ads
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,11 @@ package Simple_Logging with Preelaborate is
-- Time between spinner frame changes. TODO: make this a property of the
-- spinner itself.

Max_Updates_Per_Second : Natural := 10;
-- Activity updates won't exceed this many per second. Set to 0 to disable
-- rate limiting. Not to be confused with Spinner_Period, which only
-- affects the spinner animation speed.

procedure Log (Message : String;
Level : Levels := Info;
Entity : String := Gnat.Source_Info.Enclosing_Entity;
Expand Down Expand Up @@ -133,12 +138,14 @@ package Simple_Logging with Preelaborate is

procedure Step (This : in out Ongoing;
New_Text : String := "";
Clear : Boolean := False)
Clear : Boolean := False;
Keyframe : Boolean := False)
with Pre => not (Clear and then New_Text /= "");
-- Say that progress was made, which will advance the spinner. Optionally,
-- update the text to display in this activity. When Clear, remove this
-- status contribution (e.g., because we are nesting further and this one
-- becomes irrelevant)
-- becomes irrelevant). When Keyframe is True, force an update even if
-- Max_Updates_Per_Second would prevent it.

procedure New_Line (This : in out Ongoing;
Text : String);
Expand Down Expand Up @@ -176,6 +183,12 @@ private

-- Rest of state not needed to rebuild the status line
Text_Autocomplete : Unbounded_String;
Period : Duration :=
(if Max_Updates_Per_Second = 0
then 0.0
else 1.0 / Max_Updates_Per_Second);
-- Here so changes to Max_Updates_Per_Second propagate to new Ongoing
-- instances
end record;
-- Note: Although activities can be nested, there is only a global spinner
-- so all that state is in the body.
Expand Down