Merge pull request #302 from tayloraswift/handle-upper-prerelease-bound

tayloraswift · web-flow · commit dacf88bf6931 · 2024-07-12T17:00:33.000-05:00
fix #297
diff --git a/Sources/PackageMetadata/Manifests/SPM.Manifest.Dependency.Resolvable.swift b/Sources/PackageMetadata/Manifests/SPM.Manifest.Dependency.Resolvable.swift
@@ -84,7 +84,7 @@ extension SPM.Manifest.Dependency.Resolvable:JSONObjectDecodable
                     with: \.value.value)))
 
             case .range:
-                let (lower, upper):(SemanticVersion, PatchVersion) = try json.decode(
+                let (lower, upper):(SemanticVersion, SemanticVersion) = try json.decode(
                     as: JSON.SingleElementRepresentation<
                         JSON.ObjectDecoder<CodingKey.Requirement.Range>>.self)
                 {
@@ -93,7 +93,7 @@ extension SPM.Manifest.Dependency.Resolvable:JSONObjectDecodable
                             as: JSON.StringRepresentation<SemanticVersion>.self,
                             with: \.value),
                         try $0.value[.upperBound].decode(
-                            as: JSON.StringRepresentation<PatchVersion>.self,
+                            as: JSON.StringRepresentation<SemanticVersion>.self,
                             with: \.value)
                     )
                 }
diff --git a/Sources/PackageMetadataTests/Main.PackageSwift.swift b/Sources/PackageMetadataTests/Main.PackageSwift.swift
@@ -214,7 +214,7 @@ extension Main.PackageSwift:TestBattery
                             location: .remote(
                                 url: "https://github.com/tayloraswift/swift-grammar"),
                             requirement: .stable(.range(.release(.v(0, 3, 1)),
-                                to: .v(0, 4, 0))))),
+                                to: .release(.v(0, 4, 0)))))),
 
                         .resolvable(.init(
                             identity: "swift-hash",
@@ -228,7 +228,7 @@ extension Main.PackageSwift:TestBattery
                             location: .local(
                                 root: "/swift/swift-mongodb"),
                             requirement: .stable(.range(.release(.v(0, 4, 5)),
-                                to: .v(0, 5, 0))))),
+                                to: .release(.v(0, 5, 0)))))),
 
                         .resolvable(.init(
                             identity: "swift-system",
diff --git a/Sources/SymbolGraphBuilderTests/Main.swift b/Sources/SymbolGraphBuilderTests/Main.swift
@@ -248,8 +248,7 @@ enum Main:TestMain, TestBattery
             })
         {
             //  the swift-docc-plugin dependency should have been linted.
-            tests.expect(docs.metadata.dependencies.map(\.package.name) **?
-            [
+            tests.expect(docs.metadata.dependencies.map(\.package.name) **? [
                 "swift-atomics",
                 "swift-collections",
                 //  swift-nio grew a dependency on swift-system in 2.63.0
@@ -276,8 +275,7 @@ enum Main:TestMain, TestBattery
                     with: toolchain)
             })
         {
-            tests.expect(docs.metadata.dependencies.map(\.package.name) **?
-            [
+            tests.expect(docs.metadata.dependencies.map(\.package.name) **? [
                 "swift-collections",
                 "swift-atomics",
                 "swift-nio",
@@ -302,8 +300,7 @@ enum Main:TestMain, TestBattery
                     with: toolchain)
             })
         {
-            tests.expect(docs.metadata.dependencies.map(\.package.name) **?
-            [
+            tests.expect(docs.metadata.dependencies.map(\.package.name) **? [
                 "swift-collections",
                 "swift-atomics",
                 "swift-nio",
@@ -337,6 +334,33 @@ enum Main:TestMain, TestBattery
             docs.roundtrip(for: tests, in: workspace.artifacts)
         }
 
+        //  The swift-snapshot-testing package at 1.17.0 has a dependency on SwiftSyntax with
+        //  prerelease bounds on both sides, so we should be able to handle that.
+
+        //  This test is disabled on macOS because `swift symbolgraph-extract` crashes there.
+        #if os(Linux)
+        if  let tests:TestGroup = tests / "swift-snapshot-testing",
+            let docs:SymbolGraphObject<Void> = (tests.do
+            {
+                try workspace.build(package: try .remote(
+                        project: "swift-snapshot-testing",
+                        from: "https://github.com/pointfreeco/swift-snapshot-testing.git",
+                        at: "1.17.0",
+                        in: workspace),
+                    with: toolchain)
+            })
+        {
+            tests.expect(docs.metadata.dependencies.map(\.package.name) **? [
+                "swift-syntax",
+            ])
+
+            tests.expect(docs.graph.cultures.count >? 0)
+            tests.expect(docs.graph.decls.nodes.count >? 0)
+
+            docs.roundtrip(for: tests, in: workspace.artifacts)
+        }
+        #endif
+
         //  IndexstoreDB links the LLVM Blocks runtime, so this tests that we handle that.
         //  Since it involves specifying the location of the Swift runtime, we can only expect
         //  this to work within a particular Docker container.
diff --git a/Sources/SymbolGraphs/Metadata/SymbolGraphMetadata.Dependency.swift b/Sources/SymbolGraphs/Metadata/SymbolGraphMetadata.Dependency.swift
@@ -44,9 +44,10 @@ extension SymbolGraphMetadata.Dependency
     {
         case package_name = "P"
         case package_scope = "S"
-        case requirement_suffix = "B"
-        case requirement_lower = "L"
-        case requirement_upper = "U"
+        case requirement_lowerNumber = "L"
+        case requirement_lowerSuffix = "B"
+        case requirement_upperNumber = "U"
+        case requirement_upperSuffix = "C"
         case revision = "H"
         case version = "V"
     }
@@ -65,13 +66,16 @@ extension SymbolGraphMetadata.Dependency:BSONDocumentEncodable
             break
 
         case .range(let version, to: let upper)?:
-            bson[.requirement_upper] = upper
+            let suffix:String = "\(upper.suffix)"
+            bson[.requirement_upperNumber] = upper.number
+            bson[.requirement_upperSuffix] = suffix.isEmpty ? nil : suffix
+
             fallthrough
 
         case .exact(let version)?:
             let suffix:String = "\(version.suffix)"
-            bson[.requirement_lower] = version.number
-            bson[.requirement_suffix] = suffix.isEmpty ? nil : suffix
+            bson[.requirement_lowerNumber] = version.number
+            bson[.requirement_lowerSuffix] = suffix.isEmpty ? nil : suffix
         }
 
         bson[.revision] = self.revision
@@ -84,9 +88,10 @@ extension SymbolGraphMetadata.Dependency:BSONDocumentDecodable
     init(bson:BSON.DocumentDecoder<CodingKey>) throws
     {
         let requirement:SymbolGraphMetadata.DependencyRequirement? = .init(
-            suffix: try bson[.requirement_suffix]?.decode(),
-            lower: try bson[.requirement_lower]?.decode(),
-            upper: try bson[.requirement_upper]?.decode())
+            lowerNumber: try bson[.requirement_lowerNumber]?.decode(),
+            lowerSuffix: try bson[.requirement_lowerSuffix]?.decode(),
+            upperNumber: try bson[.requirement_upperNumber]?.decode(),
+            upperSuffix: try bson[.requirement_upperSuffix]?.decode())
 
         self.init(package: .init(
                 scope: try bson[.package_scope]?.decode(),
diff --git a/Sources/SymbolGraphs/Metadata/SymbolGraphMetadata.DependencyRequirement.swift b/Sources/SymbolGraphs/Metadata/SymbolGraphMetadata.DependencyRequirement.swift
@@ -6,31 +6,40 @@ extension SymbolGraphMetadata
     enum DependencyRequirement:Equatable, Hashable, Sendable
     {
         case exact(SemanticVersion)
-        case range(SemanticVersion, to:PatchVersion)
+        case range(SemanticVersion, to:SemanticVersion)
     }
 }
 extension SymbolGraphMetadata.DependencyRequirement
 {
     @inlinable public
-    init?(suffix:SemanticVersion.Suffix?, lower:PatchVersion?, upper:PatchVersion?)
+    init?(
+        lowerNumber:PatchVersion?,
+        lowerSuffix:SemanticVersion.Suffix?,
+        upperNumber:PatchVersion?,
+        upperSuffix:SemanticVersion.Suffix?)
     {
         guard
-        let version:PatchVersion = lower
+        let lowerNumber:PatchVersion
         else
         {
             return nil
         }
 
-        let suffix:SemanticVersion.Suffix =  suffix ?? .release()
+        let lower:SemanticVersion = .init(
+            number: lowerNumber,
+            suffix: lowerSuffix ?? .release())
 
-        if  let upper:PatchVersion,
-                upper >= version
+        if  let upperNumber:PatchVersion,
+                upperNumber >= lowerNumber
         {
-            self = .range(.init(number: version, suffix: suffix), to: upper)
+            let upper:SemanticVersion = .init(number: upperNumber,
+                suffix: upperSuffix ?? .release())
+
+            self = .range(lower, to: upper)
         }
         else
         {
-            self = .exact(.init(number: version, suffix: suffix))
+            self = .exact(lower)
         }
     }
 }
diff --git a/Sources/SymbolGraphs/SymbolGraphABI.swift b/Sources/SymbolGraphs/SymbolGraphABI.swift
@@ -3,5 +3,5 @@ import SemanticVersions
 @frozen public
 enum SymbolGraphABI
 {
-    @inlinable public static var version:PatchVersion { .v(0, 9, 6) }
+    @inlinable public static var version:PatchVersion { .v(0, 9, 7) }
 }
diff --git a/Sources/UnidocRecords/Volumes/Metadata/Unidoc.VolumeMetadata.Dependency.swift b/Sources/UnidocRecords/Volumes/Metadata/Unidoc.VolumeMetadata.Dependency.swift
@@ -38,9 +38,10 @@ extension Unidoc.VolumeMetadata.Dependency
     enum CodingKey:String, Sendable
     {
         case exonym = "_id"
-        case requirement_suffix = "B"
-        case requirement_lower = "L"
-        case requirement_upper = "U"
+        case requirement_lowerNumber = "L"
+        case requirement_lowerSuffix = "B"
+        case requirement_upperNumber = "U"
+        case requirement_upperSuffix = "C"
         case resolution = "S"
         case linked = "p"
         case pinned = "q"
@@ -59,13 +60,15 @@ extension Unidoc.VolumeMetadata.Dependency:BSONDocumentEncodable
             break
 
         case .range(let version, to: let upper)?:
-            bson[.requirement_upper] = upper
+            let suffix:String = "\(upper.suffix)"
+            bson[.requirement_upperNumber] = upper.number
+            bson[.requirement_upperSuffix] = suffix.isEmpty ? nil : suffix
             fallthrough
 
         case .exact(let version)?:
             let suffix:String = "\(version.suffix)"
-            bson[.requirement_lower] = version.number
-            bson[.requirement_suffix] = suffix.isEmpty ? nil : suffix
+            bson[.requirement_lowerNumber] = version.number
+            bson[.requirement_lowerSuffix] = suffix.isEmpty ? nil : suffix
         }
 
         bson[.resolution] = self.resolution
@@ -84,9 +87,10 @@ extension Unidoc.VolumeMetadata.Dependency:BSONDocumentDecodable
     init(bson:BSON.DocumentDecoder<CodingKey>) throws
     {
         let requirement:SymbolGraphMetadata.DependencyRequirement? = .init(
-            suffix: try bson[.requirement_suffix]?.decode(),
-            lower: try bson[.requirement_lower]?.decode(),
-            upper: try bson[.requirement_upper]?.decode())
+            lowerNumber: try bson[.requirement_lowerNumber]?.decode(),
+            lowerSuffix: try bson[.requirement_lowerSuffix]?.decode(),
+            upperNumber: try bson[.requirement_upperNumber]?.decode(),
+            upperSuffix: try bson[.requirement_upperSuffix]?.decode())
 
         let pin:Unidoc.VolumeMetadata.DependencyPin?
 

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ extension SPM.Manifest.Dependency.Resolvable:JSONObjectDecodable`
`84`	`84`	`with: \.value.value)))`
`85`	`85`
`86`	`86`	`case .range:`
`87`		`- let (lower, upper):(SemanticVersion, PatchVersion) = try json.decode(`
	`87`	`+ let (lower, upper):(SemanticVersion, SemanticVersion) = try json.decode(`
`88`	`88`	`as: JSON.SingleElementRepresentation<`
`89`	`89`	`JSON.ObjectDecoder<CodingKey.Requirement.Range>>.self)`
`90`	`90`	`{`
`@@ -93,7 +93,7 @@ extension SPM.Manifest.Dependency.Resolvable:JSONObjectDecodable`
`93`	`93`	`as: JSON.StringRepresentation<SemanticVersion>.self,`
`94`	`94`	`with: \.value),`
`95`	`95`	`try $0.value[.upperBound].decode(`
`96`		`- as: JSON.StringRepresentation<PatchVersion>.self,`
	`96`	`+ as: JSON.StringRepresentation<SemanticVersion>.self,`
`97`	`97`	`with: \.value)`
`98`	`98`	`)`
`99`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,31 +6,40 @@ extension SymbolGraphMetadata`
`6`	`6`	`enum DependencyRequirement:Equatable, Hashable, Sendable`
`7`	`7`	`{`
`8`	`8`	`case exact(SemanticVersion)`
`9`		`- case range(SemanticVersion, to:PatchVersion)`
	`9`	`+ case range(SemanticVersion, to:SemanticVersion)`
`10`	`10`	`}`
`11`	`11`	`}`
`12`	`12`	`extension SymbolGraphMetadata.DependencyRequirement`
`13`	`13`	`{`
`14`	`14`	`@inlinable public`
`15`		`- init?(suffix:SemanticVersion.Suffix?, lower:PatchVersion?, upper:PatchVersion?)`
	`15`	`+ init?(`
	`16`	`+ lowerNumber:PatchVersion?,`
	`17`	`+ lowerSuffix:SemanticVersion.Suffix?,`
	`18`	`+ upperNumber:PatchVersion?,`
	`19`	`+ upperSuffix:SemanticVersion.Suffix?)`
`16`	`20`	`{`
`17`	`21`	`guard`
`18`		`- let version:PatchVersion = lower`
	`22`	`+ let lowerNumber:PatchVersion`
`19`	`23`	`else`
`20`	`24`	`{`
`21`	`25`	`return nil`
`22`	`26`	`}`
`23`	`27`
`24`		`- let suffix:SemanticVersion.Suffix = suffix ?? .release()`
	`28`	`+ let lower:SemanticVersion = .init(`
	`29`	`+ number: lowerNumber,`
	`30`	`+ suffix: lowerSuffix ?? .release())`
`25`	`31`
`26`		`- if let upper:PatchVersion,`
`27`		`- upper >= version`
	`32`	`+ if let upperNumber:PatchVersion,`
	`33`	`+ upperNumber >= lowerNumber`
`28`	`34`	`{`
`29`		`- self = .range(.init(number: version, suffix: suffix), to: upper)`
	`35`	`+ let upper:SemanticVersion = .init(number: upperNumber,`
	`36`	`+ suffix: upperSuffix ?? .release())`
	`37`	`+`
	`38`	`+ self = .range(lower, to: upper)`
`30`	`39`	`}`
`31`	`40`	`else`
`32`	`41`	`{`
`33`		`- self = .exact(.init(number: version, suffix: suffix))`
	`42`	`+ self = .exact(lower)`
`34`	`43`	`}`
`35`	`44`	`}`
`36`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@ import SemanticVersions`
`3`	`3`	`@frozen public`
`4`	`4`	`enum SymbolGraphABI`
`5`	`5`	`{`
`6`		`- @inlinable public static var version:PatchVersion { .v(0, 9, 6) }`
	`6`	`+ @inlinable public static var version:PatchVersion { .v(0, 9, 7) }`
`7`	`7`	`}`