Fix Observer Alert list (#2925)

refs: MBL-17893
affects: Parent
release note: Fixed alert list not refreshing after an alert is read or dismissed.

Author: rh12

Core/Core/ObserverAlerts/APIObserverAlert.swift

@@ -67,30 +67,3 @@ extension APIObserverAlert {
     }
 }
 #endif
-
-// Not documented
-public struct GetObserverAlertsRequest: APIRequestable {
-    public typealias Response = [APIObserverAlert]
-
-    public let studentID: String
-    public var path: String { "users/self/observer_alerts/\(studentID)" }
-    public var query: [APIQueryItem] { [ .perPage(100) ] }
-}
-
-// Not documented
-public struct MarkObserverAlertReadRequest: APIRequestable {
-    public typealias Response = APIObserverAlert
-
-    public let alertID: String
-    public var method: APIMethod { .put }
-    public var path: String { "users/self/observer_alerts/\(alertID)/read" }
-}
-
-// Not documented
-public struct DismissObserverAlertRequest: APIRequestable {
-    public typealias Response = APIObserverAlert
-
-    public let alertID: String
-    public var method: APIMethod { .put }
-    public var path: String { "users/self/observer_alerts/\(alertID)/dismissed" }
-}

Core/Core/ObserverAlerts/GetObserverAlerts.swift

@@ -47,6 +47,10 @@ public final class ObserverAlert: NSManagedObject {
         set { workflowStateRaw = newValue.rawValue }
     }
 
+    public var isUnread: Bool {
+        workflowState == .unread
+    }
+
     public var courseID: String? {
         switch alertType {
         case .courseGradeHigh, .courseGradeLow:

Core/Core/ObserverAlerts/ObserverAlert.swift

@@ -21,26 +21,50 @@ import XCTest
 import TestsFoundation
 
 class ObserverAlertTests: CoreTestCase {
-    func testProperties() {
+
+    private var alert: ObserverAlert!
+
+    override func setUp() {
+        super.setUp()
         let alert: ObserverAlert = databaseClient.insert()
+        self.alert = alert
+    }
+
+    override func tearDown() {
+        alert = nil
+        super.tearDown()
+    }
+
+    func testAlertType() {
         alert.alertTypeRaw = "bogus"
         XCTAssertEqual(alert.alertType, .institutionAnnouncement)
-        alert.alertType = .courseAnnouncement
+
+        alert.alertTypeRaw = "course_announcement"
         XCTAssertEqual(alert.alertType, .courseAnnouncement)
 
+        alert.alertType = .assignmentMissing
+        XCTAssertEqual(alert.alertTypeRaw, "assignment_missing")
+    }
+
+    func testWorkflowState() {
         alert.workflowStateRaw = "bogus"
         XCTAssertEqual(alert.workflowState, .unread)
-        alert.workflowState = .dismissed
+        XCTAssertEqual(alert.isUnread, true)
+
+        alert.workflowStateRaw = "dismissed"
         XCTAssertEqual(alert.workflowState, .dismissed)
+        XCTAssertEqual(alert.isUnread, false)
+
+        alert.workflowState = .read
+        XCTAssertEqual(alert.workflowStateRaw, "read")
+        XCTAssertEqual(alert.isUnread, false)
     }
 
     func testLockedForUserDefaultValue() {
-        let alert: ObserverAlert = databaseClient.insert()
         XCTAssertEqual(alert.lockedForUser, false)
     }
 
     func testLockedForUserAPIMapping() {
-        let alert: ObserverAlert = databaseClient.insert()
         alert.id = "testId"
 
         ObserverAlert.save(.make(id: "testId", locked_for_user: nil), in: databaseClient)
@@ -54,7 +78,6 @@ class ObserverAlertTests: CoreTestCase {
     }
 
     func testCourseID() {
-        let alert: ObserverAlert = databaseClient.insert()
         alert.contextID = "contextID"
         alert.htmlURL = URL(string: "https://test.com/courses/courseID/assignments/1434231")!
 

Core/CoreTests/ObserverAlerts/ObserverAlertTests.swift

@@ -0,0 +1,49 @@
+//
+// This file is part of Canvas.
+// Copyright (C) 2024-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 XCTest
+@testable import Core
+
+extension API {
+
+    @discardableResult
+    public func mock<Request: APIRequestable>(
+        _ request: Request,
+        expectation: XCTestExpectation,
+        value: Request.Response? = nil,
+        response: URLResponse? = nil,
+        error: Error? = nil
+    ) -> APIMock {
+        mock(request) { _ in
+            expectation.fulfill()
+            return (value, response, error)
+        }
+    }
+
+    @discardableResult
+    public func mock<U: APIUseCase>(
+        _ useCase: U,
+        expectation: XCTestExpectation,
+        value: U.Request.Response? = nil,
+        response: URLResponse? = nil,
+        error: Error? = nil
+    ) -> APIMock {
+        mock(useCase.request, expectation: expectation, value: value, response: response, error: error)
+    }
+}