expo-build-properties 0.4.0 → 0.4.1

package/CHANGELOG.md

@@ -10,6 +10,12 @@
 
 ### 💡 Others
 
+## 0.4.1 — 2022-11-24
+
+### 🐛 Bug fixes
+
+- Fixed `extraProguardRules` be overwritten from multiple `withBuildProperties` execution. ([#20106](https://github.com/expo/expo/pull/20106) by [@kudo](https://github.com/kudo))
+
 ## 0.4.0 — 2022-10-25
 
 ### 🛠 Breaking changes

package/build/android.d.ts

@@ -1,15 +1,20 @@
-import { ConfigPlugin } from '@expo/config-plugins';
+import { ConfigPlugin } from 'expo/config-plugins';
 import type { PluginConfigType } from './pluginConfig';
 export declare const withAndroidBuildProperties: ConfigPlugin<PluginConfigType>;
 /**
  * Appends `props.android.extraProguardRules` content into `android/app/proguard-rules.pro`
  */
 export declare const withAndroidProguardRules: ConfigPlugin<PluginConfigType>;
+/**
+ * Purge generated proguard contents from previous prebuild.
+ * This plugin only runs once in the prebuilding phase and should execute before any `withAndroidProguardRules` calls.
+ */
+export declare const withAndroidPurgeProguardRulesOnce: ConfigPlugin;
 /**
  * Update `newProguardRules` to original `proguard-rules.pro` contents if needed
  *
  * @param contents the original `proguard-rules.pro` contents
- * @param newProguardRules new proguard rules to add. If the value is null, the generated proguard rules will be cleanup
- * @returns return string when results is updated or return null when nothing changed.
+ * @param newProguardRules new proguard rules to add. If the value is null, the returned value will be original `contents`.
+ * @returns return updated contents
  */
-export declare function updateAndroidProguardRules(contents: string, newProguardRules: string | null): string | null;
+export declare function updateAndroidProguardRules(contents: string, newProguardRules: string | null, updateMode: 'append' | 'overwrite'): string;

package/build/android.js

@@ -3,11 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateAndroidProguardRules = exports.withAndroidProguardRules = exports.withAndroidBuildProperties = void 0;
-const config_plugins_1 = require("@expo/config-plugins");
-const generateCode_1 = require("@expo/config-plugins/build/utils/generateCode");
+exports.updateAndroidProguardRules = exports.withAndroidPurgeProguardRulesOnce = exports.withAndroidProguardRules = exports.withAndroidBuildProperties = void 0;
+const config_plugins_1 = require("expo/config-plugins");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const fileContentsUtils_1 = require("./fileContentsUtils");
 const { createBuildGradlePropsConfigPlugin } = config_plugins_1.AndroidConfig.BuildProperties;
 exports.withAndroidBuildProperties = createBuildGradlePropsConfigPlugin([
     {
@@ -61,8 +61,8 @@ const withAndroidProguardRules = (config, props) => {
             const extraProguardRules = props.android?.extraProguardRules ?? null;
             const proguardRulesFile = path_1.default.join(config.modRequest.platformProjectRoot, 'app', 'proguard-rules.pro');
             const contents = await fs_1.default.promises.readFile(proguardRulesFile, 'utf8');
-            const newContents = updateAndroidProguardRules(contents, extraProguardRules);
-            if (newContents) {
+            const newContents = updateAndroidProguardRules(contents, extraProguardRules, 'append');
+            if (contents !== newContents) {
                 await fs_1.default.promises.writeFile(proguardRulesFile, newContents);
             }
             return config;
@@ -70,35 +70,70 @@ const withAndroidProguardRules = (config, props) => {
     ]);
 };
 exports.withAndroidProguardRules = withAndroidProguardRules;
+/**
+ * Purge generated proguard contents from previous prebuild.
+ * This plugin only runs once in the prebuilding phase and should execute before any `withAndroidProguardRules` calls.
+ */
+const withAndroidPurgeProguardRulesOnce = (config) => {
+    return (0, config_plugins_1.withDangerousMod)(config, [
+        'android',
+        async (config) => {
+            const RUN_ONCE_NAME = 'expo-build-properties-android-purge-proguard-rules-once';
+            /**
+             * The `withRunOnce` plugin will delay this plugin's execution.
+             * To make sure this plugin executes before any `withAndroidProguardRules`.
+             * We use the `withRunOnce` internal History functions to do the check.
+             * Example calls to demonstrate the case:
+             * ```ts
+             * config = withBuildProperties(config as ExpoConfig, {
+             *   android: {
+             *     kotlinVersion: "1.6.10",
+             *   },
+             * });
+             * config = withBuildProperties(config as ExpoConfig, {
+             *   android: {
+             *     enableProguardInReleaseBuilds: true,
+             *     extraProguardRules: "-keep class com.mycompany.** { *; }",
+             *   },
+             * });
+             * ```
+             */
+            if (config_plugins_1.History.getHistoryItem(config, RUN_ONCE_NAME)) {
+                return config;
+            }
+            else {
+                config_plugins_1.History.addHistoryItem(config, { name: RUN_ONCE_NAME });
+            }
+            const proguardRulesFile = path_1.default.join(config.modRequest.platformProjectRoot, 'app', 'proguard-rules.pro');
+            const contents = await fs_1.default.promises.readFile(proguardRulesFile, 'utf8');
+            const newContents = updateAndroidProguardRules(contents, '', 'overwrite');
+            if (contents !== newContents) {
+                await fs_1.default.promises.writeFile(proguardRulesFile, newContents);
+            }
+            return config;
+        },
+    ]);
+};
+exports.withAndroidPurgeProguardRulesOnce = withAndroidPurgeProguardRulesOnce;
 /**
  * Update `newProguardRules` to original `proguard-rules.pro` contents if needed
  *
  * @param contents the original `proguard-rules.pro` contents
- * @param newProguardRules new proguard rules to add. If the value is null, the generated proguard rules will be cleanup
- * @returns return string when results is updated or return null when nothing changed.
+ * @param newProguardRules new proguard rules to add. If the value is null, the returned value will be original `contents`.
+ * @returns return updated contents
  */
-function updateAndroidProguardRules(contents, newProguardRules) {
-    const mergeTag = 'expo-build-properties';
-    let mergeResults;
-    if (newProguardRules) {
-        mergeResults = (0, generateCode_1.mergeContents)({
-            tag: mergeTag,
-            src: contents,
-            newSrc: newProguardRules,
-            anchor: /^/,
-            offset: contents.length,
-            comment: '#',
-        });
+function updateAndroidProguardRules(contents, newProguardRules, updateMode) {
+    if (newProguardRules == null) {
+        return contents;
     }
-    else {
-        mergeResults = (0, generateCode_1.removeContents)({
-            tag: mergeTag,
-            src: contents,
-        });
+    const options = { tag: 'expo-build-properties', commentPrefix: '#' };
+    let newContents = contents;
+    if (updateMode === 'overwrite') {
+        newContents = (0, fileContentsUtils_1.purgeContents)(contents, options);
     }
-    if (mergeResults.didMerge || mergeResults.didClear) {
-        return mergeResults.contents;
+    if (newProguardRules !== '') {
+        newContents = (0, fileContentsUtils_1.appendContents)(newContents, newProguardRules, options);
     }
-    return null;
+    return newContents;
 }
 exports.updateAndroidProguardRules = updateAndroidProguardRules;

package/build/fileContentsUtils.d.ts

@@ -0,0 +1,28 @@
+/**
+ * A set of helper functions to update file contents. This is a simplified version to the config-plugins internal generateCode functions.
+ */
+/**
+ * Options for a generated section
+ */
+export interface SectionOptions {
+    /**
+     * A meaningful tag to differentiate the generated section
+     */
+    tag: string;
+    /**
+     * Defines comment for the generated code.
+     * E.g. '//' for js code or '#' for shell script
+     */
+    commentPrefix: string;
+}
+/**
+ * Append new contents to src with generated section comments
+ *
+ * If there is already a generated section, this function will append the new contents at the end of the section.
+ * Otherwise, this function will generate a new section at the end of file.
+ */
+export declare function appendContents(src: string, contents: string, sectionOptions: SectionOptions): string;
+/**
+ * Purge a generated section
+ */
+export declare function purgeContents(src: string, sectionOptions: SectionOptions): string;

package/build/fileContentsUtils.js

@@ -0,0 +1,60 @@
+"use strict";
+/**
+ * A set of helper functions to update file contents. This is a simplified version to the config-plugins internal generateCode functions.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.purgeContents = exports.appendContents = void 0;
+const assert_1 = __importDefault(require("assert"));
+/**
+ * Append new contents to src with generated section comments
+ *
+ * If there is already a generated section, this function will append the new contents at the end of the section.
+ * Otherwise, this function will generate a new section at the end of file.
+ */
+function appendContents(src, contents, sectionOptions) {
+    const start = createSectionComment(sectionOptions.commentPrefix, sectionOptions.tag, true);
+    const end = createSectionComment(sectionOptions.commentPrefix, sectionOptions.tag, false);
+    const regex = new RegExp(`(\\n${escapeRegExp(end)})`, 'gm');
+    const match = regex.exec(src);
+    if (match) {
+        (0, assert_1.default)(src.indexOf(start) >= 0);
+        return src.replace(regex, `\n${contents}$1`);
+    }
+    else {
+        const sectionedContents = `${start}\n${contents}\n${end}`;
+        return `${src}\n${sectionedContents}`;
+    }
+}
+exports.appendContents = appendContents;
+/**
+ * Purge a generated section
+ */
+function purgeContents(src, sectionOptions) {
+    const start = createSectionComment(sectionOptions.commentPrefix, sectionOptions.tag, true);
+    const end = createSectionComment(sectionOptions.commentPrefix, sectionOptions.tag, false);
+    const regex = new RegExp(`\\n${escapeRegExp(start)}\\n[\\s\\S]*\\n${escapeRegExp(end)}`, 'gm');
+    return src.replace(regex, '');
+}
+exports.purgeContents = purgeContents;
+/**
+ * Create comments for generated section
+ */
+function createSectionComment(commentPrefix, tag, isBeginComment) {
+    if (isBeginComment) {
+        return `${commentPrefix} @generated begin ${tag} - expo prebuild (DO NOT MODIFY)`;
+    }
+    else {
+        return `${commentPrefix} @generated end ${tag}`;
+    }
+}
+/**
+ * Escape a string for regular expression
+ *
+ * Reference from {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping}
+ */
+function escapeRegExp(input) {
+    return input.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+}

package/build/ios.d.ts

@@ -1,4 +1,4 @@
-import { ConfigPlugin } from '@expo/config-plugins';
+import { ConfigPlugin } from 'expo/config-plugins';
 import type { PluginConfigType } from './pluginConfig';
 export declare const withIosBuildProperties: ConfigPlugin<PluginConfigType>;
 export declare const withIosDeploymentTarget: ConfigPlugin<PluginConfigType>;

package/build/ios.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withIosDeploymentTarget = exports.withIosBuildProperties = void 0;
-const config_plugins_1 = require("@expo/config-plugins");
+const config_plugins_1 = require("expo/config-plugins");
 const { createBuildPodfilePropsConfigPlugin } = config_plugins_1.IOSConfig.BuildProperties;
 exports.withIosBuildProperties = createBuildPodfilePropsConfigPlugin([
     {

package/build/withBuildProperties.d.ts

@@ -1,4 +1,4 @@
-import type { ConfigPlugin } from '@expo/config-plugins';
+import type { ConfigPlugin } from 'expo/config-plugins';
 import { PluginConfigType } from './pluginConfig';
 /**
  * Config plugin to customize native Android or iOS build properties for managed apps

package/build/withBuildProperties.js

@@ -14,6 +14,13 @@ const withBuildProperties = (config, props) => {
     const pluginConfig = (0, pluginConfig_1.validateConfig)(props || {});
     config = (0, android_1.withAndroidBuildProperties)(config, pluginConfig);
     config = (0, android_1.withAndroidProguardRules)(config, pluginConfig);
+    // Assuming `withBuildProperties` could be called multiple times from different config-plugins,
+    // the `withAndroidProguardRules` always appends new rules by default.
+    // That is not ideal if we leave generated contents from previous prebuild there.
+    // The `withAndroidPurgeProguardRulesOnce` is for this purpose and it would only run once in prebuilding phase.
+    //
+    // plugins order matter: the later one would run first
+    config = (0, android_1.withAndroidPurgeProguardRulesOnce)(config);
     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.4.0",
+  "version": "0.4.1",
   "description": "Config plugin to customize native build properties on prebuild",
   "main": "build/withBuildProperties.js",
   "types": "build/withBuildProperties.d.ts",
@@ -43,5 +43,5 @@
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "eab2b09c735fb0fc2bf734a3f29a6593adba3838"
+  "gitHead": "1c5b1b798ecf9801a8004614140441c4d37f3935"
 }

package/src/android.ts

@@ -1,12 +1,8 @@
-import { AndroidConfig, ConfigPlugin, withDangerousMod } from '@expo/config-plugins';
-import {
-  mergeContents,
-  removeContents,
-  MergeResults,
-} from '@expo/config-plugins/build/utils/generateCode';
+import { AndroidConfig, ConfigPlugin, History, withDangerousMod } from 'expo/config-plugins';
 import fs from 'fs';
 import path from 'path';
 
+import { appendContents, purgeContents } from './fileContentsUtils';
 import type { PluginConfigType } from './pluginConfig';
 
 const { createBuildGradlePropsConfigPlugin } = AndroidConfig.BuildProperties;
@@ -72,8 +68,59 @@ export const withAndroidProguardRules: ConfigPlugin<PluginConfigType> = (config,
       );
 
       const contents = await fs.promises.readFile(proguardRulesFile, 'utf8');
-      const newContents = updateAndroidProguardRules(contents, extraProguardRules);
-      if (newContents) {
+      const newContents = updateAndroidProguardRules(contents, extraProguardRules, 'append');
+      if (contents !== newContents) {
+        await fs.promises.writeFile(proguardRulesFile, newContents);
+      }
+      return config;
+    },
+  ]);
+};
+
+/**
+ * Purge generated proguard contents from previous prebuild.
+ * This plugin only runs once in the prebuilding phase and should execute before any `withAndroidProguardRules` calls.
+ */
+export const withAndroidPurgeProguardRulesOnce: ConfigPlugin = (config) => {
+  return withDangerousMod(config, [
+    'android',
+    async (config) => {
+      const RUN_ONCE_NAME = 'expo-build-properties-android-purge-proguard-rules-once';
+
+      /**
+       * The `withRunOnce` plugin will delay this plugin's execution.
+       * To make sure this plugin executes before any `withAndroidProguardRules`.
+       * We use the `withRunOnce` internal History functions to do the check.
+       * Example calls to demonstrate the case:
+       * ```ts
+       * config = withBuildProperties(config as ExpoConfig, {
+       *   android: {
+       *     kotlinVersion: "1.6.10",
+       *   },
+       * });
+       * config = withBuildProperties(config as ExpoConfig, {
+       *   android: {
+       *     enableProguardInReleaseBuilds: true,
+       *     extraProguardRules: "-keep class com.mycompany.** { *; }",
+       *   },
+       * });
+       * ```
+       */
+      if (History.getHistoryItem(config, RUN_ONCE_NAME)) {
+        return config;
+      } else {
+        History.addHistoryItem(config, { name: RUN_ONCE_NAME });
+      }
+
+      const proguardRulesFile = path.join(
+        config.modRequest.platformProjectRoot,
+        'app',
+        'proguard-rules.pro'
+      );
+
+      const contents = await fs.promises.readFile(proguardRulesFile, 'utf8');
+      const newContents = updateAndroidProguardRules(contents, '', 'overwrite');
+      if (contents !== newContents) {
         await fs.promises.writeFile(proguardRulesFile, newContents);
       }
       return config;
@@ -85,34 +132,25 @@ export const withAndroidProguardRules: ConfigPlugin<PluginConfigType> = (config,
  * Update `newProguardRules` to original `proguard-rules.pro` contents if needed
  *
  * @param contents the original `proguard-rules.pro` contents
- * @param newProguardRules new proguard rules to add. If the value is null, the generated proguard rules will be cleanup
- * @returns return string when results is updated or return null when nothing changed.
+ * @param newProguardRules new proguard rules to add. If the value is null, the returned value will be original `contents`.
+ * @returns return updated contents
  */
 export function updateAndroidProguardRules(
   contents: string,
-  newProguardRules: string | null
-): string | null {
-  const mergeTag = 'expo-build-properties';
-
-  let mergeResults: MergeResults;
-  if (newProguardRules) {
-    mergeResults = mergeContents({
-      tag: mergeTag,
-      src: contents,
-      newSrc: newProguardRules,
-      anchor: /^/,
-      offset: contents.length,
-      comment: '#',
-    });
-  } else {
-    mergeResults = removeContents({
-      tag: mergeTag,
-      src: contents,
-    });
+  newProguardRules: string | null,
+  updateMode: 'append' | 'overwrite'
+): string {
+  if (newProguardRules == null) {
+    return contents;
   }
 
-  if (mergeResults.didMerge || mergeResults.didClear) {
-    return mergeResults.contents;
+  const options = { tag: 'expo-build-properties', commentPrefix: '#' };
+  let newContents = contents;
+  if (updateMode === 'overwrite') {
+    newContents = purgeContents(contents, options);
+  }
+  if (newProguardRules !== '') {
+    newContents = appendContents(newContents, newProguardRules, options);
   }
-  return null;
+  return newContents;
 }

package/src/fileContentsUtils.ts

@@ -0,0 +1,73 @@
+/**
+ * A set of helper functions to update file contents. This is a simplified version to the config-plugins internal generateCode functions.
+ */
+
+import assert from 'assert';
+
+/**
+ * Options for a generated section
+ */
+export interface SectionOptions {
+  /**
+   * A meaningful tag to differentiate the generated section
+   */
+  tag: string;
+
+  /**
+   * Defines comment for the generated code.
+   * E.g. '//' for js code or '#' for shell script
+   */
+  commentPrefix: string;
+}
+
+/**
+ * Append new contents to src with generated section comments
+ *
+ * If there is already a generated section, this function will append the new contents at the end of the section.
+ * Otherwise, this function will generate a new section at the end of file.
+ */
+export function appendContents(src: string, contents: string, sectionOptions: SectionOptions) {
+  const start = createSectionComment(sectionOptions.commentPrefix, sectionOptions.tag, true);
+  const end = createSectionComment(sectionOptions.commentPrefix, sectionOptions.tag, false);
+
+  const regex = new RegExp(`(\\n${escapeRegExp(end)})`, 'gm');
+  const match = regex.exec(src);
+  if (match) {
+    assert(src.indexOf(start) >= 0);
+    return src.replace(regex, `\n${contents}$1`);
+  } else {
+    const sectionedContents = `${start}\n${contents}\n${end}`;
+    return `${src}\n${sectionedContents}`;
+  }
+}
+
+/**
+ * Purge a generated section
+ */
+export function purgeContents(src: string, sectionOptions: SectionOptions) {
+  const start = createSectionComment(sectionOptions.commentPrefix, sectionOptions.tag, true);
+  const end = createSectionComment(sectionOptions.commentPrefix, sectionOptions.tag, false);
+
+  const regex = new RegExp(`\\n${escapeRegExp(start)}\\n[\\s\\S]*\\n${escapeRegExp(end)}`, 'gm');
+  return src.replace(regex, '');
+}
+
+/**
+ * Create comments for generated section
+ */
+function createSectionComment(commentPrefix: string, tag: string, isBeginComment: boolean) {
+  if (isBeginComment) {
+    return `${commentPrefix} @generated begin ${tag} - expo prebuild (DO NOT MODIFY)`;
+  } else {
+    return `${commentPrefix} @generated end ${tag}`;
+  }
+}
+
+/**
+ * Escape a string for regular expression
+ *
+ * Reference from {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping}
+ */
+function escapeRegExp(input: string) {
+  return input.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+}

package/src/ios.ts

@@ -1,4 +1,4 @@
-import { IOSConfig, ConfigPlugin, withXcodeProject, XcodeProject } from '@expo/config-plugins';
+import { IOSConfig, ConfigPlugin, withXcodeProject, XcodeProject } from 'expo/config-plugins';
 
 import type { PluginConfigType } from './pluginConfig';
 

package/src/withBuildProperties.ts

@@ -1,6 +1,10 @@
-import type { ConfigPlugin } from '@expo/config-plugins';
+import type { ConfigPlugin } from 'expo/config-plugins';
 
-import { withAndroidBuildProperties, withAndroidProguardRules } from './android';
+import {
+  withAndroidBuildProperties,
+  withAndroidProguardRules,
+  withAndroidPurgeProguardRulesOnce,
+} from './android';
 import { withIosBuildProperties, withIosDeploymentTarget } from './ios';
 import { PluginConfigType, validateConfig } from './pluginConfig';
 
@@ -14,7 +18,16 @@ export const withBuildProperties: ConfigPlugin<PluginConfigType> = (config, prop
   const pluginConfig = validateConfig(props || {});
 
   config = withAndroidBuildProperties(config, pluginConfig);
+
   config = withAndroidProguardRules(config, pluginConfig);
+  // Assuming `withBuildProperties` could be called multiple times from different config-plugins,
+  // the `withAndroidProguardRules` always appends new rules by default.
+  // That is not ideal if we leave generated contents from previous prebuild there.
+  // The `withAndroidPurgeProguardRulesOnce` is for this purpose and it would only run once in prebuilding phase.
+  //
+  // plugins order matter: the later one would run first
+  config = withAndroidPurgeProguardRulesOnce(config);
+
   config = withIosBuildProperties(config, pluginConfig);
   config = withIosDeploymentTarget(config, pluginConfig);