feat(dev-menu): add the Developer Menu to Amplify (#844)

* feat(amplify-dev-menu): Initial code setup for Amplify Developer Menu (#594)

* refactor: Updated protocols for initial setup and added documentation (#615)

This PR added documentation to the Developer Menu codebase and added protocols to make it more testable.

* feat(device-info-screen): Device Info Screen in Developer Menu (#624)

* feat(environment-info-screen): Environment Info Screen in Developer Menu (#637)

* feat(log-viewer): Log Viewer Screen in Developer Menu (#653)

* feat(report-issue-screen): Report Issue Screen in Developer Menu (#668)

* test(dev-menu): Unit tests for Amplify+DevMenu extension (#682)

* feat(report-issue-screen): Minimum character limit added for issue de… (#692)

* test(dev-menu): Unit tests for PersistentLoggingPlugin and GestureRecognizer (#696)

* remove the log output in the issue report

Co-authored-by: Abhash Kumar Singh <[email protected]>

Author: drochetti

Amplify.xcodeproj/project.pbxproj

@@ -62,7 +62,6 @@ public class Amplify {
                 "Verify that the library version is correct and supports the plugin's category.")
         }
     }
-
 }
 
 extension Amplify: DefaultLogger { }

Amplify/Amplify.swift

@@ -44,7 +44,7 @@ public extension HubPayload.EventName.DataStore {
 
     /// Dispatched when all models have been synced
     static let syncQueriesReady = "DataStore.syncQueriesReady"
-  
+
     /// Dispatched when:
     /// - local store has loaded outgoing mutations from local storage
     /// - if online, all data has finished syncing with cloud

Amplify/Categories/DataStore/DataStoreCategory+HubPayloadEventName.swift

@@ -49,7 +49,7 @@ final public class LoggingCategory: Category {
     /// Returns the plugin added to the category. Upon creation, the LoggingCategory will have a default plugin and a
     /// configuration state reflecting that. Customers can still add custom plugins; doing so will remove the default
     /// plugin.
-    var plugin: LoggingCategoryPlugin = AWSUnifiedLoggingPlugin()
+    var plugin: LoggingCategoryPlugin = Amplify.getLoggingCategoryPlugin(loggingPlugin: AWSUnifiedLoggingPlugin())
 
     // MARK: - Plugin handling
 
@@ -77,7 +77,7 @@ final public class LoggingCategory: Category {
                 throw error
             }
 
-            configurationState = .pendingConfiguration(plugin)
+            configurationState = .pendingConfiguration(Amplify.getLoggingCategoryPlugin(loggingPlugin: plugin))
         }
     }
 
@@ -103,7 +103,7 @@ final public class LoggingCategory: Category {
             guard plugin.key == key else {
                 return
             }
-            plugin = AWSUnifiedLoggingPlugin()
+            plugin = Amplify.getLoggingCategoryPlugin(loggingPlugin: AWSUnifiedLoggingPlugin())
         }
     }
 

Amplify/Categories/Logging/LoggingCategory.swift

@@ -43,6 +43,10 @@ extension Amplify {
             }
         }
 
+        if #available(iOS 13.0.0, *) {
+            devMenu = nil
+        }
+
         group.wait()
 
         // Initialize Logging and Hub first, to ensure their default plugins are registered and available to other

Amplify/Core/Configuration/Internal/Amplify+Reset.swift

@@ -0,0 +1,48 @@
+//
+// Copyright 2018-2020 Amazon.com,
+// Inc. or its affiliates. All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Foundation
+
+/// Extension of `Amplify` for supporting Developer Menu feature
+extension Amplify {
+
+    @available(iOS 13.0.0, *)
+    static var devMenu: AmplifyDevMenu?
+
+    @available(iOS 13.0.0, *)
+    public static func enableDevMenu(contextProvider: DevMenuPresentationContextProvider) {
+        #if DEBUG
+            devMenu = AmplifyDevMenu(devMenuPresentationContextProvider: contextProvider)
+        #else
+            Logging.warn(DevMenuStringConstants.logTag + "Developer Menu is available only in debug mode")
+        #endif
+
+    }
+
+    /// Checks whether developer menu is enabled by developer
+    @available(iOS 13.0.0, *)
+    static func isDevMenuEnabled() -> Bool {
+        return devMenu != nil
+    }
+
+    /// Returns a `PersistentLoggingPlugin` if developer menu feature is enabled in debug mode
+    static func getLoggingCategoryPlugin(loggingPlugin: LoggingCategoryPlugin) -> LoggingCategoryPlugin {
+        if #available(iOS 13.0.0, *) {
+            #if DEBUG
+                if isDevMenuEnabled() {
+                    return PersistentLoggingPlugin(plugin: loggingPlugin)
+                } else {
+                    return loggingPlugin
+                }
+            #else
+                return loggingPlugin
+            #endif
+        } else {
+            return loggingPlugin
+        }
+    }
+}

Amplify/DevMenu/Amplify+DevMenu.swift

@@ -0,0 +1,41 @@
+//
+// Copyright 2018-2020 Amazon.com,
+// Inc. or its affiliates. All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Foundation
+import UIKit
+import SwiftUI
+
+/// Presents a developer menu using the provided `DevMenuPresentationContextProvider`
+/// upon notification from a `TriggerRecognizer`. Default recognizer is a `LongPressGestureRecognizer`
+@available(iOS 13.0.0, *)
+public final class AmplifyDevMenu: DevMenuBehavior, TriggerDelegate {
+
+    weak var devMenuPresentationContextProvider: DevMenuPresentationContextProvider?
+    var triggerRecognizer: TriggerRecognizer?
+
+    init(devMenuPresentationContextProvider: DevMenuPresentationContextProvider) {
+        self.devMenuPresentationContextProvider = devMenuPresentationContextProvider
+        self.triggerRecognizer = LongPressGestureRecognizer(
+            uiWindow: devMenuPresentationContextProvider.devMenuPresentationContext())
+        triggerRecognizer?.updateTriggerDelegate(delegate: self)
+    }
+
+    public func onTrigger(triggerRecognizer: TriggerRecognizer) {
+        showMenu()
+    }
+
+    public func showMenu() {
+        guard let rootViewController =
+            devMenuPresentationContextProvider?.devMenuPresentationContext().rootViewController else {
+                Amplify.Logging.warn(DevMenuStringConstants.logTag +
+                    "RootViewController of the UIWindow is nil")
+                return
+        }
+        let viewController = UIHostingController(rootView: DevMenuList())
+        rootViewController.present(viewController, animated: true)
+    }
+}

Amplify/DevMenu/AmplifyDevMenu.swift

@@ -0,0 +1,13 @@
+//
+// Copyright 2018-2020 Amazon.com,
+// Inc. or its affiliates. All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Foundation
+
+/// Implement this protocol to support versioning in your plugin
+protocol AmplifyVersionable {
+    var version: String { get }
+}

Amplify/DevMenu/AmplifyVersionable.swift

@@ -0,0 +1,19 @@
+//
+// Copyright 2018-2020 Amazon.com,
+// Inc. or its affiliates. All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Foundation
+
+/// Data class for a row shown in the Developer Menu
+@available(iOS 13.0.0, *)
+struct DevMenuItem: Identifiable {
+    let id = UUID()
+    let type: DevMenuItemType
+
+    init(type: DevMenuItemType) {
+        self.type = type
+    }
+}

Amplify/DevMenu/Data/DevMenuItem.swift

@@ -0,0 +1,43 @@
+//
+// Copyright 2018-2020 Amazon.com,
+// Inc. or its affiliates. All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Foundation
+
+/// Item types for each row in the Developer Menu
+enum DevMenuItemType {
+    case environmentInformation
+    case deviceInformation
+    case logViewer
+    case reportIssue
+
+    var stringValue: String {
+        switch self {
+        case .environmentInformation:
+            return "Environment Information"
+        case  .deviceInformation:
+            return "Device Information"
+        case .logViewer:
+            return "Log Viewer"
+        case .reportIssue:
+            return "Report Issue"
+        }
+    }
+
+    // systemName parameter for SFSymbols used in `UIImage(systemName:)` initializer
+    var iconName: String {
+        switch self {
+        case .environmentInformation:
+            return "globe"
+        case  .deviceInformation:
+            return "desktopcomputer"
+        case .logViewer:
+            return "eyeglasses"
+        case .reportIssue:
+            return "exclamationmark.circle"
+        }
+    }
+}