╭─────────────╮ │scroll to top│ ╰─────────────╯ ╭ progress.zig ─────────────────────────────────────────────────╮ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ╰───────────────────────────────────────────────────────────────╯
🬐 🬠 🬞🬂🬏 🬟 🬑 🬟 🬑 ╭7690bfb7..╮ 7690bfb7.. haxy: 🬋🬋🬋 🬋🬋🬋 🬋 🬋 │files │ commits refs discuss issues patches new login 🬐 🬠 🬐 🬠 🬑 🬟 🬰 ╰──────────╯ (689) 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 markdown.zig notify.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
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. unpacking is 34 // left out because it runs while the client is still sending, so its line 35 // fights with the client's own upload bar over the same row. 36 fn reported(kind: rp.ProgressKind) bool { 37 return switch (kind) { 38 .writing_object, .checking_object, .walking_commit, .enumerating_object, .compressing_object, .writing_patch => true, 39 .writing_object_from_pack, .sending_bytes, .receiving_bytes => false, 40 }; 41 } 42 43 pub fn run(self: *Sideband, _: std.Io, event: rp.ProgressEvent) !void { 44 switch (event) { 45 .start => |start| { 46 if (!reported(start.kind)) return; 47 // a pack phase carries no label of its own; the rest send a 48 // .text first 49 switch (start.kind) { 50 .writing_object => self.label = "Copying objects", 51 .checking_object => self.label = "Checking connectivity", 52 .walking_commit => self.label = "Walking commits", 53 .enumerating_object => self.label = "Enumerating objects", 54 .compressing_object => self.label = "Compressing objects", 55 else => {}, 56 } 57 self.total = start.estimated_total_items; 58 self.count = 0; 59 self.step = 0; 60 }, 61 .complete_one => |kind| { 62 if (!reported(kind)) return; 63 self.count += 1; 64 }, 65 .end => |kind| { 66 if (!reported(kind)) return; 67 }, 68 // each phase names itself before reporting its count 69 .text => |text| { 70 self.label = text; 71 return; 72 }, 73 else => return, 74 } 75 // a phase that knows no total counts instead, and stays quiet until it 76 // has something to count 77 if (self.total == 0 and self.count == 0) return; 78 79 // every report flushes, so one is sent per percent, or per block of 80 // items when there is no total to turn into one 81 const step: usize = if (self.total > 0) @intCast(@as(u128, self.count) * 100 / self.total) else self.count / report_every; 82 if (event == .complete_one and step == self.step) return; 83 self.step = step; 84 85 // reporting is the only moment a transaction looks up from its work 86 if (self.sess) |sess| if (sess.peerGone()) { 87 self.gone = true; 88 return error.ClientGone; 89 }; 90 91 var buffer: [128]u8 = undefined; 92 const suffix = if (event == .end) "\n" else "\r"; 93 const text = if (self.total > 0) 94 try std.fmt.bufPrint(&buffer, "{s}: {d}% ({d}/{d}){s}", .{ self.label, step, self.count, self.total, suffix }) 95 else 96 try std.fmt.bufPrint(&buffer, "{s}: {d}{s}", .{ self.label, self.count, suffix }); 97 if (self.response) |response| { 98 try response.progress(self.writer, text); 99 } else { 100 try xit.net_server_pkt.sendSideband(self.writer, 2, text); 101 try self.writer.flush(); 102 } 103 } 104 }; 105 106 // whether the client the work is reporting to has hung up. only a sideband 107 // reporter probes, so any other context never cancels. 108 pub fn cancelled(comptime repo_opts: rp.RepoOpts(.xit), progress_ctx_maybe: ?repo_opts.ProgressCtx) bool { 109 if (repo_opts.ProgressCtx != *Sideband) return false; 110 const progress_ctx = progress_ctx_maybe orelse return false; 111 return progress_ctx.gone; 112 } 113