Ask for reviews after the user has used the app a bit

PersonalGPT.xcodeproj/project.pbxproj

@@ -36,6 +36,9 @@
 		48C554512A0FEE4800C96823 /* CodeBlockView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 48C554502A0FEE4800C96823 /* CodeBlockView.swift */; };
 		48C554532A10C66A00C96823 /* AltCodeBlockView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 48C554522A10C66A00C96823 /* AltCodeBlockView.swift */; };
 		48C7F7842A1CE2FD007C0A3D /* Markdown in Frameworks */ = {isa = PBXBuildFile; productRef = 48C7F7832A1CE2FD007C0A3D /* Markdown */; };
+		48C7F7862A1CEF2D007C0A3D /* StoreKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 48C7F7852A1CEF2C007C0A3D /* StoreKit.framework */; };
+		48C7F7882A1CEF95007C0A3D /* SKSReviewManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 48C7F7872A1CEF95007C0A3D /* SKSReviewManager.swift */; };
+		48C7F78E2A1CFDAC007C0A3D /* DeviceDetection.swift in Sources */ = {isa = PBXBuildFile; fileRef = 48C7F78D2A1CFDAC007C0A3D /* DeviceDetection.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -111,6 +114,9 @@
 		48C5544E2A0FE32B00C96823 /* ParserResult.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ParserResult.swift; sourceTree = "<group>"; };
 		48C554502A0FEE4800C96823 /* CodeBlockView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CodeBlockView.swift; sourceTree = "<group>"; };
 		48C554522A10C66A00C96823 /* AltCodeBlockView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AltCodeBlockView.swift; sourceTree = "<group>"; };
+		48C7F7852A1CEF2C007C0A3D /* StoreKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = StoreKit.framework; path = Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS16.4.sdk/System/Library/Frameworks/StoreKit.framework; sourceTree = DEVELOPER_DIR; };
+		48C7F7872A1CEF95007C0A3D /* SKSReviewManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SKSReviewManager.swift; sourceTree = "<group>"; };
+		48C7F78D2A1CFDAC007C0A3D /* DeviceDetection.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DeviceDetection.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -121,6 +127,7 @@
 				48C7F7842A1CE2FD007C0A3D /* Markdown in Frameworks */,
 				48241DF32A13C6A4008FB7F5 /* Accelerate.framework in Frameworks */,
 				486279082A12463E00F45C4E /* Highlighter in Frameworks */,
+				48C7F7862A1CEF2D007C0A3D /* StoreKit.framework in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -169,6 +176,7 @@
 		48241DF12A13C6A4008FB7F5 /* Frameworks */ = {
 			isa = PBXGroup;
 			children = (
+				48C7F7852A1CEF2C007C0A3D /* StoreKit.framework */,
 				48241E092A157576008FB7F5 /* Accelerate.framework */,
 				48241DF22A13C6A4008FB7F5 /* Accelerate.framework */,
 			);
@@ -223,6 +231,7 @@
 		48B929A629ED80EA00607E43 /* PersonalGPT */ = {
 			isa = PBXGroup;
 			children = (
+				48C7F78C2A1CFD9B007C0A3D /* Reviews */,
 				4825EA802A16AFEE00A02361 /* Settings */,
 				48B485AF2A1118A200F63766 /* Info.plist */,
 				48B929A729ED80EA00607E43 /* PersonalGPTApp.swift */,
@@ -269,6 +278,15 @@
 			path = PersonalGPTUITests;
 			sourceTree = "<group>";
 		};
+		48C7F78C2A1CFD9B007C0A3D /* Reviews */ = {
+			isa = PBXGroup;
+			children = (
+				48C7F7872A1CEF95007C0A3D /* SKSReviewManager.swift */,
+				48C7F78D2A1CFDAC007C0A3D /* DeviceDetection.swift */,
+			);
+			path = Reviews;
+			sourceTree = "<group>";
+		};
 /* End PBXGroup section */
 
 /* Begin PBXNativeTarget section */
@@ -423,7 +441,9 @@
 				48C554512A0FEE4800C96823 /* CodeBlockView.swift in Sources */,
 				48B929AA29ED80EA00607E43 /* ContentView.swift in Sources */,
 				48055F732A0D2B070057C3BE /* ggml.c in Sources */,
+				48C7F78E2A1CFDAC007C0A3D /* DeviceDetection.swift in Sources */,
 				48055F8F2A0F998F0057C3BE /* ChatBubble.swift in Sources */,
+				48C7F7882A1CEF95007C0A3D /* SKSReviewManager.swift in Sources */,
 				48055F8D2A0F96E10057C3BE /* TypingIndicator.swift in Sources */,
 				4825EA822A16B01000A02361 /* UserSettings.swift in Sources */,
 				48B929A829ED80EA00607E43 /* PersonalGPTApp.swift in Sources */,
@@ -526,7 +546,7 @@
 				MACOSX_DEPLOYMENT_TARGET = 13.0;
 				MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
 				MTL_FAST_MATH = YES;
-				ONLY_ACTIVE_ARCH = NO;
+				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = macosx;
 				SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG;
 				SWIFT_OPTIMIZATION_LEVEL = "-O";

PersonalGPT.xcodeproj/xcuserdata/jeethu.xcuserdatad/xcschemes/xcschememanagement.plist

@@ -4,6 +4,27 @@
 <dict>
 	<key>SchemeUserState</key>
 	<dict>
+		<key>DeviceKitPlayground (Playground) 1.xcscheme</key>
+		<dict>
+			<key>isShown</key>
+			<false/>
+			<key>orderHint</key>
+			<integer>2</integer>
+		</dict>
+		<key>DeviceKitPlayground (Playground) 2.xcscheme</key>
+		<dict>
+			<key>isShown</key>
+			<false/>
+			<key>orderHint</key>
+			<integer>3</integer>
+		</dict>
+		<key>DeviceKitPlayground (Playground).xcscheme</key>
+		<dict>
+			<key>isShown</key>
+			<false/>
+			<key>orderHint</key>
+			<integer>1</integer>
+		</dict>
 		<key>PersonalGPT.xcscheme_^#shared#^_</key>
 		<dict>
 			<key>orderHint</key>

PersonalGPT/ChatBubble.swift

@@ -25,7 +25,7 @@ struct ChatBubbleShape: Shape {
             return Path()
         }
     }
-    
+
     private func leftBubble(in rect: CGRect) -> Path {
         let width = rect.width
         let height = rect.height

PersonalGPT/ChatState.swift

@@ -230,6 +230,8 @@ class ChatState: ObservableObject {
                 }
             }
             markFinish()
+            let messageLength = backend.getMessage().count
+            SKSReviewManager.requestReview(generatedTextLength: messageLength)
         }
     }
 

PersonalGPT/PersonalGPTApp.swift

@@ -34,7 +34,16 @@ struct PrivateAIChatApp: App {
         func applicationShouldTerminateAfterLastWindowClosed(_: NSApplication) -> Bool {
             true
         }
+
+        func applicationDidFinishLaunching(_: Notification) {
+            SKSReviewManager.incrementAppOpenCount()
+        }
     }
 #else
-    class AppDelegate: NSObject, UIApplicationDelegate {}
+    class AppDelegate: NSObject, UIApplicationDelegate {
+        func application(_: UIApplication, didFinishLaunchingWithOptions _: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
+            SKSReviewManager.incrementAppOpenCount()
+            return true
+        }
+    }
 #endif

PersonalGPT/Reviews/DeviceDetection.swift

@@ -0,0 +1,113 @@
+//
+//  DeviceDetection.swift
+//  PrivateAIChat
+//
+//  Created by jrb16 on 23/05/2023.
+//
+#if os(iOS)
+    import UIKit
+
+    public extension UIDevice {
+        static let modelName: String = {
+            var systemInfo = utsname()
+            uname(&systemInfo)
+            let machineMirror = Mirror(reflecting: systemInfo.machine)
+            let identifier = machineMirror.children.reduce("") { identifier, element in
+                guard let value = element.value as? Int8, value != 0 else { return identifier }
+                return identifier + String(UnicodeScalar(UInt8(value)))
+            }
+
+            func mapToDevice(identifier: String) -> String { // swiftlint:disable:this cyclomatic_complexity
+                #if os(iOS)
+                    switch identifier {
+                    case "iPod5,1": return "iPod touch (5th generation)"
+                    case "iPod7,1": return "iPod touch (6th generation)"
+                    case "iPod9,1": return "iPod touch (7th generation)"
+                    case "iPhone3,1", "iPhone3,2", "iPhone3,3": return "iPhone 4"
+                    case "iPhone4,1": return "iPhone 4s"
+                    case "iPhone5,1", "iPhone5,2": return "iPhone 5"
+                    case "iPhone5,3", "iPhone5,4": return "iPhone 5c"
+                    case "iPhone6,1", "iPhone6,2": return "iPhone 5s"
+                    case "iPhone7,2": return "iPhone 6"
+                    case "iPhone7,1": return "iPhone 6 Plus"
+                    case "iPhone8,1": return "iPhone 6s"
+                    case "iPhone8,2": return "iPhone 6s Plus"
+                    case "iPhone9,1", "iPhone9,3": return "iPhone 7"
+                    case "iPhone9,2", "iPhone9,4": return "iPhone 7 Plus"
+                    case "iPhone10,1", "iPhone10,4": return "iPhone 8"
+                    case "iPhone10,2", "iPhone10,5": return "iPhone 8 Plus"
+                    case "iPhone10,3", "iPhone10,6": return "iPhone X"
+                    case "iPhone11,2": return "iPhone XS"
+                    case "iPhone11,4", "iPhone11,6": return "iPhone XS Max"
+                    case "iPhone11,8": return "iPhone XR"
+                    case "iPhone12,1": return "iPhone 11"
+                    case "iPhone12,3": return "iPhone 11 Pro"
+                    case "iPhone12,5": return "iPhone 11 Pro Max"
+                    case "iPhone13,1": return "iPhone 12 mini"
+                    case "iPhone13,2": return "iPhone 12"
+                    case "iPhone13,3": return "iPhone 12 Pro"
+                    case "iPhone13,4": return "iPhone 12 Pro Max"
+                    case "iPhone14,4": return "iPhone 13 mini"
+                    case "iPhone14,5": return "iPhone 13"
+                    case "iPhone14,2": return "iPhone 13 Pro"
+                    case "iPhone14,3": return "iPhone 13 Pro Max"
+                    case "iPhone14,7": return "iPhone 14"
+                    case "iPhone14,8": return "iPhone 14 Plus"
+                    case "iPhone15,2": return "iPhone 14 Pro"
+                    case "iPhone15,3": return "iPhone 14 Pro Max"
+                    case "iPhone8,4": return "iPhone SE"
+                    case "iPhone12,8": return "iPhone SE (2nd generation)"
+                    case "iPhone14,6": return "iPhone SE (3rd generation)"
+                    case "iPad2,1", "iPad2,2", "iPad2,3", "iPad2,4": return "iPad 2"
+                    case "iPad3,1", "iPad3,2", "iPad3,3": return "iPad (3rd generation)"
+                    case "iPad3,4", "iPad3,5", "iPad3,6": return "iPad (4th generation)"
+                    case "iPad6,11", "iPad6,12": return "iPad (5th generation)"
+                    case "iPad7,5", "iPad7,6": return "iPad (6th generation)"
+                    case "iPad7,11", "iPad7,12": return "iPad (7th generation)"
+                    case "iPad11,6", "iPad11,7": return "iPad (8th generation)"
+                    case "iPad12,1", "iPad12,2": return "iPad (9th generation)"
+                    case "iPad13,18", "iPad13,19": return "iPad (10th generation)"
+                    case "iPad4,1", "iPad4,2", "iPad4,3": return "iPad Air"
+                    case "iPad5,3", "iPad5,4": return "iPad Air 2"
+                    case "iPad11,3", "iPad11,4": return "iPad Air (3rd generation)"
+                    case "iPad13,1", "iPad13,2": return "iPad Air (4th generation)"
+                    case "iPad13,16", "iPad13,17": return "iPad Air (5th generation)"
+                    case "iPad2,5", "iPad2,6", "iPad2,7": return "iPad mini"
+                    case "iPad4,4", "iPad4,5", "iPad4,6": return "iPad mini 2"
+                    case "iPad4,7", "iPad4,8", "iPad4,9": return "iPad mini 3"
+                    case "iPad5,1", "iPad5,2": return "iPad mini 4"
+                    case "iPad11,1", "iPad11,2": return "iPad mini (5th generation)"
+                    case "iPad14,1", "iPad14,2": return "iPad mini (6th generation)"
+                    case "iPad6,3", "iPad6,4": return "iPad Pro (9.7-inch)"
+                    case "iPad7,3", "iPad7,4": return "iPad Pro (10.5-inch)"
+                    case "iPad8,1", "iPad8,2", "iPad8,3", "iPad8,4": return "iPad Pro (11-inch) (1st generation)"
+                    case "iPad8,9", "iPad8,10": return "iPad Pro (11-inch) (2nd generation)"
+                    case "iPad13,4", "iPad13,5", "iPad13,6", "iPad13,7": return "iPad Pro (11-inch) (3rd generation)"
+                    case "iPad14,3", "iPad14,4": return "iPad Pro (11-inch) (4th generation)"
+                    case "iPad6,7", "iPad6,8": return "iPad Pro (12.9-inch) (1st generation)"
+                    case "iPad7,1", "iPad7,2": return "iPad Pro (12.9-inch) (2nd generation)"
+                    case "iPad8,5", "iPad8,6", "iPad8,7", "iPad8,8": return "iPad Pro (12.9-inch) (3rd generation)"
+                    case "iPad8,11", "iPad8,12": return "iPad Pro (12.9-inch) (4th generation)"
+                    case "iPad13,8", "iPad13,9", "iPad13,10", "iPad13,11": return "iPad Pro (12.9-inch) (5th generation)"
+                    case "iPad14,5", "iPad14,6": return "iPad Pro (12.9-inch) (6th generation)"
+                    case "AppleTV5,3": return "Apple TV"
+                    case "AppleTV6,2": return "Apple TV 4K"
+                    case "AudioAccessory1,1": return "HomePod"
+                    case "AudioAccessory5,1": return "HomePod mini"
+                    case "i386", "x86_64", "arm64": return "Simulator \(mapToDevice(identifier: ProcessInfo().environment["SIMULATOR_MODEL_IDENTIFIER"] ?? "iOS"))"
+                    default: return identifier
+                    }
+                #elseif os(tvOS)
+                    switch identifier {
+                    case "AppleTV5,3": return "Apple TV 4"
+                    case "AppleTV6,2": return "Apple TV 4K"
+                    case "i386", "x86_64": return "Simulator \(mapToDevice(identifier: ProcessInfo().environment["SIMULATOR_MODEL_IDENTIFIER"] ?? "tvOS"))"
+                    default: return identifier
+                    }
+                #endif
+            }
+
+            return mapToDevice(identifier: identifier)
+        }()
+    }
+#endif

PersonalGPT/Reviews/SKSReviewManager.swift

@@ -0,0 +1,81 @@
+//
+//  SKSReviewManager.swift
+//  PrivateAIChat
+//
+//  Created by jrb16 on 23/05/2023.
+//
+
+import Foundation
+
+import StoreKit
+class SKSReviewManager {
+    private static let instance = SKSReviewManager()
+    static let openCountKey = "open_count_config"
+    static let replyCountKey = "reply_count_config"
+    static let totalGeneratedTextLengthKey = "generated_text_length_config"
+    static let lastVersionPromptedForReviewKey = "last_version_prompted_config"
+
+    var sharedInstance: SKSReviewManager {
+        .instance
+    }
+
+    static func incrementAppOpenCount() { // called from appdelegate didfinishLaunchingWithOptions:
+        let ud = UserDefaults.standard
+        var count = ud.integer(forKey: Self.openCountKey)
+        count += 1
+        ud.set(count, forKey: Self.openCountKey)
+    }
+
+    static func requestReview(generatedTextLength: Int) {
+        let ud = UserDefaults.standard
+        let count = ud.integer(forKey: Self.openCountKey)
+        let lastVersionPromptedForReview = ud.string(forKey: Self.lastVersionPromptedForReviewKey)
+
+        // Increment the number of replies
+        var replyCount = ud.integer(forKey: Self.replyCountKey)
+        replyCount += 1
+        ud.set(replyCount, forKey: Self.replyCountKey)
+
+        // Increment the generated text length
+        var totalGeneratedTextLength = ud.integer(forKey: Self.totalGeneratedTextLengthKey)
+        totalGeneratedTextLength += generatedTextLength
+        ud.set(totalGeneratedTextLength, forKey: Self.totalGeneratedTextLengthKey)
+
+        // Get the current bundle version for the app.
+        let infoDictionaryKey = kCFBundleVersionKey as String
+        guard let currentVersion = Bundle.main.object(forInfoDictionaryKey: infoDictionaryKey) as? String
+        else { fatalError("Expected to find a bundle version in the info dictionary.") }
+        // Verify the user completes the process several times and doesn’t receive a prompt for this app version.
+        if count >= 4, replyCount >= 8, totalGeneratedTextLength >= 256, currentVersion != lastVersionPromptedForReview, shouldRequestReview() {
+            Task { @MainActor [] in
+                // Delay for two seconds to avoid interrupting the person using the app.
+                // Use the equation n * 10^9 to convert seconds to nanoseconds.
+                try? await Task.sleep(nanoseconds: UInt64(2e9))
+
+                #if os(iOS)
+                    let allScenes = UIApplication.shared.connectedScenes
+                    let scene = allScenes.first { $0.activationState == .foregroundActive }
+
+                    if let windowScene = scene as? UIWindowScene {
+                        SKStoreReviewController.requestReview(in: windowScene)
+                        UserDefaults.standard.set(currentVersion, forKey: Self.lastVersionPromptedForReviewKey)
+                    }
+                #else
+                    SKStoreReviewController.requestReview()
+                #endif
+            }
+        }
+    }
+
+    private static func shouldRequestReview() -> Bool {
+        #if os(iOS)
+            let verboteniPhones = ["iPhone XS", "iPhone XS Max", "iPhone XR", "iPhone 11", "iPhone 11 Pro", "iPhone 11 Pro Max", "iPhone 12 mini", "iPhone 12", "iPhone 12 Pro", "iPhone 12 Pro Max"]
+            let verboteniPads = ["iPad (8th generation)", "iPad mini (5th generation)", "iPad Air (3rd generation)"]
+            let modelName = UIDevice.modelName
+            if verboteniPhones.contains(modelName) || verboteniPads.contains(modelName) {
+                return false
+            }
+        #endif
+        return true
+    }
+}

redpajama/ChatBackend.mm

@@ -442,10 +442,21 @@ CPPChatBackend::~CPPChatBackend() {
     backend->decode(temperature, topK, topP, enable_mirostat);
 }
 
+- (NSString *)removeSuffixes:(NSArray *)suffixes fromString:(NSString *)string {
+    for (NSString *suffix in suffixes) {
+        if ([string hasSuffix:suffix]) {
+            string = [string substringToIndex:string.length - suffix.length];
+        }
+    }
+    return string;
+}
+
 - (NSString*)getMessage {
     CPPChatBackend* backend = [self getBackendInstance];
     std::string message = backend->getMessage();
-    return [NSString stringWithUTF8String:message.c_str()];
+    NSString* msg = [NSString stringWithUTF8String:message.c_str()];
+    NSArray *suffixes = @[@"\n", @"<human", @"<human>", @"<bot", @"<bot>"];
+    return [self removeSuffixes:suffixes fromString:msg];
 }
 
 - (bool)stopped {