add git commit date and SHA-1 hash to volume metadata (#410)

Author: tayloraswift

Package.resolved

@@ -15,7 +15,7 @@ extension Unidoc.VolumeMetadata
  projection[.id] = true
  projection[.package] = true
  projection[.version] = true
- projection[.refname] = true
+ projection[.commit_name] = true
  projection[.display] = true
  projection[.latest] = true
  projection[.realm] = true

Sources/UnidocDB/Volumes/Unidoc.VolumeMetadata.NameFields.swift

@@ -17,7 +17,9 @@ extension Unidoc.VolumeMetadata
  projection[.package] = true
  projection[.version] = true
  projection[.display] = true
- projection[.refname] = true
+ projection[.commit_name] = true
+ projection[.commit_sha1] = true
+ projection[.commit_date] = true
  projection[.patch] = true
 
  // TODO: we only need this for top-level queries and

Sources/UnidocDB/Volumes/Unidoc.VolumeMetadata.StoredFields.swift

@@ -111,7 +111,7 @@ extension Unidoc.LinkerContext
  let metadata:Unidoc.VolumeMetadata = .init(id: self.current.id,
  dependencies: boundaries.map(\.target),
  display: self.current.metadata.display,
- refname: self.current.metadata.commit?.name,
+ commit: self.current.metadata.commit,
  symbol: volume,
  latest: self.current.id == latestRelease,
  realm: realm,

Sources/UnidocLinker/Unidoc.LinkerContext.swift

@@ -82,7 +82,7 @@ struct VolumeQueries:Unidoc.TestBattery
 
  #expect(output.canonicalVolume?.patch == .v(0, 2, 0))
  #expect(output.principalVolume.patch == nil)
- #expect(output.principalVolume.refname == "1.0.0-beta.1")
+ #expect(output.principalVolume.commit?.name == "1.0.0-beta.1")
  #expect(output.principalVertex?.landing != nil)
  }
  }

Sources/UnidocQueryTests/VolumeQueries.swift

@@ -18,7 +18,7 @@ extension Unidoc
  public
  var display:String?
  public
- var refname:String?
+ var commit:SymbolGraphMetadata.Commit?
 
  public
  var symbol:Symbol.Volume
@@ -42,7 +42,7 @@ extension Unidoc
  init(id:Unidoc.Edition,
  dependencies:[Dependency] = [],
  display:String? = nil,
- refname:String? = nil,
+ commit:SymbolGraphMetadata.Commit? = nil,
  symbol:Symbol.Volume,
  latest:Bool,
  realm:Unidoc.Realm?,
@@ -55,7 +55,7 @@ extension Unidoc
  self.id = id
  self.dependencies = dependencies
  self.display = display
- self.refname = refname
+ self.commit = commit
  self.symbol = symbol
  self.latest = latest
  self.realm = realm
@@ -91,7 +91,9 @@ extension Unidoc.VolumeMetadata
  /// This is currently copied verbatim from the symbol graph archive, but it is expected
  /// to match (and duplicate) the refname in the associated ``Unidoc.EditionMetadata``
  /// record.
- case refname = "G"
+ case commit_name = "G"
+ case commit_sha1 = "M"
+ case commit_date = "N"
 
  @available(*, unavailable)
  case commit = "H"
@@ -139,7 +141,9 @@ extension Unidoc.VolumeMetadata:BSONDocumentEncodable
  bson[.version] = self.symbol.version
 
  bson[.display] = self.display
- bson[.refname] = self.refname
+ bson[.commit_name] = self.commit?.name
+ bson[.commit_sha1] = self.commit?.sha1
+ bson[.commit_date] = self.commit?.date
 
  bson[.latest] = self.latest ? true : nil
  bson[.realm] = self.realm
@@ -162,10 +166,22 @@ extension Unidoc.VolumeMetadata:BSONDocumentDecodable
  @inlinable public
  init(bson:BSON.DocumentDecoder<CodingKey>) throws
  {
+ let commit:SymbolGraphMetadata.Commit?
+ if let name:String = try bson[.commit_name]?.decode()
+ {
+ commit = .init(name: name,
+ sha1: try bson[.commit_sha1]?.decode(),
+ date: try bson[.commit_date]?.decode())
+ }
+ else
+ {
+ commit = nil
+ }
+
  self.init(id: try bson[.id].decode(),
  dependencies: try bson[.dependencies]?.decode() ?? [],
  display: try bson[.display]?.decode(),
- refname: try bson[.refname]?.decode(),
+ commit: commit,
  symbol: .init(
  package: try bson[.package].decode(),
  version: try bson[.version].decode()),

Sources/UnidocRecords/Volumes/Metadata/Unidoc.VolumeMetadata.swift

@@ -21,6 +21,8 @@ extension Unidoc
  /// `Package.swift` manifest.
  public
  var requirements:[SymbolGraphMetadata.PlatformRequirement]
+
+ /// TODO: we get this from the Volume Metadata instead.
  /// The git commit hash from the symbol graph metadata.
  public
  var commit:SHA1?

Sources/UnidocRecords/Volumes/Vertices/Unidoc.SnapshotDetails.swift

@@ -9,6 +9,7 @@ import Symbols
 import Unidoc
 import UnidocDB
 import UnidocRecords
+import UnixCalendar
 import UnixTime
 import URI
 
@@ -99,7 +100,7 @@ extension Unidoc.DocsEndpoint.PackagePage:Unidoc.ApicalPage
  $0[.div]
  {
  $0.class = "chyron"
- } = repo.chyron(now: format.time, ref: self.volume.refname)
+ } = repo.chyron(now: format.time, ref: self.volume.commit?.name)
  }
 
  main[.section] { $0.class = "notice canonical" } = self.context.canonical
@@ -231,7 +232,9 @@ extension Unidoc.DocsEndpoint.PackagePage:Unidoc.ApicalPage
  }
  }
 
- if let commit:SHA1 = self.apex.snapshot.commit
+ // TODO: we shouldn’t need the SnapshotDetails for this, after uplinking all
+ // the volume metadata.
+ if let commit:SHA1 = self.volume.commit?.sha1 ?? self.apex.snapshot.commit
  {
  $0[.dt] = "Git revision"
  $0[.dd]
@@ -249,6 +252,12 @@ extension Unidoc.DocsEndpoint.PackagePage:Unidoc.ApicalPage
  $0[link: url] { $0.external(safe: false) } = "\(commit)"
  }
  }
+ if let date:UnixMillisecond = self.volume.commit?.date,
+ let date:Timestamp = date.timestamp
+ {
+ $0[.dt] = "Git commit date"
+ $0[.dd] = "\(date.http)"
+ }
  }
 
  main[.div] { $0.class = "more" } = Unidoc.StatsThumbnail.init(

Sources/UnidocUI/Endpoints/Docs/Unidoc.DocsEndpoint.PackagePage.swift

@@ -40,7 +40,7 @@ extension Unidoc
  var media:PackageMedia = packages.principal?.media ?? .init()
  if let repo:PackageRepo = packages.principal?.repo
  {
- let ref:String = principal.refname ?? repo.master ?? "master"
+ let ref:String = principal.commit?.name ?? repo.master ?? "master"
  let path:String
  switch repo.origin
  {

Sources/UnidocUI/Page contexts/Unidoc.IdentifiablePageContext.swift

@@ -67,7 +67,7 @@ extension Unidoc.VertexContext
  func link(source file:Unidoc.Scalar, line:Int? = nil) -> Unidoc.SourceLink?
  {
  guard
- let refname:String = self[file.edition]?.refname,
+ let refname:String = self[file.edition]?.commit?.name,
  let vertex:Unidoc.FileVertex = self.vertices[file]?.vertex.file,
  let origin:Unidoc.PackageOrigin = self.repo?.origin
  else