╭─────────────╮ │scroll to top│ ╰─────────────╯ ╭ Issue.zig ────────────────────────────────────────────────────╮ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ╰───────────────────────────────────────────────────────────────╯
🬐 🬠 🬞🬂🬏 🬟 🬑 🬟 🬑 ╭0c3d9ada..╮ 0c3d9ada.. see-em: 🬋🬋🬋 🬋🬋🬋 🬋 🬋 │files │ commits refs discuss issues new login 🬐 🬠 🬐 🬠 🬑 🬟 🬰 ╰──────────╯ (443) user
╭────╮ ╭ clone ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ╮ │http│ ssh │ │ ╰────╯ ╰ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ╯
.. Attachment.zig Comment.zig Discussion.zig Fork.zig ╭─────────────────────────────────╮ │Issue.zig │ ╰─────────────────────────────────╯ Patch.zig PatchRev.zig Repo.zig User.zig
5 const rp = xit.repo; 6 const hash = xit.hash; 7 8 title: []const u8, 9 description: []const u8, 10 tags: []const u8, // space-separated 11 status: Status = .open, 12 13 // what the db stores: the event's data plus the commit-derived fields 14 pub const Record = struct { 15 event: Self, 16 removed: bool = false, 17 author_email: ?[]const u8 = null, 18 created_order: u64 = 0, 19 }; 20 21 const Self = @This(); 22 23 pub const Status = enum { 24 open, 25 closed, 26 27 const longest_len = blk: { 28 var len: usize = 0; 29 for (@typeInfo(Status).@"enum".fields) |field| len = @max(len, field.name.len); 30 break :blk len; 31 }; 32 }; 33 34 pub const tag_max_len = 64; 35 36 // the moment keys `evt.merge` reads and writes for this kind 37 pub const merge_policy: evt.MergePolicy = .field_conflicts; 38 pub const record_map_key = "event-id->issue"; 39 pub const id_set_key = "issue-id-set"; 40 pub const conflicts_key = "conflicted-issue-id->conflict"; 41 pub const id_to_field_to_oid_key = "issue-id->field->oid"; 42 pub const status_to_id_set_key = "status->issue-id-set"; 43 pub const tag_status_to_id_set_key = "tag+status->issue-id-set"; 44 45 // a "tag status" key names a tag's per-status issue set (tags can't contain 46 // spaces, so the pair is unambiguous) 47 pub const TagStatusKey = [tag_max_len + 1 + Status.longest_len]u8; 48 49 pub fn tagStatusKey(buffer: *TagStatusKey, tag: []const u8, status: Status) ![]const u8 { 50 return std.fmt.bufPrint(buffer, "{s} {s}", .{ tag, @tagName(status) }); 51 } 52 53 pub fn tagIterator(tags: []const u8) std.mem.SplitIterator(u8, .scalar) { 54 return std.mem.splitScalar(u8, tags, ' '); 55 } 56 57 // a title is required, and a too-long tag would go unindexed once consumed 58 pub fn fieldsValid(title: []const u8, tags: []const u8) bool { 59 if (title.len == 0) return false; 60 var tag_iter = tagIterator(tags); 61 while (tag_iter.next()) |tag| { 62 if (tag.len > tag_max_len) return false; 63 } 64 return true; 65 } 66 67 pub fn consume( 68 comptime DB: type, 69 comptime hash_kind: hash.HashKind, 70 haxy_moment: DB.HashMap(.read_write), 71 event_id: *const [evt.event_id_size]u8, 72 record_maybe: ?Record, 73 arena: *std.heap.ArenaAllocator, 74 // the commit this event came from, recorded against every field it 75 // changes. null from `merge`, which sets oids and conflicts itself. 76 event_oid: ?[]const u8, 77 ) !void { 78 const issue_key = hash.hashInt(hash_kind, event_id); 79 80 const event_id_to_issue_cursor = try haxy_moment.putCursor(hash.hashInt(hash_kind, record_map_key)); 81 const event_id_to_issue = try DB.HashMap(.read_write).init(event_id_to_issue_cursor); 82 83 // the per-status sets the issues views list, ordered by creation, 84 // keyed by status name 85 const status_to_issues_cursor = try haxy_moment.putCursor(hash.hashInt(hash_kind, status_to_id_set_key)); 86 const status_to_issues = try DB.SortedMap(.read_write).init(status_to_issues_cursor); 87 88 // the per-tag, per-status sets, keyed "tag,status" 89 const tag_to_issues_cursor = try haxy_moment.putCursor(hash.hashInt(hash_kind, tag_status_to_id_set_key)); 90 const tag_to_issues = try DB.SortedMap(.read_write).init(tag_to_issues_cursor); 91 92 const conflicts_cursor = try haxy_moment.putCursor(hash.hashInt(hash_kind, conflicts_key)); 93 const conflicts = try DB.SortedMap(.read_write).init(conflicts_cursor); 94 95 const issue_id_to_field_to_oid_cursor = try haxy_moment.putCursor(hash.hashInt(hash_kind, id_to_field_to_oid_key)); 96 const issue_id_to_field_to_oid = try DB.HashMap(.read_write).init(issue_id_to_field_to_oid_cursor); 97 98 var existing_record_maybe: ?Record = null; 99 const existing_cursor_maybe = try event_id_to_issue.getCursor(issue_key); 100 if (existing_cursor_maybe) |existing_cursor| { 101 const existing_issue = try DB.HashMap(.read_only).init(existing_cursor); 102 existing_record_maybe = try evt.read(Record, DB, hash_kind, arena, existing_issue); 103 } 104 105 var record_to_write = if (record_maybe) |record| 106 record 107 else blk: { 108 var record = existing_record_maybe orelse return error.EventNotFound; 109 record.removed = true; 110 break :blk record; 111 }; 112 113 if (existing_record_maybe) |existing_record| { 114 // updates preserve the original creation order and author 115 record_to_write.created_order = existing_record.created_order; 116 record_to_write.author_email = existing_record.author_email; 117 118 // drop the old status's and tags' entries; active values are re-added below 119 const order_key = evt.orderKeyDesc(existing_record.created_order, event_id); 120 if (!existing_record.removed) { 121 const status_set = try statusSet(DB, status_to_issues, existing_record.event.status); 122 _ = try status_set.remove(&order_key); 123 try removeFromTagSets(DB, tag_to_issues, existing_record.event.tags, existing_record.event.status, &order_key); 124 } 125 126 // any event settles the conflict, since resolving in the ui may 127 // keep our own values and so change nothing to detect 128 if (event_oid != null or record_to_write.removed) _ = try conflicts.remove(&order_key); 129 } 130 131 try evt.writeOid(Self, DB, hash_kind, issue_id_to_field_to_oid, issue_key, if (existing_record_maybe) |existing| existing.event else null, record_to_write.event, event_oid); 132 133 const issue_cursor = try event_id_to_issue.putCursor(issue_key); 134 const issue = try DB.HashMap(.read_write).init(issue_cursor); 135 try evt.upsert(Record, DB, hash_kind, issue, record_to_write); 136 try evt.indexEvent(DB, hash_kind, haxy_moment, event_id, .issue, record_to_write.created_order, record_to_write.removed); 137 138 const order_key = evt.orderKeyDesc(record_to_write.created_order, event_id); 139 140 // the id set retains removed records so merges can carry removals 141 if (existing_cursor_maybe == null) { 142 const issue_id_set_cursor = try haxy_moment.putCursor(hash.hashInt(hash_kind, id_set_key)); 143 const issue_id_set = try DB.SortedSet(.read_write).init(issue_id_set_cursor); 144 try issue_id_set.put(&order_key); 145 } 146 147 if (!record_to_write.removed) { 148 const status_set = try statusSet(DB, status_to_issues, record_to_write.event.status); 149 try status_set.put(&order_key); 150 151 var tag_iter = tagIterator(record_to_write.event.tags); 152 while (tag_iter.next()) |tag| { 153 // an over-long tag goes unindexed rather than failing the consume, 154 // which would wedge the branch it arrived on 155 if (tag.len == 0 or tag.len > tag_max_len) continue; 156 var key_buffer: TagStatusKey = undefined; 157 const tag_set_cursor = try tag_to_issues.putCursor(try tagStatusKey(&key_buffer, tag, record_to_write.event.status)); 158 const tag_set = try DB.SortedSet(.read_write).init(tag_set_cursor); 159 try tag_set.put(&order_key); 160 } 161 } 162 } 163 164 // `status`'s sorted set within `statuses`, keyed by status name 165 fn statusSet( 166 comptime DB: type, 167 statuses: DB.SortedMap(.read_write), 168 status: Status, 169 ) !DB.SortedSet(.read_write) { 170 const cursor = try statuses.putCursor(@tagName(status)); 171 return DB.SortedSet(.read_write).init(cursor); 172 } 173 174 // the resolve form's inputs: null fields keep the live values, `hunks` holds 175 // the description conflict hunks' resolutions in chunk order (absent 176 // trailing ones keep our side) 177 pub const Resolve = struct { 178 title: ?[]const u8 = null, 179 tags: ?[]const u8 = null, 180 hunks: []const []const u8 = &.{}, 181 }; 182 183 // what an update replaces on an issue: its status, its content, or — for a 184 // conflicted issue — the resolution of its conflict 185 pub const Update = union(enum) { 186 status: Status, 187 fields: struct { title: []const u8, tags: []const u8, description: []const u8 }, 188 resolve: Resolve, 189 }; 190 191 // re-emit the issue `id_bytes` names with `change` applied, preserving the 192 // rest of its current state. error.NotFound when the id names no issue, 193 // error.InvalidFields when a resolve composes invalid fields. `repo` must be 194 // writable. 195 pub fn update( 196 comptime repo_kind: rp.RepoKind, 197 comptime repo_opts: rp.RepoOpts(repo_kind), 198 io: std.Io, 199 allocator: std.mem.Allocator, 200 repo: *rp.Repo(repo_kind, repo_opts), 201 id_bytes: *const [evt.event_id_size]u8, 202 change: Update, 203 author: evt.CommitAuthor, 204 ) !void { 205 var arena = std.heap.ArenaAllocator.init(allocator); 206 defer arena.deinit(); 207 208 const issue = (try readById(repo_kind, repo_opts, io, allocator, &arena, repo, id_bytes)) orelse return error.NotFound; 209 if (issue.removed) return error.NotFound; 210 211 var updated = issue.event; 212 switch (change) { 213 .status => |status| { 214 if (updated.status == status) return; 215 updated.status = status; 216 }, 217 .fields => |fields| { 218 updated.title = fields.title; 219 updated.tags = fields.tags; 220 updated.description = fields.description; 221 }, 222 .resolve => |resolve| { 223 updated = try resolveFields(repo_kind, repo_opts, io, allocator, &arena, repo, id_bytes, issue, resolve); 224 if (!fieldsValid(updated.title, updated.tags)) return error.InvalidFields; 225 }, 226 } 227 228 try evt.consume(.repo, repo_kind, repo_opts, io, allocator, repo, evt.events_ref, &[_]evt.EventWithId{.{ 229 .id = std.fmt.bytesToHex(id_bytes.*, .lower), 230 .timestamp = @intCast(std.Io.Timestamp.now(io, .real).toSeconds()), 231 .author = author, 232 .event = .{ .issue = updated }, 233 }}); 234 } 235 236 // the live fields with `resolve` applied: submitted title/tags stand in for the 237 // live ones, and a conflicted description is reassembled from the hunk 238 // resolutions against the conflict entry. the chunking is deterministic: the 239 // entry holds immutable slots and any event since would have removed it, so 240 // the hunks match what the resolve form was built from. a settled or 241 // unreadable entry keeps the live description. 242 fn resolveFields( 243 comptime repo_kind: rp.RepoKind, 244 comptime repo_opts: rp.RepoOpts(repo_kind), 245 io: std.Io, 246 allocator: std.mem.Allocator, 247 arena: *std.heap.ArenaAllocator, 248 repo: *rp.Repo(repo_kind, repo_opts), 249 id_bytes: *const [evt.event_id_size]u8, 250 live: Record, 251 resolve: Resolve, 252 ) !Self { 253 const DB = evt.EventDB(repo_opts.hash); 254 const aa = arena.allocator(); 255 256 var updated = live.event; 257 if (resolve.title) |title| updated.title = title; 258 if (resolve.tags) |tags| updated.tags = tags; 259 260 var event_db_maybe: ?evt.LocalEventDB(repo_opts.hash) = if (repo_kind == .git) try evt.LocalEventDB(repo_opts.hash).openReadOnly(io, allocator, repo.core.repo_dir) else null; 261 defer if (event_db_maybe) |*event_db| event_db.deinit(io, allocator); 262 const moment = (if (event_db_maybe) |*event_db| 263 evt.currentMomentFromDb(repo_opts.hash, event_db.db) 264 else if (repo_kind == .git) 265 return updated 266 else 267 evt.currentMoment(repo_opts, repo)) catch return updated; 268 269 const conflicts_cursor = (try moment.getCursor(hash.hashInt(repo_opts.hash, conflicts_key))) orelse return updated; 270 const conflicts = try DB.SortedMap(.read_only).init(conflicts_cursor); 271 const order_key = evt.orderKeyDesc(live.created_order, id_bytes); 272 const conflict_cursor = (try conflicts.getCursor(&order_key)) orelse return updated; 273 const entry = try DB.HashMap(.read_only).init(conflict_cursor); 274 275 const fields_cursor = (try entry.getCursor(hash.hashInt(repo_opts.hash, evt.conflicted_fields_key))) orelse return updated; 276 const conflicted_fields = try fields_cursor.readBytesAlloc(aa, null); 277 if (std.mem.indexOf(u8, conflicted_fields, "description") == null) return updated; 278 279 const their_cursor = (try entry.getCursor(hash.hashInt(repo_opts.hash, evt.their_record_key))) orelse return updated; 280 const theirs = try evt.read(Record, DB, repo_opts.hash, arena, try DB.HashMap(.read_only).init(their_cursor)); 281 282 // absent when both sides created the issue independently 283 var base_description: []const u8 = ""; 284 if (try entry.getCursor(hash.hashInt(repo_opts.hash, evt.base_record_key))) |base_cursor| { 285 const base = try evt.read(Record, DB, repo_opts.hash, arena, try DB.HashMap(.read_only).init(base_cursor)); 286 base_description = base.event.description; 287 } 288 289 const chunks = try diff3.chunks(io, allocator, arena, base_description, live.event.description, theirs.event.description); 290 var resolutions: std.ArrayList([]const u8) = .empty; 291 var hunk_index: usize = 0; 292 for (chunks) |chunk| { 293 if (chunk != .conflict) continue; 294 try resolutions.append(aa, if (hunk_index < resolve.hunks.len) resolve.hunks[hunk_index] else (chunk.conflict.ours orelse "")); 295 hunk_index += 1; 296 } 297 updated.description = try diff3.assemble(aa, chunks, resolutions.items); 298 return updated; 299 } 300 301 // the issue `id_bytes` names in the repo's consumed event db (the repo's own 302 // db for xit; the side db next to a git repo), or null 303 fn readById( 304 comptime repo_kind: rp.RepoKind, 305 comptime repo_opts: rp.RepoOpts(repo_kind), 306 io: std.Io, 307 allocator: std.mem.Allocator, 308 arena: *std.heap.ArenaAllocator, 309 repo: *rp.Repo(repo_kind, repo_opts), 310 id_bytes: *const [evt.event_id_size]u8, 311 ) !?Record { 312 const DB = evt.EventDB(repo_opts.hash); 313 var event_db_maybe: ?evt.LocalEventDB(repo_opts.hash) = if (repo_kind == .git) try evt.LocalEventDB(repo_opts.hash).openReadOnly(io, allocator, repo.core.repo_dir) else null; 314 defer if (event_db_maybe) |*event_db| event_db.deinit(io, allocator); 315 const moment = (if (event_db_maybe) |*event_db| 316 evt.currentMomentFromDb(repo_opts.hash, event_db.db) 317 else if (repo_kind == .git) 318 return null 319 else 320 evt.currentMoment(repo_opts, repo)) catch return null; 321 const event_id_to_issue_cursor = (try moment.getCursor(hash.hashInt(repo_opts.hash, record_map_key))) orelse return null; 322 const event_id_to_issue = try DB.HashMap(.read_only).init(event_id_to_issue_cursor); 323 const issue_cursor = (try event_id_to_issue.getCursor(hash.hashInt(repo_opts.hash, id_bytes))) orelse return null; 324 const issue_map = try DB.HashMap(.read_only).init(issue_cursor); 325 return try evt.read(Record, DB, repo_opts.hash, arena, issue_map); 326 } 327 328 // remove an issue's order key from its tags' `status` sets, pruning entries 329 // whose set becomes empty 330 fn removeFromTagSets( 331 comptime DB: type, 332 tag_to_issues: DB.SortedMap(.read_write), 333 tags: []const u8, 334 status: Status, 335 order_key: []const u8, 336 ) !void { 337 var tag_iter = tagIterator(tags); 338 while (tag_iter.next()) |tag| { 339 // skipped the same way consume skipped it, so it was never indexed 340 if (tag.len == 0 or tag.len > tag_max_len) continue; 341 var key_buffer: TagStatusKey = undefined; 342 const key = try tagStatusKey(&key_buffer, tag, status); 343 const tag_set_cursor = try tag_to_issues.putCursor(key); 344 const tag_set = try DB.SortedSet(.read_write).init(tag_set_cursor); 345 _ = try tag_set.remove(order_key); 346 if (0 == try tag_set.count()) _ = try tag_to_issues.remove(key); 347 } 348 } 349