Packaging prototype #5154

VinayGuthal · 2023-07-11T15:56:56Z

Move the ktx library inside of the main artifact for both firebase-common and firebase-functions. This prototype achieves the following things

Firebase-common builds properly when Firebase.kt is copied from Firebase-common-ktx to firebase-common.
firebase-functions builds propertly when Functions.kt is copied from firebase-functions-ktx to firebase-functions provided there is a dependency on the latest version of firebase-common (which has the new ktx)
All sdks/app outside of firebase-common(or any sdk for that matter) can depend on and use Firebase.kt which is moved to the main artifact.

github-actions · 2023-07-11T15:57:09Z

📝 PRs merging into main branch

Our main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released.

google-oss-bot · 2023-07-11T15:57:43Z

	1 Warning
⚠️	Did you forget to add a changelog entry? (Add the 'no-changelog' label to the PR to silence this warning.)

Generated by 🚫 Danger

google-oss-bot · 2023-07-11T16:04:37Z

Coverage Report ¹

Affected Products

`firebase-common`

Overall coverage changed from ? (837979c) to 55.11% (26628cf) by ?.

50 individual files with coverage change

Filename	Base (`837979c`)	Merge (`26628cf`)	Diff
AutoValue_HeartBeatResult.java	?	33.33%	?
AutoValue_LibraryVersion.java	?	58.33%	?
AutoValue_SdkHeartBeatResult.java	?	0.00%	?
AutoValue_StartupTime.java	?	20.00%	?
ComponentDiscoveryService.java	?	0.00%	?
ComponentMonitor.java	?	100.00%	?
CustomThreadFactory.java	?	41.18%	?
DataCollectionConfigStorage.java	?	88.89%	?
DataCollectionDefaultChange.java	?	100.00%	?
DefaultHeartBeatController.java	?	95.59%	?
DefaultUserAgentPublisher.java	?	95.45%	?
DelegatingScheduledExecutorService.java	?	22.64%	?
DelegatingScheduledFuture.java	?	69.23%	?
EmulatedServiceSettings.java	?	0.00%	?
ExecutorsRegistrar.java	?	100.00%	?
Firebase.kt	?	55.56%	?
FirebaseApp.java	?	58.82%	?
FirebaseAppLifecycleListener.java	?	0.00%	?
FirebaseCommonRegistrar.java	?	97.87%	?
FirebaseError.java	?	0.00%	?
FirebaseExecutors.java	?	0.00%	?
FirebaseInitProvider.java	?	69.57%	?
FirebaseNetworkException.java	?	0.00%	?
FirebaseOptions.java	?	31.94%	?
FirebaseTooManyRequestsException.java	?	0.00%	?
FirebaseTrace.java	?	100.00%	?
GlobalLibraryVersionRegistrar.java	?	75.00%	?
HeartBeatConsumer.java	?	0.00%	?
HeartBeatConsumerComponent.java	?	0.00%	?
HeartBeatController.java	?	0.00%	?
HeartBeatInfo.java	?	100.00%	?
HeartBeatInfoStorage.java	?	93.23%	?
HeartBeatResult.java	?	100.00%	?
KotlinDetector.java	?	33.33%	?
LibraryVersion.java	?	100.00%	?
LibraryVersionComponent.java	?	100.00%	?
LimitedConcurrencyExecutor.java	?	0.00%	?
LimitedConcurrencyExecutorService.java	?	0.00%	?
PausableExecutor.java	?	0.00%	?
PausableExecutorImpl.java	?	0.00%	?
PausableExecutorService.java	?	0.00%	?
PausableExecutorServiceImpl.java	?	0.00%	?
PausableScheduledExecutorService.java	?	0.00%	?
PausableScheduledExecutorServiceImpl.java	?	0.00%	?
PublicApi.java	?	0.00%	?
SdkHeartBeatResult.java	?	0.00%	?
SequentialExecutor.java	?	0.00%	?
StartupTime.java	?	100.00%	?
UiExecutor.java	?	60.00%	?
UserAgentPublisher.java	?	0.00%	?

`firebase-functions`

Overall coverage changed from ? (837979c) to 0.00% (26628cf) by ?.

20 individual files with coverage change

Filename	Base (`837979c`)	Merge (`26628cf`)	Diff
ContextProvider.java	?	0.00%	?
DaggerFunctionsComponent.java	?	0.00%	?
FirebaseContextProvider.java	?	0.00%	?
FirebaseContextProvider_Factory.java	?	0.00%	?
FirebaseFunctions.java	?	0.00%	?
FirebaseFunctionsException.java	?	0.00%	?
FirebaseFunctions_Factory.java	?	0.00%	?
Functions.kt	?	0.00%	?
FunctionsComponent.java	?	0.00%	?
FunctionsComponent_MainModule_BindProjectIdFactory.java	?	0.00%	?
FunctionsMultiResourceComponent.java	?	0.00%	?
FunctionsMultiResourceComponent_Factory.java	?	0.00%	?
FunctionsMultiResourceComponent_FirebaseFunctionsFactory_Impl.java	?	0.00%	?
FunctionsRegistrar.java	?	0.00%	?
HttpsCallableContext.java	?	0.00%	?
HttpsCallableOptions.java	?	0.00%	?
HttpsCallableReference.java	?	0.00%	?
HttpsCallableResult.java	?	0.00%	?
HttpsCallOptions.java	?	0.00%	?
Serializer.java	?	0.00%	?

firebase-functions-ktx
Overall coverage changed from ? (837979c) to 0.00% (26628cf) by ?.

Test Logs

Merge (26628cf): https://github.com/firebase/firebase-android-sdk/actions/runs/5591292998

https://storage.googleapis.com/firebase-sdk-metric-reports/TkwD7vAJXr.html

google-oss-bot · 2023-07-11T16:07:16Z

The public api surface has changed for the subproject firebase-functions:
error: Added class com.google.firebase.functions.FunctionsKt [AddedClass]

The public api surface has changed for the subproject firebase-common:
error: Added class com.google.firebase.Firebase [AddedClass]
error: Added class com.google.firebase.FirebaseKt [AddedClass]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

github-actions · 2023-07-11T16:07:51Z

Unit Test Results

  48 files -     6   48 suites - 6 1m 26s ⏱️ - 5m 39s
  78 tests - 392   78 ✔️ - 392 0 💤 ±0 0 ❌ ±0
156 runs - 784 156 ✔️ - 784 0 💤 ±0 0 ❌ ±0

Results for commit 1723142. ± Comparison against base commit 8fff029.

This pull request removes 470 and adds 78 tests. Note that renamed tests count towards both.

com.google.firebase.iid.FirebaseInstanceIdWithFcmReceiverRoboTest ‑ testBindsService_oAndTargetingO
com.google.firebase.iid.FirebaseInstanceIdWithFcmReceiverRoboTest ‑ testNoWrappedIntent
com.google.firebase.iid.FirebaseInstanceIdWithFcmReceiverRoboTest ‑ testNullIntent
com.google.firebase.iid.FirebaseInstanceIdWithFcmReceiverRoboTest ‑ testStartsService_OTargetingO_highPriority
com.google.firebase.iid.FirebaseInstanceIdWithFcmReceiverRoboTest ‑ testStartsService_fallsBackToBindService
com.google.firebase.iid.FirebaseInstanceIdWithFcmReceiverRoboTest ‑ testStartsService_notOButTargetingO
com.google.firebase.iid.FirebaseInstanceIdWithFcmReceiverRoboTest ‑ testStartsService_notOButTargetingO[19]
com.google.firebase.iid.FirebaseInstanceIdWithFcmReceiverRoboTest ‑ testStartsService_notOButTargetingO[21]
com.google.firebase.iid.FirebaseInstanceIdWithFcmReceiverRoboTest ‑ testStartsService_notOButTargetingO[22]
com.google.firebase.iid.FirebaseInstanceIdWithFcmReceiverRoboTest ‑ testStartsService_notOButTargetingO[23]
…

com.google.firebase.CoroutinesPlayServicesTests ‑ Task#await() resolves to the same result as Task#getResult()
com.google.firebase.CoroutinesPlayServicesTests ‑ Task#await() throws an Exception for failing Tasks
com.google.firebase.DataCollectionPostNDefaultEnabledTest ‑ isDataCollectionDefaultEnabled_shouldDefaultToTrue
com.google.firebase.DataCollectionPostNDefaultEnabledTest ‑ isDataCollectionDefaultEnabled_whenPrefsFalse_shouldReturnFalse
com.google.firebase.DataCollectionPostNDefaultEnabledTest ‑ isDataCollectionDefaultEnabled_whenPrefsTrue_shouldReturnTrue
com.google.firebase.DataCollectionPostNDefaultEnabledTest ‑ setDataCollectionDefaultEnabledFalse_shouldUpdateSharedPrefs
com.google.firebase.DataCollectionPostNDefaultEnabledTest ‑ setDataCollectionDefaultEnabled_shouldNotAffectOtherFirebaseAppInstances
com.google.firebase.DataCollectionPreNDefaultEnabledTest ‑ isDataCollectionDefaultEnabled_shouldDefaultToTrue
com.google.firebase.DataCollectionPreNDefaultEnabledTest ‑ isDataCollectionDefaultEnabled_whenPrefsFalse_shouldReturnFalse
com.google.firebase.DataCollectionPreNDefaultEnabledTest ‑ isDataCollectionDefaultEnabled_whenPrefsTrue_shouldReturnTrue
…

♻️ This comment has been updated with latest results.

google-oss-bot · 2023-07-11T17:09:19Z

The public api surface has changed for the subproject firebase-functions:
error: Added class com.google.firebase.functions.FunctionsKt [AddedClass]

The public api surface has changed for the subproject firebase-common:
error: Added class com.google.firebase.Firebase [AddedClass]
error: Added class com.google.firebase.FirebaseKt [AddedClass]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

google-oss-bot · 2023-07-11T17:37:16Z

The public api surface has changed for the subproject firebase-functions:
error: Added class com.google.firebase.functions.FunctionsKt [AddedClass]

The public api surface has changed for the subproject firebase-common:
error: Added class com.google.firebase.Firebase [AddedClass]
error: Added class com.google.firebase.FirebaseKt [AddedClass]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

google-oss-bot · 2023-07-11T18:18:18Z

The public api surface has changed for the subproject firebase-functions:
error: Added class com.google.firebase.functions.FunctionsKt [AddedClass]

The public api surface has changed for the subproject firebase-common:
error: Added class com.google.firebase.Firebase [AddedClass]
error: Added class com.google.firebase.FirebaseKt [AddedClass]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

google-oss-bot · 2023-07-11T18:23:11Z

The public api surface has changed for the subproject firebase-functions:
error: Added class com.google.firebase.functions.FunctionsKt [AddedClass]

The public api surface has changed for the subproject firebase-common:
error: Added class com.google.firebase.Firebase [AddedClass]
error: Added class com.google.firebase.FirebaseKt [AddedClass]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

google-oss-bot · 2023-07-11T18:36:58Z

The public api surface has changed for the subproject firebase-functions:
error: Added class com.google.firebase.functions.FunctionsKt [AddedClass]

The public api surface has changed for the subproject firebase-common:
error: Added class com.google.firebase.Firebase [AddedClass]
error: Added class com.google.firebase.FirebaseKt [AddedClass]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

google-oss-bot · 2023-07-11T18:44:35Z

The public api surface has changed for the subproject firebase-functions:
error: Added class com.google.firebase.functions.FunctionsKt [AddedClass]

The public api surface has changed for the subproject firebase-common:
error: Added class com.google.firebase.Firebase [AddedClass]
error: Added class com.google.firebase.FirebaseKt [AddedClass]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

google-oss-bot · 2023-07-11T18:52:40Z

Size Report ¹

Affected Products

firebase-common
Type Base (837979c) Merge (26628cf) Diff
aar 75.7 kB 88.4 kB +12.6 kB (+16.7%)
apk (aggressive) 112 kB 123 kB +11.8 kB (+10.6%)
apk (release) 1.26 MB 1.64 MB +377 kB (+29.8%)
firebase-common-ktx
Type Base (837979c) Merge (26628cf) Diff
aar 13.3 kB 3.12 kB -10.2 kB (-76.6%)
apk (aggressive) 123 kB 123 kB +76 B (+0.1%)
apk (release) 1.64 MB 1.64 MB +820 B (+0.0%)
firebase-functions
Type Base (837979c) Merge (26628cf) Diff
aar 47.1 kB 51.9 kB +4.81 kB (+10.2%)
apk (aggressive) 400 kB 408 kB +8.49 kB (+2.1%)
apk (release) 1.82 MB 2.20 MB +382 kB (+21.0%)
firebase-functions-ktx
Type Base (837979c) Merge (26628cf) Diff
aar 6.33 kB 3.60 kB -2.73 kB (-43.1%)
apk (aggressive) 408 kB 408 kB +80 B (+0.0%)
apk (release) 2.19 MB 2.20 MB +2.94 kB (+0.1%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/OALzBgjkDk.html

firebase-functions/src/main/java/com/google/firebase/functions/Functions.kt

google-oss-bot · 2023-07-18T16:09:08Z

The public api surface has changed for the subproject firebase-functions:
error: Added class com.google.firebase.functions.FunctionsKt [AddedClass]

The public api surface has changed for the subproject firebase-common:
error: Added class com.google.firebase.Firebase [AddedClass]
error: Added class com.google.firebase.FirebaseKt [AddedClass]

The public api surface has changed for the subproject firebase-common_ktx:
error: Removed package com.google.firebase.ktx [RemovedPackage]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

firebase-functions/ktx/ktx.gradle.kts

rlazo · 2023-07-18T19:00:54Z

firebase-functions/ktx/src/test/kotlin/com/google/firebase/functions/ktx/FunctionsTests.kt

@@ -99,7 +99,7 @@ class LibraryVersionTest : BaseTestCase() {
  @Test
  fun `library version should be registered with runtime`() {
    val publisher = Firebase.app.get(UserAgentPublisher::class.java)
-    assertThat(publisher.userAgent).contains(LIBRARY_NAME)
+    assertThat(publisher.userAgent).contains("fire-fun-ktx")


This only happens if the ktx sdk is present, right? or should it work even if there's no common-ktx artifact?

currently i think with the new approach irrespective of anything this will be logged.. I think we should stop supporting this.

to register what was discussed offline: there's value keep reporting the ktx usage in the user agent string.

google-oss-bot · 2023-07-18T19:04:45Z

The public api surface has changed for the subproject firebase-functions_ktx:
error: Removed package com.google.firebase.functions.ktx [RemovedPackage]

The public api surface has changed for the subproject firebase-functions:
error: Added class com.google.firebase.functions.FunctionsKt [AddedClass]

The public api surface has changed for the subproject firebase-common:
error: Added class com.google.firebase.Firebase [AddedClass]
error: Added class com.google.firebase.FirebaseKt [AddedClass]

The public api surface has changed for the subproject firebase-common_ktx:
error: Removed package com.google.firebase.ktx [RemovedPackage]

Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly.

thatfiredev · 2023-07-26T09:36:27Z

firebase-common/src/main/java/com/google/firebase/ktx/Firebase.kt

+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package com.google.firebase.ktx


Should we mark everything in this file as deprecated?

VinayGuthal added 2 commits July 11, 2023 11:40

test commit

31d3d05

prototype packaging

319cfe1

google-oss-bot added the size/L label Jul 11, 2023

add unit tests

8985e56

update ktx

3afcb15

VinayGuthal added 2 commits July 11, 2023 14:06

update gradle ktx

c23c0f9

copy tests for functions

034fbe6

VinayGuthal added 2 commits July 11, 2023 14:26

update

b7c1be5

update

9cc3ce5

rlazo reviewed Jul 11, 2023

View reviewed changes

firebase-functions/src/main/java/com/google/firebase/functions/Functions.kt Outdated Show resolved Hide resolved

VinayGuthal marked this pull request as draft July 11, 2023 19:35

update prototype

806db8f

VinayGuthal added 2 commits July 18, 2023 14:23

update

b9aca18

packaging prototype latest version

1723142

google-oss-bot added size/XL and removed size/L labels Jul 18, 2023

rlazo reviewed Jul 18, 2023

View reviewed changes

thatfiredev reviewed Jul 26, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Packaging prototype #5154

Packaging prototype #5154

VinayGuthal commented Jul 11, 2023

github-actions bot commented Jul 11, 2023 •

edited

Loading

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023 •

edited

Loading

`firebase-common`

`firebase-functions`

`firebase-functions-ktx`

google-oss-bot commented Jul 11, 2023

github-actions bot commented Jul 11, 2023 •

edited

Loading

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023 •

edited

Loading

`firebase-common`

`firebase-common-ktx`

`firebase-functions`

`firebase-functions-ktx`

google-oss-bot commented Jul 18, 2023

rlazo Jul 18, 2023

VinayGuthal Jul 19, 2023

rlazo Jul 19, 2023

google-oss-bot commented Jul 18, 2023

thatfiredev Jul 26, 2023

rlazo Jul 26, 2023

Packaging prototype #5154

Are you sure you want to change the base?

Packaging prototype #5154

Conversation

VinayGuthal commented Jul 11, 2023

github-actions bot commented Jul 11, 2023 • edited Loading

📝 PRs merging into main branch

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023 • edited Loading

Coverage Report 1

Affected Products

firebase-common

firebase-functions

firebase-functions-ktx

Test Logs

google-oss-bot commented Jul 11, 2023

github-actions bot commented Jul 11, 2023 • edited Loading

Unit Test Results

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023

google-oss-bot commented Jul 11, 2023 • edited Loading

Size Report 1

Affected Products

firebase-common

firebase-common-ktx

firebase-functions

firebase-functions-ktx

Test Logs

google-oss-bot commented Jul 18, 2023

rlazo Jul 18, 2023

Choose a reason for hiding this comment

VinayGuthal Jul 19, 2023

Choose a reason for hiding this comment

rlazo Jul 19, 2023

Choose a reason for hiding this comment

google-oss-bot commented Jul 18, 2023

thatfiredev Jul 26, 2023

Choose a reason for hiding this comment

rlazo Jul 26, 2023

Choose a reason for hiding this comment

github-actions bot commented Jul 11, 2023 •

edited

Loading

google-oss-bot commented Jul 11, 2023 •

edited

Loading

Coverage Report ¹

`firebase-common`

`firebase-functions`

`firebase-functions-ktx`

github-actions bot commented Jul 11, 2023 •

edited

Loading

google-oss-bot commented Jul 11, 2023 •

edited

Loading

Size Report ¹

`firebase-common`

`firebase-common-ktx`

`firebase-functions`

`firebase-functions-ktx`