stanwood/Stanwood_Debugger_iOS

View on GitHub
Sources/Harlow/Controller/LogManagers/DebuggerCrash.swift

Summary

Maintainability
A
1 hr
Test Coverage
//
//  DebuggerLogs.swift
//
//  The MIT License (MIT)
//
//  Copyright (c) 2020 Stanwood GmbH (www.stanwood.io)
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
//

import Foundation
import UIKit

typealias CrashCompletion = () -> Void

class DebuggerCrash {

    private static var defaults: UserDefaults {
        return UserDefaults.standard
    }

    static var didReceiveCrash: Bool {
        get {
            return defaults.bool(forKey: #function)
        }

        set {
            defaults.set(newValue, forKey: #function)
        }
    }
    
    static var crashCompletion: CrashCompletion?
    
    static var isEnabled: Bool = true {
        didSet {
            switch isEnabled {
            case true:
                DebuggerCrash.register()
            case false:
                DebuggerCrash.unregister()
            }
        }
    }

    private class func register() {
        NSSetUncaughtExceptionHandler(DebuggerCrash.didCatchException)
        signal(SIGABRT, DebuggerCrash.didCatchSignal)
        signal(SIGILL, DebuggerCrash.didCatchSignal)
        signal(SIGSEGV, DebuggerCrash.didCatchSignal)
        signal(SIGFPE, DebuggerCrash.didCatchSignal)
        signal(SIGBUS, DebuggerCrash.didCatchSignal)
        signal(SIGPIPE, DebuggerCrash.didCatchSignal)
        signal(SIGTRAP, DebuggerCrash.didCatchSignal)
        signal(SIGSYS, DebuggerCrash.didCatchSignal)
    }

    private class func unregister() {
        NSSetUncaughtExceptionHandler(nil)
        signal(SIGABRT, SIG_DFL)
        signal(SIGILL, SIG_DFL)
        signal(SIGSEGV, SIG_DFL)
        signal(SIGFPE, SIG_DFL)
        signal(SIGBUS, SIG_DFL)
        signal(SIGPIPE, SIG_DFL)
        signal(SIGTRAP, SIG_DFL)
        signal(SIGSYS, SIG_DFL)
    }

    private static let didCatchException: @convention(c) (NSException) -> Void = { exception in
        guard DebuggerCrash.isEnabled else { return }
        let crashItem = CrashItem(exception: exception, appInfo: appInfo)
        didCatch(crash: crashItem)
    }

    private static let didCatchSignal: @convention(c) (Int32) -> Void = { signal in
        guard DebuggerCrash.isEnabled else { return }
        let crashItem = CrashItem(signal: signal, stack: Thread.callStackSymbols, appInfo: appInfo)
        didCatch(crash: crashItem)
    }

    private static func didCatch(crash: CrashItem) {
        DebuggerCrash.crashCompletion?()
        self.didReceiveCrash = true
        NotificationCenter.default.post(name: NSNotification.Name.DeuggerDidReceiveCrashItem, object: crash)
    }

    private static var appInfo: String {
        let displayName = Bundle.main.object(forInfoDictionaryKey: "CFBundleName") ?? ""
        let shortVersion = Bundle.main.object(forInfoDictionaryKey: "CFBundleShortVersionString") ?? ""
        let version = Bundle.main.object(forInfoDictionaryKey: "CFBundleVersion") ?? ""
        let deviceModel = UIDevice.current.model
        let systemName = UIDevice.current.systemName
        let systemVersion = UIDevice.current.systemVersion
        return "App: \(displayName) \(shortVersion)(\(version))\n"
            + "Device: \(deviceModel)\n"
            + "OS Version: \(systemName) \(systemVersion)"
    }
}