iOSプロジェクトへのFirebase導入で詰まったことメモ

iOSプロジェクトへのFirebase導入で詰まったことのメモを残します.


パッケージマネージャ

Firebase を iOS プロジェクトに追加する - Googleを参照すると,現状ではXcode 12.0 以降,CocoaPods 1.9.0 以降が推奨されているので,Swift Packaging ManagerではなくCocoapodsを使う.

Property Listの扱い

FirebaseのconsoleでのApp追加時に取得するplistを環境毎に分けたい場合.それぞれFirebaseのプロジェクト毎にリネームし,iOSプロジェクト内に配置.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// AppDelegate.swift

// MARK: - Firebase init
let configFileName: String
#if DEBUG
configFileName = "GoogleService-dev-Info"
#else
configFileName = "GoogleService-prod-Info"
#endif
guard let filePath = Bundle.main.path(forResource: configFileName, ofType: "plist"),
    let options = FirebaseOptions(contentsOfFile: filePath) else {
    fatalError("Firebase plist file is not found.")
}
FirebaseApp.configure(options: options)

Crashlystics導入

Build PhaseでビルドしたApp内にplistを配置する必要がある.

Get started with Firebase Crashlytics - Google

ビルド時の最後に走らせる必要があるので,Podfileに定義する.

1
2
3
4
5
6
7
8
9
10
# Podfile

target 'PROJECT_NAME' do
  # Comment the next line if you don't want to use dynamic frameworks
  use_frameworks!
  
  pod 'Firebase/Crashlytics'
  script_phase :name=> 'FirebaseCrashlytics',
                 :script=> '"${PODS_ROOT}/FirebaseCrashlytics/run"',
                 :input_files=> ['$(SRCROOT)/$(BUILT_PRODUCTS_DIR)/$(INFOPLIST_PATH)']

そしてその前に各環境毎のplistをApp内の指定したパスにコピーしておく.lpれはXCodeのCodegen上にスクリプトを足しておく.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Type a script or drag a script file from your workspace to insert its path.

# Crashlytics用にGoogleService-Info.plistをビルドディレクトリにコピーする必要があるた
PATH_TO_GOOGLE_PLISTS="${PROJECT_DIR}/bengoshi-ios/Firebase"

case "${CONFIGURATION}" in
"Debug" )
cp -r "$PATH_TO_GOOGLE_PLISTS/GoogleService-dev-Info.plist" "${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.app/GoogleService-Info.plist" ;;

"Release" )
cp -r "$PATH_TO_GOOGLE_PLISTS/GoogleService-prod-Info.plist" "${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.app/GoogleService-Info.plist" ;;

*)
;;
esac

Firebase App Distributionの場合はアーカイブ時に Rebuild from Bitcodeをオフにする.これによりdSYMが同梱されるためアップロードの必要がなくなるらしい. App Store Connectにアップロードする際は,

Firebase Analytics

以下のように各種イベントの種類等定義しておく

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
import Foundation
import Firebase
import FirebaseAnalytics

class EventLogs {
    // MARK: - LogIn
    static func loginInputTelNumber(success: Bool, error_type: String? = nil) {
        if success {
            Analytics.logEvent("ios_login_input_tel_number_succeed",
                               parameters: nil)
        } else {
            Analytics.logEvent("ios_login_input_tel_number_failure",
                               parameters: ["error_type": error_type as Any])
        }
    }
    static func login(success: Bool, error_type: String? = nil) {
        if success {
            Analytics.logEvent("login", parameters: ["method": "iOS"])
            Analytics.logEvent("ios_login_succeed", parameters: nil)
        } else {
            Analytics.logEvent("ios_login_failure",
                               parameters: ["error_type": error_type as Any])
        }
    }
    static func logout() {
        Analytics.logEvent("ios_logout", parameters: nil)
    }
    // MARK: - UI
    static func openModal() {
        Analytics.logEvent("ios_ui_modal_open", parameters: nil)
    }
    static func closeModal() {
        Analytics.logEvent("ios_ui_modal_close", parameters: nil)
    }
: 
:

ただ,Firabse AnaltyicsのEventは反映されるのに時間がかかるので,DebugView 機能を用いる.Xcodeで、Product -> Scheme -> Edit schemeのArgumentsタブで -FIRDebugEnabledを引数に設定する.すると,数十秒のラグでデバッグしながらイベントを確認できる.

参考

https://www.apps-gcp.com/introduction-of-firebase-analytics/#i-5