@alaudoni/expo-firebase-extension-plugin
Version:
The Firebase Expo plugin allows you to use Firebase without leaving the managed workflow. Developed in collaboration with SweetGreen.
220 lines (219 loc) • 11.5 kB
JavaScript
;
/**
* Expo config plugin for Firebase (iOS)
* @see https://rnfirebase.io/messaging/ios-notification-images#main
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.withFirebaseIos = void 0;
const config_plugins_1 = require("@expo/config-plugins");
const assert_1 = __importDefault(require("assert"));
const fs = __importStar(require("fs"));
const path = __importStar(require("path"));
const getEasManagedCredentialsConfigExtra_1 = __importDefault(require("../support/eas/getEasManagedCredentialsConfigExtra"));
const FileManager_1 = require("../support/FileManager");
const FirebaseLog_1 = require("../support/FirebaseLog");
const iosConstants_1 = require("../support/iosConstants");
const NseUpdaterManager_1 = __importDefault(require("../support/NseUpdaterManager"));
const updatePodfile_1 = require("../support/updatePodfile");
/**
* Add 'aps-environment' record with current environment to '<project-name>.entitlements' file
* @see https://rnfirebase.io/messaging/ios-notification-images#main
*/
const withAppEnvironment = (config, FirebaseProps) => {
return (0, config_plugins_1.withEntitlementsPlist)(config, (newConfig) => {
if (FirebaseProps?.mode == null) {
throw new Error(`
Missing required "mode" key in your app.json or app.config.js file for "Firebase-expo-plugin".
"mode" can be either "development" or "production".
Please see Firebase-expo-plugin's README.md for more details.`);
}
newConfig.modResults["aps-environment"] = FirebaseProps.mode;
return newConfig;
});
};
/**
* Add "Background Modes -> Remote notifications" and "App Group" permissions
* @see https://rnfirebase.io/messaging/ios-notification-images#main
*/
const withRemoteNotificationsPermissions = (config) => {
const BACKGROUND_MODE_KEYS = ["remote-notification"];
return (0, config_plugins_1.withInfoPlist)(config, (newConfig) => {
if (!Array.isArray(newConfig.modResults.UIBackgroundModes)) {
newConfig.modResults.UIBackgroundModes = [];
}
for (const key of BACKGROUND_MODE_KEYS) {
if (!newConfig.modResults.UIBackgroundModes.includes(key)) {
newConfig.modResults.UIBackgroundModes.push(key);
}
}
return newConfig;
});
};
/**
* Add "App Group" permission
* @see https://rnfirebase.io/messaging/ios-notification-images#main (step 4.4)
*/
const withAppGroupPermissions = (config) => {
const APP_GROUP_KEY = "com.apple.security.application-groups";
return (0, config_plugins_1.withEntitlementsPlist)(config, (newConfig) => {
if (!Array.isArray(newConfig.modResults[APP_GROUP_KEY])) {
newConfig.modResults[APP_GROUP_KEY] = [];
}
const modResultsArray = newConfig.modResults[APP_GROUP_KEY];
const entitlement = `group.${newConfig?.ios?.bundleIdentifier || ""}.Firebase`;
if (modResultsArray.indexOf(entitlement) !== -1) {
return newConfig;
}
modResultsArray.push(entitlement);
return newConfig;
});
};
const withEasManagedCredentials = (config) => {
(0, assert_1.default)(config.ios?.bundleIdentifier, "Missing 'ios.bundleIdentifier' in app config.");
config.extra = (0, getEasManagedCredentialsConfigExtra_1.default)(config);
return config;
};
const withFirebasePodfile = (config) => {
return (0, config_plugins_1.withDangerousMod)(config, [
"ios",
async (config) => {
// not awaiting in order to not block main thread
const iosRoot = path.join(config.modRequest.projectRoot, "ios");
(0, updatePodfile_1.updatePodfile)(iosRoot).catch((err) => {
FirebaseLog_1.FirebaseLog.error(err);
});
return config;
},
]);
};
const withFirebaseNSE = (config, props) => {
// support for monorepos where node_modules can be above the project directory.
const pluginDir = require.resolve("@alaudoni/expo-firebase-extension-plugin/package.json");
const sourceDir = path.join(pluginDir, "../build/support/serviceExtensionFiles/");
return (0, config_plugins_1.withDangerousMod)(config, [
"ios",
async (config) => {
const iosPath = path.join(config.modRequest.projectRoot, "ios");
/* COPY OVER EXTENSION FILES */
fs.mkdirSync(`${iosPath}/${iosConstants_1.NSE_TARGET_NAME}`, { recursive: true });
for (let i = 0; i < iosConstants_1.NSE_EXT_FILES.length; i++) {
const extFile = iosConstants_1.NSE_EXT_FILES[i];
const targetFile = `${iosPath}/${iosConstants_1.NSE_TARGET_NAME}/${extFile}`;
await FileManager_1.FileManager.copyFile(`${sourceDir}${extFile}`, targetFile);
}
// Copy NSE source file either from configuration-provided location, falling back to the default one.
const sourcePath = props.iosNSEFilePath ?? `${sourceDir}${iosConstants_1.NSE_SOURCE_FILE}`;
const targetFile = `${iosPath}/${iosConstants_1.NSE_TARGET_NAME}/${iosConstants_1.NSE_SOURCE_FILE}`;
await FileManager_1.FileManager.copyFile(`${sourcePath}`, targetFile);
/* MODIFY COPIED EXTENSION FILES */
const nseUpdater = new NseUpdaterManager_1.default(iosPath);
await nseUpdater.updateNSEEntitlements(`group.${config.ios?.bundleIdentifier}.Firebase`);
await nseUpdater.updateNSEBundleVersion(config.ios?.buildNumber ?? iosConstants_1.DEFAULT_BUNDLE_VERSION);
await nseUpdater.updateNSEBundleShortVersion(config?.version ?? iosConstants_1.DEFAULT_BUNDLE_SHORT_VERSION);
return config;
},
]);
};
const withFirebaseXcodeProject = (config, props) => {
return (0, config_plugins_1.withXcodeProject)(config, (newConfig) => {
const xcodeProject = newConfig.modResults;
if (!!xcodeProject.pbxTargetByName(iosConstants_1.NSE_TARGET_NAME)) {
FirebaseLog_1.FirebaseLog.log(`${iosConstants_1.NSE_TARGET_NAME} already exists in project. Skipping...`);
return newConfig;
}
// Create new PBXGroup for the extension
const extGroup = xcodeProject.addPbxGroup([...iosConstants_1.NSE_EXT_FILES, iosConstants_1.NSE_SOURCE_FILE], iosConstants_1.NSE_TARGET_NAME, iosConstants_1.NSE_TARGET_NAME);
// Add the new PBXGroup to the top level group. This makes the
// files / folder appear in the file explorer in Xcode.
const groups = xcodeProject.hash.project.objects["PBXGroup"];
Object.keys(groups).forEach(function (key) {
if (typeof groups[key] === "object" &&
groups[key].name === undefined &&
groups[key].path === undefined) {
xcodeProject.addToPbxGroup(extGroup.uuid, key);
}
});
// WORK AROUND for codeProject.addTarget BUG
// Xcode projects don't contain these if there is only one target
// An upstream fix should be made to the code referenced in this link:
// - https://github.com/apache/cordova-node-xcode/blob/8b98cabc5978359db88dc9ff2d4c015cba40f150/lib/pbxProject.js#L860
const projObjects = xcodeProject.hash.project.objects;
projObjects["PBXTargetDependency"] =
projObjects["PBXTargetDependency"] || {};
projObjects["PBXContainerItemProxy"] =
projObjects["PBXTargetDependency"] || {};
// Add the NSE target
// This adds PBXTargetDependency and PBXContainerItemProxy for you
const nseTarget = xcodeProject.addTarget(iosConstants_1.NSE_TARGET_NAME, "app_extension", iosConstants_1.NSE_TARGET_NAME, `${config.ios?.bundleIdentifier}.${iosConstants_1.NSE_TARGET_NAME}`);
// Add build phases to the new target
xcodeProject.addBuildPhase(["NotificationService.m"], "PBXSourcesBuildPhase", "Sources", nseTarget.uuid);
xcodeProject.addBuildPhase([], "PBXResourcesBuildPhase", "Resources", nseTarget.uuid);
xcodeProject.addBuildPhase([], "PBXFrameworksBuildPhase", "Frameworks", nseTarget.uuid);
// Edit the Deployment info of the new Target, only IphoneOS and Targeted Device Family
// However, can be more
const configurations = xcodeProject.pbxXCBuildConfigurationSection();
for (const key in configurations) {
if (typeof configurations[key].buildSettings !== "undefined" &&
configurations[key].buildSettings.PRODUCT_NAME == `"${iosConstants_1.NSE_TARGET_NAME}"`) {
const buildSettingsObj = configurations[key].buildSettings;
buildSettingsObj.DEVELOPMENT_TEAM = props?.devTeam;
buildSettingsObj.IPHONEOS_DEPLOYMENT_TARGET =
props?.iPhoneDeploymentTarget ?? iosConstants_1.IPHONEOS_DEPLOYMENT_TARGET;
buildSettingsObj.TARGETED_DEVICE_FAMILY = iosConstants_1.TARGETED_DEVICE_FAMILY;
buildSettingsObj.CODE_SIGN_ENTITLEMENTS = `${iosConstants_1.NSE_TARGET_NAME}/${iosConstants_1.NSE_TARGET_NAME}.entitlements`;
buildSettingsObj.CODE_SIGN_STYLE = "Automatic";
}
}
// Add development teams to both your target and the original project
xcodeProject.addTargetAttribute("DevelopmentTeam", props?.devTeam, nseTarget);
xcodeProject.addTargetAttribute("DevelopmentTeam", props?.devTeam);
return newConfig;
});
};
const withFirebaseIos = (config, props) => {
config = withAppEnvironment(config, props);
config = withRemoteNotificationsPermissions(config, props);
config = withAppGroupPermissions(config, props);
config = withFirebasePodfile(config, props);
config = withFirebaseNSE(config, props);
config = withFirebaseXcodeProject(config, props);
config = withEasManagedCredentials(config, props);
return config;
};
exports.withFirebaseIos = withFirebaseIos;