Merge pull request #2879 from SwiftPackageIndex/issue-2873

Issue 2873

Author: finestructure

Sources/App/Commands/Analyze.swift

@@ -479,12 +479,8 @@ extension Analyze {
     /// - Returns: future
     static func applyVersionDelta(on transaction: Database,
                                   delta: VersionDelta) async throws {
-        // Preserve existing default branch doc archives to prevent a documentation gap
-        // https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/issues/2288
-        if let oldDefaultBranchDocArchives = delta.toDelete.first(where: { $0.isBranch })?.docArchives,
-           let newDefaultBranch = delta.toAdd.first(where: { $0.isBranch} ) {
-            newDefaultBranch.docArchives = oldDefaultBranchDocArchives
-        }
+        // Preserve certain existing default branch properties
+        carryOverDefaultBranchData(versionDelta: delta)
 
         try await delta.toDelete.delete(on: transaction)
         delta.toDelete.forEach {
@@ -499,6 +495,38 @@ extension Analyze {
         }
     }
 
+    
+    /// If `versionDelta` removes and adds a default branch version, copy certain properties
+    /// over to the new version in order to avoid gaps in data display until downstream processes
+    /// have processed the new version.
+    /// - Parameter versionDelta: The version change
+    static func carryOverDefaultBranchData(versionDelta: VersionDelta) {
+        guard versionDelta.toDelete.filter(\.isBranch).count <= 1 else {
+            Current.logger().warning("versionDelta.toDelete has more than one branch version")
+            return
+        }
+        guard versionDelta.toAdd.filter(\.isBranch).count <= 1 else {
+            Current.logger().warning("versionDelta.toAdd has more than one branch version")
+            return
+        }
+        guard let oldDefaultBranch = versionDelta.toDelete.first(where: \.isBranch),
+              let newDefaultBranch = versionDelta.toAdd.first(where: \.isBranch)
+        else { return }
+        // Preserve existing default branch doc archives to prevent a documentation gap
+        // https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/issues/2288
+        if let existingDocArchives = oldDefaultBranch.docArchives {
+            newDefaultBranch.docArchives = existingDocArchives
+        }
+        // Preserve dependency information
+        // https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/issues/2873
+        if let existingResolvedDependencies = oldDefaultBranch.resolvedDependencies {
+            newDefaultBranch.resolvedDependencies = existingResolvedDependencies
+        }
+        if let existingProductDependencies = oldDefaultBranch.productDependencies {
+            newDefaultBranch.productDependencies = existingProductDependencies
+        }
+    }
+
 
     /// Run `swift package dump-package` for a package at the given path.
     /// - Parameters:

Tests/AppTests/AnalyzerTests.swift

@@ -1459,6 +1459,66 @@ class AnalyzerTests: AppTestCase {
         }
     }
 
+    func test_issue_2873() async throws {
+        // Ensure we preserve dependency counts from previous default branch version
+        // https://github.com/SwiftPackageIndex/SwiftPackageIndex-Server/issues/2873
+        // setup
+        let pkg = try await savePackageAsync(on: app.db, id: .id0, "https://github.com/foo/1".url, processingStage: .ingestion)
+        try await Repository(package: pkg,
+                             defaultBranch: "main",
+                             name: "1",
+                             owner: "foo",
+                             stars: 100).save(on: app.db)
+        Current.git.commitCount = { _ in 12 }
+        Current.git.getTags = { _ in [] }
+        Current.git.hasBranch = { _, _ in true }
+        Current.git.firstCommitDate = { _ in .t0 }
+        Current.git.lastCommitDate = { _ in .t1 }
+        Current.git.revisionInfo = { _, _ in .init(commit: "sha1", date: .t0) }
+        Current.git.shortlog = { _ in "10\tPerson 1" }
+        Current.shell.run = { cmd, path in
+            if cmd == .swiftDumpPackage { return .packageDump(name: "foo1") }
+            return ""
+        }
+
+        // MUT and validation
+
+        // first analysis pass
+        try await Analyze.analyze(client: app.client, database: app.db, logger: app.logger, mode: .id(.id0))
+        do { // validate
+            let pkg = try await Package.query(on: app.db).first()
+            // numberOfDependencies is nil here, because we've not yet received the info back from the build
+            XCTAssertEqual(pkg?.scoreDetails?.numberOfDependencies, nil)
+        }
+        
+        do { // receive build report - we could send an actual report here via the API but let's just update
+             // the field directly instead, we're not testing build reporting after all
+            let version = try await Version.query(on: app.db).first()
+            version?.resolvedDependencies = .some([.init(packageName: "dep",
+                                                         repositoryURL: "https://github.com/some/dep")])
+            try await version?.save(on: app.db)
+        }
+        
+        // second analysis pass
+        try await Analyze.analyze(client: app.client, database: app.db, logger: app.logger, mode: .id(.id0))
+        do { // validate
+            let pkg = try await Package.query(on: app.db).first()
+            // numberOfDependencies is 1 now, because we see the updated version
+            XCTAssertEqual(pkg?.scoreDetails?.numberOfDependencies, 1)
+        }
+        
+        // now we simulate a new version on the default branch
+        Current.git.revisionInfo = { _, _ in .init(commit: "sha2", date: .t1) }
+        
+        // third analysis pass
+        try await Analyze.analyze(client: app.client, database: app.db, logger: app.logger, mode: .id(.id0))
+        do { // validate
+            let pkg = try await Package.query(on: app.db).first()
+            // numberOfDependencies must be preserved as 1, even though we've not built this version yet
+            XCTAssertEqual(pkg?.scoreDetails?.numberOfDependencies, 1)
+        }
+    }
+
 }
 
 
@@ -1559,3 +1619,24 @@ private enum TestError: Error {
     case simulatedFetchError
     case unknownCommand
 }
+
+
+private extension String {
+    static func packageDump(name: String) -> Self {
+        #"""
+        {
+          "name": "\#(name)",
+          "products": [
+            {
+              "name": "p1",
+              "targets": ["t1"],
+              "type": {
+                "executable": null
+              }
+            }
+          ],
+          "targets": [{"name": "t1", "type": "executable"}]
+        }
+        """#
+    }
+}

Tests/AppTests/Helpers/Version+init.swift

@@ -14,6 +14,7 @@ extension Version {
                      docArchives: [DocArchive]? = nil,
                      latest: Kind? = nil,
                      packageName: String? = nil,
+                     productDependencies: [ProductDependency]? = nil,
                      publishedAt: Date? = nil,
                      reference: Reference = .branch("main"),
                      releaseNotes: String? = nil,
@@ -31,6 +32,7 @@ extension Version {
         self.docArchives = docArchives
         self.latest = latest
         self.packageName = packageName
+        self.productDependencies = productDependencies
         self.publishedAt = publishedAt
         self.reference = reference
         self.releaseNotes = releaseNotes