Commit 8d384722937edcfdcb3c461d316ed97405e6e2ee | zig

author	Andrew Kelley <andrew@ziglang.org> 2023-02-14 13:12:47-07:00
committer	Andrew Kelley <andrew@ziglang.org> 2023-03-15 10:48:12-07:00
log	8d384722937edcfdcb3c461d316ed97405e6e2ee
tree	e4a33a5a1d235e84961c2fc0adf3a49af7646d72
parent	02381c037221937e941e03c5e7439383dde8a2a1

std.Build: further enhance debug message for bad getPath()

Now it also shows the step stack trace of the step whose make function
is being run.

2 files changed, 42 insertions(+), 8 deletions(-)

lib
- std
  - Build.zig
  - Build
    InstallFileStep.zig

lib/std/Build.zig+41-7

 @@ -1661,13 +1661,20 @@ pub const FileSource = union(enum) {
     /// Should only be called during make(), returns a path relative to the build root or absolute.
     pub fn getPath(self: FileSource, src_builder: *Build) []const u8 {
+        return getPath2(self, src_builder, null);
+    }
+    /// Should only be called during make(), returns a path relative to the build root or absolute.
+    /// asking_step is only used for debugging purposes; it's the step being run that is asking for
+    /// the path.
+    pub fn getPath2(self: FileSource, src_builder: *Build, asking_step: ?*Step) []const u8 {
         switch (self) {
             .path => |p| return src_builder.pathFromRoot(p),
             .generated => |gen| return gen.path orelse {
                 std.debug.getStderrMutex().lock();
                 const stderr = std.io.getStdErr();
-                dumpBadGetPathHelp(gen.step, stderr, src_builder) catch {};
+                dumpBadGetPathHelp(gen.step, stderr, src_builder, asking_step) catch {};
-                @panic("unable to get path");
+                @panic("misconfigured build script");
             },
         }
     }
 @@ -1681,25 +1688,52 @@ pub const FileSource = union(enum) {
     }
 };
-fn dumpBadGetPathHelp(s: *Step, stderr: fs.File, src_builder: *Build) anyerror!void {
+/// In this function the stderr mutex has already been locked.
-    try stderr.writer().print(
+fn dumpBadGetPathHelp(
+    s: *Step,
+    stderr: fs.File,
+    src_builder: *Build,
+    asking_step: ?*Step,
+) anyerror!void {
+    const w = stderr.writer();
+    try w.print(
         \\getPath() was called on a GeneratedFile that wasn't built yet.
         \\  source package path: {s}
         \\  Is there a missing Step dependency on step '{s}'?
-        \\    The step was created by this stack trace:
         \\
     , .{
         src_builder.build_root.path orelse ".",
         s.name,
     });
+    const tty_config = std.debug.detectTTYConfig(stderr);
+    tty_config.setColor(w, .Red) catch {};
+    try stderr.writeAll("    The step was created by this stack trace:\n");
+    tty_config.setColor(w, .Reset) catch {};
     const debug_info = std.debug.getSelfDebugInfo() catch |err| {
-        try stderr.writer().print("Unable to dump stack trace: Unable to open debug info: {s}\n", .{@errorName(err)});
+        try w.print("Unable to dump stack trace: Unable to open debug info: {s}\n", .{@errorName(err)});
         return;
     };
-    std.debug.writeStackTrace(s.getStackTrace(), stderr.writer(), debug_info.allocator, debug_info, std.debug.detectTTYConfig(stderr)) catch |err| {
+    const ally = debug_info.allocator;
+    std.debug.writeStackTrace(s.getStackTrace(), w, ally, debug_info, tty_config) catch |err| {
         try stderr.writer().print("Unable to dump stack trace: {s}\n", .{@errorName(err)});
         return;
     };
+    if (asking_step) |as| {
+        tty_config.setColor(w, .Red) catch {};
+        try stderr.writeAll("    The step that is missing a dependency on the above step was created by this stack trace:\n");
+        tty_config.setColor(w, .Reset) catch {};
+        std.debug.writeStackTrace(as.getStackTrace(), w, ally, debug_info, tty_config) catch |err| {
+            try stderr.writer().print("Unable to dump stack trace: {s}\n", .{@errorName(err)});
+            return;
+        };
+    }
+    tty_config.setColor(w, .Red) catch {};
+    try stderr.writeAll("    Hope that helps. Proceeding to panic.\n");
+    tty_config.setColor(w, .Reset) catch {};
 }
 /// Allocates a new string for assigning a value to a named macro.

lib/std/Build/InstallFileStep.zig+1-1

...	@@ -38,7 +38,7 @@ pub fn init(	...	@@ -38,7 +38,7 @@ pub fn init(
38	fn make(step: *Step) !void {	38	fn make(step: *Step) !void {
39	const self = @fieldParentPtr(InstallFileStep, "step", step);	39	const self = @fieldParentPtr(InstallFileStep, "step", step);
40	const src_builder = self.override_source_builder orelse self.builder;	40	const src_builder = self.override_source_builder orelse self.builder;
41	const full_src_path = self.source.getPath(src_builder);	41	const full_src_path = self.source.getPath2(src_builder, step);
42	const full_dest_path = self.builder.getInstallPath(self.dir, self.dest_rel_path);	42	const full_dest_path = self.builder.getInstallPath(self.dir, self.dest_rel_path);
43	try self.builder.updateFile(full_src_path, full_dest_path);	43	try self.builder.updateFile(full_src_path, full_dest_path);
44	}	44	}