[Horizon] Merge master

Core/Core/Common/CommonModels/API/API.swift

@@ -119,8 +119,12 @@ public class API {
                                     callback: ((URL?, URLResponse?, Error?) -> Void)? = nil)
     -> APITask? {
         var request = URLRequest(url: url)
-        let token = AppEnvironment.shared.currentSession?.accessToken ?? ""
-        request.setValue("Bearer \(token)", forHTTPHeaderField: HttpHeader.authorization)
+
+        if AppEnvironment.shared.app == .horizon {
+            let token = AppEnvironment.shared.currentSession?.accessToken ?? ""
+            request.setValue("Bearer \(token)", forHTTPHeaderField: HttpHeader.authorization)
+        }
+
         if let method {
             request.httpMethod = method.rawValue.uppercased()
         }

Core/Core/Common/CommonModels/API/ID.swift

@@ -146,4 +146,19 @@ public extension String {
         formatter.numberStyle = .decimal
         return formatter
     }()
+
+    /// Get a copy of this ID where `shardID` of the original login session being
+    /// inserted as prefix to it.
+    /// For example, ID of **`239`** transformed to **`217540000000000239`**
+    /// with **`21754`** as being `shardID` extracted from the original access token.
+    var asRootID: String {
+        let env = AppEnvironment.shared
+
+        guard let shardID = env.currentSession?.accessToken?.shardID
+        else { return self }
+
+        if hasShardID { return self }
+
+        return ID.expandTildeID("\(shardID)~\(self)")
+    }
 }

Core/Core/Common/CommonModels/AppEnvironment/AppEnvironment.swift

@@ -66,6 +66,9 @@ open class AppEnvironment {
         self.logger = Logger.shared
     }
 
+    open var root: AppEnvironment { self }
+    public var isRoot: Bool { root === self }
+
     /**
      - parameters:
         - isSilent: If this parameter is true then the method won't trigger a widget refresh
@@ -141,7 +144,7 @@ open class AppEnvironment {
     public static var shared = AppEnvironment()
 
     public func subscribe<U>(_ useCase: U, _ callback: @escaping Store<U>.EventHandler = { }) -> Store<U> where U: UseCase {
-        return Store(env: self, useCase: useCase, eventHandler: callback)
+        return Store(env: self, useCase: useCase.modified(for: self), eventHandler: callback)
     }
 
     public func subscribe<Model>(scope: Scope, _ callback: @escaping Store<LocalUseCase<Model>>.EventHandler = {}) -> Store<LocalUseCase<Model>> {

Core/Core/Common/CommonModels/AppEnvironment/AppEnvironmentOverride.swift

@@ -36,6 +36,8 @@ public final class AppEnvironmentOverride: AppEnvironment {
         API(currentSession, baseURL: baseURL)
     }()
 
+    public override var root: AppEnvironment { base }
+
     public override var app: AppEnvironment.App? {
         get { base.app }
         set {}
@@ -89,7 +91,7 @@ public final class AppEnvironmentOverride: AppEnvironment {
                 masquerader: cSession.masquerader,
                 refreshToken: cSession.refreshToken,
                 userAvatarURL: cSession.userAvatarURL,
-                userID: cSession.userID,
+                userID: cSession.userID.localID,
                 userName: cSession.userName,
                 userEmail: cSession.userEmail,
                 clientID: cSession.clientID,

Core/Core/Common/CommonModels/Contexts/GetCustomColors.swift

@@ -28,6 +28,14 @@ public class GetCustomColors: APIUseCase {
 
     public init() {}
 
+    public func makeRequest(
+        environment: AppEnvironment,
+        completionHandler: @escaping (APICustomColors?, URLResponse?, Error?) -> Void
+    ) {
+        // Always call root account API for this request.
+        environment.root.api.makeRequest(request, callback: completionHandler)
+    }
+
     public func write(response: APICustomColors?, urlResponse: URLResponse?, to client: NSManagedObjectContext) {
         guard let response = response else { return }
         ContextColor.save(response, in: client)

Core/Core/Common/CommonModels/Router/Router.swift

@@ -224,8 +224,6 @@ open class Router {
         guard let window = AppEnvironment.shared.window else { return }
         UIView.transition(with: window, duration: 0.5, options: isLoginTransition ? .transitionFlipFromRight : .transitionFlipFromLeft) {
             window.rootViewController = viewController
-            // TODO: root vc analytics
-//            Analytics.shared.logScreenView(route: "/login", viewController: window.rootViewController)
         }
     }
 

Core/Core/Common/CommonModels/Store/ReactiveStore.swift

@@ -40,7 +40,7 @@ public class ReactiveStore<U: UseCase> {
         environment: AppEnvironment = .shared
     ) {
         self.offlineModeInteractor = offlineModeInteractor
-        self.useCase = useCase
+        self.useCase = useCase.modified(for: environment)
         self.context = context
         self.environment = environment
     }
@@ -138,7 +138,8 @@ public class ReactiveStore<U: UseCase> {
         context: NSManagedObjectContext,
         environment: AppEnvironment
     ) -> AnyPublisher<[T], Error> {
-        return useCase.hasCacheExpired()
+        return useCase
+            .hasCacheExpired(environment: environment)
             .setFailureType(to: Error.self)
             .flatMap { hasExpired -> AnyPublisher<[T], Error> in
                 if hasExpired {

Core/Core/Common/CommonModels/Store/UseCase.swift

@@ -33,6 +33,7 @@ public protocol UseCase {
     func reset(context: NSManagedObjectContext)
     func write(response: Response?, urlResponse: URLResponse?, to client: NSManagedObjectContext)
     func getNext(from response: URLResponse) -> GetNextRequest<Response>?
+    func modified(for env: AppEnvironment) -> Self
 }
 
 public extension UseCase {
@@ -52,6 +53,16 @@ public extension UseCase {
         // no-op
     }
 
+    func modified(for env: AppEnvironment) -> Self {
+        self
+    }
+}
+
+// MARK: - The actual UseCase logic
+
+public extension UseCase {
+
+    /// Cache expiration check used by the legacy `Store`.
     func hasExpired(in client: NSManagedObjectContext) -> Bool {
         guard let cacheKey = cacheKey, !ProcessInfo.isUITest else { return true }
         var expired = true
@@ -63,6 +74,7 @@ public extension UseCase {
         return expired
     }
 
+    /// Private helper method, used by both closure based and reactive `fetch()` methods.
     func updateTTL(in client: NSManagedObjectContext) {
         guard let cacheKey = cacheKey else { return }
         let predicate = NSPredicate(format: "%K == %@", #keyPath(TTL.key), cacheKey)
@@ -71,6 +83,7 @@ public extension UseCase {
         cache.lastRefresh = Clock.now
     }
 
+    /// Closure based `fetch()`, used by the legacy `Store` and directly from other places.
     func fetch(environment: AppEnvironment = .shared, force: Bool = false, _ callback: RequestCallback? = nil) {
         // Make sure we write to the database that initiated this request
         let database = environment.database
@@ -106,6 +119,7 @@ public extension UseCase {
         }
     }
 
+    /// Cache expiration check used by the `ReactiveStore`.
     func hasCacheExpired(environment: AppEnvironment = .shared) -> Future<Bool, Never> {
         Future<Bool, Never> { promise in
             environment.database.performWriteTask { context in
@@ -114,6 +128,7 @@ public extension UseCase {
         }
     }
 
+    /// Reactive `fetch()`, used by the `ReactiveStore` and directly from other places.
     func fetchWithFuture(environment: AppEnvironment = .shared) -> Future<URLResponse?, Error> {
         Future<URLResponse?, Error> { promise in
             self.makeRequest(environment: environment) { response, urlResponse, error in
@@ -145,6 +160,9 @@ public extension UseCase {
     }
 }
 
+// MARK: - API UseCases
+
+/// A `UseCase` that provides a default `makeRequest()` implementation which uses the provided API `request`.
 public protocol APIUseCase: UseCase {
     associatedtype Request: APIRequestable
     var request: Request { get }
@@ -162,13 +180,17 @@ public extension APIUseCase where Response == Request.Response {
     }
 }
 
+/// An `APIUseCase` that deletes all existing CoreData entities matching `scope` before each `write`.
+/// This is needed when the new collection should replace the old collection as a whole.
+/// Otherwise elements not in the new collection would stay in CoreData, which is usually a bug.
 public protocol CollectionUseCase: APIUseCase {}
 public extension CollectionUseCase {
     func reset(context: NSManagedObjectContext) {
         context.delete(context.fetch(scope: scope) as [Model])
     }
 }
 
+/// An `APIUseCase` that sends `request` and on success it deletes all CoreData entities matching `scope`.
 public protocol DeleteUseCase: APIUseCase {}
 public extension DeleteUseCase {
     func write(response _: Response?, urlResponse _: URLResponse?, to client: NSManagedObjectContext) {
@@ -200,6 +222,11 @@ public struct GetNextUseCase<U: UseCase>: APIUseCase {
     }
 }
 
+// MARK: - WriteableModel
+
+/// Defines basic `save()` methods for CoreData entities which doesn't require additional parameters besides their corresponding API model.
+/// These allow for default `UseCase.write()` implementations, making the `UseCase` using the entity a bit simpler.
+/// The associated type `JSON` is the corresponding API model used to save the entity.
 public protocol WriteableModel {
     associatedtype JSON
 
@@ -235,6 +262,9 @@ public extension UseCase where Model: WriteableModel, Response: Collection, Mode
     }
 }
 
+// MARK: - Local UseCases
+
+/// Does not send out an API request, only fetches the entities from CoreData.
 public class LocalUseCase<T>: UseCase where T: NSManagedObject {
     public typealias Model = T
     // Response doesn't matter so this is just a Codable stub
@@ -255,6 +285,7 @@ public class LocalUseCase<T>: UseCase where T: NSManagedObject {
     public func write(response _: Int?, urlResponse _: URLResponse?, to _: NSManagedObjectContext) {}
 }
 
+/// A `LocalUseCase` that deletes all CoreData entities matching `scope`.
 public class DeleteLocalUseCase<T>: UseCase where T: NSManagedObject {
     public typealias Model = T
     // Response doesn't matter so this is just a Codable stub

Core/Core/Common/CommonUI/InstUI/BaseScreen.swift

@@ -169,8 +169,7 @@ public extension InstUI {
                     .frame(width: geometry.size.width, height: geometry.size.height)
                 }
             }
-            // TODO: Check if it's needed here
-//            .background(Color.backgroundLightest)
+            .background(AppEnvironment.shared.app == .horizon ? Color.clear : Color.backgroundLightest)
             .scrollBounceBehavior(config.scrollBounce)
         }
     }

Core/Core/Common/CommonUI/InstUI/Styles/Elevation.swift

@@ -23,39 +23,29 @@ extension InstUI.Styles {
     public enum Elevation {
 
         public enum Shape {
-            case card
+            case cardSmall
+            case cardLarge
             case pill
 
             var cornerRadius: CGFloat {
                 switch self {
-                case .card: 6
+                case .cardSmall: 6
+                case .cardLarge: 24
                 case .pill: 100
                 }
             }
         }
-
-        public enum BaseBackground {
-            case light
-            case lightest
-
-            var elevationBackground: Color {
-                switch self {
-                case .light: .backgroundLightest
-                case .lightest: .backgroundLightestElevated
-                }
-            }
-        }
     }
 }
 
 extension View {
 
     public func elevation(
         _ shape: InstUI.Styles.Elevation.Shape,
-        aboveBackground baseBackground: InstUI.Styles.Elevation.BaseBackground
+        background: Color
     ) -> some View {
         self
-            .background(baseBackground.elevationBackground)
+            .background(background)
             .cornerRadius(shape.cornerRadius)
             .shadow(color: .black.opacity(0.08), radius: 2, y: 2)
             .shadow(color: .black.opacity(0.16), radius: 2, y: 1)

Core/Core/Common/CommonUI/InstUI/Styles/SectionDisclosureStyle.swift

@@ -0,0 +1,81 @@
+//
+// This file is part of Canvas.
+// Copyright (C) 2025-present  Instructure, Inc.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+//
+
+import SwiftUI
+
+extension InstUI {
+
+    public struct SectionDisclosureStyle: DisclosureGroupStyle {
+
+        public struct HeaderConfiguration {
+            let paddingSet: InstUI.Styles.PaddingSet
+            let accessoryIconSize: CGFloat
+            let hasDividerBelowHeader: Bool
+        }
+
+        @Environment(\.dynamicTypeSize) private var dynamicTypeSize
+
+        private let headerConfig: HeaderConfiguration
+
+        public init(headerConfig: HeaderConfiguration) {
+            self.headerConfig = headerConfig
+        }
+
+        public func makeBody(configuration: Configuration) -> some View {
+            VStack(alignment: .leading, spacing: 0) {
+                Button(
+                    action: {
+                        withAnimation(.smooth(duration: 0.3)) {
+                            configuration.isExpanded.toggle()
+                        }
+                    },
+                    label: {
+                        header(configuration: configuration)
+                            .paddingStyle(set: headerConfig.paddingSet)
+                            .contentShape(Rectangle())
+                            .background(.backgroundLightest) // to stop collapsing views above showing through
+                    }
+                )
+                .buttonStyle(.plain)
+
+                if headerConfig.hasDividerBelowHeader {
+                    InstUI.Divider()
+                }
+
+                if configuration.isExpanded {
+                    configuration.content
+                        .background(.backgroundLightest) // to stop collapsing views above showing through
+                }
+            }
+        }
+
+        private func header(configuration: Configuration) -> some View {
+            HStack(alignment: .center, spacing: 0) {
+                configuration.label
+                    .frame(maxWidth: .infinity, alignment: .leading)
+                    .accessibilityAddTraits([.isHeader])
+
+                Image.chevronDown
+                    .scaledIcon(size: headerConfig.accessoryIconSize)
+                    .foregroundStyle(.textDark)
+                    .rotationEffect(.degrees(configuration.isExpanded ? 180 : 0))
+                    .paddingStyle(.leading, .cellAccessoryPadding)
+            }
+        }
+    }
+}