Merge pull request #1847 from sparkle-project/sandbox-errors

Log more sandbox errors
sparkle-project · May 2, 2021 · 5da8199 · 5da8199
2 parents e179443 + 79a6bb1
commit 5da8199
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 4 deletions.
diff --git a/InstallerLauncher/SUInstallerLauncher.m b/InstallerLauncher/SUInstallerLauncher.m
@@ -337,9 +337,17 @@ static BOOL SPUNeedsSystemAuthorizationAccess(NSString *path, NSString *installa
 - (void)launchInstallerWithHostBundlePath:(NSString *)hostBundlePath updaterIdentifier:(NSString *)updaterIdentifier authorizationPrompt:(NSString *)authorizationPrompt installationType:(NSString *)installationType allowingDriverInteraction:(BOOL)allowingDriverInteraction allowingUpdaterInteraction:(BOOL)allowingUpdaterInteraction completion:(void (^)(SUInstallerLauncherStatus, BOOL))completionHandler
 {
     dispatch_async(dispatch_get_main_queue(), ^{
-        NSBundle *hostBundle = [NSBundle bundleWithPath:hostBundlePath];
         BOOL needsSystemAuthorization = SPUNeedsSystemAuthorizationAccess(hostBundlePath, installationType);
 
+        NSBundle *hostBundle = [NSBundle bundleWithPath:hostBundlePath];
+        if (hostBundle == nil) {
+            SULog(SULogLevelError, @"InstallerLauncher failed to create bundle at %@", hostBundlePath);
+            SULog(SULogLevelError, @"Please make sure InstallerLauncher is not sandboxed and do not sign your app by passing --deep. Check: codesign -d --entitlements :- \"%@\"", NSBundle.mainBundle.bundlePath);
+            SULog(SULogLevelError, @"More information regarding sandboxing: https://sparkle-project.org/documentation/sandboxing/");
+            completionHandler(SUInstallerLauncherFailure, needsSystemAuthorization);
+            return;
+        }
+
         if (needsSystemAuthorization && !allowingUpdaterInteraction) {
             SULog(SULogLevelError, @"Updater is not allowing interaction to the launcher.");
             completionHandler(SUInstallerLauncherFailure, needsSystemAuthorization);
@@ -419,6 +427,7 @@ - (void)launchInstallerWithHostBundlePath:(NSString *)hostBundlePath updaterIden
             }
         } else if (installerStatus == SUInstallerLauncherFailure) {
             SULog(SULogLevelError, @"Failed to submit installer job");
+            SULog(SULogLevelError, @"If your application is sandboxed please follow steps at: https://sparkle-project.org/documentation/sandboxing/");
         }
 
         if (installerStatus == SUInstallerLauncherCanceled) {

diff --git a/Sparkle.xcodeproj/xcshareddata/xcschemes/Sparkle Test App.xcscheme b/Sparkle.xcodeproj/xcshareddata/xcschemes/Sparkle Test App.xcscheme
@@ -37,9 +37,11 @@
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"
-      debugDocumentVersioning = "YES"
+      debugDocumentVersioning = "NO"
       debugServiceExtension = "internal"
-      allowLocationSimulation = "YES">
+      enableGPUFrameCaptureMode = "3"
+      enableGPUValidationMode = "1"
+      allowLocationSimulation = "NO">
       <BuildableProductRunnable
          runnableDebuggingMode = "0">
          <BuildableReference

diff --git a/Sparkle/SPUInstallerDriver.m b/Sparkle/SPUInstallerDriver.m
@@ -123,7 +123,7 @@ - (void)setUpConnection
 
                 NSMutableDictionary *userInfo = [NSMutableDictionary dictionaryWithDictionary:@{
                     NSLocalizedDescriptionKey: SULocalizedString(@"An error occurred while running the updater. Please try again later.", nil),
-                    NSLocalizedFailureReasonErrorKey:@"The remote port connection was invalidated from the updater. For additional details, please check Console logs for "@SPARKLE_RELAUNCH_TOOL_NAME
+                    NSLocalizedFailureReasonErrorKey:@"The remote port connection was invalidated from the updater. For additional details, please check Console logs for "@SPARKLE_RELAUNCH_TOOL_NAME". If your application is sandboxed, please also ensure Installer Connection & Status entitlements are correctly set up: https://sparkle-project.org/documentation/sandboxing/"
                 }];
 
                 NSError *installerError = strongSelf.installerError;