デバッグメニューのメンテナンスが大変だったので、専用アプリを作りました。 / iOSDC Japan 2020

iOSDC Japan 2020 Day1 13:20~ Track B

プロポーザル：https://fortee.jp/iosdc-japan-2020/proposal/3fb66bbc-5a43-44d0-aa60-89abb12939e1
参考実装：https://github.com/FromAtom/iosdc-2020-sample

Transcript

1. デバッグメニューの メンテナンスが大変だったので、 専用アプリを作りました。 iOSDC Japan 2020 2020/09/20 13:20〜 Track B pixiv.inc @FromAtom
2. • pixiv Sketch / pixiv Sketch LIVE • アプリ分野テックリードしています • 好きなSwiftは guard @FromAtom
3. 原稿も出しました。
4. 原稿も出しました。 （なぜか2本も）
5. めちゃ大変だったので読んで♡
6. アジェンダ • デバッグメニューとは • 背景 • 仕組み • 実装方法 • デバッグメニューアプリ作りのコツ • CI時のコツ • メリットとデメリット
7. アジェンダ • デバッグメニューとは • 背景 • 仕組み • 実装方法 • デバッグメニューアプリ作りのコツ • CI時のコツ • メリットとデメリット
8. デバッグメニューとは？ 一般ユーザには提供されず、 開発者のみが利用できる機能群
9. デバッグメニューのメリット ビルドせずアプリ内部の状態を確認・変更できる
10. • 接続するAPIを切り替える • Feature Flagを切り替える • アカウントの状態を切り替える • キャッシュやDBを空にする デバッグメニューの機能
11. デバッグメニューの用途 • デバッグ • 社内テスト • ベータテスト
12. デバッグメニュー 開発・デバッグの効率化
13. アジェンダ • デバッグメニューとは • 背景 • 仕組み • 実装方法 • デバッグメニューアプリ作りのコツ • CI時のコツ • メリットとデメリット
14. 弊社の背景 • 7つのiOSアプリを開発・提供 • アプリによって下記が異なる ‣ メニューの有無 ‣ アクセス方法 ‣ UI ‣ 実装方法 独自デバッグメニュー なし なし 独自デバッグメニュー 独自デバッグメニュー なし なし
15. 問題点 • 社内テストの準備が手間 • 学習コストが高い • 新規導入のコストが高い • 開発優先度が低くメンテナンスされにくい • 散在する #if DEBUG による事故リスク
16. 解決案 独自デバッグメニュー なし なし 独自デバッグメニュー 独自デバッグメニュー なし なし
17. 解決案 全アプリのデバッグメニューを 1つのアプリにする
18. [ DEMO ]
20. アジェンダ • デバッグメニューとは • 背景 • 仕組み • 実装方法 • デバッグメニューアプリ作りのコツ • CI時のコツ • メリットとデメリット
21. 仕組み App Groups + UserDefaults
22. App Groups 同一デベロッパーのアプリ間でデータを共有
23. 仕組み
24. UserDefaults 仕組み
25. UserDefaults UserDefaults 仕組み
26. UserDefaults UserDefaults 仕組み
27. UserDefaults UserDefaults 仕組み
28. App Groups UserDefaults UserDefaults 仕組み
29. UserDefaults UserDefaults 共用 UserDefaults App Groups 仕組み
30. App Groups UserDefaults UserDefaults 共用 UserDefaults 仕組み
31. App Groups 共用 UserDefaults 仕組み
32. 共用 UserDefaults isDebug: false 仕組み
33. 共用 UserDefaults isDebug: true isDebug: false 仕組み
34. 共用 UserDefaults isDebug: true isDebug: true 仕組み
35. 共用 UserDefaults isDebug: true isDebug: true 仕組み
36. 共用 UserDefaults デバッグモードやな isDebug: true isDebug: true 仕組み
37. 共用 UserDefaults isDebug: true api: "sample.com/api" newFeature: false 仕組み
38. アジェンダ • デバッグメニューとは • 背景 • 仕組み • 実装方法 • デバッグメニューアプリ作りのコツ • CI時のコツ • メリットとデメリット
39. App Groupsの設定
40. App Groupsの設定
41. App Groupsの設定
42. App Groupsの設定
43. App Groupsの設定
44. App Groupsの設定
45. App Groupsの設定 group.com.fromatom.sample.iosdc
46. App Groupsの設定｜Xcode
47. App Groupsの設定｜Xcode
48. App Groupsの設定｜Xcode
49. App Groupsの設定｜Xcode
50. App Groupsの設定｜Xcode
51. App Groupsの設定｜Xcode
52. App Groupsの設定｜Code let suiteName = "group.com.fromatom.sample.iosdc" let userDefaults = UserDefaults(suiteName: suiteName) userDefaults?.set(true, forKey: "isDebug")
53. これで実装可能
54. アジェンダ • デバッグメニューとは • 背景 • 仕組み • 実装方法 • デバッグメニューアプリ作りのコツ • CI時のコツ • メリットとデメリット
55. このアプリのつくりかた
57. UI実装したくない！
58. 宣言的にUIが生成されるように
59. App import Foundation final class App { let name: String let bundleID: String var groups: [Group] = [] init(name: String, bundleID: String) { self.name = name self.bundleID = bundleID } func add(group: Group) { groups.append(group) } }
60. App( name: "iOSDC Japan 2020", bundleID: "com.example.iosdc" ) App
61. let apps = [ App(name: "iOSDC Japan 2020", bundleID: "com.example.iosdc") App(name: "pixiv Sketch", bundleID: "com.example.sketch"), App(name: "BOOTH", bundleID: "com.example.booth"), App(name: "pixiv", bundleID: "com.example.pixiv"), App(name: "pixivコミック", bundleID: "com.example.comic") ] App
63. Selector
64. BoolSelector( key: Keys.changeAPI.rawValue, title: "接続先APIを差し替える" ) Selector(Bool)
65. StringSelector( key: Keys.apiEndpoint.rawValue, title: "接続先API", values: [ "https://example.com/api", "https://example.com/sandbox-api", "https://example.com/staging-api", ] ) Selector(String)
66. let apiGroup = Group(title: "API", selectors: [ BoolSelector(key: Keys.changeAPI.rawValue, title: "接続先APIを差し替える"), StringSelector(key: Keys.apiEndpoint.rawValue, title: "接続先API", values: [ "https://example.com/api", "https://example.com/sandbox-api", "https://example.com/staging-api", ]) ]) Group
67. let apiGroup = Group(title: "API", selectors: [ BoolSelector(key: Keys.changeAPI.rawValue, title: "接続先APIを差し替える"), StringSelector(key: Keys.apiEndpoint.rawValue, title: "接続先API", values: [ "https://example.com/api", "https://example.com/sandbox-api", "https://example.com/staging-api", ]) ]) let debugModeGroup = Group(title: "DEBUG", selectors: [ BoolSelector(key: Keys.isDebugMode.rawValue, title: "デバッグモード") ]) let featureGroup = Group(title: "FEATURE", selectors: [ BoolSelector(key: Keys.featureFlagA.rawValue, title: "新機能Aを有効化"), BoolSelector(key: Keys.featureFlagB.rawValue, title: "新機能Bを有効化"), BoolSelector(key: Keys.featureFlagC.rawValue, title: "新機能Cを有効化"), ]) Group
68. let app = App(name: "iOSDC Japan 2020", bundleID: "com.example.iosdc") let debugModeGroup = Group(title: "DEBUG", selectors: [ BoolSelector(key: Keys.isDebugMode.rawValue, title: "デバッグモード") ]) app.add(group: debugModeGroup) let apiGroup = Group(title: "API", selectors: [ BoolSelector(key: Keys.changeAPI.rawValue, title: "接続先APIを差し替える"), StringSelector(key: Keys.apiEndpoint.rawValue, title: "接続先API", values: [ "https://example.com/api", "https://example.com/sandbox-api", "https://example.com/staging-api", ]) ]) app.add(group: apiGroup) let featureGroup = Group(title: "FEATURE", selectors: [ BoolSelector(key: Keys.featureFlagA.rawValue, title: "新機能Aを有効化"), BoolSelector(key: Keys.featureFlagB.rawValue, title: "新機能Bを有効化"), BoolSelector(key: Keys.featureFlagC.rawValue, title: "新機能Cを有効化"), ]) app.add(group: featureGroup)
69. let app = App(name: "iOSDC Japan 2020", bundleID: "com.example.iosdc") let debugModeGroup = Group(title: "DEBUG", selectors: [ BoolSelector(key: Keys.isDebugMode.rawValue, title: "デバッグモード") ]) app.add(group: debugModeGroup) let apiGroup = Group(title: "API", selectors: [ BoolSelector(key: Keys.changeAPI.rawValue, title: "接続先APIを差し替える"), StringSelector(key: Keys.apiEndpoint.rawValue, title: "接続先API", values: [ "https://example.com/api", "https://example.com/sandbox-api", "https://example.com/staging-api", ]) ]) app.add(group: apiGroup) let featureGroup = Group(title: "FEATURE", selectors: [ BoolSelector(key: Keys.featureFlagA.rawValue, title: "新機能Aを有効化"), BoolSelector(key: Keys.featureFlagB.rawValue, title: "新機能Bを有効化"), BoolSelector(key: Keys.featureFlagC.rawValue, title: "新機能Cを有効化"), ]) app.add(group: featureGroup)
70. let app = App(name: "iOSDC Japan 2020", bundleID: "com.example.iosdc") let debugModeGroup = Group(title: "DEBUG", selectors: [ BoolSelector(key: Keys.isDebugMode.rawValue, title: "デバッグモード") ]) app.add(group: debugModeGroup) let apiGroup = Group(title: "API", selectors: [ BoolSelector(key: Keys.changeAPI.rawValue, title: "接続先APIを差し替える"), StringSelector(key: Keys.apiEndpoint.rawValue, title: "接続先API", values: [ "https://example.com/api", "https://example.com/sandbox-api", "https://example.com/staging-api", ]) ]) app.add(group: apiGroup) let featureGroup = Group(title: "FEATURE", selectors: [ BoolSelector(key: Keys.featureFlagA.rawValue, title: "新機能Aを有効化"), BoolSelector(key: Keys.featureFlagB.rawValue, title: "新機能Bを有効化"), BoolSelector(key: Keys.featureFlagC.rawValue, title: "新機能Cを有効化"), ]) app.add(group: featureGroup)
71. let app = App(name: "iOSDC Japan 2020", bundleID: "com.example.iosdc") let debugModeGroup = Group(title: "DEBUG", selectors: [ BoolSelector(key: Keys.isDebugMode.rawValue, title: "デバッグモード") ]) app.add(group: debugModeGroup) let apiGroup = Group(title: "API", selectors: [ BoolSelector(key: Keys.changeAPI.rawValue, title: "接続先APIを差し替える"), StringSelector(key: Keys.apiEndpoint.rawValue, title: "接続先API", values: [ "https://example.com/api", "https://example.com/sandbox-api", "https://example.com/staging-api", ]) ]) app.add(group: apiGroup) let featureGroup = Group(title: "FEATURE", selectors: [ BoolSelector(key: Keys.featureFlagA.rawValue, title: "新機能Aを有効化"), BoolSelector(key: Keys.featureFlagB.rawValue, title: "新機能Bを有効化"), BoolSelector(key: Keys.featureFlagC.rawValue, title: "新機能Cを有効化"), ]) app.add(group: featureGroup)
72. 参考実装 https://github.com/FromAtom/iosdc-2020-sample
73. YAMLやTOMLを使ったら？
74. YAMLやTOMLを使わない理由 • 正しいデータ形式か確認する機構の実装が必須 ‣ YAML, TOMLとしての正しさ ‣ Chushaが扱う形として正しさ • Swiftで書けばコンパイラが正しいか見てくれる • [個人の感想] 読み書きするのキツくない？
75. アジェンダ • デバッグメニューとは • 背景 • 仕組み • 実装方法 • デバッグメニューアプリ作りのコツ • CI時のコツ • メリットとデメリット
76. CIで生成するもの • 実機用の ".ipa" • シミュレーター用の ".app"
77. CIで生成するもの • 実機用の ".ipa" • シミュレーター用の ".app"
78. ".app" の作り方 ビルド方法 lane :build_app_file do xcodebuild( scheme: 'Chusha', build: true, sdk: 'iphonesimulator', derivedDataPath: 'build' ) end Fastfile Bitrise OR
79. ".app" の作り方 GitHub Releasesにuploadする set -eu go get -u github.com/tcnksm/ghr version=0.0.1 name=chusha-${version}.tar.gz mkdir -p releases cp -r build/Build/Products/Debug-iphonesimulator/Chusha.app releases/Chucha.app tar zcvf $name releases body="ADHOC: ${ADHOC_INSTALL_PAGE_URL} <br>INHOUSE: ${INHOUSE_INSTALL_PAGE_URL}" echo $ADHOC_INSTALL_PAGE_URL echo $body ghr -delete -n $version -b "${body}" $version $name
80. ".app" の作り方 GitHub Releasesにuploadする set -eu go get -u github.com/tcnksm/ghr version=0.0.1 name=chusha-${version}.tar.gz mkdir -p releases cp -r build/Build/Products/Debug-iphonesimulator/Chusha.app releases/Chucha.app tar zcvf $name releases body="ADHOC: ${ADHOC_INSTALL_PAGE_URL} <br>INHOUSE: ${INHOUSE_INSTALL_PAGE_URL}" echo $ADHOC_INSTALL_PAGE_URL echo $body ghr -delete -n $version -b "${body}" $version $name
81. ".app" の作り方 GitHub Releasesにuploadする set -eu go get -u github.com/tcnksm/ghr version=0.0.1 name=chusha-${version}.tar.gz mkdir -p releases cp -r build/Build/Products/Debug-iphonesimulator/Chusha.app releases/Chucha.app tar zcvf $name releases body="ADHOC: ${ADHOC_INSTALL_PAGE_URL} <br>INHOUSE: ${INHOUSE_INSTALL_PAGE_URL}" echo $ADHOC_INSTALL_PAGE_URL echo $body ghr -delete -n $version -b "${body}" $version $name
82. ".app" の作り方
83. ".app" の作り方
84. ".app" の作り方
86. アジェンダ • デバッグメニューとは • 背景 • 仕組み • 実装方法 • デバッグメニューアプリ作りのコツ • CI時のコツ • メリットとデメリット
87. メリット • 1つのアプリで複数のアプリにデバッグ情報を注入できる • 起動した時点でデバッグ情報が注入されている ‣ 初回起動時になにかしたい時に便利 • App Storeに公開されているアプリでも使える • #if DEBUG の利用が減らせる ※登壇後追記：収録後の2020年9月11日にレビューガイドラインが更新され、下記の通りガイドラインの明確化されました。 2.3.1: Don’t include any hidden, dormant, or undocumented features in your app; your app’s functionality should be clear to end users and App Review. このため、App Storeに公開されるバージョンでもChushaが利用できると、リジェクトされる可能性があります。あらかじめご了承ください。
88. デメリット • Chushaのインストールが必要になる • 別アプリに移動しないといけない • 即時反映系の機能が作りにくい ‣ DBクリア、キャッシュクリア
89. まとめ • AppGroupsとUserDefaultsでデバッグメニューをアプリ化 • デバッグメニューアプリは宣言的にUIを実装 • ".app" を生成しておけばシミュレータでも使える