-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
64 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,94 +1,94 @@ | ||
| --- | ||
| title: v6.4.0 | ||
| description: 'Features, Bug fixes and documentation updates release.' | ||
| description: 'Messaging focused release with features, bug fixes and documentation updates.' | ||
| date: 2020-04-03 | ||
| author: russellwheatley | ||
| tags: | ||
| - analytics | ||
| - auth | ||
| - dynamic-links | ||
| - firestore | ||
| - functions | ||
| - in-app-messaging | ||
| - messaging | ||
| --- | ||
|
|
||
| # v6.4.0 Release | ||
|
|
||
| > Please tag any GitHub issues regarding v6 with `[v6]` in the title. | ||
| 🐞 This is a bug fix and feature release. 🐞 | ||
|
|
||
| ## Platform | ||
|
|
||
| - **iOS:** fix iOS build issue when using static frameworks i.e., `use_framework` ([#3253](https://github.com/invertase/react-native-firebase/issues/3253)) ([#530f8bb](https://github.com/invertase/react-native-firebase/commit/530f8bbb51f89f106854dbf1df5ec80211e2cf8b)) | ||
|
|
||
| ## Features | ||
|
|
||
| - **messaging:** ([#d66a611](https://github.com/invertase/react-native-firebase/commit/d66a6118f82005087f53b86571990fc071402153)) | ||
| - `iOS`: added a Podfile option to allow using React Native Firebase packages as static frameworks ([#3253](https://github.com/invertase/react-native-firebase/issues/3253)) ([#530f8bb](https://github.com/invertase/react-native-firebase/commit/530f8bbb51f89f106854dbf1df5ec80211e2cf8b)) | ||
| - see [Allow iOS Static Frameworks](/#allow-ios-static-frameworks) to learn more. This option will default to true in the next major release. | ||
|
|
||
| - **Android, iOS**: messaging now supports `onNotificationOpenedApp` & also `getInitialNotification` APIs. These are used to detect if a user opened the app via pressing a notification | ||
| - **Android, iOS**: the `RemoteMessage` API now includes a notification payload (if present) when being sent to the messaging APIs (e.g. `onMessage`) | ||
| - **iOS**: `setBackgroundMessageHandler` support for iOS | ||
| - **iOS**: the permissions API has been upgraded to now support custom permissions. The permission API selects sensible defaults however allows you to fully customise them if required. Please note, provisional permissions is now disabled by default (previously, it was enabled by default for iOS 12+ devices) | ||
| - **iOS**: the `requestPermission` & `hasPermission` API now returns the current authorization status, rather than a boolean value. This generally won't break existing apps as any "truthy" logic checks should still work | ||
| ### Messaging | ||
|
|
||
| - **storage:** `put` method has `snapshot` property. `put` method now returns a `Task` instead of a promise ([#ea19622](https://github.com/invertase/react-native-firebase/commit/ea1962270b6c20d5b15dbaaea5c4d88a0a4ae3e2)) | ||
| - added support for `onNotificationOpenedApp` & `getInitialNotification` APIs. | ||
| - these can be used to detect if a user opened the app via pressing a notification. ([#d66a611](https://github.com/invertase/react-native-firebase/commit/d66a6118f82005087f53b86571990fc071402153)) | ||
| - the `RemoteMessage` event (e.g. via `onMessage`) now includes a notification payload (if present). ([#d66a611](https://github.com/invertase/react-native-firebase/commit/d66a6118f82005087f53b86571990fc071402153)) | ||
| - `setBackgroundMessageHandler` now supported on iOS. ([#d66a611](https://github.com/invertase/react-native-firebase/commit/d66a6118f82005087f53b86571990fc071402153)) | ||
| - the iOS permissions API has been upgraded to now support custom permissions. | ||
| - the permission API selects sensible defaults, however; allows you to fully customise them if required. | ||
| - provisional permissions are now disabled by default (previously, it was enabled by default for iOS 12+ devices). ([#d66a611](https://github.com/invertase/react-native-firebase/commit/d66a6118f82005087f53b86571990fc071402153)) | ||
| - the `requestPermission` & `hasPermission` APIs now returns the current authorization status as an enum, rather than a boolean value. | ||
| - this generally won't break existing apps as any "truthy" logic checks should still work. ([#d66a611](https://github.com/invertase/react-native-firebase/commit/d66a6118f82005087f53b86571990fc071402153)) | ||
| - see [AuthorizationStatus](/reference/messaging/authorizationstatus) reference documentation for available enum members | ||
|
|
||
| ### SDK & Dependencies Updates | ||
|
|
||
| - **in-app-messaging:** update in-app-messaging dependency to latest package name in iOS `InAppMessaging` ([#166692d](https://github.com/invertase/react-native-firebase/commit/166692d68ef396f3e8664edd7feab7c80038004b)) | ||
|
|
||
| - **in-app-messaging:** allowing gradle to have more than the default memory Firebase dependencies are pretty heavy and the build will fail otherwise ([#3154](https://github.com/invertase/react-native-firebase/issues/3154))([#d65e634](https://github.com/invertase/react-native-firebase/commit/d65e6341a48c66604493e14269d6488d3cc64028)) | ||
| --- | ||
|
|
||
| ## Bug Fixes | ||
|
|
||
| - **analytics:** logging event params can be objects and arrays ([#2876](https://github.com/invertase/react-native-firebase/issues/2876)) ([#eebfb04](https://github.com/invertase/react-native-firebase/commit/eebfb04a7c0a856a9d5d311ae99138df9ab90c3b)) | ||
| - `iOS`: update `in-app-messaging` dependency to latest package name in iOS `InAppMessaging` ([#166692d](https://github.com/invertase/react-native-firebase/commit/166692d68ef396f3e8664edd7feab7c80038004b)) | ||
|
|
||
| - **auth:** `user.metadata.lastSignInTime` & `user.metadata.creationTime` ([#2555](https://github.com/invertase/react-native-firebase/issues/2555)) ([#8adef65](https://github.com/invertase/react-native-firebase/commit/8adef653faa008e0146374f99f5ba1af902749bf)) | ||
| ### Analytics | ||
|
|
||
| - **analytics:** update `logEvent` types ([#65ec7eb](https://github.com/invertase/react-native-firebase/commit/65ec7eb431712f8c4d3cf96c24489e6a13ef4e13)) | ||
| - logging event params can be objects and arrays ([#2876](https://github.com/invertase/react-native-firebase/issues/2876)) ([#eebfb04](https://github.com/invertase/react-native-firebase/commit/eebfb04a7c0a856a9d5d311ae99138df9ab90c3b)) | ||
| - update `logEvent` types ([#65ec7eb](https://github.com/invertase/react-native-firebase/commit/65ec7eb431712f8c4d3cf96c24489e6a13ef4e13)) | ||
|
|
||
| - **dynamic-links:** switch ShortLinkType interface to an enum ([#870d0a1](https://github.com/invertase/react-native-firebase/commit/870d0a198692c65d2857765d1b216738ec74856f)) | ||
| ### Authentication | ||
|
|
||
| - **dynamic-links:** links options not correctly applied in iOS ([#54bc6f8](https://github.com/invertase/react-native-firebase/commit/54bc6f8403b12a8cfaf0b862d13310ef28076d06)) | ||
| - `user.metadata.lastSignInTime` & `user.metadata.creationTime` now correctly return an ISO date string ([#2555](https://github.com/invertase/react-native-firebase/issues/2555)) ([#8adef65](https://github.com/invertase/react-native-firebase/commit/8adef653faa008e0146374f99f5ba1af902749bf)) | ||
|
|
||
| - **dynamic-links:** missing return statement causing bug in iOS ([#3315](https://github.com/invertase/react-native-firebase/issues/3315)) ([#1661f6e](https://github.com/invertase/react-native-firebase/commit/1661f6e084c47ed835cc4539c654286964a6d9a8)) | ||
| ### Dynamic Links | ||
|
|
||
| - **firestore:** improve firestore querying. `where` field parameter cannot match `orderBy` parameter ([#6311dc8](https://github.com/invertase/react-native-firebase/commit/6311dc8f68e6cf0605d2f306885d2fbc0ef779d6)) | ||
| - switch ShortLinkType interface to an enum ([#870d0a1](https://github.com/invertase/react-native-firebase/commit/870d0a198692c65d2857765d1b216738ec74856f)) | ||
| - fix links options not correctly applied in iOS ([#54bc6f8](https://github.com/invertase/react-native-firebase/commit/54bc6f8403b12a8cfaf0b862d13310ef28076d06)) | ||
| - fix missing return statement causing bug in iOS ([#3315](https://github.com/invertase/react-native-firebase/issues/3315)) ([#1661f6e](https://github.com/invertase/react-native-firebase/commit/1661f6e084c47ed835cc4539c654286964a6d9a8)) | ||
|
|
||
| - **firestore:** improve query validation ([#3326](https://github.com/invertase/react-native-firebase/issues/3326)) ([#ea19622](https://github.com/invertase/react-native-firebase/commit/b90a736fc8f9a1b25239bb68e5a62de711b673c7)) | ||
| ### Firestore | ||
|
|
||
| - **functions:** throw UNAVAILABLE code on network IO errors for Android so error is the same, correct type as iOS ([#3310](https://github.com/invertase/react-native-firebase/issues/3310)) ([#7351147](https://github.com/invertase/react-native-firebase/commit/73511472bd7690158f3d9924d5f4d8c0cad69910)) | ||
| - improve firestore query validation; | ||
| - `where` field parameter cannot match `orderBy` parameter ([#6311dc8](https://github.com/invertase/react-native-firebase/commit/6311dc8f68e6cf0605d2f306885d2fbc0ef779d6)) | ||
| - field path cannot be used with a `orderBy` parameter ([#ea19622](https://github.com/invertase/react-native-firebase/commit/b90a736fc8f9a1b25239bb68e5a62de711b673c7)) | ||
|
|
||
| - **messaging:** fix remote notification tokens ([#bd4dc06](https://github.com/invertase/react-native-firebase/commit/bd4dc06a05f168344d13d001241c81df1949ba29)) | ||
| ### Functions | ||
|
|
||
| - **messaging:** messaging receiver updates / initial notification handling. Attach Notification to RemoteMessage ([#cf0bbdc](https://github.com/invertase/react-native-firebase/commit/cf0bbdcaf06a3f1ba8c210ef1c03bcfff10b5522)) | ||
| - correctly throw an `UNAVAILABLE` error code on network IO errors for Android to match iOS ([#3310](https://github.com/invertase/react-native-firebase/issues/3310)) ([#7351147](https://github.com/invertase/react-native-firebase/commit/73511472bd7690158f3d9924d5f4d8c0cad69910)) | ||
|
|
||
| - **messaging:** ([#d66a611](https://github.com/invertase/react-native-firebase/commit/d66a6118f82005087f53b86571990fc071402153)) | ||
| ### Messaging | ||
|
|
||
| - **Android**: ensure a color is always present when user does not set one | ||
| - **Android**: better handling/messages in cases where no handler is set | ||
| - **Android**: `onMessage` will work for data-only, notification-only AND data-notification messages. Currently it only works for data-only | ||
| - **Android**: `setBackgroundMessageHandler` will now work when the app is both fully quit and backgrounded, for data-only, notification-only AND data-notification messages. Previously, when the app was fully quit, events were not being handled | ||
| - **iOS**: calling `registerDeviceForRemoteMessages`/`registerForRemoteNotifications` was causing permissions to be requested before explicitly requesting them via the messaging API | ||
| - **iOS**: registering the device was not being called if it was already registered internally. Devices should always register when `registerDeviceForRemoteMessages` is called as per Apple guidelines, irregardless of current registration status. Make sure you always call `registerDeviceForRemoteMessages` during your app initialization on iOS | ||
| - **iOS**: in cases where requesting an FCM with default scope/authorizedEntity, the underlying code now uses the recommended `instanceIDWithHandler` vs `tokenWithAuthorizedEntity`. This fixes an issue where FCM would throw a "The operation couldn’t be completed" error | ||
| - **iOS**: direct FCM connection is now fixed. When the app was in the foreground, data-only messages were not coming through | ||
| - **iOS**: when in debug mode, the APNS token will be set as a "sandbox" key type as per the Apple guidelines | ||
| - **iOS**: the original APNS swizzling we implemented was not functioning correctly with application:didReceiveRemoteNotification:fetchCompletionHandler:. We added additional logic whereby this is executed in all scenarios (foreground/background/quit) and replaces a deprecated Apple API. This fixes issues with data-only messages not being handled by the device | ||
| - **iOS**: when the application is in the foreground, notification messages were not being sent to the onMessage handler (via willPresentNotification) | ||
| - **iOS**: `FIRMessagingDelegate` methods added to your `AppDelegate.m` will also be called | ||
| - `onMessage` now works correctly for `data-only`, `notification-only` & `data-notification` messages. Previously it only worked for `data-only` messages | ||
| - `setBackgroundMessageHandler` now works when the app fully quit or backgrounded, for `data-only`, `notification-only` & `data-notification` messages. Previously, when the app was fully quit, events were not being handled | ||
| - for iOS this requires `content-available` to be set | ||
| - add better handling for messages in cases where no user handler has been set | ||
| - `Android`: ensure a default notification color is always present when user does not set one | ||
| - `iOS`: calling `registerDeviceForRemoteMessages`/`registerForRemoteNotifications` was incorrectly causing permissions to be requested before explicitly requesting them via the messaging API | ||
| - `iOS`: registering the device was not being called if it was already registered internally. | ||
| - Devices should **always** register with `registerDeviceForRemoteMessages`, as per Apple guidelines, irregardless of current registration status. | ||
| - Make sure you **always** call `registerDeviceForRemoteMessages` during your app initialization on iOS | ||
| - `iOS`: in cases where requesting an FCM with the default `scope` & `authorizedEntity`, the underlying code now uses the recommended `instanceIDWithHandler` vs `tokenWithAuthorizedEntity`. | ||
| - This fixes an issue where FCM would throw a `"The operation couldn’t be completed"` error ([#2657](https://github.com/invertase/react-native-firebase/issues/2657)) | ||
| - `iOS`: direct FCM connection is now fixed. | ||
| - When the app was in the foreground, `data-only` messages were not coming through, they are now. | ||
| - `iOS`: when running debug build, the APNS token will be registered with FCM as a `"sandbox"` key type | ||
| - `iOS`: the original APNS swizzling we implemented was not functioning correctly with `application:didReceiveRemoteNotification:fetchCompletionHandler:`. | ||
| - We added additional logic whereby this is executed in all scenarios (foreground/background/quit) and replaces a deprecated Apple API. | ||
| - This fixes issues with `data-only` messages not being handled by the device | ||
| - `iOS`: any custom `FIRMessagingDelegate` methods you add to your `AppDelegate.m` will now also be called internally by React Native Firebase messaging. | ||
|
|
||
| - **storage:** fixed a bug with parsing encoded urls ([#2753](https://github.com/invertase/react-native-firebase/issues/2753)) ([#8e99b9c](https://github.com/invertase/react-native-firebase/commit/8e99b9cb9093ba0cc3aadcb56127c8500ea8bf36)) | ||
| ### Storage | ||
|
|
||
| ## Deprecated | ||
| - fixed a bug that occurred when parsing encoded urls ([#2753](https://github.com/invertase/react-native-firebase/issues/2753)) ([#8e99b9c](https://github.com/invertase/react-native-firebase/commit/8e99b9cb9093ba0cc3aadcb56127c8500ea8bf36)) | ||
| - storage tasks now correctly have a `snapshot` property - to match the Web SDK | ||
| - `put` method now correctly returns a thenable `Task` instance instead of a promise ([#ea19622](https://github.com/invertase/react-native-firebase/commit/ea1962270b6c20d5b15dbaaea5c4d88a0a4ae3e2)) | ||
|
|
||
| --- | ||
|
|
||
| - **messaging:** ([#d66a611](https://github.com/invertase/react-native-firebase/commit/d66a6118f82005087f53b86571990fc071402153)) | ||
| - **iOS**: `registerForRemoteNotifications` has been deprecated in favour of `registerDeviceForRemoteMessages`. It will be removed in v7. Underlying functionality has not changed, just renamed to avoid confusion with messages vs notifications | ||
| - **iOS**: `isRegisteredForRemoteNotifications` has been deprecated in favour of `isDeviceRegisteredForRemoteMessages`. It will be removed in v7. Underlying functionality has not changed, just renamed to avoid confusion with messages vs notifications. | ||
| - **iOS**: `unregisterForRemoteNotifications` has been deprecated in favour of `unregisterDeviceForRemoteMessages`. It will be removed in v7. Underlying functionality has not changed, just renamed to avoid confusion with messages vs notifications. | ||
| ## Deprecations | ||
|
|
||
| ## Removed | ||
| ### Messaging | ||
|
|
||
| - removed `indexing` package ([#d7ac657](https://github.com/invertase/react-native-firebase/commit/d7ac657155826ea51edd75502b51b9102140acc6)) | ||
| - `registerForRemoteNotifications` has been deprecated in favour of `registerDeviceForRemoteMessages`. | ||
| - It will be removed in a following major version. Underlying functionality has not changed - renamed to avoid confusion with messages vs notifications. ([#d66a611](https://github.com/invertase/react-native-firebase/commit/d66a6118f82005087f53b86571990fc071402153)) | ||
| - `isRegisteredForRemoteNotifications` has been deprecated in favour of `isDeviceRegisteredForRemoteMessages`. | ||
| - It will be removed in a following major version. Underlying functionality has not changed - renamed to avoid confusion with messages vs notifications. ([#d66a611](https://github.com/invertase/react-native-firebase/commit/d66a6118f82005087f53b86571990fc071402153)) | ||
| - `unregisterForRemoteNotifications` has been deprecated in favour of `unregisterDeviceForRemoteMessages`. | ||
| - It will be removed in a following major version. Underlying functionality has not changed - renamed to avoid confusion with messages vs notifications. ([#d66a611](https://github.com/invertase/react-native-firebase/commit/d66a6118f82005087f53b86571990fc071402153)) |