feat(fcm): Add directBootOk field to AndroidConfig (#2745)

firebase · Oct 30, 2024 · f33ccd1 · f33ccd1
1 parent 8d49b7e
commit f33ccd1
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 0 deletions.
diff --git a/etc/firebase-admin.messaging.api.md b/etc/firebase-admin.messaging.api.md
@@ -14,6 +14,7 @@ export interface AndroidConfig {
     data?: {
         [key: string]: string;
     };
+    directBootOk?: boolean;
     fcmOptions?: AndroidFcmOptions;
     notification?: AndroidNotification;
     priority?: ('high' | 'normal');

diff --git a/src/messaging/messaging-api.ts b/src/messaging/messaging-api.ts
@@ -418,6 +418,12 @@ export interface AndroidConfig {
    * Options for features provided by the FCM SDK for Android.
    */
   fcmOptions?: AndroidFcmOptions;
+
+  /**
+  * A boolean indicating whether messages will be allowed to be delivered to
+  * the app while the device is in direct boot mode.
+  */
+  directBootOk?: boolean;
 }
 
 /**

diff --git a/src/messaging/messaging-internal.ts b/src/messaging/messaging-internal.ts
@@ -398,6 +398,7 @@ function validateAndroidConfig(config: AndroidConfig | undefined): void {
   const propertyMappings = {
     collapseKey: 'collapse_key',
     restrictedPackageName: 'restricted_package_name',
+    directBootOk: 'direct_boot_ok',
   };
   renameProperties(config, propertyMappings);
 }

diff --git a/test/integration/messaging.spec.ts b/test/integration/messaging.spec.ts
@@ -45,6 +45,7 @@ const message: Message = {
   },
   android: {
     restrictedPackageName: 'com.google.firebase.testing',
+    directBootOk: true,
     notification: {
       title: 'test.title',
       ticker: 'test.ticker',

diff --git a/test/unit/messaging/messaging.spec.ts b/test/unit/messaging/messaging.spec.ts
@@ -3961,6 +3961,7 @@ describe('Messaging', () => {
           android: {
             collapseKey: 'test.key',
             restrictedPackageName: 'test.package',
+            directBootOk: true,
             notification: {
               clickAction: 'test.click.action',
               titleLocKey: 'title.loc.key',
@@ -3988,6 +3989,7 @@ describe('Messaging', () => {
           android: {
             collapse_key: 'test.key',
             restricted_package_name: 'test.package',
+            direct_boot_ok: true,
             notification: {
               click_action: 'test.click.action',
               title_loc_key: 'title.loc.key',
@@ -4043,6 +4045,7 @@ describe('Messaging', () => {
             priority: 'high',
             collapseKey: 'test.key',
             restrictedPackageName: 'test.package',
+            directBootOk: true,
             ttl: 5,
             data: {
               k1: 'v1',
@@ -4089,6 +4092,7 @@ describe('Messaging', () => {
             priority: 'high',
             collapse_key: 'test.key',
             restricted_package_name: 'test.package',
+            direct_boot_ok: true,
             ttl: '0.005000000s', // 5 ms = 5,000,000 ns
             data: {
               k1: 'v1',