expo-build-properties 0.5.0 → 0.5.1

package/CHANGELOG.md

@@ -10,6 +10,12 @@
 
 ### 💡 Others
 
+## 0.5.1 — 2023-02-09
+
+### 🎉 New features
+
+- Add support for enabling [Flipper](https://fbflipper.com/) as bundled with react-native. ([#20890](https://github.com/expo/expo/pull/20861) by [@jakobo](https://github.com/jakobo))
+
 ## 0.5.0 — 2023-02-03
 
 ### 🎉 New features

package/README.md

@@ -27,10 +27,12 @@ Add plugin to `app.json`. For example:
           "android": {
             "compileSdkVersion": 31,
             "targetSdkVersion": 31,
-            "buildToolsVersion": "31.0.0"
+            "buildToolsVersion": "31.0.0",
+            "flipper": true
           },
           "ios": {
-            "deploymentTarget": "13.0"
+            "deploymentTarget": "13.0",
+            "flipper": true
           }
         }
       ]
@@ -41,7 +43,7 @@ Add plugin to `app.json`. For example:
 
 ## Contributing
 
-Contributions are very welcome! Please refer to guidelines described in the [contributing guide][contributing].
+Contributions are very welcome! Please refer to guidelines described in the [contributing guide][../../contributing.md].
 
 [docs-main]: https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/build-properties.mdx
 [docs-stable]: https://docs.expo.dev/versions/latest/sdk/build-properties/

package/build/android.d.ts

@@ -1,6 +1,7 @@
 import { ConfigPlugin } from 'expo/config-plugins';
 import type { PluginConfigType } from './pluginConfig';
 export declare const withAndroidBuildProperties: ConfigPlugin<PluginConfigType>;
+export declare const withAndroidFlipper: ConfigPlugin<PluginConfigType>;
 /**
  * Appends `props.android.extraProguardRules` content into `android/app/proguard-rules.pro`
  */

package/build/android.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateAndroidProguardRules = exports.withAndroidPurgeProguardRulesOnce = exports.withAndroidProguardRules = exports.withAndroidBuildProperties = void 0;
+exports.updateAndroidProguardRules = exports.withAndroidPurgeProguardRulesOnce = exports.withAndroidProguardRules = exports.withAndroidFlipper = exports.withAndroidBuildProperties = void 0;
 const config_plugins_1 = require("expo/config-plugins");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
@@ -55,6 +55,31 @@ exports.withAndroidBuildProperties = createBuildGradlePropsConfigPlugin([
         propValueGetter: (config) => config.android?.enableProguardInReleaseBuilds?.toString(),
     },
 ], 'withAndroidBuildProperties');
+const withAndroidFlipper = (config, props) => {
+    const ANDROID_FLIPPER_KEY = 'FLIPPER_VERSION';
+    const FLIPPER_FALLBACK = '0.125.0';
+    // when not set, make no changes
+    if (props.android?.flipper === undefined) {
+        return config;
+    }
+    return (0, config_plugins_1.withGradleProperties)(config, (c) => {
+        // check for Flipper version in package. If set, use that
+        let existing;
+        const found = c.modResults.find((item) => item.type === 'property' && item.key === ANDROID_FLIPPER_KEY);
+        if (found && found.type === 'property') {
+            existing = found.value;
+        }
+        // strip key and re-add based on setting
+        c.modResults = c.modResults.filter((item) => !(item.type === 'property' && item.key === ANDROID_FLIPPER_KEY));
+        c.modResults.push({
+            type: 'property',
+            key: ANDROID_FLIPPER_KEY,
+            value: (props.android?.flipper ?? existing ?? FLIPPER_FALLBACK),
+        });
+        return c;
+    });
+};
+exports.withAndroidFlipper = withAndroidFlipper;
 /**
  * Appends `props.android.extraProguardRules` content into `android/app/proguard-rules.pro`
  */

package/build/ios.js

@@ -12,6 +12,15 @@ exports.withIosBuildProperties = createBuildPodfilePropsConfigPlugin([
         propName: 'ios.useFrameworks',
         propValueGetter: (config) => config.ios?.useFrameworks,
     },
+    {
+        propName: 'ios.flipper',
+        propValueGetter: (config) => {
+            if (typeof config.ios?.flipper === 'string' || typeof config.ios?.flipper === 'boolean') {
+                return config.ios.flipper.toString();
+            }
+            return undefined;
+        },
+    },
 ], 'withIosBuildProperties');
 const withIosDeploymentTarget = (config, props) => {
     const deploymentTarget = props.ios?.deploymentTarget;

package/build/pluginConfig.d.ts

@@ -54,6 +54,13 @@ export interface PluginConfigTypeAndroid {
      * Interface representing available configuration for Android Gradle plugin [PackagingOptions](https://developer.android.com/reference/tools/gradle-api/7.0/com/android/build/api/dsl/PackagingOptions).
      */
     packagingOptions?: PluginConfigTypeAndroidPackagingOptions;
+    /**
+     * Change the [Flipper](https://fbflipper.com/) version when running your app on Android.
+     * Flipper is by default enabled with the version that comes bundled with react-native.
+     * However, you can set the `flipper` property to a semver string and specify an
+     * alternate Flipper version.
+     */
+    flipper?: string;
 }
 /**
  * Interface representing available configuration for iOS native build properties.
@@ -73,8 +80,20 @@ export interface PluginConfigTypeIos {
     /**
      * Enable [`use_frameworks!`](https://guides.cocoapods.org/syntax/podfile.html#use_frameworks_bang)
      * in `Podfile` to use frameworks instead of static libraries for Pods.
+     *
+     * Note: You cannot use `useFrameworks` and `flipper` at the same time
      */
     useFrameworks?: 'static' | 'dynamic';
+    /**
+     * Enable [Flipper](https://fbflipper.com/) when running your app on iOS in
+     * Debug mode. Setting `true` enables the default version of Flipper, while
+     * setting a semver string will enable a specific version of Flipper you've
+     * declared in your package.json. The default for this configuration is `false`.
+     *
+     * Note: You cannot use `flipper` at the same time as `useFrameworks`, and
+     * doing so will generate an error.
+     */
+    flipper?: boolean | string;
 }
 /**
  * Interface representing available configuration for Android Gradle plugin [PackagingOptions](https://developer.android.com/reference/tools/gradle-api/7.0/com/android/build/api/dsl/PackagingOptions).

package/build/pluginConfig.js

@@ -35,6 +35,10 @@ const schema = {
                 kotlinVersion: { type: 'string', nullable: true },
                 enableProguardInReleaseBuilds: { type: 'boolean', nullable: true },
                 extraProguardRules: { type: 'string', nullable: true },
+                flipper: {
+                    type: 'string',
+                    nullable: true,
+                },
                 packagingOptions: {
                     type: 'object',
                     properties: {
@@ -54,6 +58,10 @@ const schema = {
                 newArchEnabled: { type: 'boolean', nullable: true },
                 deploymentTarget: { type: 'string', pattern: '\\d+\\.\\d+', nullable: true },
                 useFrameworks: { type: 'string', enum: ['static', 'dynamic'], nullable: true },
+                flipper: {
+                    type: ['boolean', 'string'],
+                    nullable: true,
+                },
             },
             nullable: true,
         },
@@ -112,11 +120,16 @@ function maybeThrowInvalidVersions(config) {
  * @ignore
  */
 function validateConfig(config) {
-    const validate = new ajv_1.default().compile(schema);
+    const validate = new ajv_1.default({ allowUnionTypes: true }).compile(schema);
     if (!validate(config)) {
         throw new Error('Invalid expo-build-properties config: ' + JSON.stringify(validate.errors));
     }
     maybeThrowInvalidVersions(config);
+    // explicitly block using use_frameworks and Flipper in iOS
+    // https://github.com/facebook/flipper/issues/2414
+    if (config?.ios?.flipper !== undefined && config?.ios?.useFrameworks !== undefined) {
+        throw new Error('`ios.flipper` cannot be enabled when `ios.useFrameworks` is set.');
+    }
     return config;
 }
 exports.validateConfig = validateConfig;

package/build/withBuildProperties.js

@@ -20,6 +20,7 @@ const withBuildProperties = (config, props) => {
     //
     // plugins order matter: the later one would run first
     config = (0, android_1.withAndroidPurgeProguardRulesOnce)(config);
+    config = (0, android_1.withAndroidFlipper)(config, pluginConfig);
     config = (0, ios_1.withIosBuildProperties)(config, pluginConfig);
     config = (0, ios_1.withIosDeploymentTarget)(config, pluginConfig);
     return config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-build-properties",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Config plugin to customize native build properties on prebuild",
   "main": "build/withBuildProperties.js",
   "types": "build/withBuildProperties.d.ts",
@@ -40,5 +40,5 @@
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "1815e2eaad8c753588c7b1eb74420174a28e01f4"
+  "gitHead": "1f8a6a09570fd451378565ca34933018ce48454e"
 }

package/src/android.ts

@@ -1,4 +1,10 @@
-import { AndroidConfig, ConfigPlugin, History, withDangerousMod } from 'expo/config-plugins';
+import {
+  AndroidConfig,
+  ConfigPlugin,
+  History,
+  withDangerousMod,
+  withGradleProperties,
+} from 'expo/config-plugins';
 import fs from 'fs';
 import path from 'path';
 
@@ -57,6 +63,41 @@ export const withAndroidBuildProperties = createBuildGradlePropsConfigPlugin<Plu
   'withAndroidBuildProperties'
 );
 
+export const withAndroidFlipper: ConfigPlugin<PluginConfigType> = (config, props) => {
+  const ANDROID_FLIPPER_KEY = 'FLIPPER_VERSION';
+  const FLIPPER_FALLBACK = '0.125.0';
+
+  // when not set, make no changes
+  if (props.android?.flipper === undefined) {
+    return config;
+  }
+
+  return withGradleProperties(config, (c) => {
+    // check for Flipper version in package. If set, use that
+    let existing: string | undefined;
+
+    const found = c.modResults.find(
+      (item) => item.type === 'property' && item.key === ANDROID_FLIPPER_KEY
+    );
+    if (found && found.type === 'property') {
+      existing = found.value;
+    }
+
+    // strip key and re-add based on setting
+    c.modResults = c.modResults.filter(
+      (item) => !(item.type === 'property' && item.key === ANDROID_FLIPPER_KEY)
+    );
+
+    c.modResults.push({
+      type: 'property',
+      key: ANDROID_FLIPPER_KEY,
+      value: (props.android?.flipper ?? existing ?? FLIPPER_FALLBACK) as string,
+    });
+
+    return c;
+  });
+};
+
 /**
  * Appends `props.android.extraProguardRules` content into `android/app/proguard-rules.pro`
  */

package/src/ios.ts

@@ -14,6 +14,15 @@ export const withIosBuildProperties = createBuildPodfilePropsConfigPlugin<Plugin
       propName: 'ios.useFrameworks',
       propValueGetter: (config) => config.ios?.useFrameworks,
     },
+    {
+      propName: 'ios.flipper',
+      propValueGetter: (config) => {
+        if (typeof config.ios?.flipper === 'string' || typeof config.ios?.flipper === 'boolean') {
+          return config.ios.flipper.toString();
+        }
+        return undefined;
+      },
+    },
   ],
   'withIosBuildProperties'
 );

package/src/pluginConfig.ts

@@ -74,6 +74,14 @@ export interface PluginConfigTypeAndroid {
    * Interface representing available configuration for Android Gradle plugin [PackagingOptions](https://developer.android.com/reference/tools/gradle-api/7.0/com/android/build/api/dsl/PackagingOptions).
    */
   packagingOptions?: PluginConfigTypeAndroidPackagingOptions;
+
+  /**
+   * Change the [Flipper](https://fbflipper.com/) version when running your app on Android.
+   * Flipper is by default enabled with the version that comes bundled with react-native.
+   * However, you can set the `flipper` property to a semver string and specify an
+   * alternate Flipper version.
+   */
+  flipper?: string;
 }
 
 /**
@@ -91,11 +99,25 @@ export interface PluginConfigTypeIos {
    *  - `PBXNativeTarget` with "com.apple.product-type.application" `productType` in the app project.
    */
   deploymentTarget?: string;
+
   /**
    * Enable [`use_frameworks!`](https://guides.cocoapods.org/syntax/podfile.html#use_frameworks_bang)
    * in `Podfile` to use frameworks instead of static libraries for Pods.
+   *
+   * Note: You cannot use `useFrameworks` and `flipper` at the same time
    */
   useFrameworks?: 'static' | 'dynamic';
+
+  /**
+   * Enable [Flipper](https://fbflipper.com/) when running your app on iOS in
+   * Debug mode. Setting `true` enables the default version of Flipper, while
+   * setting a semver string will enable a specific version of Flipper you've
+   * declared in your package.json. The default for this configuration is `false`.
+   *
+   * Note: You cannot use `flipper` at the same time as `useFrameworks`, and
+   * doing so will generate an error.
+   */
+  flipper?: boolean | string;
 }
 
 /**
@@ -137,6 +159,11 @@ const schema: JSONSchemaType<PluginConfigType> = {
         enableProguardInReleaseBuilds: { type: 'boolean', nullable: true },
         extraProguardRules: { type: 'string', nullable: true },
 
+        flipper: {
+          type: 'string',
+          nullable: true,
+        },
+
         packagingOptions: {
           type: 'object',
           properties: {
@@ -156,6 +183,11 @@ const schema: JSONSchemaType<PluginConfigType> = {
         newArchEnabled: { type: 'boolean', nullable: true },
         deploymentTarget: { type: 'string', pattern: '\\d+\\.\\d+', nullable: true },
         useFrameworks: { type: 'string', enum: ['static', 'dynamic'], nullable: true },
+
+        flipper: {
+          type: ['boolean', 'string'],
+          nullable: true,
+        },
       },
       nullable: true,
     },
@@ -221,11 +253,18 @@ function maybeThrowInvalidVersions(config: PluginConfigType) {
  * @ignore
  */
 export function validateConfig(config: any): PluginConfigType {
-  const validate = new Ajv().compile(schema);
+  const validate = new Ajv({ allowUnionTypes: true }).compile(schema);
   if (!validate(config)) {
     throw new Error('Invalid expo-build-properties config: ' + JSON.stringify(validate.errors));
   }
 
   maybeThrowInvalidVersions(config);
+
+  // explicitly block using use_frameworks and Flipper in iOS
+  // https://github.com/facebook/flipper/issues/2414
+  if (config?.ios?.flipper !== undefined && config?.ios?.useFrameworks !== undefined) {
+    throw new Error('`ios.flipper` cannot be enabled when `ios.useFrameworks` is set.');
+  }
+
   return config;
 }

package/src/withBuildProperties.ts

@@ -4,6 +4,7 @@ import {
   withAndroidBuildProperties,
   withAndroidProguardRules,
   withAndroidPurgeProguardRulesOnce,
+  withAndroidFlipper,
 } from './android';
 import { withIosBuildProperties, withIosDeploymentTarget } from './ios';
 import { PluginConfigType, validateConfig } from './pluginConfig';
@@ -27,6 +28,7 @@ export const withBuildProperties: ConfigPlugin<PluginConfigType> = (config, prop
   // plugins order matter: the later one would run first
   config = withAndroidPurgeProguardRulesOnce(config);
 
+  config = withAndroidFlipper(config, pluginConfig);
   config = withIosBuildProperties(config, pluginConfig);
   config = withIosDeploymentTarget(config, pluginConfig);