mirror of https://github.com/oxen-io/session-ios
Updated the code to decode and use updated notifications
Made the JobQueue execution type explicit Fixed a bug where legacy group's might not be unsubscribed frompull/856/head
Morgan Pretty
2 years ago
parent
61ad85b97b
commit
09ab977861
@ -0,0 +1,47 @@
|
||||
// Copyright © 2023 Rangeproof Pty Ltd. All rights reserved.
|
||||
|
||||
import Foundation
|
||||
|
||||
extension PushNotificationAPI {
|
||||
struct NotificationMetadata: Codable {
|
||||
private enum CodingKeys: String, CodingKey {
|
||||
case accountId = "@"
|
||||
case hash = "#"
|
||||
case namespace = "n"
|
||||
case dataLength = "l"
|
||||
case dataTooLong = "B"
|
||||
}
|
||||
|
||||
/// Account ID (such as Session ID or closed group ID) where the message arrived.
|
||||
let accountId: String
|
||||
|
||||
/// The hash of the message in the swarm.
|
||||
let hash: String
|
||||
|
||||
/// The swarm namespace in which this message arrived.
|
||||
let namespace: Int
|
||||
|
||||
/// The length of the message data. This is always included, even if the message content
|
||||
/// itself was too large to fit into the push notification.
|
||||
let dataLength: Int
|
||||
|
||||
/// This will be `true` if the data was omitted because it was too long to fit in a push
|
||||
/// notification (around 2.5kB of raw data), in which case the push notification includes
|
||||
/// only this metadata but not the message content itself.
|
||||
let dataTooLong: Bool
|
||||
}
|
||||
}
|
||||
|
||||
extension PushNotificationAPI.NotificationMetadata {
|
||||
init(from decoder: Decoder) throws {
|
||||
let container: KeyedDecodingContainer<CodingKeys> = try decoder.container(keyedBy: CodingKeys.self)
|
||||
|
||||
self = PushNotificationAPI.NotificationMetadata(
|
||||
accountId: try container.decode(String.self, forKey: .accountId),
|
||||
hash: try container.decode(String.self, forKey: .hash),
|
||||
namespace: try container.decode(Int.self, forKey: .namespace),
|
||||
dataLength: try container.decode(Int.self, forKey: .dataLength),
|
||||
dataTooLong: ((try? container.decode(Bool.self, forKey: .dataTooLong)) ?? false)
|
||||
)
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,13 @@
|
||||
// Copyright © 2023 Rangeproof Pty Ltd. All rights reserved.
|
||||
|
||||
import Foundation
|
||||
|
||||
public extension PushNotificationAPI {
|
||||
enum ProcessResult {
|
||||
case success
|
||||
case failure
|
||||
case legacySuccess
|
||||
case legacyFailure
|
||||
case legacyForceSilent
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,263 @@
|
||||
// Copyright © 2023 Rangeproof Pty Ltd. All rights reserved.
|
||||
|
||||
import Foundation
|
||||
|
||||
public protocol BencodableType {
|
||||
associatedtype ValueType: BencodableType
|
||||
|
||||
static var isCollection: Bool { get }
|
||||
static var isDictionary: Bool { get }
|
||||
}
|
||||
|
||||
public struct BencodeResponse<T: Codable> {
|
||||
public let info: T
|
||||
public let data: Data?
|
||||
}
|
||||
|
||||
extension BencodeResponse: Equatable where T: Equatable {}
|
||||
|
||||
public enum Bencode {
|
||||
private enum Element: Character {
|
||||
case number0 = "0"
|
||||
case number1 = "1"
|
||||
case number2 = "2"
|
||||
case number3 = "3"
|
||||
case number4 = "4"
|
||||
case number5 = "5"
|
||||
case number6 = "6"
|
||||
case number7 = "7"
|
||||
case number8 = "8"
|
||||
case number9 = "9"
|
||||
case intIndicator = "i"
|
||||
case listIndicator = "l"
|
||||
case dictIndicator = "d"
|
||||
case endIndicator = "e"
|
||||
case separator = ":"
|
||||
|
||||
init?(_ byte: UInt8?) {
|
||||
guard
|
||||
let byte: UInt8 = byte,
|
||||
let byteString: String = String(data: Data([byte]), encoding: .utf8),
|
||||
let character: Character = byteString.first,
|
||||
let result: Element = Element(rawValue: character)
|
||||
else { return nil }
|
||||
|
||||
self = result
|
||||
}
|
||||
}
|
||||
|
||||
private struct BencodeString {
|
||||
let value: String?
|
||||
let rawValue: Data
|
||||
}
|
||||
|
||||
// MARK: - Functions
|
||||
|
||||
public static func decodeResponse<T>(
|
||||
from data: Data,
|
||||
using dependencies: Dependencies = Dependencies()
|
||||
) throws -> BencodeResponse<T> where T: Decodable {
|
||||
guard
|
||||
let result: [Data] = try? decode([Data].self, from: data),
|
||||
let responseData: Data = result.first
|
||||
else { throw HTTPError.parsingFailed }
|
||||
|
||||
return BencodeResponse(
|
||||
info: try responseData.decoded(as: T.self, using: dependencies),
|
||||
data: (result.count > 1 ? result.last : nil)
|
||||
)
|
||||
}
|
||||
|
||||
public static func decode<T: BencodableType>(_ type: T.Type, from data: Data) throws -> T {
|
||||
guard
|
||||
let decodedData: (value: Any, remainingData: Data) = decodeData(data),
|
||||
decodedData.remainingData.isEmpty == true // Ensure there is no left over data
|
||||
else { throw HTTPError.parsingFailed }
|
||||
|
||||
return try recursiveCast(type, from: decodedData.value)
|
||||
}
|
||||
|
||||
// MARK: - Logic
|
||||
|
||||
private static func decodeData(_ data: Data) -> (value: Any, remainingData: Data)? {
|
||||
switch Element(data.first) {
|
||||
case .number0, .number1, .number2, .number3, .number4,
|
||||
.number5, .number6, .number7, .number8, .number9:
|
||||
return decodeString(data)
|
||||
|
||||
case .intIndicator: return decodeInt(data)
|
||||
case .listIndicator: return decodeList(data)
|
||||
case .dictIndicator: return decodeDict(data)
|
||||
default: return nil
|
||||
}
|
||||
}
|
||||
|
||||
/// Decode a string element from iterator assumed to have structure `{length}:{data}`
|
||||
private static func decodeString(_ data: Data) -> (value: BencodeString, remainingData: Data)? {
|
||||
var mutableData: Data = data
|
||||
var lengthData: [UInt8] = []
|
||||
|
||||
// Remove bytes until we hit the separator
|
||||
while let next: UInt8 = mutableData.popFirst(), Element(next) != .separator {
|
||||
lengthData.append(next)
|
||||
}
|
||||
|
||||
// Need to reset the index of the data (it maintains the index after popping/slicing)
|
||||
// See https://forums.swift.org/t/data-subscript/57195 for more info
|
||||
mutableData = Data(mutableData)
|
||||
|
||||
guard
|
||||
let lengthString: String = String(data: Data(lengthData), encoding: .ascii),
|
||||
let length: Int = Int(lengthString, radix: 10),
|
||||
mutableData.count >= length
|
||||
else { return nil }
|
||||
|
||||
// Need to reset the index of the data (it maintains the index after popping/slicing)
|
||||
// See https://forums.swift.org/t/data-subscript/57195 for more info
|
||||
return (
|
||||
BencodeString(
|
||||
value: String(data: mutableData[0..<length], encoding: .ascii),
|
||||
rawValue: mutableData[0..<length]
|
||||
),
|
||||
Data(mutableData.dropFirst(length))
|
||||
)
|
||||
}
|
||||
|
||||
/// Decode an int element from iterator assumed to have structure `i{int}e`
|
||||
private static func decodeInt(_ data: Data) -> (value: Int, remainingData: Data)? {
|
||||
var mutableData: Data = data
|
||||
var intData: [UInt8] = []
|
||||
_ = mutableData.popFirst() // drop `i`
|
||||
|
||||
// Pop until after `e`
|
||||
while let next: UInt8 = mutableData.popFirst(), Element(next) != .endIndicator {
|
||||
intData.append(next)
|
||||
}
|
||||
|
||||
guard
|
||||
let intString: String = String(data: Data(intData), encoding: .ascii),
|
||||
let result: Int = Int(intString, radix: 10)
|
||||
else { return nil }
|
||||
|
||||
// Need to reset the index of the data (it maintains the index after popping/slicing)
|
||||
// See https://forums.swift.org/t/data-subscript/57195 for more info
|
||||
return (result, Data(mutableData))
|
||||
}
|
||||
|
||||
/// Decode a list element from iterator assumed to have structure `l{data}e`
|
||||
private static func decodeList(_ data: Data) -> ([Any], Data)? {
|
||||
var mutableData: Data = data
|
||||
var listElements: [Any] = []
|
||||
_ = mutableData.popFirst() // drop `l`
|
||||
|
||||
while !mutableData.isEmpty, let next: UInt8 = mutableData.first, Element(next) != .endIndicator {
|
||||
guard let result = decodeData(mutableData) else { break }
|
||||
|
||||
listElements.append(result.value)
|
||||
mutableData = result.remainingData
|
||||
}
|
||||
|
||||
_ = mutableData.popFirst() // drop `e`
|
||||
|
||||
// Need to reset the index of the data (it maintains the index after popping/slicing)
|
||||
// See https://forums.swift.org/t/data-subscript/57195 for more info
|
||||
return (listElements, Data(mutableData))
|
||||
}
|
||||
|
||||
/// Decode a dict element from iterator assumed to have structure `d{data}e`
|
||||
private static func decodeDict(_ data: Data) -> ([String: Any], Data)? {
|
||||
var mutableData: Data = data
|
||||
var dictElements: [String: Any] = [:]
|
||||
_ = mutableData.popFirst() // drop `d`
|
||||
|
||||
while !mutableData.isEmpty, let next: UInt8 = mutableData.first, Element(next) != .endIndicator {
|
||||
guard
|
||||
let keyResult = decodeString(mutableData),
|
||||
let key: String = keyResult.value.value,
|
||||
let valueResult = decodeData(keyResult.remainingData)
|
||||
else { return nil }
|
||||
|
||||
dictElements[key] = valueResult.value
|
||||
mutableData = valueResult.remainingData
|
||||
}
|
||||
|
||||
_ = mutableData.popFirst() // drop `e`
|
||||
|
||||
// Need to reset the index of the data (it maintains the index after popping/slicing)
|
||||
// See https://forums.swift.org/t/data-subscript/57195 for more info
|
||||
return (dictElements, Data(mutableData))
|
||||
}
|
||||
|
||||
// MARK: - Internal Functions
|
||||
|
||||
private static func recursiveCast<T: BencodableType>(_ type: T.Type, from value: Any) throws -> T {
|
||||
switch (type.isCollection, type.isDictionary) {
|
||||
case (_, true):
|
||||
guard let dictValue: [String: Any] = value as? [String: Any] else { throw HTTPError.parsingFailed }
|
||||
|
||||
return try (
|
||||
dictValue.mapValues { try recursiveCast(type.ValueType.self, from: $0) } as? T ??
|
||||
{ throw HTTPError.parsingFailed }()
|
||||
)
|
||||
|
||||
case (true, _):
|
||||
guard let arrayValue: [Any] = value as? [Any] else { throw HTTPError.parsingFailed }
|
||||
|
||||
return try (
|
||||
arrayValue.map { try recursiveCast(type.ValueType.self, from: $0) } as? T ??
|
||||
{ throw HTTPError.parsingFailed }()
|
||||
)
|
||||
|
||||
default:
|
||||
switch (value, type) {
|
||||
case (let bencodeString as BencodeString, is String.Type):
|
||||
return try (bencodeString.value as? T ?? { throw HTTPError.parsingFailed }())
|
||||
|
||||
case (let bencodeString as BencodeString, is Optional<String>.Type):
|
||||
return try (bencodeString.value as? T ?? { throw HTTPError.parsingFailed }())
|
||||
|
||||
case (let bencodeString as BencodeString, _):
|
||||
return try (bencodeString.rawValue as? T ?? { throw HTTPError.parsingFailed }())
|
||||
|
||||
default: return try (value as? T ?? { throw HTTPError.parsingFailed }())
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - BencodableType Extensions
|
||||
|
||||
extension Data: BencodableType {
|
||||
public typealias ValueType = Data
|
||||
|
||||
public static var isCollection: Bool { false }
|
||||
public static var isDictionary: Bool { false }
|
||||
}
|
||||
|
||||
extension Int: BencodableType {
|
||||
public typealias ValueType = Int
|
||||
|
||||
public static var isCollection: Bool { false }
|
||||
public static var isDictionary: Bool { false }
|
||||
}
|
||||
|
||||
extension String: BencodableType {
|
||||
public typealias ValueType = String
|
||||
|
||||
public static var isCollection: Bool { false }
|
||||
public static var isDictionary: Bool { false }
|
||||
}
|
||||
|
||||
extension Array: BencodableType where Element: BencodableType {
|
||||
public typealias ValueType = Element
|
||||
|
||||
public static var isCollection: Bool { true }
|
||||
public static var isDictionary: Bool { false }
|
||||
}
|
||||
|
||||
extension Dictionary: BencodableType where Key == String, Value: BencodableType {
|
||||
public typealias ValueType = Value
|
||||
|
||||
public static var isCollection: Bool { false }
|
||||
public static var isDictionary: Bool { true }
|
||||
}
|
||||
@ -0,0 +1,97 @@
|
||||
// Copyright © 2023 Rangeproof Pty Ltd. All rights reserved.
|
||||
|
||||
import Foundation
|
||||
|
||||
import Quick
|
||||
import Nimble
|
||||
|
||||
@testable import SessionUtilitiesKit
|
||||
|
||||
class BencodeSpec: QuickSpec {
|
||||
struct TestType: Codable, Equatable {
|
||||
let intValue: Int
|
||||
let stringValue: String
|
||||
}
|
||||
|
||||
// MARK: - Spec
|
||||
|
||||
override func spec() {
|
||||
describe("Bencode") {
|
||||
context("when decoding") {
|
||||
it("should decode a basic string") {
|
||||
let basicStringData: Data = "5:howdy".data(using: .utf8)!
|
||||
let result = try? Bencode.decode(String.self, from: basicStringData)
|
||||
|
||||
expect(result).to(equal("howdy"))
|
||||
}
|
||||
|
||||
it("should decode a basic integer") {
|
||||
let basicIntegerData: Data = "i3e".data(using: .utf8)!
|
||||
let result = try? Bencode.decode(Int.self, from: basicIntegerData)
|
||||
|
||||
expect(result).to(equal(3))
|
||||
}
|
||||
|
||||
it("should decode a list of integers") {
|
||||
let basicIntListData: Data = "li1ei2ee".data(using: .utf8)!
|
||||
let result = try? Bencode.decode([Int].self, from: basicIntListData)
|
||||
|
||||
expect(result).to(equal([1, 2]))
|
||||
}
|
||||
|
||||
it("should decode a basic dict") {
|
||||
let basicDictData: Data = "d4:spaml1:a1:bee".data(using: .utf8)!
|
||||
let result = try? Bencode.decode([String: [String]].self, from: basicDictData)
|
||||
|
||||
expect(result).to(equal(["spam": ["a", "b"]]))
|
||||
}
|
||||
}
|
||||
|
||||
context("when decoding a response") {
|
||||
it("decodes successfully") {
|
||||
let data: Data = "l37:{\"intValue\":100,\"stringValue\":\"Test\"}5:\u{01}\u{02}\u{03}\u{04}\u{05}e"
|
||||
.data(using: .utf8)!
|
||||
let result: BencodeResponse<TestType>? = try? Bencode.decodeResponse(from: data)
|
||||
|
||||
expect(result)
|
||||
.to(equal(
|
||||
BencodeResponse(
|
||||
info: TestType(
|
||||
intValue: 100,
|
||||
stringValue: "Test"
|
||||
),
|
||||
data: Data([1, 2, 3, 4, 5])
|
||||
)
|
||||
))
|
||||
}
|
||||
|
||||
it("decodes successfully with no body") {
|
||||
let data: Data = "l37:{\"intValue\":100,\"stringValue\":\"Test\"}e"
|
||||
.data(using: .utf8)!
|
||||
let result: BencodeResponse<TestType>? = try? Bencode.decodeResponse(from: data)
|
||||
|
||||
expect(result)
|
||||
.to(equal(
|
||||
BencodeResponse(
|
||||
info: TestType(
|
||||
intValue: 100,
|
||||
stringValue: "Test"
|
||||
),
|
||||
data: nil
|
||||
)
|
||||
))
|
||||
}
|
||||
|
||||
it("throws a parsing error when invalid") {
|
||||
let data: Data = "l36:{\"INVALID\":100,\"stringValue\":\"Test\"}5:\u{01}\u{02}\u{03}\u{04}\u{05}e"
|
||||
.data(using: .utf8)!
|
||||
|
||||
expect {
|
||||
let result: BencodeResponse<TestType> = try Bencode.decodeResponse(from: data)
|
||||
_ = result
|
||||
}.to(throwError(HTTPError.parsingFailed))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue