.doNotRetain

Author: adam-fowler

Sources/JobsPostgres/PostgresJobsQueue.swift

@@ -197,7 +197,7 @@ public final class PostgresJobQueue: JobQueueDriver, CancellableJobQueue, Resuma
     public func cancel(jobID: JobID) async throws {
         try await self.client.withTransaction(logger: logger) { connection in
             try await deleteFromQueue(jobID: jobID, connection: connection)
-            if configuration.retentionPolicy.cancelled == .never {
+            if configuration.retentionPolicy.cancelled == .doNotRetain {
                 try await delete(jobID: jobID)
             } else {
                 try await setStatus(jobID: jobID, status: .cancelled, connection: connection)
@@ -278,7 +278,7 @@ public final class PostgresJobQueue: JobQueueDriver, CancellableJobQueue, Resuma
 
     /// This is called to say job has finished processing and it can be deleted
     public func finished(jobID: JobID) async throws {
-        if configuration.retentionPolicy.completed == .never {
+        if configuration.retentionPolicy.completed == .doNotRetain {
             try await self.delete(jobID: jobID)
         } else {
             try await self.setStatus(jobID: jobID, status: .completed)
@@ -287,7 +287,7 @@ public final class PostgresJobQueue: JobQueueDriver, CancellableJobQueue, Resuma
 
     /// This is called to say job has failed to run and should be put aside
     public func failed(jobID: JobID, error: Error) async throws {
-        if configuration.retentionPolicy.failed == .never {
+        if configuration.retentionPolicy.failed == .doNotRetain {
             try await self.delete(jobID: jobID)
         } else {
             try await self.setStatus(jobID: jobID, status: .failed)

Sources/JobsPostgres/RetentionPolicy.swift

@@ -27,22 +27,19 @@ public struct RetentionPolicy: Sendable {
         /// Retain task
         public static var retain: RetainData { RetainData(rawValue: .retain) }
         /// Never retain any data
-        public static var never: RetainData { RetainData(rawValue: .doNotRetain) }
+        public static var doNotRetain: RetainData { RetainData(rawValue: .doNotRetain) }
     }
 
     /// Jobs with status cancelled
-    /// default retention is set for 7 days
     public var cancelled: RetainData
     /// Jobs with status completed
-    /// default retention is set to 7 days
     public var completed: RetainData
     /// Jobs with status failed
-    /// default retention is set to 30 days
     public var failed: RetainData
 
     public init(
-        cancelled: RetainData = .retain,
-        completed: RetainData = .never,
+        cancelled: RetainData = .doNotRetain,
+        completed: RetainData = .doNotRetain,
         failed: RetainData = .retain
     ) {
         self.cancelled = cancelled

Tests/JobsPostgresTests/JobsTests.swift

@@ -499,9 +499,9 @@ final class JobsTests: XCTestCase {
             numWorkers: 4,
             configuration: .init(
                 retentionPolicy: .init(
-                    cancelled: .never,
-                    completed: .never,
-                    failed: .never
+                    cancelled: .doNotRetain,
+                    completed: .doNotRetain,
+                    failed: .doNotRetain
                 )
             )
         ) { jobQueue in
@@ -787,9 +787,9 @@ final class JobsTests: XCTestCase {
             numWorkers: 1,
             configuration: .init(
                 retentionPolicy: .init(
-                    cancelled: .never,
-                    completed: .never,
-                    failed: .never
+                    cancelled: .doNotRetain,
+                    completed: .doNotRetain,
+                    failed: .doNotRetain
                 )
             ),
             function: #function
@@ -893,7 +893,7 @@ final class JobsTests: XCTestCase {
             configuration: .init(
                 retentionPolicy: .init(
                     cancelled: .retain,
-                    completed: .never,
+                    completed: .doNotRetain,
                     failed: .retain
                 )
             )
@@ -904,7 +904,7 @@ final class JobsTests: XCTestCase {
                     queueName: "SecondQueue",
                     retentionPolicy: .init(
                         cancelled: .retain,
-                        completed: .never,
+                        completed: .doNotRetain,
                         failed: .retain
                     )
                 )