tiny.smg.command.impact

1const std = @import("std");23const smg = @import("../root.zig");4const graph_mod = smg.graph;5const model = smg.model;6const query = smg.query;7const traversal = smg.traversal;8const cli_json = smg.cli.json;9const cli_options = smg.cli.options;10const cli_output = smg.cli.output;11const cli_resolve = smg.cli.resolve;12const cli_session = smg.command.session;13const table = smg.cli.table;14const cli_validation = smg.cli.validation;1516pub fn run(allocator: std.mem.Allocator, phases: std.mem.Allocator, args: []const []const u8, limits: smg.Limits, boundary: cli_session.PhaseBoundary) !u8 {17    if (try cli_validation.rejectMissingOptionValues(allocator, args, &.{ "--depth", "--format", "--limit" })) return 2;18    if (try cli_validation.rejectUnexpectedOptionsPlain(allocator, "impact", "[OPTIONS] NAME", args, &.{ "--depth", "--format", "--coupling-only", "--all-rels", "--limit" })) return 2;19    if (try cli_validation.rejectInvalidChoiceOption(allocator, "impact", "[OPTIONS] NAME", args, "--format", &.{ "text", "json" })) return 2;20    if (try cli_validation.rejectInvalidIntegerOption(allocator, "impact", "[OPTIONS] NAME", args, "--depth")) return 2;21    if (try cli_validation.rejectInvalidIntegerOption(allocator, "impact", "[OPTIONS] NAME", args, "--limit")) return 2;22    const pos = try cli_options.positional(allocator, args);23    if (pos.len == 0) {24        try cli_output.writeClickUsageError(allocator, "impact", "[OPTIONS] NAME", "Missing argument 'NAME'.");25        return 2;26    }27    if (pos.len > 1) {28        try cli_output.writeClickUsageError(allocator, "impact", "[OPTIONS] NAME", try cli_validation.unexpectedArgumentMessage(allocator, pos[1..]));29        return 2;30    }31    _ = phases;32    const root = try smg.storage.requireRoot(allocator);33    try cli_session.noteGraphAge(allocator, root);34    var opened = try smg.storage.store.openRead(allocator, root, limits.storage);35    defer opened.close();36    const name = try cli_resolve.storedNode(37        allocator,38        root,39        &opened.reader,40        pos[0],41        limits.suggestions,42    );43    const coupling_only = cli_options.couplingOnlyValue(args);44    const names = try query.impactFromReader(45        allocator,46        &opened.reader,47        name,48        cli_options.depthValue(args),49        coupling_only,50    );51    boundary.seal();52    defer boundary.beginTeardown();53    const limit = cli_options.signedLimitValue(args);54    const displayed = cli_options.slicedLen(names.len, limit);55    var out: std.Io.Writer.Allocating = .init(allocator);56    if (std.mem.eql(u8, cli_options.flagValue(args, "--format") orelse "", "json")) {57        try cli_json.writeImpact(&out.writer, name, names[0..displayed], names.len, limit, coupling_only);58        return try cli_output.writeOut(out.written());59    }60    try writeTextSource(61        allocator,62        &out.writer,63        .{ .stored = &opened.reader },64        name,65        names[0..displayed],66        names.len,67    );68    return try cli_output.writeOut(out.written());69}7071pub fn writeText(writer: *std.Io.Writer, graph: graph_mod.Graph, target: []const u8, names: []const []const u8, total: usize) !void {72    return try writeTextSource(graph.allocator, writer, .{ .graph = graph }, target, names, total);73}7475fn writeTextSource(76    allocator: std.mem.Allocator,77    writer: *std.Io.Writer,78    source: traversal.Source,79    target: []const u8,80    names: []const []const u8,81    total: usize,82) !void {83    if (total == 0) {84        try writer.print("{s}: no upstream dependents\n", .{target});85        return;86    }87    try writer.print("Impact of changing {s}:\n", .{target});88    const columns = [_]table.Column{89        .{ .header = "type", .max_width = 14 },90        .{ .header = "name", .max_width = 72 },91    };92    var scratch_state = std.heap.ArenaAllocator.init(allocator);93    defer scratch_state.deinit();94    const scratch = scratch_state.allocator();95    var rows: std.ArrayList([]const []const u8) = .empty;96    for (names) |name| {97        const node_type = if (try source.node(scratch, name)) |node| node.type else "?";98        try table.appendRow(scratch, &rows, &.{ node_type, name });99    }100    try table.writeJsonOption(allocator, writer, &columns, rows.items, total, "--format json");101    try writer.print("\n{d} node(s) affected\n", .{total});102}103104test "impact renders all relationship text contract" {105    var arena = std.heap.ArenaAllocator.init(std.testing.allocator);106    defer arena.deinit();107    const allocator = arena.allocator();108    var graph = graph_mod.init(allocator);109    try graph_mod.addNode(&graph, .{ .name = "app", .type = model.NodeType.module });110    try graph_mod.addNode(&graph, .{ .name = "app.main", .type = model.NodeType.function });111    try graph_mod.addNode(&graph, .{ .name = "app.helper", .type = model.NodeType.function });112    try graph_mod.addNode(&graph, .{ .name = "owner", .type = model.NodeType.module });113    try graph_mod.addEdge(&graph, .{ .source = "app", .rel = model.RelType.contains, .target = "app.main" });114    try graph_mod.addEdge(&graph, .{ .source = "app.main", .rel = model.RelType.calls, .target = "app.helper" });115    try graph_mod.addEdge(&graph, .{ .source = "owner", .rel = model.RelType.contains, .target = "app.helper" });116    const all = try query.impact(allocator, graph, "app.helper", null, false);117    var out: std.Io.Writer.Allocating = .init(allocator);118    try writeText(&out.writer, graph, "app.helper", all[0..1], all.len);119    try std.testing.expectEqualStrings(120        "Impact of changing app.helper:\n" ++121            "type    name\n" ++122            "------  ----\n" ++123            "module  app\n" ++124            "(showing 1 of 3 \xE2\x80\x94 use --limit 0 for all, --format json for exact records)\n" ++125            "\n" ++126            "3 node(s) affected\n",127        out.written(),128    );129}

1pub const impact = @import("impact.zig");