Merge executors to master #4322

vkryachko · 2022-11-14T19:40:36Z

This makes executors available to product teams through components.

For more details see

Lines 1 to 26 in c1adf5b

    
           # Intro 
        
           OS threads are a limited resource that needs to be used with care. In order to minimize the number of threads used by Firebase 
        
           as a whole and to increase resource sharing Firebase Common provides a set of standard 
        
           [executors](https://developer.android.com/reference/java/util/concurrent/Executor) 
        
           and [coroutine dispatchers](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-dispatcher/) 
        
           for use by all Firebase SDKs. 
        
           These executors are available as components and can be requested by product SDKs as component dependencies. 
        
           Example: 
        
           ```java 
        
           public class MyRegistrar implements ComponentRegistrar { 
        
             public List<Component<?>> getComponents() { 
        
               Qualified<Executor> backgroundExecutor = Qualified.qualified(Background.class, Executor.class); 
        
               Qualified<ExecutorService> liteExecutorService = Qualified.qualified(Lightweight.class, ExecutorService.class); 
        
               return Collections.singletonList( 
        
                 Component.builder(MyComponent.class) 
        
                   .add(Dependency.required(backgroundExecutor)) 
        
                   .add(Dependency.required(liteExecutorService)) 
        
                   .factory(c -> new MyComponent(c.get(backgroundExecutor), c.get(liteExecutorService))) 
        
                   .build()); 
        
             } 
        
           } 
        
           ```

* Add qualifier support to firebase components. Details: go/firebase-component-qualifiers * fix errorprone error. * change copyright year.

* Register executors as components. The intent for those is to be used by all Firebase SDKs and forbid creating their own at will. * Add copyrights. * add more copyrights * ktlintformat * gJF * ktlint * Address review comments.

Namely, SequentialExecutor and directExecutor.

Any violations would kill the app in debug builds of firebase-common, and log a warning in release builds. This is done to fail tests that incorrectly use executors while not affecting 3p apps in release builds. Additionally correctly set thread priorities in an Android specific way.

* Enable thread pool linter check. All violations are now suppressed, bugs filed to fix each product. * ktlint * Remove init * Fix copyright

google-oss-bot · 2022-11-14T19:41:07Z

	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 · 2022-11-14T20:05:31Z

Size Report ¹

Affected Products

base
Type Base (c1adf5b) Merge (3be5919) Diff
apk (aggressive) ? 8.39 kB ? (?)
apk (release) ? 8.65 kB ? (?)
firebase-abt
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 13.8 kB ? (?)
apk (aggressive) ? 95.2 kB ? (?)
apk (release) ? 705 kB ? (?)
firebase-annotations
Type Base (c1adf5b) Merge (3be5919) Diff
apk (aggressive) ? 8.39 kB ? (?)
apk (release) ? 9.46 kB ? (?)
firebase-appcheck
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 37.7 kB ? (?)
apk (aggressive) ? 341 kB ? (?)
apk (release) ? 995 kB ? (?)
firebase-appcheck-debug
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 11.6 kB ? (?)
apk (aggressive) ? 341 kB ? (?)
apk (release) ? 998 kB ? (?)
firebase-appcheck-interop
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 5.02 kB ? (?)
apk (aggressive) ? 337 kB ? (?)
apk (release) ? 981 kB ? (?)
firebase-appcheck-playintegrity
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 10.1 kB ? (?)
apk (aggressive) ? 341 kB ? (?)
apk (release) ? 1.01 MB ? (?)
firebase-appcheck-safetynet
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 12.1 kB ? (?)
apk (aggressive) ? 341 kB ? (?)
apk (release) ? 1.01 MB ? (?)
firebase-appdistribution
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 140 kB ? (?)
apk (aggressive) ? 785 kB ? (?)
apk (release) ? 2.01 MB ? (?)
firebase-appdistribution-api
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 14.2 kB ? (?)
apk (aggressive) ? 95.2 kB ? (?)
apk (release) ? 707 kB ? (?)
firebase-common
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 65.3 kB ? (?)
apk (aggressive) ? 94.5 kB ? (?)
apk (release) ? 699 kB ? (?)
firebase-common-ktx
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 13.2 kB ? (?)
apk (aggressive) ? 122 kB ? (?)
apk (release) ? 1.64 MB ? (?)
firebase-components
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 44.9 kB ? (?)
apk (aggressive) ? 8.68 kB ? (?)
apk (release) ? 33.6 kB ? (?)
firebase-config
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 63.0 kB ? (?)
apk (aggressive) ? 103 kB ? (?)
apk (release) ? 753 kB ? (?)
firebase-crashlytics
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 342 kB ? (?)
apk (aggressive) ? 226 kB ? (?)
apk (release) ? 912 kB ? (?)
firebase-database
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 488 kB ? (?)
apk (aggressive) ? 343 kB ? (?)
apk (release) ? 1.16 MB ? (?)
firebase-database-collection
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 33.6 kB ? (?)
apk (aggressive) ? 312 kB ? (?)
apk (release) ? 941 kB ? (?)
firebase-datatransport
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 4.94 kB ? (?)
apk (aggressive) ? 145 kB ? (?)
apk (release) ? 787 kB ? (?)
firebase-encoders
Type Base (c1adf5b) Merge (3be5919) Diff
apk (aggressive) ? 8.68 kB ? (?)
apk (release) ? 15.3 kB ? (?)
firebase-encoders-json
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 10.7 kB ? (?)
apk (aggressive) ? 8.68 kB ? (?)
apk (release) ? 20.1 kB ? (?)
firebase-encoders-proto
Type Base (c1adf5b) Merge (3be5919) Diff
apk (aggressive) ? 8.68 kB ? (?)
apk (release) ? 21.6 kB ? (?)
firebase-firestore
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 1.31 MB ? (?)
apk (aggressive) ? 501 kB ? (?)
apk (release) ? 3.37 MB ? (?)
firebase-inappmessaging
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 470 kB ? (?)
apk (aggressive) ? 681 kB ? (?)
apk (release) ? 3.39 MB ? (?)
firebase-installations
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 55.0 kB ? (?)
apk (aggressive) ? 96.0 kB ? (?)
apk (release) ? 723 kB ? (?)
firebase-installations-interop
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 8.05 kB ? (?)
apk (aggressive) ? 65.0 kB ? (?)
apk (release) ? 651 kB ? (?)
firebase-messaging
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 142 kB ? (?)
apk (aggressive) ? 448 kB ? (?)
apk (release) ? 1.16 MB ? (?)
firebase-messaging-directboot
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 8.79 kB ? (?)
apk (aggressive) ? 448 kB ? (?)
apk (release) ? 1.16 MB ? (?)
firebase-ml-modeldownloader
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 87.6 kB ? (?)
apk (aggressive) ? 152 kB ? (?)
apk (release) ? 841 kB ? (?)
firebase-perf
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 313 kB ? (?)
apk (aggressive) ? 1.04 MB ? (?)
apk (release) ? 2.49 MB ? (?)
firebase-segmentation
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 20.2 kB ? (?)
apk (aggressive) ? 96.5 kB ? (?)
apk (release) ? 730 kB ? (?)
firebase-storage
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 116 kB ? (?)
apk (aggressive) ? 338 kB ? (?)
apk (release) ? 1.03 MB ? (?)
protolite-well-known-types
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 999 kB ? (?)
apk (aggressive) ? 134 kB ? (?)
apk (release) ? 663 kB ? (?)
transport-api
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 6.74 kB ? (?)
apk (aggressive) ? 8.68 kB ? (?)
apk (release) ? 14.9 kB ? (?)
transport-backend-cct
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 53.6 kB ? (?)
apk (aggressive) ? 58.2 kB ? (?)
apk (release) ? 105 kB ? (?)
transport-runtime
Type Base (c1adf5b) Merge (3be5919) Diff
aar ? 180 kB ? (?)
apk (aggressive) ? 44.0 kB ? (?)
apk (release) ? 83.5 kB ? (?)

Test Logs

Merge (3be5919): https://github.com/firebase/firebase-android-sdk/actions/runs/3464629508

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

github-actions · 2022-11-14T20:47:55Z

Unit Test Results

  384 files - 11   384 suites - 11 19m 13s ⏱️ - 1m 23s
4 683 tests - 47 4 661 ✔️ - 47 22 💤 ±0 0 ❌ ±0
4 699 runs - 47 4 677 ✔️ - 47 22 💤 ±0 0 ❌ ±0

Results for commit a59f456. ± Comparison against base commit c1adf5b.

♻️ This comment has been updated with latest results.

rlazo

Don't forget to add the label for no-changelog

* Add qualifier support to firebase components. (#3180) * Add qualifier support to firebase components. Details: go/firebase-component-qualifiers * fix errorprone error. * change copyright year. * Register executors as components. (#4288) * Register executors as components. The intent for those is to be used by all Firebase SDKs and forbid creating their own at will. * Add copyrights. * add more copyrights * ktlintformat * gJF * ktlint * Address review comments. * Adds generally useful executors (#4305) Namely, SequentialExecutor and directExecutor. * Enable strict mode for executors. (#4303) Any violations would kill the app in debug builds of firebase-common, and log a warning in release builds. This is done to fail tests that incorrectly use executors while not affecting 3p apps in release builds. Additionally correctly set thread priorities in an Android specific way. * Enable thread pool linter check. (#4297) * Enable thread pool linter check. All violations are now suppressed, bugs filed to fix each product. * ktlint * Remove init * Fix copyright

vkryachko added 6 commits November 8, 2022 11:23

Add qualifier support to firebase components. (#3180)

fe5b2f3

* Add qualifier support to firebase components. Details: go/firebase-component-qualifiers * fix errorprone error. * change copyright year.

Register executors as components. (#4288)

3cf020a

* Register executors as components. The intent for those is to be used by all Firebase SDKs and forbid creating their own at will. * Add copyrights. * add more copyrights * ktlintformat * gJF * ktlint * Address review comments.

Adds generally useful executors (#4305)

6b7178a

Namely, SequentialExecutor and directExecutor.

Enable thread pool linter check. (#4297)

57d3b15

* Enable thread pool linter check. All violations are now suppressed, bugs filed to fix each product. * ktlint * Remove init * Fix copyright

Merge branch 'master' into executors

a59f456

google-oss-bot added the size/XXL label Nov 14, 2022

vkryachko requested review from rlazo and emilypgoogle November 15, 2022 16:23

rlazo approved these changes Nov 15, 2022

View reviewed changes

vkryachko added the no-changelog label Nov 15, 2022

vkryachko merged commit e0cfdd6 into master Nov 15, 2022

vkryachko deleted the executors branch November 15, 2022 18:16

firebase locked and limited conversation to collaborators Dec 16, 2022

	# Intro

	OS threads are a limited resource that needs to be used with care. In order to minimize the number of threads used by Firebase
	as a whole and to increase resource sharing Firebase Common provides a set of standard
	[executors](https://developer.android.com/reference/java/util/concurrent/Executor)
	and [coroutine dispatchers](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-dispatcher/)
	for use by all Firebase SDKs.

	These executors are available as components and can be requested by product SDKs as component dependencies.

	Example:
	```java
	public class MyRegistrar implements ComponentRegistrar {
	public List<Component<?>> getComponents() {
	Qualified<Executor> backgroundExecutor = Qualified.qualified(Background.class, Executor.class);
	Qualified<ExecutorService> liteExecutorService = Qualified.qualified(Lightweight.class, ExecutorService.class);

	return Collections.singletonList(
	Component.builder(MyComponent.class)
	.add(Dependency.required(backgroundExecutor))
	.add(Dependency.required(liteExecutorService))
	.factory(c -> new MyComponent(c.get(backgroundExecutor), c.get(liteExecutorService)))
	.build());
	}
	}
	```

Merge executors to master #4322

Merge executors to master #4322

Uh oh!

Conversation

vkryachko commented Nov 14, 2022

Uh oh!

google-oss-bot commented Nov 14, 2022

Uh oh!

google-oss-bot commented Nov 14, 2022

Size Report 1

Affected Products

base

firebase-abt

firebase-annotations

firebase-appcheck

firebase-appcheck-debug

firebase-appcheck-interop

firebase-appcheck-playintegrity

firebase-appcheck-safetynet

firebase-appdistribution

firebase-appdistribution-api

firebase-common

firebase-common-ktx

firebase-components

firebase-config

firebase-crashlytics

firebase-database

firebase-database-collection

firebase-datatransport

firebase-encoders

firebase-encoders-json

firebase-encoders-proto

firebase-firestore

firebase-inappmessaging

firebase-installations

firebase-installations-interop

firebase-messaging

firebase-messaging-directboot

firebase-ml-modeldownloader

firebase-perf

firebase-segmentation

firebase-storage

protolite-well-known-types

transport-api

transport-backend-cct

transport-runtime

Test Logs

Uh oh!

github-actions bot commented Nov 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Test Results

Uh oh!

rlazo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Size Report ¹

`base`

`firebase-abt`

`firebase-annotations`

`firebase-appcheck`

`firebase-appcheck-debug`

`firebase-appcheck-interop`

`firebase-appcheck-playintegrity`

`firebase-appcheck-safetynet`

`firebase-appdistribution`

`firebase-appdistribution-api`

`firebase-common`

`firebase-common-ktx`

`firebase-components`

`firebase-config`

`firebase-crashlytics`

`firebase-database`

`firebase-database-collection`

`firebase-datatransport`

`firebase-encoders`

`firebase-encoders-json`

`firebase-encoders-proto`

`firebase-firestore`

`firebase-inappmessaging`

`firebase-installations`

`firebase-installations-interop`

`firebase-messaging`

`firebase-messaging-directboot`

`firebase-ml-modeldownloader`

`firebase-perf`

`firebase-segmentation`

`firebase-storage`

`protolite-well-known-types`

`transport-api`

`transport-backend-cct`

`transport-runtime`

github-actions bot commented Nov 14, 2022 •

edited

Loading