Skip to content

Commit 98e5328

Browse files
manny-jimenezManny Jimenez
authored andcommitted
Audit of classes making classes as private as possible (#3235)
* Audit of classes making classes as private as possible * Making lifecycle public * Changing constructors * Making enums package-private * Making status public again * Making UpdateStatus public again * Bringing back internal package * Moving installactivity and logwrapper to internal * Adding logs back in * Removing local changes that were used for testing * Removing logwrapper * Adding in ktx api.txt * Fixing api.txt Co-authored-by: Manny Jimenez <[email protected]>
1 parent 42ec220 commit 98e5328

27 files changed

+156
-52
lines changed

firebase-app-distribution/api.txt

Lines changed: 68 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,77 @@
11
// Signature format: 2.0
22
package com.google.firebase.app.distribution {
3-
public class FirebaseAppDistribution{
3+
4+
public abstract class AppDistributionRelease {
5+
ctor public AppDistributionRelease();
6+
method @NonNull public abstract com.google.firebase.app.distribution.BinaryType getBinaryType();
7+
method @NonNull public abstract String getDisplayVersion();
8+
method @Nullable public abstract String getReleaseNotes();
9+
method @NonNull public abstract long getVersionCode();
10+
}
11+
12+
public enum BinaryType {
13+
enum_constant public static final com.google.firebase.app.distribution.BinaryType AAB;
14+
enum_constant public static final com.google.firebase.app.distribution.BinaryType APK;
15+
}
16+
17+
public class FirebaseAppDistribution {
18+
method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.app.distribution.AppDistributionRelease> checkForNewRelease();
419
method @NonNull public static com.google.firebase.app.distribution.FirebaseAppDistribution getInstance();
520
method @NonNull public static com.google.firebase.app.distribution.FirebaseAppDistribution getInstance(@NonNull com.google.firebase.FirebaseApp);
6-
method @NonNull public com.google.firebase.app.distribution.UpdateTask updateIfNewReleaseAvailable();
21+
method public boolean isTesterSignedIn();
722
method @NonNull public com.google.android.gms.tasks.Task<java.lang.Void> signInTester();
8-
method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.app.distribution.AppDistributionRelease> checkForNewRelease();
23+
method public void signOutTester();
924
method @NonNull public com.google.firebase.app.distribution.UpdateTask updateApp();
10-
method public java.lang.Boolean istesterSignedIn()
11-
method public java.lang.Void signOutTester();
25+
method @NonNull public com.google.firebase.app.distribution.UpdateTask updateIfNewReleaseAvailable();
26+
}
27+
28+
public class FirebaseAppDistributionException extends com.google.firebase.FirebaseException {
29+
method @NonNull public com.google.firebase.app.distribution.FirebaseAppDistributionException.Status getErrorCode();
30+
method @Nullable public com.google.firebase.app.distribution.AppDistributionRelease getRelease();
31+
}
32+
33+
public enum FirebaseAppDistributionException.Status {
34+
enum_constant public static final com.google.firebase.app.distribution.FirebaseAppDistributionException.Status APP_RUNNING_IN_PRODUCTION;
35+
enum_constant public static final com.google.firebase.app.distribution.FirebaseAppDistributionException.Status AUTHENTICATION_CANCELED;
36+
enum_constant public static final com.google.firebase.app.distribution.FirebaseAppDistributionException.Status AUTHENTICATION_FAILURE;
37+
enum_constant public static final com.google.firebase.app.distribution.FirebaseAppDistributionException.Status DOWNLOAD_FAILURE;
38+
enum_constant public static final com.google.firebase.app.distribution.FirebaseAppDistributionException.Status INSTALLATION_CANCELED;
39+
enum_constant public static final com.google.firebase.app.distribution.FirebaseAppDistributionException.Status INSTALLATION_FAILURE;
40+
enum_constant public static final com.google.firebase.app.distribution.FirebaseAppDistributionException.Status INSTALLATION_FAILURE_SIGNATURE_MISMATCH;
41+
enum_constant public static final com.google.firebase.app.distribution.FirebaseAppDistributionException.Status NETWORK_FAILURE;
42+
enum_constant public static final com.google.firebase.app.distribution.FirebaseAppDistributionException.Status RELEASE_URL_EXPIRED;
43+
enum_constant public static final com.google.firebase.app.distribution.FirebaseAppDistributionException.Status UNKNOWN;
44+
enum_constant public static final com.google.firebase.app.distribution.FirebaseAppDistributionException.Status UPDATE_NOT_AVAILABLE;
45+
}
46+
47+
public interface OnProgressListener {
48+
method public void onProgressUpdate(@NonNull com.google.firebase.app.distribution.UpdateProgress);
49+
}
50+
51+
public abstract class UpdateProgress {
52+
ctor public UpdateProgress();
53+
method @NonNull public abstract long getApkBytesDownloaded();
54+
method @NonNull public abstract long getApkFileTotalBytes();
55+
method @NonNull public abstract com.google.firebase.app.distribution.UpdateStatus getUpdateStatus();
56+
}
57+
58+
public enum UpdateStatus {
59+
enum_constant public static final com.google.firebase.app.distribution.UpdateStatus DOWNLOADED;
60+
enum_constant public static final com.google.firebase.app.distribution.UpdateStatus DOWNLOADING;
61+
enum_constant public static final com.google.firebase.app.distribution.UpdateStatus DOWNLOAD_FAILED;
62+
enum_constant public static final com.google.firebase.app.distribution.UpdateStatus INSTALL_CANCELED;
63+
enum_constant public static final com.google.firebase.app.distribution.UpdateStatus INSTALL_FAILED;
64+
enum_constant public static final com.google.firebase.app.distribution.UpdateStatus NEW_RELEASE_CHECK_FAILED;
65+
enum_constant public static final com.google.firebase.app.distribution.UpdateStatus NEW_RELEASE_NOT_AVAILABLE;
66+
enum_constant public static final com.google.firebase.app.distribution.UpdateStatus PENDING;
67+
enum_constant public static final com.google.firebase.app.distribution.UpdateStatus REDIRECTED_TO_PLAY;
68+
enum_constant public static final com.google.firebase.app.distribution.UpdateStatus UPDATE_CANCELED;
69+
}
70+
71+
public abstract class UpdateTask extends com.google.android.gms.tasks.Task<java.lang.Void> {
72+
ctor public UpdateTask();
73+
method @NonNull public abstract com.google.firebase.app.distribution.UpdateTask addOnProgressListener(@NonNull com.google.firebase.app.distribution.OnProgressListener);
74+
method @NonNull public abstract com.google.firebase.app.distribution.UpdateTask addOnProgressListener(@Nullable java.util.concurrent.Executor, @NonNull com.google.firebase.app.distribution.OnProgressListener);
1275
}
1376

1477
}

firebase-app-distribution/ktx/api.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ package com.google.firebase.app.distribution.ktx {
33

44
public final class FirebaseAppDistributionKt {
55
ctor public FirebaseAppDistributionKt();
6-
method @NonNull public static com.google.firebase.app.distribution.FirebaseAppDistribution getAppDistribution(@NonNull com.google.firebase.ktx.Firebase);
76
method @NonNull public static com.google.firebase.app.distribution.FirebaseAppDistribution appDistribution(@NonNull com.google.firebase.ktx.Firebase, @NonNull com.google.firebase.FirebaseApp app);
7+
method @NonNull public static com.google.firebase.app.distribution.FirebaseAppDistribution getAppDistribution(@NonNull com.google.firebase.ktx.Firebase);
88
}
99

10-
}
10+
}
11+

firebase-app-distribution/src/main/AndroidManifest.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@
3232
<!-- The launch mode for Install Activity is singleTask to ensure that after the unknown sources UI
3333
or the installation flow is complete, the Install Activity does not get recreated which causes loss of state
3434
See here for more info - https://developer.android.com/guide/components/activities/tasks-and-back-stack#ManifestForTasks -->
35-
<activity android:name="com.google.firebase.app.distribution.InstallActivity" android:exported="true" android:launchMode="singleTask"/>
35+
<activity android:name="com.google.firebase.app.distribution.internal.InstallActivity" android:exported="true" android:launchMode="singleTask"/>
3636

37-
<activity android:name="com.google.firebase.app.distribution.SignInResultActivity" android:exported="true">
37+
<activity android:name="com.google.firebase.app.distribution.internal.SignInResultActivity" android:exported="true">
3838
<intent-filter>
3939
<action android:name="android.intent.action.VIEW"/>
4040
<category android:name="android.intent.category.DEFAULT"/>
@@ -46,7 +46,7 @@
4646
</activity>
4747

4848
<provider
49-
android:name="com.google.firebase.app.distribution.FirebaseAppDistributionFileProvider"
49+
android:name="com.google.firebase.app.distribution.internal.FirebaseAppDistributionFileProvider"
5050
android:authorities="${applicationId}.FirebaseAppDistributionFileProvider"
5151
android:exported="false"
5252
android:grantUriPermissions="true">

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/AppDistributionRelease.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
public abstract class AppDistributionRelease {
3232

3333
@NonNull
34-
public static Builder builder() {
34+
static Builder builder() {
3535
return new com.google.firebase.app.distribution.AutoValue_AppDistributionRelease.Builder();
3636
}
3737

@@ -53,21 +53,21 @@ public static Builder builder() {
5353

5454
/** Builder for {@link AppDistributionRelease}. */
5555
@AutoValue.Builder
56-
public abstract static class Builder {
56+
abstract static class Builder {
5757

5858
@NonNull
59-
public abstract Builder setDisplayVersion(@NonNull String value);
59+
abstract Builder setDisplayVersion(@NonNull String value);
6060

6161
@NonNull
62-
public abstract Builder setVersionCode(@NonNull long value);
62+
abstract Builder setVersionCode(@NonNull long value);
6363

6464
@NonNull
65-
public abstract Builder setReleaseNotes(@Nullable String value);
65+
abstract Builder setReleaseNotes(@Nullable String value);
6666

6767
@NonNull
68-
public abstract Builder setBinaryType(@NonNull BinaryType value);
68+
abstract Builder setBinaryType(@NonNull BinaryType value);
6969

7070
@NonNull
71-
public abstract AppDistributionRelease build();
71+
abstract AppDistributionRelease build();
7272
}
7373
}

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/CheckForNewReleaseClient.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import com.google.android.gms.tasks.Task;
2626
import com.google.android.gms.tasks.Tasks;
2727
import com.google.firebase.FirebaseApp;
28+
import com.google.firebase.app.distribution.internal.LogWrapper;
2829
import com.google.firebase.installations.FirebaseInstallationsApi;
2930
import com.google.firebase.installations.InstallationTokenResult;
3031
import java.io.File;

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/FirebaseAppDistribution.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@
3232
import com.google.firebase.FirebaseApp;
3333
import com.google.firebase.app.distribution.Constants.ErrorMessages;
3434
import com.google.firebase.app.distribution.FirebaseAppDistributionException.Status;
35+
import com.google.firebase.app.distribution.internal.LogWrapper;
36+
import com.google.firebase.app.distribution.internal.SignInResultActivity;
37+
import com.google.firebase.app.distribution.internal.SignInStorage;
3538
import com.google.firebase.installations.FirebaseInstallationsApi;
3639

3740
public class FirebaseAppDistribution {
@@ -80,7 +83,7 @@ public class FirebaseAppDistribution {
8083
}
8184

8285
/** Constructor for FirebaseAppDistribution */
83-
public FirebaseAppDistribution(
86+
FirebaseAppDistribution(
8487
@NonNull FirebaseApp firebaseApp,
8588
@NonNull FirebaseInstallationsApi firebaseInstallationsApi,
8689
@NonNull SignInStorage signInStorage,
@@ -97,7 +100,7 @@ firebaseApp, new FirebaseAppDistributionTesterApiClient(), firebaseInstallations
97100
}
98101

99102
/** Constructor for FirebaseAppDistribution */
100-
public FirebaseAppDistribution(
103+
FirebaseAppDistribution(
101104
@NonNull FirebaseApp firebaseApp,
102105
@NonNull FirebaseInstallationsApi firebaseInstallationsApi) {
103106
this(

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/FirebaseAppDistributionException.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,27 +58,27 @@ public enum Status {
5858
@NonNull private final Status status;
5959
@Nullable private final AppDistributionRelease release;
6060

61-
public FirebaseAppDistributionException(@NonNull String message, @NonNull Status status) {
61+
FirebaseAppDistributionException(@NonNull String message, @NonNull Status status) {
6262
super(message);
6363
this.status = status;
6464
this.release = null;
6565
}
6666

67-
public FirebaseAppDistributionException(
67+
FirebaseAppDistributionException(
6868
@NonNull String message, @NonNull Status status, @Nullable AppDistributionRelease release) {
6969
super(message);
7070
this.status = status;
7171
this.release = release;
7272
}
7373

74-
public FirebaseAppDistributionException(
74+
FirebaseAppDistributionException(
7575
@NonNull String message, @NonNull Status status, @NonNull Throwable cause) {
7676
super(message, cause);
7777
this.status = status;
7878
this.release = null;
7979
}
8080

81-
public FirebaseAppDistributionException(
81+
FirebaseAppDistributionException(
8282
@NonNull String message,
8383
@NonNull Status status,
8484
@Nullable AppDistributionRelease release,

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/FirebaseAppDistributionLifecycleNotifier.java

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@
2323
import java.util.ArrayDeque;
2424
import java.util.Queue;
2525

26-
public class FirebaseAppDistributionLifecycleNotifier
27-
implements Application.ActivityLifecycleCallbacks {
26+
class FirebaseAppDistributionLifecycleNotifier implements Application.ActivityLifecycleCallbacks {
2827

2928
private static FirebaseAppDistributionLifecycleNotifier instance;
3029
private final Object lock = new Object();
@@ -50,48 +49,48 @@ public class FirebaseAppDistributionLifecycleNotifier
5049

5150
private FirebaseAppDistributionLifecycleNotifier() {}
5251

53-
public static synchronized FirebaseAppDistributionLifecycleNotifier getInstance() {
52+
static synchronized FirebaseAppDistributionLifecycleNotifier getInstance() {
5453
if (instance == null) {
5554
instance = new FirebaseAppDistributionLifecycleNotifier();
5655
}
5756
return instance;
5857
}
5958

60-
public interface OnActivityCreatedListener {
59+
interface OnActivityCreatedListener {
6160
void onCreated(Activity activity);
6261
}
6362

64-
public interface OnActivityStartedListener {
63+
interface OnActivityStartedListener {
6564
void onStarted(Activity activity);
6665
}
6766

68-
public interface OnActivityPausedListener {
67+
interface OnActivityPausedListener {
6968
void onPaused(Activity activity);
7069
}
7170

72-
public interface OnActivityDestroyedListener {
71+
interface OnActivityDestroyedListener {
7372
void onDestroyed(Activity activity);
7473
}
7574

76-
public Activity getCurrentActivity() {
75+
Activity getCurrentActivity() {
7776
synchronized (lock) {
7877
return currentActivity;
7978
}
8079
}
8180

82-
public void addOnActivityCreatedListener(@NonNull OnActivityCreatedListener listener) {
81+
void addOnActivityCreatedListener(@NonNull OnActivityCreatedListener listener) {
8382
synchronized (lock) {
8483
this.onActivityCreatedListeners.add(listener);
8584
}
8685
}
8786

88-
public void addOnActivityStartedListener(@NonNull OnActivityStartedListener listener) {
87+
void addOnActivityStartedListener(@NonNull OnActivityStartedListener listener) {
8988
synchronized (lock) {
9089
this.onActivityStartedListeners.add(listener);
9190
}
9291
}
9392

94-
public void addOnActivityDestroyedListener(@NonNull OnActivityDestroyedListener listener) {
93+
void addOnActivityDestroyedListener(@NonNull OnActivityDestroyedListener listener) {
9594
synchronized (lock) {
9695
this.onDestroyedListeners.add(listener);
9796
}

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/FirebaseAppDistributionNotificationsManager.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
import androidx.core.app.NotificationCompat;
2929
import androidx.core.content.ContextCompat;
3030
import com.google.firebase.FirebaseApp;
31+
import com.google.firebase.app.distribution.internal.LogWrapper;
3132

3233
class FirebaseAppDistributionNotificationsManager {
3334
private static final String TAG = "NotificationsManager:";

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/FirebaseAppDistributionRegistrar.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import androidx.annotation.Keep;
1919
import androidx.annotation.NonNull;
2020
import com.google.firebase.FirebaseApp;
21+
import com.google.firebase.app.distribution.internal.LogWrapper;
2122
import com.google.firebase.components.Component;
2223
import com.google.firebase.components.ComponentContainer;
2324
import com.google.firebase.components.ComponentRegistrar;

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/FirebaseAppDistributionTesterApiClient.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import com.google.android.gms.common.util.Hex;
2323
import com.google.firebase.app.distribution.Constants.ErrorMessages;
2424
import com.google.firebase.app.distribution.FirebaseAppDistributionException.Status;
25+
import com.google.firebase.app.distribution.internal.LogWrapper;
2526
import java.io.BufferedInputStream;
2627
import java.io.ByteArrayOutputStream;
2728
import java.io.IOException;

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/InstallApkClient.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
import androidx.annotation.Nullable;
2323
import com.google.android.gms.tasks.Task;
2424
import com.google.android.gms.tasks.TaskCompletionSource;
25+
import com.google.firebase.app.distribution.internal.InstallActivity;
26+
import com.google.firebase.app.distribution.internal.LogWrapper;
2527

2628
class InstallApkClient {
2729
private static final String TAG = "ApkInstallClient:";

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/ReleaseIdentificationUtils.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import android.content.pm.PackageManager;
2020
import androidx.annotation.NonNull;
2121
import androidx.annotation.Nullable;
22+
import com.google.firebase.app.distribution.internal.LogWrapper;
2223
import java.io.File;
2324
import java.io.IOException;
2425
import java.nio.ByteBuffer;

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/TaskUtils.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import com.google.android.gms.tasks.Task;
1818
import com.google.android.gms.tasks.TaskCompletionSource;
1919
import com.google.android.gms.tasks.Tasks;
20+
import com.google.firebase.app.distribution.internal.LogWrapper;
2021

2122
class TaskUtils {
2223
private static final String TAG = "TaskUtils:";

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/TesterSignInClient.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@
3535
import com.google.android.gms.tasks.Tasks;
3636
import com.google.firebase.FirebaseApp;
3737
import com.google.firebase.app.distribution.Constants.ErrorMessages;
38+
import com.google.firebase.app.distribution.internal.InstallActivity;
39+
import com.google.firebase.app.distribution.internal.LogWrapper;
40+
import com.google.firebase.app.distribution.internal.SignInResultActivity;
41+
import com.google.firebase.app.distribution.internal.SignInStorage;
3842
import com.google.firebase.installations.FirebaseInstallationsApi;
3943
import java.util.List;
4044

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/UpdateAabClient.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@
2323
import androidx.annotation.GuardedBy;
2424
import androidx.annotation.NonNull;
2525
import androidx.annotation.VisibleForTesting;
26+
import com.google.firebase.app.distribution.internal.InstallActivity;
27+
import com.google.firebase.app.distribution.internal.LogWrapper;
28+
import com.google.firebase.app.distribution.internal.SignInResultActivity;
2629
import java.io.IOException;
2730
import java.net.URL;
2831
import java.util.concurrent.Executor;

firebase-app-distribution/src/main/java/com/google/firebase/app/distribution/UpdateApkClient.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import com.google.android.gms.tasks.Task;
2626
import com.google.android.gms.tasks.TaskCompletionSource;
2727
import com.google.firebase.FirebaseApp;
28+
import com.google.firebase.app.distribution.internal.LogWrapper;
2829
import java.io.BufferedOutputStream;
2930
import java.io.File;
3031
import java.io.IOException;

0 commit comments

Comments
 (0)