╭ progress.zig ─────────────────────────────────────────────────╮ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ╰───────────────────────────────────────────────────────────────╯
🬐 🬠 🬞🬂🬏 🬟 🬑 🬟 🬑 ╭a2974328..╮ a2974328.. see-em: 🬋🬋🬋 🬋🬋🬋 🬋 🬋 │files │ commits refs discuss issues new login 🬐 🬠 🬐 🬠 🬑 🬟 🬰 ╰──────────╯ (557) user
╭────╮ ╭ clone ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ╮ │http│ ssh │ │ ╰────╯ ╰ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ╯
.. embed/ event/ test/ ui/ command.zig diff3.zig event.zig find.zig fork.zig lib.zig main.zig main_wasm.zig patch.zig ╭─────────────────────────────────╮ │progress.zig │ ╰─────────────────────────────────╯ push.zig search.zig search_commit.zig search_thread.zig serve.zig serve_common.zig serve_http.zig serve_ssh.zig serve_ssh_protocol.zig test.zig testnet.zig try.zig ui.zig web.zig
1 const std = @import("std"); 2 const xit = @import("xit"); 3 const rp = xit.repo; 4 const ssh = @import("./serve_ssh_protocol.zig"); 5 6 // reporting is optional and best effort: a failed report must not fail the work 7 pub fn report(comptime repo_opts: rp.RepoOpts(.xit), io: std.Io, progress_ctx_maybe: ?repo_opts.ProgressCtx, event: rp.ProgressEvent) void { 8 if (repo_opts.ProgressCtx != void) { 9 if (progress_ctx_maybe) |progress_ctx| progress_ctx.run(io, event) catch {}; 10 } 11 } 12 13 // a push's or a clone's progress, sent on the pack stream's sideband 14 pub const Sideband = struct { 15 // a push reports through its deferred response, which knows whether the 16 // client wanted sideband at all. a clone has none and writes band 2 itself. 17 response: ?*xit.net_server_receive_pack.Response = null, 18 writer: *std.Io.Writer, 19 // the client to probe, absent when nothing is listening 20 sess: ?*ssh.SessionCtx = null, 21 // set once it has hung up, so the phase in flight can stop too 22 gone: bool = false, 23 label: []const u8 = "Processing commits", 24 count: usize = 0, 25 total: usize = 0, 26 // the last reported step, so a line is sent only when it changes 27 step: usize = 0, 28 29 // how many items a phase with no total advances between reports 30 const report_every = 1000; 31 32 // the phases a client is told about, listed so a new kind has to be 33 // decided on rather than inherit whatever label was last set 34 fn reported(kind: rp.ProgressKind) bool { 35 return switch (kind) { 36 .writing_object_from_pack, .checking_object, .enumerating_object, .compressing_object, .writing_patch => true, 37 .writing_object, .sending_bytes, .receiving_bytes => false, 38 }; 39 } 40 41 pub fn run(self: *Sideband, _: std.Io, event: rp.ProgressEvent) !void { 42 switch (event) { 43 .start => |start| { 44 if (!reported(start.kind)) return; 45 // a pack phase carries no label of its own; the rest send a 46 // .text first 47 switch (start.kind) { 48 .writing_object_from_pack => self.label = "Unpacking objects", 49 .checking_object => self.label = "Checking connectivity", 50 .enumerating_object => self.label = "Enumerating objects", 51 .compressing_object => self.label = "Compressing objects", 52 else => {}, 53 } 54 self.total = start.estimated_total_items; 55 self.count = 0; 56 self.step = 0; 57 }, 58 .complete_one => |kind| { 59 if (!reported(kind)) return; 60 self.count += 1; 61 }, 62 .end => |kind| { 63 if (!reported(kind)) return; 64 }, 65 // each phase names itself before reporting its count 66 .text => |text| { 67 self.label = text; 68 return; 69 }, 70 else => return, 71 } 72 // a phase that knows no total counts instead, and stays quiet until it 73 // has something to count 74 if (self.total == 0 and self.count == 0) return; 75 76 // every report flushes, so one is sent per percent, or per block of 77 // items when there is no total to turn into one 78 const step: usize = if (self.total > 0) @intCast(@as(u128, self.count) * 100 / self.total) else self.count / report_every; 79 if (event == .complete_one and step == self.step) return; 80 self.step = step; 81 82 // reporting is the only moment a transaction looks up from its work 83 if (self.sess) |sess| if (sess.peerGone()) { 84 self.gone = true; 85 return error.ClientGone; 86 }; 87 88 var buffer: [128]u8 = undefined; 89 const suffix = if (event == .end) "\n" else "\r"; 90 const text = if (self.total > 0) 91 try std.fmt.bufPrint(&buffer, "{s}: {d}% ({d}/{d}){s}", .{ self.label, step, self.count, self.total, suffix }) 92 else 93 try std.fmt.bufPrint(&buffer, "{s}: {d}{s}", .{ self.label, self.count, suffix }); 94 if (self.response) |response| { 95 try response.progress(self.writer, text); 96 } else { 97 try xit.net_server_pkt.sendSideband(self.writer, 2, text); 98 try self.writer.flush(); 99 } 100 } 101 }; 102 103 // whether the client the work is reporting to has hung up. only a sideband 104 // reporter probes, so any other context never cancels. 105 pub fn cancelled(comptime repo_opts: rp.RepoOpts(.xit), progress_ctx_maybe: ?repo_opts.ProgressCtx) bool { 106 if (repo_opts.ProgressCtx != *Sideband) return false; 107 const progress_ctx = progress_ctx_maybe orelse return false; 108 return progress_ctx.gone; 109 } 110