Skip to content

CHANGELOG.md

Latest commit

 

History

History
267 lines (204 loc) · 11.2 KB

CHANGELOG.md

File metadata and controls

267 lines (204 loc) · 11.2 KB

Unreleased

v2.17.0

  • [added] Added new send_all() and send_multicast() APIs to the messasing module.
  • [added] Added a new auth.DELETE_ATTRIBUTE sentinel value, which can be used to delete phone_number, display_name, photo_url and custom_claims attributes from a user account. It is now recommended to use this sentinel value over passing None for deleting attributes.

v2.16.0

  • [added] Added generate_password_reset_link(), generate_email_verification_link() and generate_sign_in_with_email_link() methods to the auth API.
  • [added] Migrated the auth user management API to the new Identity Toolkit endpoint.
  • [fixed] Extending HTTP retries to more HTTP methods like POST and PATCH.

v2.15.1

  • [added] Implemented HTTP retries. The SDK now retries HTTP calls on low-level connection and socket read errors, as well as HTTP 500 and 503 errors.

v2.15.0

  • [changed] Taking a direct dependency on google-api-core[grpc] in order to resolve some long standing Firestore installation problems.
  • messaging.WebpushConfig class now supports configuring additional [added] FCM options for the features supported by the web SDK. A new messaging.WebpushFcmOptions type has been introduced for this purpose.
  • [added] messaging.Aps class now supports configuring a critical sound. A new messaging.CriticalSound class has been introduced for this purpose.
  • [changed] Dropped support for Python 3.3.

v2.14.0

  • [added] A new project_management API for managing apps in a project.
  • [added] messaging.AndroidNotification type now supports channel_id.
  • [fixed] FCM errors sent by the back-end now include more details that are helpful when debugging problems.
  • [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] Ensuring that UserRecord.tokens_valid_after_time always returns an integer, and never returns None.
  • [fixed] Fixing a performance issue in the db.listen() API where it was taking a long time to process large RTDB nodes.

v2.13.0

  • [added] The db.Reference type now provides a listen() API for receiving realtime update events from the Firebase Database.
  • [added] The db.reference() method now optionally takes a url parameter. This can be used to access multiple Firebase Databases in the same project more easily.
  • [added] The messaging.WebpushNotification type now supports additional parameters.

v2.12.0

  • [added] Implemented the ability to create custom tokens without service account credentials.
  • [added] Admin SDK can now read the project ID from both GCLOUD_PROJECT and GOOGLE_CLOUD_PROJECT environment variables.

v2.11.0

  • [added] A new auth.import_users() API for importing users into Firebase Auth in bulk.
  • [fixed] The db.Reference.update() function now accepts dictionaries with None values. This can be used to delete child keys from a reference.

v2.10.0

  • [added] A new create_session_cookie() method for creating a long-lived session cookie given a valid ID token.
  • [added] A new verify_session_cookie() method for verifying a given cookie string is valid.
  • [added] auth module now caches the public key certificates used to verify ID tokens and sessions cookies. This enables the SDK to avoid making a network call everytime a credential needs to be verified.
  • [added] Added the mutable_content optional field to the messaging.Aps type.
  • [added] Added support for specifying arbitrary custom key-value fields in the messaging.Aps type.

v2.9.1

Cloud Messaging

  • [changed] Improved error handling in FCM by mapping more server-side errors to client-side error codes. See documentation.
  • [changed] The messaging module now supports specifying an HTTP timeout for all egress requests. Pass the httpTimeout option to firebase_admin.initialize_app() before invoking any functions in messaging.

v2.9.0

Cloud Messaging

  • [feature] Added the firebase_admin.messaging module for sending Firebase notifications and managing topic subscriptions.

Authentication

  • [added] The 'verify_id_token()' function now accepts an optional check_revoked parameter. When True, an additional check is performed to see whether the token has been revoked.
  • [added] A new 'auth.revoke_refresh_tokens(uid)' function has been added to invalidate all tokens issued to a user.
  • [added] A new tokens_valid_after_timestamp property has been added to the 'UserRecord', class indicating the time before which tokens are not valid.

v2.8.0

Initialization

  • [added] The initialize_app() method can now be invoked without any arguments. This initializes an app using Google Application Default Credentials, and other options loaded from the FIREBASE_CONFIG environment variable.

Realtime Database

  • [added] The db.Reference.get() method now accepts an optional shallow argument. If set to True this causes the SDK to execute a shallow read, which does not retrieve the child node values of the current reference.

v2.7.0

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

v2.6.0

Authentication

  • [added] Added the list_users() function to the firebase_admin.auth module. This function enables listing or iterating over all user accounts in a Firebase project.
  • [added] Added the set_custom_user_claims() function to the firebase_admin.auth module. This function enables setting custom claims on a Firebase user. The custom claims can be accessed via that user's ID token.

Realtime Database

  • [changed] Updated the start_at(), end_at() and equal_to() methods of the db.Query class so they can accept empty string arguments.

v2.5.0

v2.4.0

Realtime Database

  • [added] The db.Reference class now has a get_if_changed() method, which retrieves a database value only if the value has changed since last read.
  • [added] The options dictionary passed to initialize_app() function can now contain an httpTimeout option, which sets the timeout (in seconds) for outbound HTTP connections started by the SDK.

v2.3.0

Realtime Database

  • [added] You can now get the ETag value of a database reference by passing etag=True to the get() method of a db.Reference object.
  • [added] The db.Reference class now has a set_if_unchanged() method, which you can use to write to a database location only when the location has the ETag value you specify.
  • [changed] Fixed an issue with the transaction() method that prevented you from updating scalar values in a transaction.

v2.2.0

Authentication

  • [added] A new user management API that allows provisioning and managing Firebase users from Python applications. This API adds get_user(), get_user_by_email(), get_user_by_phone_number(), create_user(), update_user() and delete_dser() methods to the firebase_admin.auth module.

Realtime Database

  • [added] The db.Reference class now exposes a transaction() method, which can be used to execute atomic updates on database references.

v2.1.1

  • [changed] Constructors of Certificate and RefreshToken credential types can now be invoked with either a file path or a parsed JSON object. This facilitates the consumption of service account credentials and refresh token credentials from sources other than the local file system.
  • [changed] Better integration with the google-auth library for making authenticated HTTP requests from the SDK.

v2.1.0

v2.0.0

  • [changed] This SDK has been migrated from oauth2client to the new google-auth library.

Authentication

  • [changed] This SDK now supports verifying ID tokens when initialized with application default credentials.

v1.0.0

Initialization

  • [added] Implemented the firebase_admin module, which provides the initialize_app() function for initializing the SDK with a credential.
  • [added] Implemented the firebase_admin.credentials module, which contains constructors for Certificate, ApplicationDefault and RefreshToken credential types.

Authentication

  • [added] Implemented the firebase_admin.auth module, which provides create_custom_token() and verify_id_token() functions for minting custom authentication tokens and verifying Firebase ID tokens.