File cache

.github/workflows/swiftpm.yml

@@ -2,9 +2,9 @@ name: SwiftPM regression tests
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main, ci-experiments ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:

.github/workflows/xcode.yml

@@ -2,9 +2,9 @@ name: Xcode regression tests
 
 on:
   push:
-    branches: [ $default-branch, main, master, ci-experiments ]
+    branches: [ main, ci-experiments ]
   pull_request:
-    branches: [ $default-branch, main, master ]
+    branches: [ main ]
 
 jobs:
   test:

Examples/GithubBrowser/GithubBrowser.xcodeproj/xcshareddata/xcschemes/GithubBrowser.xcscheme

@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1140"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "DA7462381B4C768B00406D67"
+               BuildableName = "GithubBrowser.app"
+               BlueprintName = "GithubBrowser"
+               ReferencedContainer = "container:GithubBrowser.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <Testables>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "DA7462381B4C768B00406D67"
+            BuildableName = "GithubBrowser.app"
+            BlueprintName = "GithubBrowser"
+            ReferencedContainer = "container:GithubBrowser.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "DA7462381B4C768B00406D67"
+            BuildableName = "GithubBrowser.app"
+            BlueprintName = "GithubBrowser"
+            ReferencedContainer = "container:GithubBrowser.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

Examples/GithubBrowser/Source/API/GithubAPI.swift

@@ -17,7 +17,7 @@ class _GitHubAPI {
     fileprivate init() {
         #if DEBUG
             // Bare-bones logging of which network calls Siesta makes:
-            SiestaLog.Category.enabled = [.network]
+            SiestaLog.Category.enabled = [.network, .cache]
 
             // For more info about how Siesta decides whether to make a network call,
             // and which state updates it broadcasts to the app:
@@ -44,13 +44,48 @@ class _GitHubAPI {
 
             $0.pipeline[.cleanup].add(
               GitHubErrorMessageExtractor(jsonDecoder: jsonDecoder))
+
+            // Cache API results for fast launch & offline access:
+
+            $0.pipeline[.rawData].cacheUsing {
+                try FileCache<Data>(
+                    poolName: "api.github.com",
+                    dataIsolation: .perUser(identifiedBy: self.username))  // Show each user their own data
+            }
+
+            // Using the closure form of cacheUsing above signals that if we encounter an error trying create a cache
+            // directory or generate a cache isolation key from the username, we should simply proceed silently without
+            // having a persistent cache.
+
+            // Note that the dataIsolation uses only username. This means that users will not _see_ other users’ data;
+            // however, it does not _secure_ one user’s data from another. A user with permission to see the cache
+            // directory could in principle see all the cached data.
+            //
+            // To fully secure one user’s data from another, the application would need to generate some long-lived
+            // secret that is unique to each user. A password can work, though it will essentially empty the user’s
+            // cache if the password changes. The server could also send some kind of high-entropy per-user token in
+            // the authentication response.
         }
 
+        RemoteImageView.defaultImageService.configure {
+            // We can cache images offline too:
+
+            $0.pipeline[.rawData].cacheUsing {
+                try FileCache<Data>(
+                    poolName: "images",
+                    dataIsolation: .sharedByAllUsers)  // images aren't secret, so no need to isolate them
+            }
+        }
+
+
         // –––––– Resource-specific configuration ––––––
 
         service.configure("/search/**") {
             // Refresh search results after 10 seconds (Siesta default is 30)
             $0.expirationTime = 10
+
+            // Don't cache search results between runs, so we don't see stale results on launch
+            $0.pipeline.removeAllCaches()
         }
 
         // –––––– Auth configuration ––––––
@@ -116,19 +151,23 @@ class _GitHubAPI {
     // MARK: - Authentication
 
     func logIn(username: String, password: String) {
-        if let auth = "\(username):\(password)".data(using: String.Encoding.utf8) {
+        self.username = username
+        if let auth = "\(username):\(password)".data(using: .utf8) {
             basicAuthHeader = "Basic \(auth.base64EncodedString())"
         }
     }
 
     func logOut() {
+        username = nil
         basicAuthHeader = nil
     }
 
     var isAuthenticated: Bool {
         return basicAuthHeader != nil
     }
 
+    private var username: String?
+
     private var basicAuthHeader: String? {
         didSet {
             // These two calls are almost always necessary when you have changing auth for your API:

Examples/GithubBrowser/Source/UI/RepositoryListViewController.swift

@@ -38,7 +38,9 @@ class RepositoryListViewController: UITableViewController, ResourceObserver {
         super.viewDidLoad()
 
         view.backgroundColor = SiestaTheme.darkColor
+
         statusOverlay.embed(in: self)
+        statusOverlay.displayPriority = [.anyData, .loading, .error]
     }
 
     override func viewDidLayoutSubviews() {

Examples/GithubBrowser/Source/UI/RepositoryViewController.swift

@@ -76,6 +76,7 @@ class RepositoryViewController: UIViewController, ResourceObserver {
         super.viewDidLoad()
 
         view.backgroundColor = SiestaTheme.darkColor
+
         statusOverlay.embed(in: self)
         statusOverlay.displayPriority = [.anyData, .loading, .error]  // Prioritize partial data over loading indicator
 

Examples/GithubBrowser/Source/UI/UserViewController.swift

@@ -53,6 +53,8 @@ class UserViewController: UIViewController, UISearchBarDelegate, ResourceObserve
         view.backgroundColor = SiestaTheme.darkColor
 
         statusOverlay.embed(in: self)
+        statusOverlay.displayPriority = [.anyData, .loading, .error]
+
         showUser(nil)
 
         searchBar.becomeFirstResponder()

Package.swift

@@ -27,6 +27,10 @@ let package = Package(
         .target(
             name: "Siesta"
         ),
+        .target(
+            name: "SiestaTools",
+            dependencies: ["Siesta"]
+        ),
         .target(
             name: "SiestaUI",
             dependencies: ["Siesta"],
@@ -42,7 +46,7 @@ let package = Package(
         ),
         .testTarget(
             name: "SiestaTests",
-            dependencies: ["SiestaUI", "Siesta_Alamofire", "Quick", "Nimble"],
+            dependencies: ["SiestaUI", "SiestaTools", "Siesta_Alamofire", "Quick", "Nimble"],
             path: "Tests/Functional",
             exclude: ["ObjcCompatibilitySpec.m"]  // SwiftPM currently only supports Swift
         ),

Siesta.podspec

@@ -79,6 +79,12 @@ Pod::Spec.new do |s|
     s.exclude_files = "**/Info*.plist"
   end
 
+  s.subspec "Tools" do |s|
+    s.source_files = "Source/SiestaTools/**/*"
+    s.exclude_files = "**/Info*.plist"
+    s.dependency "Siesta/Core"
+  end
+
   s.subspec "UI" do |s|
     s.ios.source_files = "Source/SiestaUI/**/*.{swift,m,h}"
     s.dependency "Siesta/Core"