Merge 1486ca7 into deb4f40

Author: mauricecarrier7

.github/workflows/unit-testing.yml

@@ -16,3 +16,37 @@ fastlane/report.xml
 fastlane/*_output
 Palace.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
 Palace.xcodeproj/xcshareddata/xcschemes/Palace.xcscheme
+*.xcresult
+.ledger/config.json
+.ledger/index.sqlite
+.ledger/last_update.json
+.ledger/model.json
+docs/ledger/CONTRACTS/CONTRACT_AudiobookBookmarkDelegate.md
+docs/ledger/CONTRACTS/CONTRACT_AudiobookLifecycleListener.md
+docs/ledger/CONTRACTS/CONTRACT_AudiobookManager.md
+docs/ledger/CONTRACTS/CONTRACT_AudiobookNetworkService.md
+docs/ledger/CONTRACTS/CONTRACT_AudiobookPlaybackTrackerDelegate.md
+docs/ledger/CONTRACTS/CONTRACT_CatalogAPI.md
+docs/ledger/CONTRACTS/CONTRACT_CatalogRepositoryProtocol.md
+docs/ledger/CONTRACTS/CONTRACT_DataManager.md
+docs/ledger/CONTRACTS/CONTRACT_DownloadTask.md
+docs/ledger/CONTRACTS/CONTRACT_DRMDecryptor.md
+docs/ledger/CONTRACTS/CONTRACT_ImageCacheType.md
+docs/ledger/CONTRACTS/CONTRACT_LCPStreamingProvider.md
+docs/ledger/CONTRACTS/CONTRACT_NetworkClient.md
+docs/ledger/CONTRACTS/CONTRACT_Player.md
+docs/ledger/CONTRACTS/CONTRACT_PositionCalculating.md
+docs/ledger/CONTRACTS/CONTRACT_StreamingCapablePlayer.md
+docs/ledger/CONTRACTS/CONTRACT_StreamingResourceProvider.md
+docs/ledger/CONTRACTS/CONTRACT_TimeEntry.md
+docs/ledger/CONTRACTS/CONTRACT_TPPPublicationSpeechSynthesizerDelegate.md
+docs/ledger/CONTRACTS/CONTRACT_Track.md
+docs/ledger/CONTRACTS/CONTRACT_TrackFactoryProtocol.md
+docs/ledger/FLOWS/FLOW_audiobookplayback.md
+docs/ledger/FLOWS/FLOW_checkout.md
+docs/ledger/FLOWS/FLOW_login.md
+docs/ledger/INDEX.md
+docs/ledger/OPEN_QUESTIONS.md
+docs/ledger/SYSTEM_MAP.md
+docs/ledger/VERIFICATION.md
+readium-sdk

.gitignore

@@ -26,7 +26,7 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldUseLaunchSchemeArgsEnv = "NO"
       systemAttachmentLifetime = "keepNever"
       codeCoverageEnabled = "YES"
       onlyGenerateCoverageForSpecifiedTargets = "YES">
@@ -39,6 +39,28 @@
             ReferencedContainer = "container:Palace.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
+      <EnvironmentVariables>
+         <EnvironmentVariable
+            key = "TEST_MODE"
+            value = "1"
+            isEnabled = "YES">
+         </EnvironmentVariable>
+         <EnvironmentVariable
+            key = "SKIP_ANIMATIONS"
+            value = "1"
+            isEnabled = "YES">
+         </EnvironmentVariable>
+         <EnvironmentVariable
+            key = "LYRASIS_BARCODE"
+            value = "01230000000002"
+            isEnabled = "YES">
+         </EnvironmentVariable>
+         <EnvironmentVariable
+            key = "LYRASIS_PIN"
+            value = "Lyrtest123"
+            isEnabled = "YES">
+         </EnvironmentVariable>
+      </EnvironmentVariables>
       <AdditionalOptions>
          <AdditionalOption
             key = "MallocStackLogging"
@@ -71,14 +93,6 @@
                BlueprintName = "PalaceTests"
                ReferencedContainer = "container:Palace.xcodeproj">
             </BuildableReference>
-            <SkippedTests>
-               <Test
-                  Identifier = "AudiobookBookmarkBusinessLogicTests">
-               </Test>
-               <Test
-                  Identifier = "AudiobookTimeTrackerTests">
-               </Test>
-            </SkippedTests>
          </TestableReference>
          <TestableReference
             skipped = "NO"
@@ -102,6 +116,16 @@
                ReferencedContainer = "container:Palace.xcodeproj">
             </BuildableReference>
          </TestableReference>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "E58EAE132ECCC4F700CDA626"
+               BuildableName = "PalaceUITests.xctest"
+               BlueprintName = "PalaceUITests"
+               ReferencedContainer = "container:Palace.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction
@@ -147,18 +171,6 @@
             isEnabled = "YES">
          </EnvironmentVariable>
       </EnvironmentVariables>
-      <AdditionalOptions>
-         <AdditionalOption
-            key = "PrefersMallocStackLoggingLite"
-            value = ""
-            isEnabled = "YES">
-         </AdditionalOption>
-         <AdditionalOption
-            key = "MallocStackLogging"
-            value = ""
-            isEnabled = "YES">
-         </AdditionalOption>
-      </AdditionalOptions>
       <LocationScenarioReference
          identifier = "New York, NY, USA"
          referenceType = "1">

Palace.xcodeproj/project.pbxproj

@@ -245,6 +245,14 @@ protocol AccountLogoDelegate: AnyObject {
     loansUrl = URL.init(string: authenticationDocument.links?.first(where: { $0.rel == "http://opds-spec.org/shelf" })?.href ?? "")
     supportsSimplyESync = userProfileUrl != nil
 
+    // Debug logging for sync support
+    Log.debug(#file, """
+      🔖 AccountDetails init for '\(authenticationDocument.title ?? "unknown")':
+         userProfileUrl: \(userProfileUrl ?? "nil")
+         supportsSimplyESync: \(supportsSimplyESync)
+         Available links: \(authenticationDocument.links?.map { "[\($0.rel ?? "no-rel"): \($0.href ?? "no-href")]" }.joined(separator: ", ") ?? "none")
+      """)
+
     mainColor = authenticationDocument.colorScheme
 
     let registerUrlStr = authenticationDocument.links?.first(where: { $0.rel == "register" })?.href

Palace.xcodeproj/xcshareddata/xcschemes/Palace.xcscheme

@@ -81,13 +81,44 @@ let currentAccountIdentifierKey = "TPPCurrentAccountIdentifier"
       return account(uuid)
     }
     set {
+      let previousAccountId = currentAccountId
+      let newAccountId = newValue?.uuid
+      
       Log.debug(#file, "Setting currentAccount to <\(newValue?.name ?? "[N/A]")>")
+      Log.debug(#file, "Previous account: \(previousAccountId ?? "nil") → New account: \(newAccountId ?? "nil")")
+      
+      if previousAccountId != newAccountId, previousAccountId != nil {
+        Log.info(#file, "🔄 Account switch detected - cleaning up active content")
+        cleanupActiveContentBeforeAccountSwitch(from: previousAccountId, to: newAccountId)
+      }
+      
       self.currentAccount?.hasUpdatedToken = false
       currentAccountId = newValue?.uuid
       TPPErrorLogger.setUserID(TPPUserAccount.sharedAccount().barcode)
       NotificationCenter.default.post(name: .TPPCurrentAccountDidChange, object: nil)
     }
   }
+  
+  /// Cleans up active audiobook playback and other content before switching accounts
+  private func cleanupActiveContentBeforeAccountSwitch(from previousId: String?, to newId: String?) {
+    Task { @MainActor in
+      // Clear any active audiobook playback
+      if let coordinator = NavigationCoordinatorHub.shared.coordinator {
+        let pathCount = coordinator.path.count
+        Log.debug(#file, "  Navigation path has \(pathCount) items")
+        
+        // If there's anything in the navigation stack, pop to root to clean up any active content
+        // This prevents audiobooks or other content from continuing to play with the wrong account context
+        if pathCount > 0 {
+          Log.info(#file, "  🔄 Popping to root to clean up active content before account switch")
+          coordinator.popToRoot()
+          
+          // Give the UI a moment to clean up
+          try? await Task.sleep(nanoseconds: 100_000_000) // 0.1s
+        }
+      }
+    }
+  }
 
   private(set) var currentAccountId: String? {
     get { UserDefaults.standard.string(forKey: currentAccountIdentifierKey) }

Palace/Accounts/Library/Account.swift

@@ -60,11 +60,13 @@ extension TPPCredentials: Codable {
     case .token:
       let additionalInfo = try values.nestedContainer(keyedBy: TokenKeys.self, forKey: .associatedTokenData)
       let token = try additionalInfo.decode(String.self, forKey: .authToken)
-      let expirationDate = try additionalInfo.decode(Date.self, forKey: .expirationDate)
+      // Use decodeIfPresent for optional Date - handles nil gracefully
+      let expirationDate = try additionalInfo.decodeIfPresent(Date.self, forKey: .expirationDate)
 
       let barcodePinInfo = try values.nestedContainer(keyedBy: BarcodeAndPinKeys.self, forKey: .associatedBarcodeAndPinData)
-      let barcode = try barcodePinInfo.decode(String.self, forKey: .barcode)
-      let pin = try barcodePinInfo.decode(String.self, forKey: .pin)
+      // Use decodeIfPresent for optional barcode/pin - handles nil gracefully
+      let barcode = try barcodePinInfo.decodeIfPresent(String.self, forKey: .barcode)
+      let pin = try barcodePinInfo.decodeIfPresent(String.self, forKey: .pin)
       self = .token(authToken: token, barcode: barcode, pin: pin, expirationDate: expirationDate)
 
     case .barcodeAndPin:

Palace/Accounts/Library/AccountsManager.swift

@@ -46,28 +46,27 @@ private enum StorageKey: String {
   var libraryUUID: String? {
     didSet {
       guard libraryUUID != oldValue else { return }
-      let variables: [StorageKey: Keyable] = [
-        StorageKey.authorizationIdentifier: _authorizationIdentifier,
-        StorageKey.adobeToken: _adobeToken,
-        StorageKey.licensor: _licensor,
-        StorageKey.patron: _patron,
-        StorageKey.adobeVendor: _adobeVendor,
-        StorageKey.provider: _provider,
-        StorageKey.userID: _userID,
-        StorageKey.deviceID: _deviceID,
-        StorageKey.credentials: _credentials,
-        StorageKey.authDefinition: _authDefinition,
-        StorageKey.cookies: _cookies,
-
-        // legacy
-        StorageKey.barcode: _barcode,
-        StorageKey.PIN: _pin,
-        StorageKey.authToken: _authToken,
-      ]
-
-      for (key, var value) in variables {
-        value.key = key.keyForLibrary(uuid: libraryUUID)
-      }
+      
+      Log.info(#file, "🔐 TPPUserAccount libraryUUID changed: \(oldValue ?? "nil") → \(libraryUUID ?? "nil")")
+      
+      // Update keychain variable keys directly to access account-specific storage
+      // Setting the key property triggers didSet which resets alreadyInited (forces re-read from keychain)
+      _authorizationIdentifier.key = StorageKey.authorizationIdentifier.keyForLibrary(uuid: libraryUUID)
+      _adobeToken.key = StorageKey.adobeToken.keyForLibrary(uuid: libraryUUID)
+      _licensor.key = StorageKey.licensor.keyForLibrary(uuid: libraryUUID)
+      _patron.key = StorageKey.patron.keyForLibrary(uuid: libraryUUID)
+      _adobeVendor.key = StorageKey.adobeVendor.keyForLibrary(uuid: libraryUUID)
+      _provider.key = StorageKey.provider.keyForLibrary(uuid: libraryUUID)
+      _userID.key = StorageKey.userID.keyForLibrary(uuid: libraryUUID)
+      _deviceID.key = StorageKey.deviceID.keyForLibrary(uuid: libraryUUID)
+      _credentials.key = StorageKey.credentials.keyForLibrary(uuid: libraryUUID)
+      _authDefinition.key = StorageKey.authDefinition.keyForLibrary(uuid: libraryUUID)
+      _cookies.key = StorageKey.cookies.keyForLibrary(uuid: libraryUUID)
+      
+      // Legacy
+      _barcode.key = StorageKey.barcode.keyForLibrary(uuid: libraryUUID)
+      _pin.key = StorageKey.PIN.keyForLibrary(uuid: libraryUUID)
+      _authToken.key = StorageKey.authToken.keyForLibrary(uuid: libraryUUID)
     }
   }
 
@@ -175,8 +174,10 @@ private enum StorageKey: String {
   }
 
   class func sharedAccount(libraryUUID: String?) -> TPPUserAccount {
-    shared.accountInfoQueue.async(flags: .barrier) {
-      shared.libraryUUID = libraryUUID
+    shared.accountInfoQueue.sync(flags: .barrier) {
+      if shared.libraryUUID != libraryUUID {
+        shared.libraryUUID = libraryUUID
+      }
     }
     return shared
   }
@@ -398,6 +399,23 @@ private enum StorageKey: String {
 
     return expirationDate <= Date()  // Expired if date is in the past
   }
+  
+  private enum TokenExpiry {
+    static let refreshThresholdSeconds: TimeInterval = 300  // 5 minutes
+  }
+  
+  /// Returns true if the auth token exists and will expire within 5 minutes.
+  /// Use this for proactive token refresh before making requests.
+  var authTokenNearExpiry: Bool {
+    guard let credentials = credentials,
+          case let TPPCredentials.token(authToken: _, barcode: _, pin: _, expirationDate: expirationDate) = credentials,
+          let expirationDate = expirationDate else {
+      return false
+    }
+    
+    let expiryThreshold = Date().addingTimeInterval(TokenExpiry.refreshThresholdSeconds)
+    return expirationDate <= expiryThreshold
+  }
 
   var patronFullName: String? {
     if let patron = patron,

Palace/Accounts/User/TPPCredentials.swift

@@ -26,6 +26,7 @@ struct AppTabHostView: View {
           }
         }
         .tag(AppTab.catalog)
+        .accessibilityIdentifier(AccessibilityID.TabBar.catalogTab)
 
       NavigationHostView(rootView: MyBooksView(model: MyBooksViewModel()))
         .tabItem {
@@ -35,6 +36,7 @@ struct AppTabHostView: View {
           }
         }
         .tag(AppTab.myBooks)
+        .accessibilityIdentifier(AccessibilityID.TabBar.myBooksTab)
 
       NavigationHostView(rootView: HoldsView())
         .tabItem {
@@ -45,10 +47,12 @@ struct AppTabHostView: View {
         }
         .badge(holdsBadgeCount)
         .tag(AppTab.holds)
+        .accessibilityIdentifier(AccessibilityID.TabBar.holdsTab)
 
       NavigationHostView(rootView: TPPSettingsView())
         .tabItem { Label(Strings.Settings.settings, systemImage: "gearshape") }
         .tag(AppTab.settings)
+        .accessibilityIdentifier(AccessibilityID.TabBar.settingsTab)
     }
     .tint(Color.accentColor)
     .onAppear { AppTabRouterHub.shared.router = router }
@@ -73,16 +77,54 @@ struct AppTabHostView: View {
 
 private extension AppTabHostView {
   func updateHoldsBadge() {
+    // Use test books if debug configuration is enabled, otherwise use real registry data
+    #if DEBUG
+    let held: [TPPBook] = DebugSettings.shared.createTestHoldBooks() ?? TPPBookRegistry.shared.heldBooks
+    let usingTestBooks = DebugSettings.shared.isTestHoldsEnabled
+    #else
     let held = TPPBookRegistry.shared.heldBooks
+    #endif
+    
     var readyCount = 0
+    
     for book in held {
       book.defaultAcquisition?.availability.matchUnavailable(nil,
                                                             limited: nil,
                                                             unlimited: nil,
                                                             reserved: nil,
                                                             ready: { _ in readyCount += 1 })
     }
+    
+    // Update in-app tab badge
     holdsBadgeCount = readyCount
+    
+    // Update home screen app icon badge (only shows books ready to borrow)
+    #if DEBUG
+    if DebugSettings.shared.isBadgeLoggingEnabled {
+      var reservedCount = 0
+      for book in held {
+        book.defaultAcquisition?.availability.matchUnavailable(nil, limited: nil, unlimited: nil,
+                                                              reserved: { _ in reservedCount += 1 }, ready: nil)
+      }
+      Log.info(#file, "[DEBUG-BADGE] updateHoldsBadge: source=\(usingTestBooks ? "TEST BOOKS" : "registry"), totalHeld=\(held.count), reserved=\(reservedCount), ready=\(readyCount)")
+      for (index, book) in held.enumerated() {
+        var status = "unknown"
+        book.defaultAcquisition?.availability.matchUnavailable(
+          { _ in status = "unavailable" },
+          limited: { _ in status = "limited" },
+          unlimited: { _ in status = "unlimited" },
+          reserved: { r in status = "reserved (pos: \(r.holdPosition))" },
+          ready: { _ in status = "READY" }
+        )
+        Log.info(#file, "[DEBUG-BADGE]   Book[\(index)]: '\(book.title)' - status: \(status)")
+      }
+    }
+    #endif
+    
+    // Update app icon badge on main thread
+    DispatchQueue.main.async {
+      UIApplication.shared.applicationIconBadgeNumber = readyCount
+    }
   }
 }