Skip to content

Latest commit

 

History

History
508 lines (380 loc) · 23 KB

CHANGELOG.md

File metadata and controls

508 lines (380 loc) · 23 KB

Unreleased

  • [added] Added WebpushFcmOptions to the FirebaseMessaging API, providing the setLink() method.

v6.9.0

  • [added] Added FcmOptions, ApnsFcmOptions and AndroidFcmOptions to the FirebaseMessaging API, which all provides a setAnalyticsLabel() method.
  • [changed] Upgraded the Cloud Firestore client to 1.9.0.
  • [changed] Upgraded the Cloud Storage client to 1.79.0.
  • [changed] Upgraded the Google API client to 1.30.1.

v6.8.1

  • [fixed] Enabled automatic retries for FCM API calls failing with HTTP 500 and 503 errors.

v6.8.0

  • [added] Implemented new sendAll() and sendMulticast() APIs in FirebaseMessaging.
  • [changed] Removed org.json dependency and replaced with com.google.code.gson.
  • [changed] Upgraded Mockito dependency, and fixed the build on Java 11.

v6.7.0

  • [added] Added generatePasswordResetLink(), generateEmailVerificationLink() and generateSignInWithEmailLink() methods to the FirebaseAuth API.
  • Aps class now supports configuring a critical sound. A new CriticalSound class has been introduced for this purpose.
  • [fixed] Firestore instances initialized by the SDK are now cleaned up, when FirebaseApp.delete() is called.
  • [added] Added new setChannelId() method to the AndroidNotification.Builder API for setting the Android notification channel ID (new in Android O).

v6.6.0

  • [added] Added a new FirebaseProjectManagement API for managing apps in a Firebase project.
  • [fixed] Fixing error handling in FCM. The SDK now checks the key type.googleapis.com/google.firebase.fcm.v1.FcmError to set error code.
  • [fixed] FCM errors sent by the back-end now include more details that are helpful when debugging problems.
  • [changed] Migrated the FirebaseAuth user management API to the

v6.5.0

  • [added] FirebaseOptions.Builder class now provides a setFirestoreOptions() method for configuring the Firestore client.
  • [changed] Upgraded the Cloud Firestore client to 0.61.0-beta.
  • [changed] Upgraded the Cloud Storage client to 1.43.0.

v6.4.0

  • [added] WebpushNotification type now supports arbitrary key-value pairs in its payload.

v6.3.0

  • [added] Implemented the ability to create custom tokens without service account credentials.
  • [added] Added the setServiceAccount() method to the FirebaseOptions.Builder API.
  • [added] The SDK can now read the Firebase/GCP project ID from both GCLOUD_PROJECT and GOOGLE_CLOUD_PROJECT environment variables.

v6.2.0

  • [added] Added new importUsersAsync() API for bulk importing users into Firebase Auth.

v6.1.0

  • [changed] Deprecated the FirebaseAuth.setCustomClaims() method. Developers should use the FirebaseAuth.setCustomUserClaims() method instead.

v6.0.0

  • [added] FirebaseAuth, FirebaseMessaging and FirebaseInstanceId interfaces now expose a set of blocking methods. Each operation has blocking an asynchronous versions.
  • [changed] Removed the deprecated FirebaseCredential interface.
  • [changed] Removed the deprecated Task interface along with the com.google.firebase.tasks package.
  • [changed] Dropped support for App Engine's Java 7 runtime. Developers are advised to use the Admin SDK with Java 8 when deploying to App Engine.
  • [changed] Removed the deprecated FirebaseDatabase.setLogLevel() API and the related logging utilities. Developers should use SLF4J to configure logging directly.

v5.11.0

  • [added] A new FirebaseAuth.createSessionCookieAsync() method for creating a long-lived session cookie given a valid ID token.
  • [added] A new FirebaseAuth.verifySessionCookieAsync() method for verifying a given cookie string is valid.
  • [fixed] Upgraded Cloud Firestore dependency version to 0.45.0-beta.
  • [fixed] Upgraded Cloud Storage dependency version to 1.27.0.
  • [fixed] Upgraded Netty dependency version to 4.1.22.

v5.10.0

  • [fixed] Using the HttpTransport specified at FirebaseOptions in GooglePublicKeysManager. This enables developers to use a custom transport to fetch public keys when verifying ID tokens and session cookies.
  • [added] Connection timeout and read timeout for HTTP/REST connections can now be configured via FirebaseOptions.Builder at app initialization.
  • [added] Added new setMutableContent(), putCustomData() and putAllCustomData() methods to the Aps.Builder API.
  • [fixed] Improved error handling in FCM by mapping more server-side errors to client-side error codes.

v5.9.0

Cloud Messaging

  • [feature] Added the FirebaseCloudMessaging API for sending Firebase notifications and managing topic subscriptions.

Authentication

  • [added] The verifyIdTokenAsync() method has an overload that accepts a boolean checkRevoked parameter. When true, an additional check is performed to see whether the token has been revoked.
  • [added] A new revokeRefreshTokensAsync() method has been added to invalidate all tokens issued to a user.
  • [added] A new getter getTokensValidAfterTimestamp() has been added to the UserRecord class, which denotes the time before which tokens are not valid.

Realtime Database

  • [fixed] Exceptions thrown by database event handlers are now logged.

Initialization

  • [fixed] The FirebaseOptions.Builder.setStorageBucket() method now throws a clear exception when invoked with a bucket URL instead of the name.
  • [fixed] Implemented a fix for a potential Guava version conflict which was causing an IllegalStateException (precondition failure) in some environments.

Cloud Firestore

  • [fixed] Upgraded the Cloud Firestore client to the latest available version.

v5.8.0

Initialization

  • [added] The FirebaseApp.initializeApp() method now provides an overload that does not require any arguments. This initializes an app using Google Application Default Credentials, and other FirebaseOptions loaded from the FIREBASE_CONFIG environment variable.

Authentication

  • [changed] Improved error handling in user management APIs in the FirebaseAuth class. These operations now throw exceptions with well-defined error codes.

Realtime Database

  • [changed] The SDK now serializes large whole double values as longs when appropriate.

v5.7.0

  • [added] A new FirebaseInstanceId API that facilitates deleting instance IDs and associated user data from Firebase projects.

Authentication

  • [changed] No longer using org.json dependency in Authentication APIs, which makes it easier to use the API in environments with conflicting JSON libraries.

v5.6.0

  • [changed] Upgraded the version of Google API Common dependency to the latest (1.2.0).

Authentication

Realtime Database

  • [changed] Re-implemented the WebSocket communication layer of the Realtime Database client using Netty.

v5.5.0

Realtime Database

  • [changed] Ensured graceful termination of database worker threads upon callng FirebaseApp.delete().

v5.4.0

  • [added] A new ThreadManager API that can be used to specify the thread pool and the ThreadFactory that should be used by the SDK.
  • [added] All APIs that support asynchronous operations now return an ApiFuture. The old Task API has been deprecated. For each method x() that returns a Task, a new xAsync() method that returns an ApiFuture has been introduced.
  • [changed] The SDK now guarantees the graceful termination of all started threads. In most environments, the SDK will use daemons for all background activities. The developer can also initiate a graceful termination of threads by calling FirebaseApp.delete().

Initialization

v5.3.1

Authentication

  • [changed] Throwing an accurate and more detailed error from verifyIdToken() in the event of a low-level exception.

Realtime Database

v5.3.0

Authentication

  • [added] Added the method getUserByPhoneNumber() to the FirebaseAuth interface. This method enables retrieving user profile information by a phone number.
  • [added] CreateRequest and UpdateRequest types now provide setters for specifying a phone number, which can be used to create users with a phone number field and/or update the phone number associated with a user.
  • [added] Added the getPhoneNumber() method to UserRecord, which exposes the phone number associated with a user account.
  • [added] Added the getPhoneNumber() method to UserInfo, which exposes the phone number associated with a user account by a linked identity provider.

Realtime Database

  • {{changed}} Deprecated the FirebaseDatabase.setLogLevel() method. Use SLF4J to configure logging.
  • [changed] Logging a detailed error when the database client fails to authenticate with the backend Firebase servers.

v5.2.0

  • [added] New factory methods in the FirebaseCredentials class that accept HttpTransport and JsonFactory arguments. These settings are used when the credentials make HTTP calls to obtain OAuth2 access tokens.
  • [added] New setHttpTransport() and setJsonFactory() methods in the FirebaseOptions class. These settings are used by all services of the SDK except FirebaseDatabase.

v5.1.0

Authentication

  • [added] A new user management API that allows provisioning and managing Firebase users from Java applications. This API adds getUser(), getUserByEmail(), createUser(), updateUser() and deleteUser() methods to the FirebaseAuth interface.

v5.0.1

Realtime Database

  • [changed] Fixed a database API thread leak that made the SDK unstable when running in the Google App Engine environment.

v5.0.0

Initialization

  • [added] Factory methods in FirebaseCredentials class can now throw IOExceptions, providing fail-fast semantics while facilitating simpler error handling.
  • [added] The deprecated setServiceAccount() method has been removed from the FirebaseOptions.Builder class in favor of the setCredential() method.
  • [added] Trying to initialize the SDK without setting a credential now results in an exception.
  • {{changed}} The FirebaseCredential interface now returns a new GoogleOAuthAccessToken type, which encapsulates both token string and its expiry time.

v4.1.7

  • [added] Introducing a new FirebaseApp.delete() method, which can be used to gracefully shut down app instances. All app invocations after a call to delete() will throw exceptions. Deleted app instances can also be re-initialized with the same name if necessary.

  • [changed] Upgraded SDK dependencies. Guava, Google API Client, and JSON libraries that the SDK depends on have been upgraded to more recent versions.

v4.1.6

Realtime Database

  • [changed] Updated the SDK to select the correct thread pool implementation when running on a regular JVM with App Engine libraries in the classpath.

v4.1.5

Realtime Database

  • [changed] Fixed the invalid SDK version constant in the FirebaseDatabase class that was released in v4.1.4.

v4.1.4

Authentication

  • [changed] Updated the SDK to periodically refresh the OAuth access token internally used by FirebaseApp. This reduces the number of authentication failures encountered at runtime by various SDK components (e.g. Realtime Database) to nearly zero. This feature is active by default when running in typical Java environments, or the Google App Engine environment with background threads support.

v4.1.3

Realtime Database

  • [changed] Updated Realtime Database to properly swap out the ID token used to authenticate the underlying websocket when a new ID token is generated. The websocket connection is still disconnected and reconnected every hour when an ID token expires unless you manually call getAccessToken on the FirebaseCredential used to authenticate the SDK. In a future release, the SDK will proactively refresh ID tokens automatically before they expire.

v4.1.2

Initialization

  • [changed] Updated initalizeApp() to synchronously read from an InputStream to avoid issues with closing the stream after initializing the SDK.
  • [changed] Improved confusing error messages when initializing the SDK with a null or malformed InputStream.

v4.1.1

Authentication

  • [changed] Fixed a dependency issue which caused the verifyIdToken() method to always throw an exception.

v4.1.0

Initialization

Authentication

  • [issue] The verifyIdToken() method is broken in this release and throws an exception due to an incorrect dependency. This was fixed in version 4.1.1.

v4.0.4

  • [changed] Fixed issue which caused threads to be terminated in Google App Engine after 24 hours, rendering the SDK unresponsive.
  • [changed] Fixed issues which caused asynchronous task execution to fail on automatically-scaled Google App Engine instances.

Authentication

  • [added] Improved error messages and added App Engine support for the verifyIdToken() method.

Realtime Database

  • [changed] Fixed a race condition which could occur when new writes are added while the connection is being closed.

v4.0.3

Initialization

Realtime Database

v4.0.2

  • [changed] This update restores Java 7 compatibilty for the Admin Java SDK.

v4.0.1

  • [changed] Fixed an issue with a missing dependency in the 4.0.0 JAR which caused the Database API to not work.
  • [issue] This version was compiled for Java 8 and does not support Java 7. This was fixed in version 4.0.2.

v4.0.0

  • [added] The Admin Java SDK (available on Maven as firebase-admin) replaces the pre-existing firebase-server-sdk Maven package, which is now deprecated. See Add the Firebase Admin SDK to your Server to get started.
  • [issue] This version is missing a dependency which causes the Database API to not work. This was fixed in version 4.0.1.
  • [issue] This version was compiled for Java 8 and does not support Java 7. This was fixed in version 4.0.2.

Authentication

  • [changed] The createCustomToken() method is now asynchronous, returning a Task<String> instead of a String.