[Swift&SwiftUI] 오픈소스 라이브러리 이슈 해결 및 컨트리뷰터 경험기

오픈소스 라이브러리를 사용하며 이슈를 발견하고, 문제를 해결하여 컨트리뷰터까지 되는 좋은 경험을 하여 정리해보고자 합니다.

앱 개발 중 메모리 사용량이 과도하게 많다는 것을 느끼고 메모리 그래프를 분석하였습니다. 분석 결과, 우리가 사용하고 있던 오픈소스 라이브러리 중 하나에서 메모리 누수 문제가 발생한 것을 알게 되었습니다. 해당 라이브러리를 잘 쓰고 있고 대체하기 어렵다고 생각했기 때문에 이슈를 직접 해결해보고자 하였습니다.

문제의 발견

메모리 분석을 통해 메모리 누수가 있다는 것을 발견했습니다. 내가 작성한 코드에서 발생한 것일 거라 생각했지만, 사용하고 있는 라이브러리에서 발생하고 있었습니다. 어느 부분에서 발생하는 것인지 파악하기 위해 Intruments를 사용하여 분석했습니다.

 

분석 및 해결과정

코드를 분석 결과 파악한 정보입니다.

• DispatchWorkItem을 가지고 있는 객체 DispathWorkHolder
• DispatchQueue 혹인 DispatchGroup에서 수행할 Task의 정보를 캡슐화하는 객체 DispatchWorkItem
• 지정한 시간 이후에 뷰가 자동으로 사라지게 하는 함수 setupAutohide()
• 뷰가 사라지게 하기 위해 setupAutohide() 내부에서 DispatchWorkHolder를 다시 참조

마지막 함수에서 DispatchWorkHolder의 Reference count를 증가시키면서 retain cycle이 발생하였습니다. 이를 해결하기 위해 마지막 과정에서 Reference count를 증가시키지 않을 방법을 공부하고, 생각해 보고, 적용해 보았습니다.

class -> struct로 변경

DispatchWorkHolder는 class이며 참조 타입이기 때문에 Referece count를 증가시킵니다. 때문에 단순하게 값 타입인 struct로 변경한다면 해결할 수 있지 않을까 생각하여 DispatchWorkHolder를 struct로 바꿔보았습니다. 

struct DispatchWorkHolder {
    var work: DispatchWorkItem?
}

public struct FullscreenPopup<Item: Equatable, PopupContent: View>: ViewModifier {

    .
    .
    .

    /// holder for autohiding dispatch work (to be able to cancel it when needed)
    private var dispatchWorkHolder = DispatchWorkHolder()
    
    .
    .
    .

    func setupAutohide() {
        // if needed, dispatch autohide and cancel previous one
        if let autohideIn = autohideIn {
            dispatchWorkHolder.work?.cancel()

            // Weak reference to avoid the work item capturing the struct,
            // which would create a retain cycle with the work holder itself.

            dispatchWorkHolder.work = DispatchWorkItem(block: { [weak isPresentedRef, weak itemRef] in
                isPresentedRef?.value.wrappedValue = false
                itemRef?.value.wrappedValue = nil
                dismissSource = .autohide
            })
            if sheetPresented, let work = dispatchWorkHolder.work {
                DispatchQueue.main.asyncAfter(deadline: .now() + autohideIn, execute: work)
            }
        }
    }

}

 

하지만 제가 간과한 것이 있었는데, 구조체는 내부 프로퍼티의 값을 변경할 수 없습니다. 프로퍼티를 가지는 FullscreenPopup이 구조체이기 때문에 이는 해결 방법이 될 수 없었습니다.

 

weak self

약한 참조를 하면 Reference count를 증가시키지 않습니다. setupAutohide() 내부의 클로저에서 DispatchWorkHolder를 재참조하기 때문에 cycle이 생긴다고 생각하였습니다. 이는 클로저 구문에서 weak self를 통해 해결할 수 있을 것이라 생각하였습니다. 하지만 현재 FullscreenPopup은 구조체이고 이는 값 타입이기 때문에 reference를 가지지 않기 때문에 self의 사용이 불가능했습니다.(또 만약 사용 가능했더라도 잘못 생각한 탓에 해결할 수 없었을 것 같습니다.😅) 이는 첫 번째 시도와와 비슷한 상황으로 문제를 해결할 수 없었습니다.

 

직접 할당 해제

Reference count를 줄이는 방법 중에 하나로 해당 객체를 nil로 바꿔주는 것이 있습니다. 최종적으로 생각한 방법으로 함수의 마지막 시점에 DispatchWorkIteam을 nil로 만들어주었습니다.

func setupAutohide() {
    // if needed, dispatch autohide and cancel previous one
    if let autohideIn = autohideIn {
        dispatchWorkHolder.work?.cancel()
        
        // Weak reference to avoid the work item capturing the struct,
        // which would create a retain cycle with the work holder itself.
        
        dispatchWorkHolder.work = DispatchWorkItem(block: { [weak isPresentedRef, weak itemRef] in
            isPresentedRef?.value.wrappedValue = false
            itemRef?.value.wrappedValue = nil
            dismissSource = .autohide
            dispatchWorkHolder.work = nil
        })
        if sheetPresented, let work = dispatchWorkHolder.work {
            DispatchQueue.main.asyncAfter(deadline: .now() + autohideIn, execute: work)
        }
    }
}

이 방법을 통해 해당 문제를 해결할 수 있었습니다.

 

결론 및 후기

비록 코드 한 줄로 문제를 해결하였지만, 해결하는 과정에서 코드 분석, 메모리 관련, 참조 관련 공부로만 1주일은 사용한 것 같습니다. 포기할까도 생각했지만 할 수 있을 것이라는 생각과 해내고 말겠다는 집념 하나로 계속 진행했던 것 같습니다. 좋은 방법인지는 모르겠지만 문제를 해결할 수 있었고 결과적으로 엄청난 공부가 되었습니다. 개발자로서 한 층 성장하고, 개발하는 것이 더욱 재밌어지는 경험이었습니다.

merge까지 해주었다. 인정받은 기분이다 ㅎㅎㅎㅎㅎ

https://github.com/exyte/PopupView

GitHub - exyte/PopupView: Toasts and popups library written with SwiftUI