🛠️ Introduce structured logging

🛠️ Add BitArray data structure
🛠️ Add BloomFilter data structure
🛠️ Refactor image handling for items
🛠️ Improve env file parsing
🛠️ Add more tests
☘ Fix sending invitation mail

.swiftlint.yml

@@ -106,4 +106,5 @@ identifier_name:
     - min
     - max
     - nil
-
+    - bit
+    - now

CHANGELOG.md

@@ -9,13 +9,24 @@
 
 ## [..]
 - 🎁 Add functionality to move items between wishlists
+
+## [1.4.1]
+- 🛠️ Introduce code generation
 - 🛠️ Introduce structured logging
+- 🛠️ Add BitArray data structure
+- 🛠️ Add BloomFilter data structure
+- 🛠️ Add data objects for database repositories
+- 🛠️ Make ids for entities into value objects
+- 🛠️ Refactor image handling for items
+- 🛠️ Improve env file parsing
+- 🛠️ Add tests
+- ☘ Fix sending invitation mail
 
 ## [1.4.0]
 - 🎁 Add invitation emails
-- ☘ fix link to fav icon
-- ☘ fix deletion of reservation for list owner
 - 🛠️ Major refactoring to implement separation of concerns
+- ☘ Fix link to fav icon
+- ☘ Fix deletion of reservation for list owner
 
 ```
 CLOC before refactoring:
@@ -32,14 +43,14 @@ Swift                          383           4390           2500          16025
 ```
 
 ## [1.3.3]
-- ☘ fix link to about page
 - 🛠️ Add favicon
+- ☘ Fix link to about page
 
 ## [1.3.2]
 - 🎁 Add pages for legal notice and privacy policy
 
 ## [1.3.1]
-- ☘ fix option "Don't spoil my surprises" on lists for notifications
+- ☘ Fix option "Don't spoil my surprises" on lists for notifications
 
 ## [1.3.0]
 - 🎁 Add settings for user in profile

Package.resolved

@@ -267,8 +267,8 @@
         "repositoryURL": "https://github.com/vapor/url-encoded-form.git",
         "state": {
           "branch": null,
-          "revision": "82d8d63bdb76b6dd8febe916c639ab8608dbbaed",
-          "version": "1.0.6"
+          "revision": "44999b47d88ca2e0c0b893599b3240e342ba39ff",
+          "version": "1.0.7"
         }
       },
       {
@@ -285,8 +285,8 @@
         "repositoryURL": "https://github.com/vapor/vapor.git",
         "state": {
           "branch": null,
-          "revision": "82ca8809b120985ebba756cc0f5d47dd5cbf6ed1",
-          "version": "3.3.2"
+          "revision": "642f3d4d1f0eafad651c85524d0d1c698b55399f",
+          "version": "3.3.3"
         }
       },
       {

Package.swift

@@ -67,23 +67,31 @@ let package = Package(
                 "App"
             ]
         ),
+        .target(
+            name: "Testing",
+            dependencies: [],
+            path: "Tests/Testing"
+        ),
         .testTarget(
             name: "LibraryTests",
             dependencies: [
+                "Testing",
                 "Library"
             ],
             path: "Tests/LibraryTests"
         ),
         .testTarget(
             name: "DomainTests",
             dependencies: [
+                "Testing",
                 "Domain"
             ],
             path: "Tests/DomainTests"
         ),
         .testTarget(
             name: "AppTests",
             dependencies: [
+                "Testing",
                 "App",
                 "VaporTestTools",
                 "LoggerAPI"

Sources/App/Domain/Adapters/Driven/Fluent/Entity/FluentItem.generated.swift

@@ -39,7 +39,7 @@ public struct FluentItem: ItemModel,
     public var imageURL: URL?
     public var createdAt: Date
     public var modifiedAt: Date
-    public var localImageURL: URL?
+    public var localImageURL: ImageStoreLocator?
     public var listKey: UUID
     public var listID: ListID { ListID(uuid: listKey) }
 
@@ -54,7 +54,7 @@ public struct FluentItem: ItemModel,
         imageURL: URL?,
         createdAt: Date,
         modifiedAt: Date,
-        localImageURL: URL?,
+        localImageURL: ImageStoreLocator?,
         listKey: UUID
     ) {
         self.uuid = uuid

Sources/App/Domain/Adapters/Driven/VaporEmailSendingProvider.swift

@@ -15,6 +15,6 @@ struct VaporEmailSendingProvider: EmailSendingProvider {
         self.request = request
     }
 
-    // func sendInvitationEmail -> implemented in file `Scenes/Invitations/InvitationEmail`
+    // func dispatchSendInvitationEmail -> implemented in file `Scenes/Invitations/InvitationEmail`
 
 }

Sources/App/Domain/Adapters/Driven/VaporImageStoreProvider.swift

@@ -1,4 +1,5 @@
 import Domain
+import Library
 
 import Vapor
 
@@ -15,54 +16,128 @@ struct VaporImageStoreProvider: ImageStoreProvider {
         self.request = request
     }
 
-    func storeImage(for imagable: Imageable, from url: URL) throws -> EventLoopFuture<URL?> {
-        return try request.make(ImageFileMiddleware.self)
-            .upload(
+    func storeImage(for imagable: Imageable, from url: URL)
+        throws -> EventLoopFuture<ImageStoreLocator?>
+    {
+        let imageFileMiddleware = try request.make(ImageFileMiddleware.self)
+        return try imageFileMiddleware
+            .uploadImage(
                 from: url,
                 width: imagable.imageableSize.width,
                 height: imagable.imageableSize.height,
                 key: requireKey(for: imagable),
-                groupkey: requireGroupKey(for: imagable),
+                groupkeys: requireGroupKeys(for: imagable),
                 on: request
             )
+            .map { imagefilelocator in
+                guard let url = imagefilelocator?.url else {
+                    return nil
+                }
+                return ImageStoreLocator(url)
+            }
     }
 
     func removeImages(for imagable: Imageable) throws {
-        try request.make(ImageFileMiddleware.self)
-            .removeAll(
-                key: requireKey(for: imagable),
-                groupkey: requireGroupKey(for: imagable),
-                deleteDirectory: true,
+        let imageFileMiddleware = try request.make(ImageFileMiddleware.self)
+        try imageFileMiddleware.removeImages(
+            key: requireKey(for: imagable),
+            groupkeys: requireGroupKeys(for: imagable),
+            deleteParentsIfEmpty: true,
+            on: request
+        )
+    }
+
+    func removeImage(at locator: ImageStoreLocator) throws {
+        let imageFileMiddleware = try request.make(ImageFileMiddleware.self)
+        if let imageFileLocator = imageFileMiddleware.imageFileLocator(from: locator.url) {
+            try imageFileMiddleware.removeFile(
+                at: imageFileLocator,
+                deleteParentsIfEmpty: true,
                 on: request
             )
+        }
     }
 
+    private static let validCharactersForImageableKey
+        = CharacterSet.alphanumerics.union(CharacterSet(charactersIn: "-"))
+
     private func requireKey(for imagable: Imageable) throws -> String {
         guard let key = imagable.imageableEntityKey else {
             throw ImageableError.keyMissing(\Imageable.imageableEntityKey)
         }
-        let validCharactersForImageableKey
-            = CharacterSet.alphanumerics.union(CharacterSet(charactersIn: "-"))
-        guard validCharactersForImageableKey.isSuperset(
+        guard VaporImageStoreProvider.validCharactersForImageableKey.isSuperset(
             of: CharacterSet(charactersIn: key)
         ) else {
             throw ImageableError.keyInvalid(\Imageable.imageableEntityKey)
         }
         return key
     }
 
-    private func requireGroupKey(for imagable: Imageable) throws -> String {
-        guard let groupkey = imagable.imageableEntityGroupKey else {
-            throw ImageableError.keyMissing(\Imageable.imageableEntityGroupKey)
+    private static let validCharactersForImageableGroupKey
+        = CharacterSet.alphanumerics.union(CharacterSet(charactersIn: "-"))
+
+    private func requireGroupKeys(for imagable: Imageable) throws -> [String] {
+        guard let groupkeys = imagable.imageableEntityGroupKeys else {
+            throw ImageableError.keyMissing(\Imageable.imageableEntityGroupKeys)
         }
-        let validCharactersForImageableGroupKey
-            = CharacterSet.alphanumerics.union(CharacterSet(charactersIn: "-"))
-        guard validCharactersForImageableGroupKey.isSuperset(
-            of: CharacterSet(charactersIn: groupkey)
-        ) else {
-            throw ImageableError.keyInvalid(\Imageable.imageableEntityGroupKey)
+        for groupkey in groupkeys {
+            guard VaporImageStoreProvider.validCharactersForImageableGroupKey.isSuperset(
+                of: CharacterSet(charactersIn: groupkey)
+            ) else {
+                throw ImageableError.keyInvalid(\Imageable.imageableEntityGroupKeys)
+            }
+        }
+        return groupkeys
+    }
+
+    // MARK: CleanupJob
+
+    final class CleanupJob: DispatchableJob<Bool> {
+
+        override func run(_ context: JobContext) -> EventLoopFuture<Bool> {
+            let container = context.container
+            do {
+                let itemRepository: ItemRepository = try container.make()
+                return itemRepository.all().map { items in
+                    // collect local image urls from all items into a bloom filter
+                    var bloomfilter = BloomFilter<String>(expectedNumberOfElements: items.count)
+                    for item in items {
+                        guard let localimageurl = item.localImageURL else {
+                            continue
+                        }
+                        bloomfilter.insert(localimageurl.absoluteString)
+                    }
+                    // iterate local file urls for images
+                    let now = Date()
+                    let imageFileMiddleware: ImageFileMiddleware = try container.make()
+                    for imagefilelocator in imageFileMiddleware.listFiles(createdBefore: now) {
+                        // if a image file url is not contained in the bloom filter the image is
+                        // definitely not used for an item, so it is save to delete
+                        let imagestorelocator = ImageStoreLocator(imagefilelocator.url)
+                        if bloomfilter.containsNot(imagestorelocator.absoluteString) {
+                            try imageFileMiddleware.removeFile(
+                                at: imagefilelocator,
+                                deleteParentsIfEmpty: true,
+                                on: container
+                            )
+                        }
+                    }
+                    imageFileMiddleware.purgeDirectories(on: container)
+                    return true
+                }
+            }
+            catch {
+                container.logger?.error("ImagesCleanupJob failed with \(error)")
+            }
+            return container.future(false)
         }
-        return groupkey
+
+        // MARK: CustomStringConvertible
+
+        override var description: String {
+            return "ImagesCleanupJob(at: \(scheduled))"
+        }
+
     }
 
 }

Sources/App/Scenes/Invitations/InvitationEmail.swift

@@ -64,13 +64,13 @@ final class InvitationEmail: HTMLMessage, CustomStringConvertible {
 
 extension VaporEmailSendingProvider {
 
-    func sendInvitationEmail(_ invitation: InvitationRepresentation, for user: UserRepresentation)
-        throws -> EventLoopFuture<Bool>
-    {
+    func dispatchSendInvitationEmail(
+        _ invitation: InvitationRepresentation,
+        for user: UserRepresentation
+    ) throws -> EventLoopFuture<Bool> {
         var email = InvitationEmail(for: invitation, invitedBy: user)
-        email.addEmailRecipient(EmailAddress(String(invitation.email)))
-        return try email.send(on: request)
-            .map { sendResult in sendResult.success == true }
+        email.addEmailRecipient(EmailAddress(invitation.email))
+        return try email.dispatchSend(on: request).transform(to: true)
     }
 
 }

Sources/App/Site.swift

@@ -71,13 +71,9 @@ struct Site: Codable, CustomDebugStringConvertible, ServiceType {
 
     // MARK: - Vapor Service
 
-    static var serviceSupports: [Any.Type] {
-        return [Site.self]
-    }
+    static let serviceSupports: [Any.Type] = [Site.self]
 
-    static func makeService(for container: Container) throws
-        -> Site
-    {
+    static func makeService(for container: Container) throws -> Site {
         return try .detect()
     }
 

Sources/App/[Framework]/Message.swift

@@ -28,7 +28,7 @@ extension Message {
     {
         let job = SendMessageJob(for: self, on: container, at: date, before: deadline)
         let jobService = try container.make(DispatchingService.self)
-        return try jobService.dispatch(AnyJob(job))
+        return try jobService.dispatch(job)
             .transform(to: job.completed)
     }
 
@@ -42,7 +42,7 @@ extension Message {
     {
         let job = SendMessageJob(for: self, on: container, at: date, before: deadline)
         let jobService = try container.make(DispatchingService.self)
-        return try jobService.dispatch(AnyJob(job))
+        return try jobService.dispatch(job)
     }
 
 }

Sources/App/[Library]/URL.swift

@@ -27,7 +27,7 @@ enum URLType {
     /// An absolute URL contains all the information necessary to locate a resource without
     /// a fragment identifier.
     case webAbsolute
-    /// An absolute URL contains with en empty path:
+    /// An absolute URL with an empty path:
     case webAbsolutePathEmpty
 }