session-ios/SessionMessagingKit/Jobs/MessageReceiveJob.swift

import SessionUtilitiesKit
import PromiseKit

public final class MessageReceiveJob : NSObject, Job, NSCoding { // NSObject/NSCoding conformance is needed for YapDatabase compatibility
    public let data: Data
    public let serverHash: String?
    public let openGroupMessageServerID: UInt64?
    public let openGroupID: String?
    public let isBackgroundPoll: Bool
    public var delegate: JobDelegate?
    public var id: String?
    public var failureCount: UInt = 0

    // MARK: Settings
    public class var collection: String { return "MessageReceiveJobCollection" }
    public static let maxFailureCount: UInt = 10

    // MARK: Initialization
    public init(data: Data, serverHash: String? = nil, openGroupMessageServerID: UInt64? = nil, openGroupID: String? = nil, isBackgroundPoll: Bool) {
        self.data = data
        self.serverHash = serverHash
        self.openGroupMessageServerID = openGroupMessageServerID
        self.openGroupID = openGroupID
        self.isBackgroundPoll = isBackgroundPoll
        #if DEBUG
        if openGroupMessageServerID != nil { assert(openGroupID != nil) }
        if openGroupID != nil { assert(openGroupMessageServerID != nil) }
        #endif
    }

    // MARK: Coding
    public init?(coder: NSCoder) {
        guard let data = coder.decodeObject(forKey: "data") as! Data?,
            let id = coder.decodeObject(forKey: "id") as! String?,
            let isBackgroundPoll = coder.decodeObject(forKey: "isBackgroundPoll") as! Bool? else { return nil }
        self.data = data
        self.serverHash = coder.decodeObject(forKey: "serverHash") as! String?
        self.openGroupMessageServerID = coder.decodeObject(forKey: "openGroupMessageServerID") as! UInt64?
        self.openGroupID = coder.decodeObject(forKey: "openGroupID") as! String?
        self.isBackgroundPoll = isBackgroundPoll
        self.id = id
        self.failureCount = coder.decodeObject(forKey: "failureCount") as! UInt? ?? 0
    }

    public func encode(with coder: NSCoder) {
        coder.encode(data, forKey: "data")
        coder.encode(serverHash, forKey: "serverHash")
        coder.encode(openGroupMessageServerID, forKey: "openGroupMessageServerID")
        coder.encode(openGroupID, forKey: "openGroupID")
        coder.encode(isBackgroundPoll, forKey: "isBackgroundPoll")
        coder.encode(id, forKey: "id")
        coder.encode(failureCount, forKey: "failureCount")
    }

    // MARK: Running
    public func execute() {
        let _: Promise<Void> = execute()
    }
    
    public func execute() -> Promise<Void> {
        if let id = id { // Can be nil (e.g. when background polling)
            JobQueue.currentlyExecutingJobs.mutate { $0.insert(id) }
        }
        let (promise, seal) = Promise<Void>.pending()
        SNMessagingKitConfiguration.shared.storage.write(with: { transaction in // Intentionally capture self
            do {
                let isRetry = (self.failureCount != 0)
                let (message, proto) = try MessageReceiver.parse(self.data, openGroupMessageServerID: self.openGroupMessageServerID, isRetry: isRetry, using: transaction)
                message.serverHash = self.serverHash
                try MessageReceiver.handle(message, associatedWithProto: proto, openGroupID: self.openGroupID, isBackgroundPoll: self.isBackgroundPoll, using: transaction)
                self.handleSuccess()
                seal.fulfill(())
            } catch {
                if let error = error as? MessageReceiver.Error, !error.isRetryable {
                    SNLog("Message receive job permanently failed due to error: \(error).")
                    self.handlePermanentFailure(error: error)
                } else {
                    SNLog("Couldn't receive message due to error: \(error).")
                    self.handleFailure(error: error)
                }
                seal.fulfill(()) // The promise is just used to keep track of when we're done
            }
        }, completion: { })
        return promise
    }

    private func handleSuccess() {
        delegate?.handleJobSucceeded(self)
    }

    private func handlePermanentFailure(error: Error) {
        delegate?.handleJobFailedPermanently(self, with: error)
    }

    private func handleFailure(error: Error) {
        delegate?.handleJobFailed(self, with: error)
    }
}