Skip to content

feat(expo): enhances notification config retrieval #8663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+201 −60
Open

feat(expo): enhances notification config retrieval #8663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c6a7418
feat(expo): enhances notification config retrieval
huextrat Aug 21, 2025
baf4c89
fix lint
huextrat Sep 23, 2025
b263759
test: make sure both config works
huextrat Sep 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 125 additions & 54 deletions packages/messaging/plugin/__tests__/androidPlugin.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,70 +1,141 @@
import { describe, expect, it } from '@jest/globals';
import { setFireBaseMessagingAndroidManifest } from '../src/android/setupFirebaseNotifationIcon';
import { ExpoConfig } from '@expo/config-types';
import expoConfigExample from './fixtures/expo-config-example';
import {
expoConfigExample,
expoNotificationsConfigExample,
expoNotificationsConfigWithoutColorExample,
expoNotificationsConfigWithoutPluginExample,
} from './fixtures/expo-config-example';
import manifestApplicationExample from './fixtures/application-example';
import { ManifestApplication } from '@expo/config-plugins/build/android/Manifest';

describe('Config Plugin Android Tests', function () {
it('applies changes to app/src/main/AndroidManifest.xml with color', async function () {
const config: ExpoConfig = JSON.parse(JSON.stringify(expoConfigExample));
const manifestApplication: ManifestApplication = JSON.parse(
JSON.stringify(manifestApplicationExample),
);
setFireBaseMessagingAndroidManifest(config, manifestApplication);
expect(manifestApplication['meta-data']).toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_icon',
'android:resource': '@drawable/notification_icon',
},
describe('notification config', () => {
it('applies changes to app/src/main/AndroidManifest.xml with color', async function () {
const config: ExpoConfig = JSON.parse(JSON.stringify(expoConfigExample));
const manifestApplication: ManifestApplication = JSON.parse(
JSON.stringify(manifestApplicationExample),
);
setFireBaseMessagingAndroidManifest(config, manifestApplication);
expect(manifestApplication['meta-data']).toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_icon',
'android:resource': '@drawable/notification_icon',
},
});
expect(manifestApplication['meta-data']).toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_color',
'android:resource': '@color/notification_icon_color',
'tools:replace': 'android:resource',
},
});
});
expect(manifestApplication['meta-data']).toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_color',
'android:resource': '@color/notification_icon_color',
'tools:replace': 'android:resource',
},

it('applies changes to app/src/main/AndroidManifest.xml without color', async function () {
const config = JSON.parse(JSON.stringify(expoConfigExample));
const manifestApplication: ManifestApplication = JSON.parse(
JSON.stringify(manifestApplicationExample),
);
config.notification!.color = undefined;
setFireBaseMessagingAndroidManifest(config, manifestApplication);
expect(manifestApplication['meta-data']).toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_icon',
'android:resource': '@drawable/notification_icon',
},
});
expect(manifestApplication['meta-data']).not.toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_icon',
'android:resource': '@drawable/notification_icon_color',
'tools:replace': 'android:resource',
},
});
});

it('applies changes to app/src/main/AndroidManifest.xml without notification', async function () {
// eslint-disable-next-line no-console
const warnOrig = console.warn;
let called = false;
// eslint-disable-next-line no-console
console.warn = (_: string) => {
called = true;
};
const config: ExpoConfig = JSON.parse(JSON.stringify(expoConfigExample));
const manifestApplication: ManifestApplication = JSON.parse(
JSON.stringify(manifestApplicationExample),
);
config.notification = undefined;
setFireBaseMessagingAndroidManifest(config, manifestApplication);
expect(called).toBeTruthy();
// eslint-disable-next-line no-console
console.warn = warnOrig;
});
});

it('applies changes to app/src/main/AndroidManifest.xml without color', async function () {
const config = JSON.parse(JSON.stringify(expoConfigExample));
const manifestApplication: ManifestApplication = JSON.parse(
JSON.stringify(manifestApplicationExample),
);
config.notification!.color = undefined;
setFireBaseMessagingAndroidManifest(config, manifestApplication);
expect(manifestApplication['meta-data']).toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_icon',
'android:resource': '@drawable/notification_icon',
},
describe('expo-notifications config', () => {
it('applies changes to app/src/main/AndroidManifest.xml with color', async function () {
const config: ExpoConfig = JSON.parse(JSON.stringify(expoNotificationsConfigExample));
const manifestApplication: ManifestApplication = JSON.parse(
JSON.stringify(manifestApplicationExample),
);
setFireBaseMessagingAndroidManifest(config, manifestApplication);
expect(manifestApplication['meta-data']).toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_icon',
'android:resource': '@drawable/notification_icon',
},
});
expect(manifestApplication['meta-data']).toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_color',
'android:resource': '@color/notification_icon_color',
'tools:replace': 'android:resource',
},
});
});
expect(manifestApplication['meta-data']).not.toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_icon',
'android:resource': '@drawable/notification_icon_color',
'tools:replace': 'android:resource',
},

it('applies changes to app/src/main/AndroidManifest.xml without color', async function () {
const config = JSON.parse(JSON.stringify(expoNotificationsConfigWithoutColorExample));
const manifestApplication: ManifestApplication = JSON.parse(
JSON.stringify(manifestApplicationExample),
);
setFireBaseMessagingAndroidManifest(config, manifestApplication);
expect(manifestApplication['meta-data']).toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_icon',
'android:resource': '@drawable/notification_icon',
},
});
expect(manifestApplication['meta-data']).not.toContainEqual({
$: {
'android:name': 'com.google.firebase.messaging.default_notification_icon',
'android:resource': '@drawable/notification_icon_color',
'tools:replace': 'android:resource',
},
});
});
});

it('applies changes to app/src/main/AndroidManifest.xml without notification', async function () {
// eslint-disable-next-line no-console
const warnOrig = console.warn;
let called = false;
// eslint-disable-next-line no-console
console.warn = (_: string) => {
called = true;
};
const config: ExpoConfig = JSON.parse(JSON.stringify(expoConfigExample));
const manifestApplication: ManifestApplication = JSON.parse(
JSON.stringify(manifestApplicationExample),
);
config.notification = undefined;
setFireBaseMessagingAndroidManifest(config, manifestApplication);
expect(called).toBeTruthy();
// eslint-disable-next-line no-console
console.warn = warnOrig;
it('applies changes to app/src/main/AndroidManifest.xml without notification', async function () {
// eslint-disable-next-line no-console
const warnOrig = console.warn;
let called = false;
// eslint-disable-next-line no-console
console.warn = (_: string) => {
called = true;
};
const config: ExpoConfig = JSON.parse(
JSON.stringify(expoNotificationsConfigWithoutPluginExample),
);
const manifestApplication: ManifestApplication = JSON.parse(
JSON.stringify(manifestApplicationExample),
);
setFireBaseMessagingAndroidManifest(config, manifestApplication);
expect(called).toBeTruthy();
// eslint-disable-next-line no-console
console.warn = warnOrig;
});
});
});
39 changes: 38 additions & 1 deletion packages/messaging/plugin/__tests__/fixtures/expo-config-example.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,41 @@ const expoConfigExample: ExpoConfig = {
},
};

export default expoConfigExample;
const expoNotificationsConfigExample: ExpoConfig = {
name: 'FirebaseMessagingTest',
slug: 'fire-base-messaging-test',
plugins: [
[
'expo-notifications',
{
icon: `IconAsset`,
color: '#1D172D',
},
],
],
};

const expoNotificationsConfigWithoutColorExample: ExpoConfig = {
name: 'FirebaseMessagingTest',
slug: 'fire-base-messaging-test',
plugins: [
[
'expo-notifications',
{
icon: `IconAsset`,
},
],
],
};

const expoNotificationsConfigWithoutPluginExample: ExpoConfig = {
name: 'FirebaseMessagingTest',
slug: 'fire-base-messaging-test',
};

export {
expoConfigExample,
expoNotificationsConfigExample,
expoNotificationsConfigWithoutColorExample,
expoNotificationsConfigWithoutPluginExample,
};
43 changes: 38 additions & 5 deletions packages/messaging/plugin/src/android/setupFirebaseNotifationIcon.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,51 @@ export const withExpoPluginFirebaseNotification: ConfigPlugin = config => {
});
};

// Helper function to get notification icon and color from either config.notification or expo-notifications plugin
const getNotificationConfig = (config: ExpoConfig) => {
// Check expo-notifications plugin
if (config.plugins) {
const expoNotificationsPlugin = config.plugins.find(
plugin => Array.isArray(plugin) && plugin[0] === 'expo-notifications',
);

if (expoNotificationsPlugin && Array.isArray(expoNotificationsPlugin)) {
const pluginConfig = expoNotificationsPlugin[1];
if (pluginConfig && typeof pluginConfig === 'object') {
return {
icon: pluginConfig.icon,
color: pluginConfig.color,
};
}
}
}

/**
* @deprecated
* Get notification config from config.notification
* Will be removed in the future as `expo-notifications` plugin is the recommended way to configure notifications.
*/
if (config.notification) {
return {
icon: config.notification.icon,
color: config.notification.color,
};
}

return { icon: undefined, color: undefined };
};

export function setFireBaseMessagingAndroidManifest(
config: ExpoConfig,
application: ManifestApplication,
) {
// If the notification object is not defined, print a friendly warning
if (!config.notification) {
const { icon, color } = getNotificationConfig(config);
if (!icon) {
// This warning is important because the notification icon can only use pure white on Android. By default, the system uses the app icon as the notification icon, but the app icon is usually not pure white, so you need to set the notification icon
// eslint-disable-next-line no-console
console.warn(
'For Android 8.0 and above, it is necessary to set the notification icon to ensure correct display. Otherwise, the notification will not show the correct icon. For more information, visit https://docs.expo.dev/versions/latest/config/app/#notification',
);
return config;
}

// Defensive code
Expand All @@ -46,7 +79,7 @@ export function setFireBaseMessagingAndroidManifest(
const metaData = application['meta-data'];

if (
config.notification.icon &&
icon &&
!hasMetaData(application, 'com.google.firebase.messaging.default_notification_icon')
) {
// Expo will automatically create '@drawable/notification_icon' resource if you specify config.notification.icon.
Expand All @@ -59,7 +92,7 @@ export function setFireBaseMessagingAndroidManifest(
}

if (
config.notification.color &&
color &&
!hasMetaData(application, 'com.google.firebase.messaging.default_notification_color')
) {
metaData.push({
Expand Down
Loading