[iOS][Swift] Dismiss Live Activities on App Termination ( feat. Semaphore )

 

📚 Semaphore (세마포어 )

 

 

일단 세마포어에 대해서 포스팅하기전에 관련된 이슈인, 이전 포스팅 'LiveActivity' 포스팅을 보고오면 이해하는데 도움이 될 것이다. 

 

https://leesangdo.tistory.com/310

[SwiftUI] LiveActivity 구현할 때, 앱 강제종료시 LiveAcivity 종료에 대해

 

위 포스팅을 보면 알다시피, LiveActivity 종료를 Dynamic Island Expanded 영역에서 X 버튼을 통해 종료시켜야하는 우회적인 방법으로 구현을 마쳐놓았었다. 

종료버튼을 통해 종료가 되니 우회적인것이 아닐지도 몰라도, 깔끔하지 않은 방법이라는 것은 확실하다. 😭😭 

백그라운드영역에서 앱을 강제종료하면 LiveActivity가 사라지지 않는 것은 여전하기 때문이다.

 

실제 우리의 타겟 유저가, LiveActivity가 계속 남아있는걸로 문의를 했으니

사용자 입장에서는 정말 좋지 않은채로 남아있었다.

이 이슈만이 계속 마음에 걸렸고, 지금은 해결을 했기에 포스팅을 한다.

 

당시 개발을 할 때에는, 로컬로만 동작하는 앱이기에 외부(서버)의 도움없이는 앱을 강제종료했을때 추가적인 함수 실행이 불가능한줄 알았는데, 최근에 다시 구글링을 해보니 앱이 종료되었을 때 실행되는 메소드가 기본적으로 제공되고 있었다.

 

우선 SwiftUI였기때문에, AppDelegate 파일을 생성해주어야했다.

class AppDelegate: UIResponder, UIApplicationDelegate {
    
    // 앱이 종료될때 실행
    func applicationWillTerminate(_ application: UIApplication) {
        print(#function)
    }
}

위에 있는 AppDelegate 파일내에 applicationWillTerminate가 앱이 종료되었을때 자동으로 실행되는 함수이다.

 

이후, @main 파일에서 AppDelegate를 접근할 수 있게 연결을 한다.

import SwiftUI

@main
struct ContentApp: App {
    
    @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

이렇게 말이다.

 

이렇게하고 테스트를 해보면, 앱을 스와이프로 강제종료했을때 AppDelegate의 함수가 print되는것을 확인할 수 있었다.

 

이후부터가 약간의 고민이었다.

class AppDelegate: UIResponder, UIApplicationDelegate {
    
    // 앱이 종료될때 실행
    func applicationWillTerminate(_ application: UIApplication) {
        Task {
            print(#function)
            await NoiseMeter.shared.endLiveActivity()
        }
    }
}

 

NoiseMeter.shared.endLiveActivity()가 LiveActivity를 종료시키는 함수인데, 이렇게 실행을 했더니 applicationWillTerminate()는 실행이 되는데, endLiveActivity()는 실행이 되지 않았다. 

 

 

🤔 왜 ? 어째서 ? 🤔

 

 

 

잠시 생각을 해보았는데, 나의 생각으로는 applicationWillTerminate가 호출된 시점에서, 비동기함수인 endLiveActivity가 비동기로 작업을 시작하면서 프로세스를 너무 빨리 종료해버려 로직이 끝까지 실행되지 못하는 걸로 판단했다.

그래서 기존의 비동기 함수인 endLiveActivity()함수를 

func endLiveActivity() async {
    print(#function)
    let semaphore = DispatchSemaphore(value: 0)
    Task {
        if let currentActivity = activity {
            await currentActivity.end(nil, dismissalPolicy: .immediate)
            print("Ending the Live Activity: \(currentActivity.id)")
            self.activity = nil
        }
        semaphore.signal()
    }
    cancellation?.cancel()
    updateTimer?.invalidate()
    updateTimer = nil
    Task {
        await self.stopMetering()
    }
    semaphore.wait()
}

이렇게 참고한 레퍼런스처럼, 세마포어를 이용해서 비동기 함수가 모두 끝나는걸 기다리면서 모두 실행되고 끝날 수 있게 시도했는데

 

 semaphore.wait() 

 

위 코드가, Swift6에서는 비동기함수 내부에서 세마포어로 하여금 스레드를 직접 블로킹 하는것을 막는다고 한다. 그래서 비동기 함수 내에서 동기적으로 대기할 수 없다고하기에, wait()을 빼고 endLiveActivity도 동기함수로 수정하였다.

그 다음은 내부에서 추가적으로 호출하는 stopMetering()도 비동기였어서 역시나 라이브액티비티가 종료되지 않았다.

 

최종적으로 endLiveActivity()와 stopMetering()도 동기함수로 변경을 하였다. 근데 이렇게 모두 모두 동기로 처리해버리니까, 굳이 세마포어가 필요하지 않게 되면서 세마포어 코드가 모두 필요하지 않게 되었다.

 

기존의 팀원이 비동기함수로 구현을 했었는데, 해당 함수들이 시간이나 메모리를 많이 잡아먹을정도로 비동기로 처리해야하는 작업은 아니기에 동기로 변경하면서 

앱 강제종료 -> applicationWillTerminate 실행 -> endLiveActivity()를 실행하면서 

앱 강제종료했을때에도 라이브 액티비티가 깔끔하게 같이 종료되게 구현 및 수정을 해놓았다 ! 

 

 

최종코드 

func applicationWillTerminate(_ application: UIApplication) {
    print(#function)
    NoiseMeter.shared.endLiveActivity()
    print("[앱 강제종료 됨 : endLiveActivity Done]")
}

 

func endLiveActivity() {
    print(#function)
    Task {
        if let currentActivity = activity {
            await currentActivity.end(nil, dismissalPolicy: .immediate)
            print("Ending the Live Activity: \(currentActivity.id)")
            self.activity = nil
        }
    }
    cancellation?.cancel()
    updateTimer?.invalidate()
    updateTimer = nil
    self.stopMetering()
}

 

 

그런데, 아직 조금 더 테스트해보고싶은 부분이있다.

밑에 있는 내가 참고한 레퍼런스를 보면

"메서드가 반환되어서 실제로 종료될 기회를 갖기전에 앱이 종료될 수 있다."

"메서드에서 반환하기 전에 활동이 끝날때까지 기다리도록 강제하는 세마포어를 추가한다."

라고 설명을 한다.

그리고 예시로 첨부한 코드도 함수명 자체는 비동기로 되어있다.

 

즉, 나는 기존의 비동기 함수를 동기함수로 수정하면서 세마포어를 사용하지 않아도 이슈를 해결했는데

기존처럼 비동기함수를 유지하면서 세마포어를 이용해 라이브 액티비티를 종료하는것으로 코드를 다시 테스트 해봐야겠다.

이것은 이어서 세마포어 정리와 3편으로 포스팅을 해볼 것이다. 🚀🔥🔥

 

 

참고 레퍼런스

https://developer.apple.com/forums/thread/732418

Dismiss Live Activities on App Ter… | Apple Developer Forums