reinstate 'ref' field for compat, refresh lockfile (#732)

Author: thomashoneyman

app/src/App/API.purs

@@ -957,7 +957,9 @@ publish maybeLegacyContext payload = do
 
       Storage.upload (un Manifest manifest).name (un Manifest manifest).version tarballPath
       Log.debug $ "Adding the new version " <> Version.print (un Manifest manifest).version <> " to the package metadata file."
-      let newPublishedVersion = { hash, compilers: NonEmptyArray.singleton compiler, publishedTime, bytes }
+      -- NOTE: The `ref` field is DEPRECATED and will be removed after 2027-01-31.
+      -- We always write `Just ""` for backwards compatibility with older package managers.
+      let newPublishedVersion = { hash, compilers: NonEmptyArray.singleton compiler, publishedTime, bytes, ref: Just "" }
       let newMetadata = metadata { published = Map.insert (un Manifest manifest).version newPublishedVersion metadata.published }
 
       Registry.writeMetadata (un Manifest manifest).name (Metadata newMetadata)

flake.lock

@@ -11,6 +11,9 @@
     mkSpagoDerivation.url = "github:jeslie0/mkSpagoDerivation";
     mkSpagoDerivation.inputs.nixpkgs.follows = "nixpkgs";
     mkSpagoDerivation.inputs.ps-overlay.follows = "purescript-overlay";
+    # FIXME: Remove as soon as mkSpagoDerivation has the new registry
+    mkSpagoDerivation.inputs.registry.url = "github:purescript/registry/a671816865ced88b888f31b8341f987aa7214027";
+    mkSpagoDerivation.inputs.registry-index.url = "github:purescript/registry-index/d37611d409c5dd95793cc80066ef9400f36f66b0";
   };
 
   outputs =

flake.nix

@@ -63,11 +63,16 @@ codec = Profunctor.wrapIso Metadata $ CJ.named "Metadata" $ CJ.object
   $ CJ.record
 
 -- | Metadata about a published package version.
+-- |
+-- | NOTE: The `ref` field is DEPRECATED and WILL BE REMOVED after 2027-01-31.
+-- | It is only present for backwards compatibility with older package managers.
+-- | Do not rely on its presence!
 type PublishedMetadata =
   { bytes :: Number
   , compilers :: NonEmptyArray Version
   , hash :: Sha256
   , publishedTime :: DateTime
+  , ref :: Maybe String
   }
 
 publishedMetadataCodec :: CJ.Codec PublishedMetadata
@@ -76,6 +81,7 @@ publishedMetadataCodec = CJ.named "PublishedMetadata" $ CJ.Record.object
   , compilers: CJ.Common.nonEmptyArray Version.codec
   , hash: Sha256.codec
   , publishedTime: Internal.Codec.iso8601DateTime
+  , ref: CJ.Record.optional CJ.string
   }
 
 -- | Metadata about an unpublished package version.

lib/src/Metadata.purs

@@ -2,8 +2,15 @@ module Test.Registry.Metadata (spec) where
 
 import Prelude
 
+import Codec.JSON.DecodeError as CJ.DecodeError
+import Data.Codec.JSON as CJ
+import Data.Either (Either(..))
+import Data.Maybe (Maybe(..))
+import Data.String as String
+import JSON as JSON
 import Registry.Metadata as Metadata
 import Registry.Test.Assert as Assert
+import Registry.Test.Utils as Utils
 import Test.Spec (Spec)
 import Test.Spec as Spec
 
@@ -14,6 +21,40 @@ spec = do
       [ { label: "record-studio", value: recordStudio }
       ]
 
+  Spec.describe "PublishedMetadata ref field (deprecated)" do
+    Spec.it "Decodes metadata without ref field" do
+      let json = Utils.fromRight "Failed to parse JSON" $ JSON.parse publishedWithoutRef
+      case CJ.decode Metadata.publishedMetadataCodec json of
+        Left err -> Assert.fail $ "Failed to decode: " <> CJ.DecodeError.print err
+        Right meta -> meta.ref `Assert.shouldEqual` Nothing
+
+    Spec.it "Decodes metadata with ref field" do
+      let json = Utils.fromRight "Failed to parse JSON" $ JSON.parse publishedWithRef
+      case CJ.decode Metadata.publishedMetadataCodec json of
+        Left err -> Assert.fail $ "Failed to decode: " <> CJ.DecodeError.print err
+        Right meta -> meta.ref `Assert.shouldEqual` (Just "v1.0.0")
+
+    Spec.it "Encodes Nothing as missing field (no ref in output)" do
+      let json = Utils.fromRight "Failed to parse JSON" $ JSON.parse publishedWithoutRef
+      case CJ.decode Metadata.publishedMetadataCodec json of
+        Left err -> Assert.fail $ "Failed to decode: " <> CJ.DecodeError.print err
+        Right meta -> do
+          let encoded = CJ.encode Metadata.publishedMetadataCodec meta
+          let jsonStr = JSON.printIndented encoded
+          -- Nothing should result in the field being omitted
+          String.contains (String.Pattern "\"ref\"") jsonStr `Assert.shouldEqual` false
+
+    Spec.it "Encodes Just \"\" as present field" do
+      let json = Utils.fromRight "Failed to parse JSON" $ JSON.parse publishedWithRef
+      case CJ.decode Metadata.publishedMetadataCodec json of
+        Left err -> Assert.fail $ "Failed to decode: " <> CJ.DecodeError.print err
+        Right meta -> do
+          let withEmptyRef = meta { ref = Just "" }
+          let encoded = CJ.encode Metadata.publishedMetadataCodec withEmptyRef
+          let jsonStr = JSON.printIndented encoded
+          -- Just "" should result in the field being present (with "ref": "" pattern)
+          String.contains (String.Pattern "\"ref\": \"\"") jsonStr `Assert.shouldEqual` true
+
 recordStudio :: String
 recordStudio =
   """
@@ -65,3 +106,26 @@ recordStudio =
     }
   }
 }"""
+
+-- PublishedMetadata without ref field (should decode with ref = Nothing)
+publishedWithoutRef :: String
+publishedWithoutRef =
+  """
+{
+  "bytes": 3438,
+  "compilers": ["0.15.10"],
+  "hash": "sha256-LPRUC8ozZc7VCeRhKa4CtSgAfNqgAoVs2lH+7mYEcTk=",
+  "publishedTime": "2021-03-27T10:03:46.000Z"
+}"""
+
+-- PublishedMetadata with ref field (should decode with ref = Just "v1.0.0")
+publishedWithRef :: String
+publishedWithRef =
+  """
+{
+  "bytes": 3438,
+  "compilers": ["0.15.10"],
+  "hash": "sha256-LPRUC8ozZc7VCeRhKa4CtSgAfNqgAoVs2lH+7mYEcTk=",
+  "publishedTime": "2021-03-27T10:03:46.000Z",
+  "ref": "v1.0.0"
+}"""

lib/test/Registry/Metadata.purs

@@ -67,7 +67,7 @@ spec = do
       inRange = unsafeDateTime "2022-12-11T12:00:00.000Z"
       compilers = NonEmptyArray.singleton (unsafeVersion "0.13.0")
 
-      publishedMetadata = { bytes: 100.0, hash: defaultHash, publishedTime: outOfRange, compilers }
+      publishedMetadata = { bytes: 100.0, hash: defaultHash, publishedTime: outOfRange, compilers, ref: Just "" }
 
       metadata = Metadata
         { location: defaultLocation