Add pre-release software update channel support

ychin · ychin · commit c4e2cc7610fe · 2022-10-31T19:30:16.000-07:00
Add a new option for the user to opt-in for getting pre-release
software. When turned on, Sparkle will accept a new "prerelease" channel
for updates.

This feature only works in Sparkle 2, which means legacy binaries
(10.9-10.12) which use Sparkle 1 won't get this. It's possible to
implement this for Sparkle 1 but we would need to do so in a completely
different (and more annoying) manner of using two separate appcast XML
files and switch among them. Given the niche nature of legacy binaries,
this is not worth doing.

The setting is in the Advanced settings pane because the pre-release
builds aren't guaranteed to be stable or well-tested, so we don't want
users to turn it on unless they looked for it. For terminology, went
back and forth on "beta", "preview", "pre-release", and eventually
settled on "pre-release" builds which also lines up with GitHub
Release's convention.
diff --git a/src/MacVim/Base.lproj/Preferences.xib b/src/MacVim/Base.lproj/Preferences.xib
@@ -15,6 +15,8 @@
                 <outlet property="generalPreferences" destination="115" id="143"/>
                 <outlet property="inputPreferences" destination="Bnq-Nx-GJH" id="FES-rQ-Fpa"/>
                 <outlet property="layoutPopUpButton" destination="427" id="596"/>
+                <outlet property="sparklePrereleaseButton" destination="4Y5-mA-blQ" id="baN-Dn-dgO"/>
+                <outlet property="sparklePrereleaseDesc" destination="ere-oJ-WLd" id="fTe-GS-5qR"/>
                 <outlet property="sparkleUpdaterPane" destination="0hT-y8-Hge" id="e0L-sv-OCW"/>
             </connections>
         </customObject>
@@ -538,11 +540,22 @@
             <point key="canvasLocation" x="137.5" y="692"/>
         </customView>
         <customView id="620" userLabel="Advanced">
-            <rect key="frame" x="0.0" y="0.0" width="483" height="264"/>
+            <rect key="frame" x="0.0" y="0.0" width="483" height="367"/>
             <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
             <subviews>
+                <button id="4Y5-mA-blQ" userLabel="Pre-release channel">
+                    <rect key="frame" x="19" y="97" width="249" height="18"/>
+                    <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
+                    <buttonCell key="cell" type="check" title="Enable pre-release software updates" bezelStyle="regularSquare" imagePosition="left" alignment="left" inset="2" id="rTs-jS-K8M">
+                        <behavior key="behavior" changeContents="YES" doesNotDimImage="YES" lightByContents="YES"/>
+                        <font key="font" metaFont="system"/>
+                    </buttonCell>
+                    <connections>
+                        <binding destination="58" name="value" keyPath="values.MMUpdaterPrereleaseChannel" id="Kb1-yL-bmN"/>
+                    </connections>
+                </button>
                 <textField verticalHuggingPriority="750" horizontalCompressionResistancePriority="250" id="826">
-                    <rect key="frame" x="17" y="116" width="449" height="56"/>
+                    <rect key="frame" x="18" y="218" width="449" height="56"/>
                     <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                     <textFieldCell key="cell" controlSize="small" sendsActionOnEndEditing="YES" id="993">
                         <font key="font" metaFont="smallSystem"/>
@@ -552,7 +565,7 @@
                     </textFieldCell>
                 </textField>
                 <button id="817">
-                    <rect key="frame" x="18" y="174" width="133" height="18"/>
+                    <rect key="frame" x="19" y="276" width="133" height="18"/>
                     <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                     <buttonCell key="cell" type="check" title="Enable Quickstart" bezelStyle="regularSquare" imagePosition="left" alignment="left" inset="2" id="992">
                         <behavior key="behavior" changeContents="YES" doesNotDimImage="YES" lightByContents="YES"/>
@@ -564,7 +577,7 @@
                     </connections>
                 </button>
                 <textField verticalHuggingPriority="750" horizontalCompressionResistancePriority="250" id="815">
-                    <rect key="frame" x="17" y="198" width="449" height="28"/>
+                    <rect key="frame" x="18" y="300" width="449" height="28"/>
                     <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                     <textFieldCell key="cell" controlSize="small" sendsActionOnEndEditing="YES" title="(Deprecated) Deselect this option to use the legacy renderer, which is unsupported and will be removed in a future version." id="991">
                         <font key="font" metaFont="smallSystem"/>
@@ -573,7 +586,7 @@
                     </textFieldCell>
                 </textField>
                 <button id="782">
-                    <rect key="frame" x="18" y="228" width="174" height="18"/>
+                    <rect key="frame" x="19" y="330" width="174" height="18"/>
                     <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                     <buttonCell key="cell" type="check" title="Use Core Text renderer" bezelStyle="regularSquare" imagePosition="left" alignment="left" inset="2" id="990">
                         <behavior key="behavior" changeContents="YES" doesNotDimImage="YES" lightByContents="YES"/>
@@ -585,7 +598,7 @@
                     </connections>
                 </button>
                 <textField verticalHuggingPriority="750" horizontalCompressionResistancePriority="250" id="1001">
-                    <rect key="frame" x="17" y="20" width="444" height="70"/>
+                    <rect key="frame" x="18" y="122" width="444" height="70"/>
                     <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                     <textFieldCell key="cell" controlSize="small" sendsActionOnEndEditing="YES" id="1004">
                         <font key="font" metaFont="smallSystem"/>
@@ -595,7 +608,7 @@
                     </textFieldCell>
                 </textField>
                 <button id="1013">
-                    <rect key="frame" x="18" y="92" width="174" height="18"/>
+                    <rect key="frame" x="19" y="194" width="174" height="18"/>
                     <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                     <buttonCell key="cell" type="check" title="Draw marked text inline" bezelStyle="regularSquare" imagePosition="left" alignment="left" inset="2" id="1014">
                         <behavior key="behavior" changeContents="YES" doesNotDimImage="YES" lightByContents="YES"/>
@@ -605,8 +618,18 @@
                         <binding destination="58" name="value" keyPath="values.MMUseInlineIm" id="1016"/>
                     </connections>
                 </button>
+                <textField verticalHuggingPriority="750" horizontalCompressionResistancePriority="250" id="ere-oJ-WLd">
+                    <rect key="frame" x="19" y="20" width="449" height="70"/>
+                    <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
+                    <textFieldCell key="cell" controlSize="small" sendsActionOnEndEditing="YES" id="Gdp-Ib-RGS">
+                        <font key="font" metaFont="smallSystem"/>
+                        <string key="title">Opt-in to the pre-release software update channel. Sofware updater will now also download early pre-release builds that will get new features faster, but will be less tested and occasionally have stability issues or incomplete features. Use this if you want to try out new features and help provide feedbacks early on, but don't use this if you need to rely on MacVim.</string>
+                        <color key="textColor" white="0.5" alpha="1" colorSpace="calibratedWhite"/>
+                        <color key="backgroundColor" name="controlColor" catalog="System" colorSpace="catalog"/>
+                    </textFieldCell>
+                </textField>
             </subviews>
-            <point key="canvasLocation" x="144" y="911"/>
+            <point key="canvasLocation" x="143.5" y="962.5"/>
         </customView>
     </objects>
 </document>
diff --git a/src/MacVim/MMAppController.m b/src/MacVim/MMAppController.m
@@ -42,7 +42,6 @@
 #import "MMVimController.h"
 #import "MMVimView.h"
 #import "MMWindowController.h"
-#import "MMSparkle2Delegate.h"
 #import "MMTextView.h"
 #import "Miscellaneous.h"
 #import <unistd.h>
@@ -51,6 +50,7 @@
 #import <Carbon/Carbon.h>
 
 #if !DISABLE_SPARKLE
+#import "MMSparkle2Delegate.h"
 #import "Sparkle.framework/Headers/Sparkle.h"
 #endif
 
@@ -261,6 +261,7 @@ + (void)initialize
         [NSNumber numberWithBool:NO],     MMSmoothResizeKey,
         [NSNumber numberWithBool:NO],     MMCmdLineAlignBottomKey,
         [NSNumber numberWithBool:YES],    MMAllowForceClickLookUpKey,
+        [NSNumber numberWithBool:NO],     MMUpdaterPrereleaseChannelKey,
         nil];
 
     [[NSUserDefaults standardUserDefaults] registerDefaults:dict];
diff --git a/src/MacVim/MMPreferenceController.h b/src/MacVim/MMPreferenceController.h
@@ -24,6 +24,10 @@
 
     // Input pane
     IBOutlet NSButton *allowForceClickLookUpButton;
+
+    // Advanced pane
+    IBOutlet NSView *sparklePrereleaseButton;
+    IBOutlet NSView *sparklePrereleaseDesc;
 }
 
 // General pane
diff --git a/src/MacVim/MMPreferenceController.m b/src/MacVim/MMPreferenceController.m
@@ -17,15 +17,35 @@ @implementation MMPreferenceController
 - (void)windowDidLoad
 {
 #if DISABLE_SPARKLE
-    // If Sparkle is disabled in config, we don't want to show the preference pane
-    // which could be confusing as it won't do anything.
-    // After hiding the Sparkle subview, shorten the height of the General pane
-    // and move its other subviews down.
-    [sparkleUpdaterPane setHidden:YES];
-    CGFloat sparkleHeight = NSHeight(sparkleUpdaterPane.frame);
-    NSRect frame = generalPreferences.frame;
-    frame.size.height -= sparkleHeight;
-    generalPreferences.frame = frame;
+    {
+        // If Sparkle is disabled in config, we don't want to show the preference pane
+        // which could be confusing as it won't do anything.
+        // After hiding the Sparkle subview, shorten the height of the General pane
+        // and move its other subviews down.
+        [sparkleUpdaterPane setHidden:YES];
+        CGFloat sparkleHeight = NSHeight(sparkleUpdaterPane.frame);
+        NSRect frame = generalPreferences.frame;
+        frame.size.height -= sparkleHeight;
+        generalPreferences.frame = frame;
+    }
+#endif
+
+#if DISABLE_SPARKLE || USE_SPARKLE_1
+    {
+        // Also hide the pre-release update channel pane, if we disabled Sparkle, or
+        // we are using Sparkle 1 still (since it doesn't support this feature).
+        [sparklePrereleaseButton setHidden:YES];
+        CGFloat sparkleHeight = NSHeight(sparklePrereleaseButton.frame);
+        NSRect frame = advancedPreferences.frame;
+        frame.size.height -= sparkleHeight;
+        advancedPreferences.frame = frame;
+
+        [sparklePrereleaseDesc setHidden:YES];
+        sparkleHeight = NSHeight(sparklePrereleaseDesc.frame);
+        frame = advancedPreferences.frame;
+        frame.size.height -= sparkleHeight;
+        advancedPreferences.frame = frame;
+    }
 #endif
     [super windowDidLoad];
 
diff --git a/src/MacVim/MMSparkle2Delegate.h b/src/MacVim/MMSparkle2Delegate.h
@@ -11,7 +11,7 @@
 @interface MMSparkle2Delegate : NSObject <SPUUpdaterDelegate, SPUStandardUserDriverDelegate>;
 
 // SPUUpdaterDelegate
-// Don't implement anything for now.
+- (nonnull NSSet<NSString *> *)allowedChannelsForUpdater:(nonnull SPUUpdater *)updater;
 
 // SPUStandardUserDriverDelegate
 // No need to implement anything for now. Default behaviors work fine.
diff --git a/src/MacVim/MMSparkle2Delegate.m b/src/MacVim/MMSparkle2Delegate.m
@@ -8,10 +8,22 @@
 
 #import "MMSparkle2Delegate.h"
 
+#import "Miscellaneous.h"
+
 #import <Foundation/Foundation.h>
 
 @implementation MMSparkle2Delegate;
 
+/// If the user has opted in, return the pre-release channel to Sparkle so pre-
+/// release builds will be available for update as well.
+- (nonnull NSSet<NSString *> *)allowedChannelsForUpdater:(nonnull SPUUpdater *)updater
+{
+    if ([[NSUserDefaults standardUserDefaults] boolForKey:MMUpdaterPrereleaseChannelKey]) {
+        return [NSSet<NSString *> setWithObject:@"prerelease"];
+    }
+    return [NSSet<NSString *> set];
+}
+
 @end;
 
 #endif
diff --git a/src/MacVim/Miscellaneous.h b/src/MacVim/Miscellaneous.h
@@ -62,6 +62,7 @@ extern NSString *MMNonNativeFullScreenSafeAreaBehaviorKey;
 extern NSString *MMSmoothResizeKey;
 extern NSString *MMCmdLineAlignBottomKey;
 extern NSString *MMAllowForceClickLookUpKey;
+extern NSString *MMUpdaterPrereleaseChannelKey;
 
 
 // Enum for MMUntitledWindowKey
diff --git a/src/MacVim/Miscellaneous.m b/src/MacVim/Miscellaneous.m
@@ -58,6 +58,7 @@
 NSString *MMSmoothResizeKey               = @"MMSmoothResize";
 NSString *MMCmdLineAlignBottomKey         = @"MMCmdLineAlignBottom";
 NSString *MMAllowForceClickLookUpKey      = @"MMAllowForceClickLookUp";
+NSString *MMUpdaterPrereleaseChannelKey   = @"MMUpdaterPrereleaseChannel";
 
 
 @implementation NSIndexSet (MMExtras)

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,10 @@`
`24`	`24`
`25`	`25`	`// Input pane`
`26`	`26`	`IBOutlet NSButton *allowForceClickLookUpButton;`
	`27`	`+`
	`28`	`+ // Advanced pane`
	`29`	`+ IBOutlet NSView *sparklePrereleaseButton;`
	`30`	`+ IBOutlet NSView *sparklePrereleaseDesc;`
`27`	`31`	`}`
`28`	`32`
`29`	`33`	`// General pane`