feat(lockfile): Add commit date to lockfile

This change adds `date` info for the commit.  Git can now use
`--shallow-since` if lockfile is enabled and plugin is in lockfile.

Author: EdenEast

lua/packer.lua

@@ -27,8 +27,8 @@ local config_defaults = {
     cmd = 'git',
     subcommands = {
       update = 'pull --ff-only --progress --rebase=false',
-      install = 'clone --depth %i --no-single-branch --progress',
-      fetch = 'fetch --depth 999999 --progress',
+      install = 'clone --no-single-branch --progress',
+      fetch = 'fetch --progress',
       checkout = 'checkout %s --',
       update_branch = 'merge --ff-only @{u}',
       current_branch = 'rev-parse --abbrev-ref HEAD',
@@ -38,6 +38,7 @@ local config_defaults = {
       get_rev = 'rev-parse --short HEAD',
       get_header = 'log --color=never --pretty=format:FMT --no-show-signature HEAD -n 1',
       get_bodies = 'log --color=never --pretty=format:"===COMMIT_START===%h%n%s===BODY_START===%b" --no-show-signature HEAD@{1}...HEAD',
+      get_date = 'show -s --format="%ct"',
       submodules = 'submodule update --init --recursive --progress',
       revert = 'reset --hard HEAD@{1}',
       revert_to = 'reset --hard %s --',

lua/packer/lockfile.lua

@@ -51,10 +51,13 @@ local function collect_commits(plugins)
         end
       else
         local rev = await(plugin.get_rev())
+        local date = await(plugin.get_date())
         if rev.err then
           failed[name] = fmt("Getting rev for '%s' failed because of error '%s'", name, vim.inspect(rev.err))
+        elseif date.err then
+          failed[name] = fmt("Getting date for '%s' failed because of error '%s'", name, vim.inspect(date.err))
         else
-          completed[name] = { commit = rev.ok }
+          completed[name] = { commit = rev.ok, date = date.ok }
         end
       end
     end
@@ -79,8 +82,7 @@ lockfile.load = function()
 end
 
 lockfile.get = function(name)
-  local res = data[name]
-  return res and res.commit
+  return data[name] or {}
 end
 
 lockfile.update = function(plugins)
@@ -89,7 +91,7 @@ lockfile.update = function(plugins)
     local commits = await(collect_commits(plugins))
 
     for name, commit in pairs(commits.ok.completed) do
-      lines[#lines + 1] = fmt([[  ["%s"] = { commit = "%s" },]], name, commit.commit)
+      lines[#lines + 1] = fmt([[  ["%s"] = { commit = "%s", date = %s },]], name, commit.commit, commit.date)
     end
 
     -- Lines are sorted so that the diff will only contain changes not random re-ordering

lua/packer/plugin_types/git.lua

@@ -86,13 +86,12 @@ git.cfg = function(_config)
   ensure_git_env()
 end
 
----Get lockfile hash if lockfile should be applied
----@param name string
----@return string|nil
-local function get_lockfile_hash(name)
-  if config.is_lockfile and not lockfile.is_updating then
-    return lockfile.get(name)
-  end
+---Get lockfile info if lockfile should be applied
+---@param plugin table @ plugin being applied
+---@return table @ either table with lockfile info or an empty table
+local function get_lockfile_info(plugin)
+  local use_lockfile = config.is_lockfile and not lockfile.is_updating
+  return use_lockfile and lockfile.get(plugin.short_name) or {}
 end
 
 ---Resets a git repo `dest` to `commit`
@@ -159,7 +158,7 @@ local handle_checkouts = function(plugin, dest, disp)
         end)
     end
 
-    local commit = plugin.commit or get_lockfile_hash(plugin.short_name)
+    local commit = plugin.commit or get_lockfile_info(plugin).commit
     if commit then
       if disp ~= nil then
         disp:task_update(plugin_name, fmt('checking out %s...', commit))
@@ -212,30 +211,49 @@ local get_rev = function(plugin)
   end)
 end
 
-git.setup = function(plugin)
+local get_date = function(plugin)
   local plugin_name = util.get_plugin_full_name(plugin)
-  local install_to = plugin.install_path
-  local install_cmd
+
+  local rev_cmd = config.exec_cmd .. config.subcommands.get_date
+
+  return async(function()
+    local rev = await(jobs.run(rev_cmd, { cwd = plugin.install_path, options = { env = git.job_env }, capture_output = true }))
+      :map_ok(function(ok)
+        local _, r = next(ok.output.data.stdout)
+        return r
+      end)
+      :map_err(function(err)
+        local _, msg = fmt('%s: %s', plugin_name, next(err.output.data.stderr))
+        return msg
+      end)
+
+    return rev
+  end)
+end
+
+local get_depth = function(plugin)
   if config.is_lockfile then
-    install_cmd = vim.split(config.exec_cmd .. fmt(config.subcommands.install, 999999), '%s+')
+    local info = lockfile.get(plugin.short_name)
+    return info.date and fmt('--shallow-since="%s"', info.date) or '--depth=999999'
   else
-    install_cmd =
-      vim.split(config.exec_cmd .. fmt(config.subcommands.install, plugin.commit and 999999 or config.depth), '%s+')
+    local depth = plugin.commit and 999999 or config.depth
+    return fmt('--depth="%s"', depth)
   end
+end
+
+git.setup = function(plugin)
+  local plugin_name = util.get_plugin_full_name(plugin)
+  local install_to = plugin.install_path
+  local install_cmd = vim.split(config.exec_cmd .. config.subcommands.install, '%s+')
+  install_cmd[#install_cmd + 1] = get_depth(plugin)
 
   local submodule_cmd = config.exec_cmd .. config.subcommands.submodules
   local rev_cmd = config.exec_cmd .. config.subcommands.get_rev
 
-  local update_cmd = config.exec_cmd
-  if config.is_lockfile then
-    update_cmd = update_cmd .. config.subcommands.fetch
-  else
-    if plugin.commit or plugin.tag then
-      update_cmd = update_cmd .. config.subcommands.fetch
-    else
-      update_cmd = update_cmd .. config.subcommands.update
-    end
-  end
+  local use_fetch = config.is_lockfile or plugin.commit or plugin.tag
+  local update_subcmd = use_fetch and config.subcommands.fetch or config.subcommands.update
+  local update_cmd = vim.split(config.exec_cmd .. update_subcmd, '%s+')
+  update_cmd[#update_cmd + 1] = get_depth(plugin)
 
   local branch_cmd = config.exec_cmd .. config.subcommands.current_branch
   local current_commit_cmd = vim.split(config.exec_cmd .. config.subcommands.get_header, '%s+')
@@ -280,7 +298,7 @@ git.setup = function(plugin)
       installer_opts.cwd = install_to
       r:and_then(await, jobs.run(submodule_cmd, installer_opts))
 
-      local commit = plugin.commit or get_lockfile_hash(plugin.short_name)
+      local commit = plugin.commit or get_lockfile_info(plugin).commit
       if commit then
         disp:task_update(plugin_name, fmt('checking out %s...', commit))
         r
@@ -565,6 +583,12 @@ git.setup = function(plugin)
   plugin.get_rev = function()
     return get_rev(plugin)
   end
+
+  ---Returns HEAD's date
+  ---@return string
+  plugin.get_date = function()
+    return get_date(plugin)
+  end
 end
 
 return git