Commit 8f6b1f2c38422168d29a6dd6fab61f337430e74e | zig

author	Christofer Nolander <christofer@nolander.me> 2024-05-11 23:19:35+02:00
committer	GitHub <noreply@github.com> 2024-05-11 14:19:35-07:00
log	8f6b1f2c38422168d29a6dd6fab61f337430e74e
tree	bf959e2178d4374690b6590322dccb93c168c958
parent	86d8688c7f14d30c66b2cb4b55826ab15b39ad55
signature	Signed by PGP key B5690EEEBB952194

`zig fetch`: resolve branch/tag names to commit SHA (#19941)

* Revert "Revert "Merge pull request #19349 from nolanderc/save-commit""

This reverts commit 6ca4ed5948d8eaab28fc5e3706aeb1b113a210af.

* update to new URI changes, rework `--save` type

* initialize `latest_commit` to null everywhere

2 files changed, 63 insertions(+), 9 deletions(-)

src
- Package
  - Fetch.zig
- main.zig

src/Package/Fetch.zig+11-1

...	@@ -44,6 +44,8 @@ omit_missing_hash_error: bool,	...	@@ -44,6 +44,8 @@ omit_missing_hash_error: bool,
44	/// which specifies inclusion rules. This is intended to be true for the first	44	/// which specifies inclusion rules. This is intended to be true for the first
45	/// fetch task and false for the recursive dependencies.	45	/// fetch task and false for the recursive dependencies.
46	allow_missing_paths_field: bool,	46	allow_missing_paths_field: bool,
		47	/// If true and URL points to a Git repository, will use the latest commit.
		48	use_latest_commit: bool,
47		49
48	// Above this are fields provided as inputs to `run`.	50	// Above this are fields provided as inputs to `run`.
49	// Below this are fields populated by `run`.	51	// Below this are fields populated by `run`.
...	@@ -59,6 +61,10 @@ actual_hash: Manifest.Digest,	...	@@ -59,6 +61,10 @@ actual_hash: Manifest.Digest,
59	has_build_zig: bool,	61	has_build_zig: bool,
60	/// Indicates whether the task aborted due to an out-of-memory condition.	62	/// Indicates whether the task aborted due to an out-of-memory condition.
61	oom_flag: bool,	63	oom_flag: bool,
		64	/// If `use_latest_commit` was true, this will be set to the commit that was used.
		65	/// If the resource pointed to by the location is not a Git-repository, this
		66	/// will be left unchanged.
		67	latest_commit: ?git.Oid,
62		68
63	// This field is used by the CLI only, untouched by this file.	69	// This field is used by the CLI only, untouched by this file.
64		70
...	@@ -699,6 +705,7 @@ fn queueJobsForDeps(f: *Fetch) RunError!void {	...	@@ -699,6 +705,7 @@ fn queueJobsForDeps(f: *Fetch) RunError!void {
699	.job_queue = f.job_queue,	705	.job_queue = f.job_queue,
700	.omit_missing_hash_error = false,	706	.omit_missing_hash_error = false,
701	.allow_missing_paths_field = true,	707	.allow_missing_paths_field = true,
		708	.use_latest_commit = false,
702		709
703	.package_root = undefined,	710	.package_root = undefined,
704	.error_bundle = undefined,	711	.error_bundle = undefined,
...	@@ -707,6 +714,7 @@ fn queueJobsForDeps(f: *Fetch) RunError!void {	...	@@ -707,6 +714,7 @@ fn queueJobsForDeps(f: *Fetch) RunError!void {
707	.actual_hash = undefined,	714	.actual_hash = undefined,
708	.has_build_zig = false,	715	.has_build_zig = false,
709	.oom_flag = false,	716	.oom_flag = false,
		717	.latest_commit = null,
710		718
711	.module = null,	719	.module = null,
712	};	720	};
...	@@ -994,7 +1002,9 @@ fn initResource(f: *Fetch, uri: std.Uri, server_header_buffer: []u8) RunError!Re	...	@@ -994,7 +1002,9 @@ fn initResource(f: *Fetch, uri: std.Uri, server_header_buffer: []u8) RunError!Re
994	}	1002	}
995	return f.fail(f.location_tok, try eb.printString("ref not found: {s}", .{want_ref}));	1003	return f.fail(f.location_tok, try eb.printString("ref not found: {s}", .{want_ref}));
996	};	1004	};
997	if (uri.fragment == null) {	1005	if (f.use_latest_commit) {
		1006	f.latest_commit = want_oid;
		1007	} else if (uri.fragment == null) {
998	const notes_len = 1;	1008	const notes_len = 1;
999	try eb.addRootErrorMessage(.{	1009	try eb.addRootErrorMessage(.{
1000	.msg = try eb.addString("url field is missing an explicit ref"),	1010	.msg = try eb.addString("url field is missing an explicit ref"),

src/main.zig+52-8

 @@ -5097,6 +5097,7 @@ fn cmdBuild(gpa: Allocator, arena: Allocator, args: []const []const u8) !void {
                     .job_queue = &job_queue,
                     .omit_missing_hash_error = true,
                     .allow_missing_paths_field = false,
+                    .use_latest_commit = false,
                     .package_root = undefined,
                     .error_bundle = undefined,
 @@ -5105,6 +5106,7 @@ fn cmdBuild(gpa: Allocator, arena: Allocator, args: []const []const u8) !void {
                     .actual_hash = undefined,
                     .has_build_zig = true,
                     .oom_flag = false,
+                    .latest_commit = null,
                     .module = build_mod,
                 };
 @@ -6894,6 +6896,8 @@ const usage_fetch =
     \\  --debug-hash                  Print verbose hash information to stdout
     \\  --save                        Add the fetched package to build.zig.zon
     \\  --save=[name]                 Add the fetched package to build.zig.zon as name
+    \\  --save-exact                  Add the fetched package to build.zig.zon, storing the URL verbatim
+    \\  --save-exact=[name]           Add the fetched package to build.zig.zon as name, storing the URL verbatim
     \\
 ;
 @@ -6908,7 +6912,11 @@ fn cmdFetch(
     var opt_path_or_url: ?[]const u8 = null;
     var override_global_cache_dir: ?[]const u8 = try EnvVar.ZIG_GLOBAL_CACHE_DIR.get(arena);
     var debug_hash: bool = false;
-    var save: union(enum) { no, yes, name: []const u8 } = .no;
+    var save: union(enum) {
+        no,
+        yes: ?[]const u8,
+        exact: ?[]const u8,
+    } = .no;
     {
         var i: usize = 0;
 @@ -6926,9 +6934,13 @@ fn cmdFetch(
                 } else if (mem.eql(u8, arg, "--debug-hash")) {
                     debug_hash = true;
                 } else if (mem.eql(u8, arg, "--save")) {
-                    save = .yes;
+                    save = .{ .yes = null };
                 } else if (mem.startsWith(u8, arg, "--save=")) {
-                    save = .{ .name = arg["--save=".len..] };
+                    save = .{ .yes = arg["--save=".len..] };
+                } else if (mem.eql(u8, arg, "--save-exact")) {
+                    save = .{ .exact = null };
+                } else if (mem.startsWith(u8, arg, "--save-exact=")) {
+                    save = .{ .exact = arg["--save=".len..] };
                 } else {
                     fatal("unrecognized parameter: '{s}'", .{arg});
                 }
 @@ -6988,6 +7000,7 @@ fn cmdFetch(
         .job_queue = &job_queue,
         .omit_missing_hash_error = true,
         .allow_missing_paths_field = false,
+        .use_latest_commit = true,
         .package_root = undefined,
         .error_bundle = undefined,
 @@ -6996,6 +7009,7 @@ fn cmdFetch(
         .actual_hash = undefined,
         .has_build_zig = false,
         .oom_flag = false,
+        .latest_commit = null,
         .module = null,
     };
 @@ -7022,12 +7036,12 @@ fn cmdFetch(
             try io.getStdOut().writeAll(hex_digest ++ "\n");
             return cleanExit();
         },
-        .yes => n: {
+        .yes, .exact => |name| name: {
+            if (name) |n| break :name n;
             const fetched_manifest = fetch.manifest orelse
                 fatal("unable to determine name; fetched package has no build.zig.zon file", .{});
-            break :n fetched_manifest.name;
+            break :name fetched_manifest.name;
         },
-        .name => |n| n,
     };
     const cwd_path = try process.getCwdAlloc(arena);
 @@ -7052,13 +7066,43 @@ fn cmdFetch(
     var fixups: Ast.Fixups = .{};
     defer fixups.deinit(gpa);
+    var saved_path_or_url = path_or_url;
+    if (fetch.latest_commit) |*latest_commit| resolved: {
+        const latest_commit_hex = try std.fmt.allocPrint(arena, "{}", .{std.fmt.fmtSliceHexLower(latest_commit)});
+        var uri = try std.Uri.parse(path_or_url);
+        if (uri.fragment) |fragment| {
+            const target_ref = try fragment.toRawMaybeAlloc(arena);
+            // the refspec may already be fully resolved
+            if (std.mem.eql(u8, target_ref, latest_commit_hex)) break :resolved;
+            std.log.info("resolved ref '{s}' to commit {s}", .{ target_ref, latest_commit_hex });
+            // include the original refspec in a query parameter, could be used to check for updates
+            uri.query = .{ .percent_encoded = try std.fmt.allocPrint(arena, "ref={%}", .{fragment}) };
+        } else {
+            std.log.info("resolved to commit {s}", .{latest_commit_hex});
+        }
+        // replace the refspec with the resolved commit SHA
+        uri.fragment = .{ .raw = latest_commit_hex };
+        switch (save) {
+            .yes => saved_path_or_url = try std.fmt.allocPrint(arena, "{}", .{uri}),
+            .no, .exact => {}, // keep the original URL
+        }
+    }
     const new_node_init = try std.fmt.allocPrint(arena,
         \\.{{
         \\            .url = "{}",
         \\            .hash = "{}",
         \\        }}
     , .{
-        std.zig.fmtEscapes(path_or_url),
+        std.zig.fmtEscapes(saved_path_or_url),
         std.zig.fmtEscapes(&hex_digest),
     });
 @@ -7078,7 +7122,7 @@ fn cmdFetch(
         if (dep.hash) |h| {
             switch (dep.location) {
                 .url => |u| {
-                    if (mem.eql(u8, h, &hex_digest) and mem.eql(u8, u, path_or_url)) {
+                    if (mem.eql(u8, h, &hex_digest) and mem.eql(u8, u, saved_path_or_url)) {
                         std.log.info("existing dependency named '{s}' is up-to-date", .{name});
                         process.exit(0);
                     }