[FR] Relax encapsulation for Firebase Messaging exception and Messages payload to enable testability
@lahirumaramba がすでに取り組んでいます。
2025年4月8日 から。
評価
この issue はまだ評価されていません。
説明
Currently, unit testing for integration with Firebase Messaging is very challenging. The encapsulation imposed by the final and visibility of the method makes it untestable. On top of this, there is no emulator for Firebase messaging which could help with testing integration with a more production-like environment.
- I want to emulate exceptions on FCM Messaging like UNREGISTERED, INVALID_ARGUMENT when calling
com.google.firebase.messaging.FirebaseMessaging#send(com.google.firebase.messaging.Message)to test my error handling implementation e.g deleting invalid token
- com.google.firebase.messaging.FirebaseMessagingException is final thus mocking with popular libraries like Mockito is more difficult. We need to enable extra feature flags in Mockito to allow for mocking the class
- It's impossible to create an instance of an exception with FCM Messaging exception as factory methods and constructors are package protected
com.google.firebase.messaging.FirebaseMessagingException#withMessagingErrorCode
- I want to unit test if a message with a given payalod was sent to FCM
Currently FCM payload represented withcom.google.firebase.messaging.Messageis not accessible to third parties via getters.
- Assuming I want to test if a proper payload was sent via
com.google.firebase.messaging.FirebaseMessaging#send(com.google.firebase.messaging.Message)to FCM I would like to mock com.google.firebase.messaging.FirebaseMessaging and validate thatcom.google.firebase.messaging.FirebaseMessaging#send(com.google.firebase.messaging.Message)method was invoked with givendataandtoken
In this case, developers used @VisibleForTesting for their purposes for testing while they totally forgot about developers who use their library and can not access the payload of the message. On top of this, there is no provided reasonable toString to make any assertions based on this.
Describe the solution you'd like
Exceptions testing
- Option 1
Relax encapsulation for com.google.firebase.messaging.FirebaseMessagingException by deleting "final" on class and makeerrorCodeprotected - Option 2
Make factory method publiccom.google.firebase.messaging.FirebaseMessagingException#withMessagingErrorCode
Messages testing
- Option 1
Make getter public forcom.google.firebase.messaging.Message#Messageto allow accessing payload of FCM message - Option 2
Provide reasonable toString to allow asserting on the toString method
Describe alternatives you've considered
- Provide emulator for FCM which allows emulating different scenarios including errors
- Provide dedicated implementations for testing purposes, open for all users
Additional context
Too aggressive encapsulation in my opinion is harmful. Developers should balance encapsulation and testability, taking into account the users of their libraries not only their own goals to protect their code with all means available in Java which are not perfect
- 主要言語
- Java
- スター
- 620
- フォーク
- 305
- 平均マージ
- 4日 9時間
- マージ済み PR(30日)
- 4
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
firebase/firebase-admin-java のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
firebase/firebase-admin-java#1231 ·
-
api: core
firebase/firebase-admin-java#1198 · コメント 3 件 · 担当者 1 名 ·
-
api: remoteconfig
firebase/firebase-admin-java#1196 · コメント 1 件 · 担当者 2 名 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
firebase/firebase-admin-java#1192 · コメント 3 件 ·
-
needs-triage type: feature request
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
firebase/firebase-admin-java#1149 · コメント 1 件 ·
firebase/firebase-admin-java の issue をすべて見る
似ている issue
-
awaiting triage bug Causes friction Hop Gui P1 P2 Transforms
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
apache/flink-agents#1152 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
jenkinsci/blueocean-plugin#5417 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
objectionary/eo-graphs#75 ·