Better Evolution Proposal error handling (#258)

* Better Evolution Proposal error handling * Update EvolutionChecker.swift * Update EvolutionChecker.swift * Update EvolutionChecker.swift
vapor · Oct 26, 2024 · ab76de7 · ab76de7
1 parent 900f84d
commit ab76de7
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 6 deletions.
diff --git a/Sources/Penny/EvolutionChecker.swift b/Sources/Penny/EvolutionChecker.swift
@@ -18,6 +18,8 @@ actor EvolutionChecker {
 
     var storage = Storage()
 
+    var reportedProposalIDsThatContainErrors: Set<String> = []
+
     /// The minimum time to wait before sending a queued-proposal
     let queuedProposalsWaitTime: Double
 
@@ -57,6 +59,23 @@ actor EvolutionChecker {
             return
         }
 
+        let proposalIDsWithError = proposals.filter {
+            !($0.errors ?? []).isEmpty
+        }.map(\.id)
+        if !proposalIDsWithError.isEmpty {
+            let allAreAlreadyReported = self.reportedProposalIDsThatContainErrors
+                .isSuperset(of: proposalIDsWithError) 
+            self.reportedProposalIDsThatContainErrors.formUnion(proposalIDsWithError)
+            self.logger.log(
+                level: allAreAlreadyReported ? .debug : .warning,
+                "Will not continue checking proposals because there are errors in some of them",
+                metadata: [
+                    "proposalsWithError": .stringConvertible(proposalIDsWithError)
+                ]
+            )
+            return
+        }
+
         /// Queue newly-added proposals
         let currentIds = Set(self.storage.previousProposals.map(\.id))
         let (olds, news) = proposals.divided({ currentIds.contains($0.id) })
@@ -208,7 +227,7 @@ actor EvolutionChecker {
                 \(upcomingFeatureFlag)
                 \(authorsString)
                 \(reviewManagersString)
-                """.replaceDoubleNewlinesWithSingleNewline(),
+                """.replaceTripleNewlinesWithDoubleNewlines(),
                 url: proposalLink,
                 color: proposal.status.color
             )],
@@ -269,7 +288,7 @@ actor EvolutionChecker {
                 \(upcomingFeatureFlag)
                 \(authorsString)
                 \(reviewManagersString)
-                """.replaceDoubleNewlinesWithSingleNewline(),
+                """.replaceTripleNewlinesWithDoubleNewlines(),
                 url: proposalLink,
                 color: proposal.status.color
             )],
@@ -445,7 +464,7 @@ private extension Collection {
 }
 
 private extension String {
-    func replaceDoubleNewlinesWithSingleNewline() -> String {
-        self.replacingOccurrences(of: "\n\n", with: "\n")
+    func replaceTripleNewlinesWithDoubleNewlines() -> String {
+        self.replacingOccurrences(of: "\n\n\n", with: "\n\n")
     }
 }
diff --git a/Tests/PennyTests/Tests/GatewayProcessingTests.swift b/Tests/PennyTests/Tests/GatewayProcessingTests.swift
@@ -327,7 +327,7 @@ extension SerializationNamespace.GatewayProcessingTests {
 
             let embed = try #require(message.embeds?.first)
             #expect(embed.title == "[SE-0051] Withdrawn: Conventionalizing stride semantics")
-            #expect(embed.description == "> \n**Status: Withdrawn**\n\n**Author(s):** [Erica Sadun](http://github.com/erica)\n")
+            #expect(embed.description == "> \n\n**Status: Withdrawn**\n\n**Author(s):** [Erica Sadun](http://github.com/erica)\n")
             #expect(embed.color == .brown)
         }
 
@@ -355,7 +355,7 @@ extension SerializationNamespace.GatewayProcessingTests {
 
             let embed = try #require(message.embeds?.first)
             #expect(embed.title == "[SE-0001] In Active Review: Allow (most) keywords as argument labels")
-            #expect(embed.description == "> Argument labels are an important part of the interface of a Swift function, describing what particular arguments to the function do and improving readability. Sometimes, the most natural label for an argument coincides with a language keyword, such as `in`, `repeat`, or `defer`. Such keywords should be allowed as argument labels, allowing better expression of these interfaces.\n**Status:** Implemented -> **Active Review**\n\n**Author(s):** [Doug Gregor](https://github.com/DougGregor)\n")
+            #expect(embed.description == "> Argument labels are an important part of the interface of a Swift function, describing what particular arguments to the function do and improving readability. Sometimes, the most natural label for an argument coincides with a language keyword, such as `in`, `repeat`, or `defer`. Such keywords should be allowed as argument labels, allowing better expression of these interfaces.\n\n**Status:** Implemented -> **Active Review**\n\n**Author(s):** [Doug Gregor](https://github.com/DougGregor)\n")
             #expect(embed.color == .orange)
         }
     }