BackupArchiveReleaseNotesRecipientArchiver.swift

//
// Copyright 2024 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
//

/// Responsible for the "release notes channel" recipient.
///
/// - Important
/// The Release Notes Channel has yet to be built on iOS, and consequently this
/// class is implemented with stubs.
public class BackupArchiveReleaseNotesRecipientArchiver: BackupArchiveProtoStreamWriter {
    typealias RecipientId = BackupArchive.RecipientId
    typealias RecipientAppId = BackupArchive.RecipientArchivingContext.Address

    typealias ArchiveFrameResult = BackupArchive.ArchiveSingleFrameResult<Void, RecipientAppId>
    typealias RestoreFrameResult = BackupArchive.RestoreFrameResult<RecipientId>

    public init() {}

    // MARK: -

    func archiveReleaseNotesRecipient(
        stream: BackupArchiveProtoOutputStream,
        context: BackupArchive.RecipientArchivingContext,
    ) -> ArchiveFrameResult {
        return context.bencher.processFrame { frameBencher in
            let releaseNotesAppId: RecipientAppId = .releaseNotesChannel
            let recipientId = context.assignRecipientId(to: releaseNotesAppId)

            let maybeError = Self.writeFrameToStream(
                stream,
                objectId: releaseNotesAppId,
                frameBencher: frameBencher,
                frameBuilder: {
                    var recipient = BackupProto_Recipient()
                    recipient.id = recipientId.value
                    recipient.destination = .releaseNotes(BackupProto_ReleaseNotes())

                    var frame = BackupProto_Frame()
                    frame.item = .recipient(recipient)
                    return frame
                },
            )

            if let maybeError {
                return .failure(maybeError)
            } else {
                return .success(())
            }
        }
    }

    // MARK: -

    func restoreReleaseNotesRecipientProto(
        _ releaseNotesRecipientProto: BackupProto_ReleaseNotes,
        recipient: BackupProto_Recipient,
        context: BackupArchive.RecipientRestoringContext,
    ) -> RestoreFrameResult {
        context[recipient.recipientId] = .releaseNotesChannel

        // TODO: [Backups] Implement restoring the Release Notes channel recipient.
        return .success
    }
}