Integrate Sparkle Updater (#1053)

mfisher31 · web-flow · commit bb57ece43491 · 2026-01-16T15:58:33.000-05:00
* feat: add Sparkle framework support for app updater on macOS
* feat: set up Sparkle skeletal implementation.
* feat: implement updater platform/product support with factory function.
* chore: add SPDX identifiers to plugin source files.
* fix: set correct rpath for embedded frameworks.
* feat: enhance updater functionality and improve plugin integration
* feat: conditionally include TestUpdater class for enhanced updater testing
* feat: update CMake configuration for Sparkle integration and enhance plist generation
* actions: tidy up workflow names
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,4 +1,4 @@
-name: Build and Test
+name: Build
 
 on:
   push:
diff --git a/.github/workflows/ldoc.yml b/.github/workflows/ldoc.yml
@@ -1,4 +1,4 @@
-name: Generate Lua Documentation
+name: LDoc
 
 on:
   push:
diff --git a/.github/workflows/reuse.yml b/.github/workflows/reuse.yml
@@ -1,7 +1,11 @@
 # SPDX-FileCopyrightText: Kushview, LLC
 # SPDX-License-Identifier: CC0-1.0
 name: REUSE compliance check
-on: [ push, pull_request ]
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
 
 jobs:
   test:
diff --git a/.gitignore b/.gitignore
@@ -62,3 +62,4 @@ docs/_build/
 
 Cardinal
 .meson-subproject*.txt
+.cache/
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -7,6 +7,9 @@ set(PROJECT_VERSION_SUFFIX "b2")
 set(PROJECT_VERSION_FULL "${PROJECT_VERSION}${PROJECT_VERSION_SUFFIX}")
 
 include(cmake/Element.cmake)
+if(APPLE AND ELEMENT_ENABLE_UPDATER)
+    include(cmake/FindSparkle.cmake)
+endif()
 include(cmake/FindJack.cmake)
 
 add_subdirectory(deps/sol2 EXCLUDE_FROM_ALL)
@@ -65,6 +68,8 @@ juce_add_gui_app(element_app
 
     BUNDLE_ID               "net.kushview.Element"
     MICROPHONE_PERMISSION_ENABLED TRUE
+
+    PLIST_TO_MERGE          "${ELEMENT_APP_PLIST_TO_MERGE}"
 )
 
 target_sources(element_app PRIVATE src/main.cc)
@@ -73,6 +78,22 @@ target_link_libraries(element_app PRIVATE kv::element)
 if(NOT APPLE)
     install(TARGETS element_app DESTINATION ${CMAKE_INSTALL_BINDIR})
 else()
+    if(ELEMENT_ENABLE_UPDATER)
+        target_compile_options(element_app PRIVATE "-F${sparkle_SOURCE_DIR}")
+        target_link_options(element_app PRIVATE "-F${sparkle_SOURCE_DIR}" -framework Sparkle)
+        target_sources(element_app PRIVATE src/sparkle.mm)
+        add_custom_command(TARGET element_app POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E rm -rf
+                    "$<TARGET_BUNDLE_CONTENT_DIR:element_app>/Frameworks/Sparkle.framework"
+            COMMAND /usr/bin/ditto
+                    "${SPARKLE_FRAMEWORK}"
+                    "$<TARGET_BUNDLE_CONTENT_DIR:element_app>/Frameworks/Sparkle.framework")
+        # Set rpath to find Sparkle.framework in app bundle
+        set_target_properties(element_app PROPERTIES
+            BUILD_RPATH "@executable_path/../Frameworks"
+            INSTALL_RPATH "@executable_path/../Frameworks"
+        )
+    endif()
     install(TARGETS element_app
         BUNDLE DESTINATION "Applications"
         COMPONENT "Standalone")
diff --git a/cmake/Element.cmake b/cmake/Element.cmake
@@ -7,6 +7,8 @@ option(ELEMENT_ENABLE_VST2 "Build with VST2 support" OFF)
 option(ELEMENT_ENABLE_LTO "Build with Link Time Optimization" OFF)
 option(ELEMENT_ENABLE_UPDATER "Build with updater support" OFF)
 
+set(ELEMENT_APP_PLIST_TO_MERGE "")
+
 if(APPLE)
     enable_language(OBJC)
     enable_language(OBJCXX)
diff --git a/cmake/FindSparkle.cmake b/cmake/FindSparkle.cmake
@@ -0,0 +1,38 @@
+set(SPARKLE_VERSION "2.8.1" CACHE STRING "Sparkle version to download")
+
+set(SPARKLE_FEED_URL "http://localhost:8000/appcast.xml"
+    CACHE STRING "The Sparkle feed url to use")
+set(SPARKLE_PUBLIC_KEY "+3pPKr274O3KL4lTWaEs/ukVk3Ayvnc7BkdS45zOnE4="
+    CACHE STRING "The Sparkle eDSA public key to use")
+
+FetchContent_Declare(
+    sparkle
+    URL https://github.com/Sparkle-project/Sparkle/releases/download/${SPARKLE_VERSION}/Sparkle-${SPARKLE_VERSION}.tar.xz
+    DOWNLOAD_EXTRACT_TIMESTAMP TRUE
+)
+
+FetchContent_MakeAvailable(sparkle)
+message(STATUS "Searching for Sparkle in: ${sparkle_SOURCE_DIR}")
+find_library(SPARKLE_FRAMEWORK Sparkle HINTS ${sparkle_SOURCE_DIR})
+
+if(SPARKLE_FRAMEWORK)
+    message(STATUS "Found Sparkle: ${SPARKLE_FRAMEWORK}")
+else()
+    message(FATAL_ERROR "Sparkle framework not found")
+endif()
+
+string(APPEND ELEMENT_APP_PLIST_TO_MERGE 
+"<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+    <!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">
+    <plist version=\"1.0\">
+    <dict>
+")
+string(APPEND ELEMENT_APP_PLIST_TO_MERGE "<key>SUFeedURL</key>")
+string(APPEND ELEMENT_APP_PLIST_TO_MERGE "<string>${SPARKLE_FEED_URL}</string>")
+string(APPEND ELEMENT_APP_PLIST_TO_MERGE "<key>SUPublicEDKey</key>")
+string(APPEND ELEMENT_APP_PLIST_TO_MERGE "<string>${SPARKLE_PUBLIC_KEY}</string>")
+string(APPEND ELEMENT_APP_PLIST_TO_MERGE "</dict></plist>")
+string(APPEND ELEMENT_APP_PLIST_TO_MERGE "<key>SUEnableAutomaticChecks</key>")
+string(APPEND ELEMENT_APP_PLIST_TO_MERGE "<false/>")
+string(APPEND ELEMENT_APP_PLIST_TO_MERGE "<key>SUScheduledCheckInterval</key>")
+string(APPEND ELEMENT_APP_PLIST_TO_MERGE "<integer>0</integer>")
diff --git a/include/element/ui/updater.hpp b/include/element/ui/updater.hpp
@@ -42,9 +42,9 @@ struct UpdatePackage {
 /** Updater helper for checking available updates */
 class Updater {
 public:
-    Updater();
-    Updater (const std::string& package, const std::string& version, const std::string& url);
-    ~Updater();
+    static std::unique_ptr<Updater> create();
+
+    virtual ~Updater();
 
     //==========================================================================
     /** Triggered when updates are found. Only fired when checking async. */
@@ -54,7 +54,7 @@ class Updater {
     void clear();
 
     /** Check for updates now or later. */
-    void check (bool async);
+    virtual void check (bool async);
 
     /** Returns all package updates listed in the repo. */
     std::vector<UpdatePackage> packages() const noexcept;
@@ -86,6 +86,10 @@ class Updater {
      */
     void setUpdatesXml (const std::string& xml);
 
+protected:
+    Updater();
+    Updater (const std::string& package, const std::string& version, const std::string& url);
+
 private:
     class Updates;
     std::unique_ptr<Updates> updates;
diff --git a/src/pluginprocessor.cpp b/src/pluginprocessor.cpp
@@ -3,13 +3,13 @@
 
 #include <element/engine.hpp>
 #include <element/ui.hpp>
+#include <element/plugins.hpp>
+#include <element/settings.hpp>
+
 #include "services/sessionservice.hpp"
 #include "services/mappingservice.hpp"
 #include "services/deviceservice.hpp"
 #include "engine/internalformat.hpp"
-#include <element/plugins.hpp>
-#include "ElementApp.h"
-#include <element/settings.hpp>
 
 #include "pluginprocessor.hpp"
 #include "plugineditor.hpp"
diff --git a/src/plugins/effect.cc b/src/plugins/effect.cc
@@ -8,3 +8,7 @@ juce::AudioProcessor* JUCE_CALLTYPE createPluginFilter()
     return new element::PluginProcessor (
         element::PluginProcessor::Effect, 16);
 }
+
+#if ELEMENT_UPDATER
+#include "./pluginupdater.cc"
+#endif
diff --git a/src/plugins/instrument.cc b/src/plugins/instrument.cc
@@ -8,3 +8,7 @@ juce::AudioProcessor* JUCE_CALLTYPE createPluginFilter()
     return new element::PluginProcessor (
         element::PluginProcessor::Instrument, 16);
 }
+
+#if ELEMENT_UPDATER
+#include "./pluginupdater.cc"
+#endif
diff --git a/src/plugins/midieffect.cc b/src/plugins/midieffect.cc
@@ -8,3 +8,7 @@ juce::AudioProcessor* JUCE_CALLTYPE createPluginFilter()
     return new element::PluginProcessor (
         element::PluginProcessor::MidiEffect, 0);
 }
+
+#if ELEMENT_UPDATER
+#include "./pluginupdater.cc"
+#endif
diff --git a/src/plugins/pluginupdater.cc b/src/plugins/pluginupdater.cc
@@ -0,0 +1,21 @@
+// SPDX-FileCopyrightText: Copyright (C) Kushview, LLC.
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#include <element/ui/updater.hpp>
+
+namespace element {
+
+//=============================================================================
+class PluginUpdater : public Updater
+{
+public:
+    PluginUpdater() = default;
+    ~PluginUpdater() = default;
+};
+
+std::unique_ptr<Updater> Updater::create()
+{
+    return std::make_unique<PluginUpdater>();
+}
+
+} // namespace element
diff --git a/src/services/guiservice.cpp b/src/services/guiservice.cpp
@@ -163,7 +163,9 @@ class GuiService::UpdateManager
 {
 public:
     UpdateManager()
+        : updater (Updater::create())
     {
+        jassert (updater != nullptr);
         setupUpdater();
     }
 
@@ -174,7 +176,7 @@ class GuiService::UpdateManager
 
     bool launchRequested() const noexcept { return launchUpdaterOnExit; }
 
-    void check() { updater.check (true); }
+    void check() { updater->check (true); }
 
 private:
     friend class GuiService;
@@ -183,12 +185,12 @@ class GuiService::UpdateManager
         juce::String ver (ELEMENT_VERSION_STRING);
         ver << "-" << ELEMENT_BUILD_NUMBER;
         // ver = "0.20.0.0";
-        updater.setInfo ("net.kushview.element", ver.toStdString());
-        updater.setRepository (ELEMENT_UPDATES_URL);
+        updater->setInfo ("net.kushview.element", ver.toStdString());
+        updater->setRepository (ELEMENT_UPDATES_URL);
 
         _conn.disconnect();
-        _conn = updater.sigUpdatesAvailable.connect ([this]() {
-            if (updater.available().size() > 0)
+        _conn = updater->sigUpdatesAvailable.connect ([this]() {
+            if (updater->available().size() > 0)
             {
                 AlertWindow::showMessageBoxAsync (
                     AlertWindow::InfoIcon,
@@ -207,7 +209,7 @@ class GuiService::UpdateManager
 
     bool launchUpdaterOnExit { false };
     bool showAlertWhenNoUpdatesReady = false;
-    element::Updater updater;
+    std::unique_ptr<element::Updater> updater;
     boost::signals2::connection _conn;
 };
 
@@ -420,8 +422,8 @@ Commands& GuiService::commands() { return impl->commands; }
 void GuiService::setUpdaterPackage (const std::string_view package, std::string_view version)
 {
 #if ELEMENT_UPDATER
-    auto& upd = updates->updater;
-    upd.setInfo (package.data(), version.data());
+    auto& updater = *updates->updater;
+    updater.setInfo (package.data(), version.data());
 #endif
 }
 
diff --git a/src/sparkle.mm b/src/sparkle.mm
@@ -0,0 +1,118 @@
+// SPDX-FileCopyrightText: Copyright (C) Kushview, LLC.
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#import <Foundation/Foundation.h>
+#import <Sparkle/Sparkle.h>
+
+#include <memory>
+
+#include <element/juce/core.hpp>
+#include <element/ui/updater.hpp>
+
+// An updater delegate class that mainly takes care of updating the check for updates menu item's state
+// This class can also be used to implement other updater delegate methods
+@interface AppUpdaterDelegate : NSObject <SPUUpdaterDelegate>
+
+@property (assign, nonatomic) SPUStandardUpdaterController* updaterController;
+
+@end
+
+@implementation AppUpdaterDelegate
+
+- (void)observeCanCheckForUpdatesWithAction:(void*)ctx
+{
+    [_updaterController.updater addObserver:self
+                                 forKeyPath:NSStringFromSelector(@selector(canCheckForUpdates))
+                                    options:(NSKeyValueObservingOptionInitial | NSKeyValueObservingOptionNew)
+                                    context:(void*)ctx];
+}
+
+- (void)observeValueForKeyPath:(NSString*)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey, id>*)change context:(void*)context
+{
+    if ([keyPath isEqualToString:NSStringFromSelector(@selector(canCheckForUpdates))])
+    {
+        // TODO: implement
+        // QAction *menuAction = (QAction *)context;
+        // menuAction->setEnabled(_updaterController.updater.canCheckForUpdates);
+    }
+    else
+    {
+        [super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
+    }
+}
+
+- (void)dealloc
+{
+    [super dealloc];
+    @autoreleasepool
+    {
+        [_updaterController.updater removeObserver:self
+                                        forKeyPath:NSStringFromSelector(@selector(canCheckForUpdates))];
+    }
+}
+
+@end
+
+namespace element
+{
+class SparkleUpdater : public Updater
+{
+   public:
+    SparkleUpdater()
+    {
+        @autoreleasepool
+        {
+            _updaterDelegate = [[AppUpdaterDelegate alloc] init];
+            _updaterDelegate.updaterController = [[SPUStandardUpdaterController alloc] initWithStartingUpdater:YES
+                                                                                               updaterDelegate:_updaterDelegate
+                                                                                            userDriverDelegate:nil];
+
+            // connect(checkForUpdatesAction, &QAction::triggered, this, &Updater::checkForUpdates);
+
+            [_updaterDelegate observeCanCheckForUpdatesWithAction:dynamic_cast<Updater*>(this)];
+        }
+    }
+
+    void check(bool async) override
+    {
+        juce::ignoreUnused(async);
+        std::cout << "checking for updates: async=" << (int)async << std::endl;
+        @autoreleasepool
+        {
+            [_updaterDelegate.updaterController checkForUpdates:nil];
+        }
+    }
+
+   private:
+    AppUpdaterDelegate* _updaterDelegate{nullptr};
+};
+
+std::unique_ptr<Updater> Updater::create()
+{
+    return std::make_unique<SparkleUpdater>();
+}
+
+} // namespace element
+
+#if 0
+// Creates and starts the updater. There's nothing else required.
+Updater::Updater(QAction *checkForUpdatesAction)
+{
+    @autoreleasepool {
+        _updaterDelegate = [[AppUpdaterDelegate alloc] init];
+        _updaterDelegate.updaterController = [[SPUStandardUpdaterController alloc] initWithStartingUpdater:YES updaterDelegate:_updaterDelegate userDriverDelegate:nil];
+        
+        connect(checkForUpdatesAction, &QAction::triggered, this, &Updater::checkForUpdates);
+        
+        [_updaterDelegate observeCanCheckForUpdatesWithAction:checkForUpdatesAction];
+    }
+}
+
+// Called when the user checks for updates
+void Updater::checkForUpdates()
+{
+    @autoreleasepool {
+        [_updaterDelegate.updaterController checkForUpdates:nil];
+    }
+}
+#endif
diff --git a/src/ui/updater.cpp b/src/ui/updater.cpp
diff --git a/test/updatetests.cpp b/test/updatetests.cpp

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Build and Test`
	`1`	`+name: Build`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`push:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Generate Lua Documentation`
	`1`	`+name: LDoc`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`push:`
Original file line number	Diff line number	Diff line change
`@@ -62,3 +62,4 @@ docs/_build/`
`62`	`62`
`63`	`63`	`Cardinal`
`64`	`64`	`.meson-subproject*.txt`
	`65`	`+.cache/`
Original file line number	Diff line number	Diff line change
`@@ -8,3 +8,7 @@ juce::AudioProcessor* JUCE_CALLTYPE createPluginFilter()`
`8`	`8`	`return new element::PluginProcessor (`
`9`	`9`	`element::PluginProcessor::Effect, 16);`
`10`	`10`	`}`
	`11`	`+`
	`12`	`+#if ELEMENT_UPDATER`
	`13`	`+#include "./pluginupdater.cc"`
	`14`	`+#endif`