[MBL-19551][S/T/P] Immersive Video Player for Studio LTI Media Embeds

Core/Core/Common/CommonModels/AppEnvironment/FeatureFlags/APIFeatureFlagState.swift

@@ -0,0 +1,66 @@
+//
+// 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 Foundation
+
+public struct APIFeatureFlagState: Codable {
+
+    public enum State: String, Codable {
+        /// (valid only for account context) The feature is `off` in the account, but may be enabled in sub-accounts and courses by setting a feature flag `on` the sub-account or course.
+        case allowed
+        /// (valid only for account context) The feature is `on` in the account, but may be disabled in sub-accounts and courses by setting a feature flag `off` the sub-account or course.
+        case allowed_on
+        /// The feature is turned `on` unconditionally for the user, course, or account and sub-accounts.
+        case on
+        /// The feature is not available for the course, user, or account and sub-accounts.
+        case off
+    }
+
+    public let feature: String
+    public let state: State
+    public let locked: Bool
+
+    private let context_id: String
+    private let context_type: String
+
+    init(feature: String, state: State, locked: Bool, context_id: String, context_type: String) {
+        self.feature = feature
+        self.state = state
+        self.locked = locked
+        self.context_id = context_id
+        self.context_type = context_type
+    }
+
+    public var contextType: ContextType? {
+        return ContextType(rawValue: context_type.lowercased())
+    }
+
+    public var canvasContextID: String {
+        return "\(context_type.lowercased())_\(context_id)"
+    }
+
+    public func overriden(state: State, context: Context) -> Self {
+        APIFeatureFlagState(
+            feature: feature,
+            state: state,
+            locked: locked,
+            context_id: context.id,
+            context_type: context.contextType.rawValue
+        )
+    }
+}

Core/Core/Common/CommonModels/AppEnvironment/FeatureFlags/FeatureFlag.swift

@@ -20,9 +20,6 @@ import Foundation
 import CoreData
 
 public struct APIFeatureFlag {
-    public enum Key: String {
-        case assignmentEnhancements = "assignments_2_student"
-    }
     public let key: String
     public let isEnabled: Bool
     public let canvasContextID: String
@@ -55,10 +52,24 @@ public final class FeatureFlag: NSManagedObject, WriteableModel {
         flag.isEnvironmentFlag = item.isEnvironmentFlag
         return flag
     }
+
+    @discardableResult
+    public static func save(_ item: APIFeatureFlagState, in context: NSManagedObjectContext) -> FeatureFlag {
+        let predicate = NSCompoundPredicate(andPredicateWithSubpredicates: [
+            NSPredicate(format: "%K == %@", #keyPath(FeatureFlag.canvasContextID), item.canvasContextID),
+            NSPredicate(format: "%K == %@", #keyPath(FeatureFlag.name), item.feature)
+        ])
+        let flag: FeatureFlag = context.fetch(predicate).first ?? context.insert()
+        flag.name = item.feature
+        flag.enabled = item.state == .on
+        flag.canvasContextID = item.canvasContextID
+        flag.isEnvironmentFlag = false
+        return flag
+    }
 }
 
 extension Collection where Element == FeatureFlag {
-    public func isFeatureFlagEnabled(_ key: APIFeatureFlag.Key) -> Bool {
+    public func isFeatureFlagEnabled(_ key: FeatureFlagName) -> Bool {
         isFeatureFlagEnabled(name: key.rawValue)
     }
 

Core/Core/Common/CommonModels/AppEnvironment/FeatureFlags/GetEnabledFeatureFlags.swift

@@ -64,7 +64,7 @@ public class GetEnabledFeatureFlags: CollectionUseCase {
 }
 
 extension Store where U == GetEnabledFeatureFlags {
-    public func isFeatureFlagEnabled(_ key: APIFeatureFlag.Key) -> Bool {
+    public func isFeatureFlagEnabled(_ key: FeatureFlagName) -> Bool {
         all.isFeatureFlagEnabled(key)
     }
 }

Core/Core/Common/CommonModels/AppEnvironment/FeatureFlags/GetFeatureFlagState.swift

@@ -0,0 +1,69 @@
+//
+// 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 Foundation
+import CoreData
+
+public class GetFeatureFlagState: CollectionUseCase {
+    public typealias Model = FeatureFlag
+
+    public let featureName: FeatureFlagName
+    public let context: Context
+
+    public var scope: Scope {
+        let contextPredicate = NSPredicate(format: "%K == %@", #keyPath(FeatureFlag.canvasContextID), context.canvasContextID)
+        let namePredicate = NSPredicate(format: "%K == %@", #keyPath(FeatureFlag.name), featureName.rawValue)
+        let predicate = NSCompoundPredicate(
+            andPredicateWithSubpredicates: [
+                contextPredicate,
+                namePredicate
+            ]
+        )
+        return Scope(predicate: predicate, order: [NSSortDescriptor(key: #keyPath(FeatureFlag.name), ascending: true)])
+    }
+
+    public var cacheKey: String? {
+        return "get-\(context.canvasContextID)-\(featureName.rawValue)-feature-flag-state"
+    }
+
+    public var request: GetFeatureFlagStateRequest {
+        return GetFeatureFlagStateRequest(featureName: featureName, context: context)
+    }
+
+    public init(featureName: FeatureFlagName, context: Context) {
+        self.featureName = featureName
+        self.context = context
+    }
+
+    public func write(response: APIFeatureFlagState?, urlResponse: URLResponse?, to client: NSManagedObjectContext) {
+        guard var item = response else { return }
+
+        /// This as workaround for an API limitation, where
+        /// requesting feature state of a course context,
+        /// if not set on that course, would return the feature state of
+        /// the most higher level (which is the account)
+        if item.contextType != context.contextType && item.contextType == .account {
+            item = item.overriden(
+                state: item.state == .allowed_on ? .on : item.state,
+                context: context
+            )
+        }
+
+        FeatureFlag.save(item, in: client)
+    }
+}

Core/Core/Common/CommonModels/AppEnvironment/FeatureFlags/GetFeatureFlagStateRequest.swift

@@ -0,0 +1,43 @@
+//
+// 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 Foundation
+
+// https://canvas.instructure.com/doc/api/feature_flags.html#method.feature_flags.show
+public struct GetFeatureFlagStateRequest: APIRequestable {
+    public typealias Response = APIFeatureFlagState
+
+    public let context: Context
+    public let featureName: FeatureFlagName
+
+    public var path: String {
+        return "\(context.pathComponent)/features/flags/\(featureName.rawValue)"
+    }
+
+    public init(featureName: FeatureFlagName, context: Context) {
+        self.featureName = featureName
+        self.context = context
+    }
+}
+
+// MARK: - Parameters
+
+public enum FeatureFlagName: String {
+    case assignmentEnhancements = "assignments_2_student"
+    case studioEmbedImprovements = "rce_studio_embed_improvements"
+}