[eas-cli][eas-json] add updates.channel to build metadata (#461)

expo · Jun 21, 2021 · be6a7f5 · be6a7f5
1 parent fff7aac
commit be6a7f5
Show file tree

Hide file tree

Showing 15 changed files with 366 additions and 48 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ This is the log of notable changes to EAS CLI and related packages.
 - Add Big Sur image for iOS builds. ([#457](https://github.com/expo/eas-cli/pull/457) by [@wkozyra95](https://github.com/wkozyra95))
 - New version of Android credentials manager ([#460](https://github.com/expo/eas-cli/pull/460) by [@quinlanj](https://github.com/quinlanj))
 - Add an internal distribution with dev client to `build:configure` defaults. ([#465](https://github.com/expo/eas-cli/pull/465) by [@fson](https://github.com/fson))
+- Add `updates.channel` to build metadata. ([#461](https://github.com/expo/eas-cli/pull/461) by [@jkhales](https://github.com/jkhales))
 
 ### 🐛 Bug fixes
 

diff --git a/packages/eas-cli/graphql.schema.json b/packages/eas-cli/graphql.schema.json
@@ -15644,11 +15644,11 @@
             "defaultValue": null
           },
           {
-            "name": "channel",
+            "name": "updates",
             "description": "",
             "type": {
-              "kind": "SCALAR",
-              "name": "String",
+              "kind": "INPUT_OBJECT",
+              "name": "BuildUpdatesInput",
               "ofType": null
             },
             "defaultValue": null
@@ -15776,6 +15776,27 @@
         ],
         "possibleTypes": null
       },
+      {
+        "kind": "INPUT_OBJECT",
+        "name": "BuildUpdatesInput",
+        "description": "",
+        "fields": null,
+        "inputFields": [
+          {
+            "name": "channel",
+            "description": "",
+            "type": {
+              "kind": "SCALAR",
+              "name": "String",
+              "ofType": null
+            },
+            "defaultValue": null
+          }
+        ],
+        "interfaces": null,
+        "enumValues": null,
+        "possibleTypes": null
+      },
       {
         "kind": "INPUT_OBJECT",
         "name": "AndroidJobSecretsInput",
@@ -16387,6 +16408,16 @@
             },
             "defaultValue": null
           },
+          {
+            "name": "updates",
+            "description": "",
+            "type": {
+              "kind": "INPUT_OBJECT",
+              "name": "BuildUpdatesInput",
+              "ofType": null
+            },
+            "defaultValue": null
+          },
           {
             "name": "secrets",
             "description": "",
@@ -16516,11 +16547,11 @@
             "defaultValue": null
           },
           {
-            "name": "channel",
+            "name": "updates",
             "description": "",
             "type": {
-              "kind": "SCALAR",
-              "name": "String",
+              "kind": "INPUT_OBJECT",
+              "name": "BuildUpdatesInput",
               "ofType": null
             },
             "defaultValue": null
@@ -16899,6 +16930,16 @@
             },
             "defaultValue": null
           },
+          {
+            "name": "updates",
+            "description": "",
+            "type": {
+              "kind": "INPUT_OBJECT",
+              "name": "BuildUpdatesInput",
+              "ofType": null
+            },
+            "defaultValue": null
+          },
           {
             "name": "distribution",
             "description": "",

diff --git a/packages/eas-cli/src/build/android/UpdatesModule.ts b/packages/eas-cli/src/build/android/UpdatesModule.ts
@@ -1,5 +1,5 @@
 import { ExpoConfig } from '@expo/config';
-import { AndroidConfig } from '@expo/config-plugins';
+import { AndroidConfig, AndroidManifest } from '@expo/config-plugins';
 import fs from 'fs-extra';
 
 import Log from '../../log';
@@ -22,12 +22,7 @@ export async function configureUpdatesAsync(projectDir: string, exp: ExpoConfig)
   }
 
   const androidManifestPath = await AndroidConfig.Paths.getAndroidManifestAsync(projectDir);
-  if (!androidManifestPath) {
-    throw new Error(`Could not find AndroidManifest.xml in project directory: "${projectDir}"`);
-  }
-  const androidManifest = await AndroidConfig.Manifest.readAndroidManifestAsync(
-    androidManifestPath
-  );
+  const androidManifest = await getAndroidManifestAsync(projectDir);
 
   if (!AndroidConfig.Updates.isMainApplicationMetaDataSynced(exp, androidManifest, accountName)) {
     const result = AndroidConfig.Updates.setUpdatesConfig(exp, androidManifest, accountName);
@@ -52,10 +47,7 @@ export async function syncUpdatesConfigurationAsync(
   }
 
   const androidManifestPath = await AndroidConfig.Paths.getAndroidManifestAsync(projectDir);
-  if (!androidManifestPath) {
-    throw new Error(`Could not find AndroidManifest.xml in project directory: "${projectDir}"`);
-  }
-  let androidManifest = await AndroidConfig.Manifest.readAndroidManifestAsync(androidManifestPath);
+  let androidManifest = await getAndroidManifestAsync(projectDir);
 
   if (!AndroidConfig.Updates.areVersionsSynced(exp, androidManifest)) {
     androidManifest = AndroidConfig.Updates.setVersionsConfig(exp, androidManifest);
@@ -78,13 +70,7 @@ async function ensureUpdatesConfiguredAsync(projectDir: string, exp: ExpoConfig)
     throw new Error(`Missing ${gradleScriptApply} in ${buildGradlePath}`);
   }
 
-  const androidManifestPath = await AndroidConfig.Paths.getAndroidManifestAsync(projectDir);
-  if (!androidManifestPath) {
-    throw new Error(`Could not find AndroidManifest.xml in project directory: "${projectDir}"`);
-  }
-  const androidManifest = await AndroidConfig.Manifest.readAndroidManifestAsync(
-    androidManifestPath
-  );
+  const androidManifest = await getAndroidManifestAsync(projectDir);
 
   if (!AndroidConfig.Updates.isMainApplicationMetaDataSet(androidManifest)) {
     throw new Error('Missing values in AndroidManifest.xml');
@@ -93,13 +79,7 @@ async function ensureUpdatesConfiguredAsync(projectDir: string, exp: ExpoConfig)
 
 export async function readReleaseChannelSafelyAsync(projectDir: string): Promise<string | null> {
   try {
-    const androidManifestPath = await AndroidConfig.Paths.getAndroidManifestAsync(projectDir);
-    if (!androidManifestPath) {
-      throw new Error(`Could not find AndroidManifest.xml in project directory: "${projectDir}"`);
-    }
-    const androidManifest = await AndroidConfig.Manifest.readAndroidManifestAsync(
-      androidManifestPath
-    );
+    const androidManifest = await getAndroidManifestAsync(projectDir);
     return AndroidConfig.Manifest.getMainApplicationMetaDataValue(
       androidManifest,
       AndroidConfig.Updates.Config.RELEASE_CHANNEL
@@ -108,3 +88,28 @@ export async function readReleaseChannelSafelyAsync(projectDir: string): Promise
     return null;
   }
 }
+
+export async function readChannelSafelyAsync(projectDir: string): Promise<string | null> {
+  try {
+    const androidManifest = await getAndroidManifestAsync(projectDir);
+    const stringifiedRequestHeaders = AndroidConfig.Manifest.getMainApplicationMetaDataValue(
+      androidManifest,
+      'expo.modules.updates.UPDATES_CONFIGURATION_REQUEST_HEADERS_KEY' //TODO-JJ AndroidConfig.Updates.Config.UPDATES_CONFIGURATION_REQUEST_HEADERS_KEY once https://github.com/expo/expo-cli/pull/3571 is published
+    );
+    if (!stringifiedRequestHeaders) {
+      return null;
+    }
+    return JSON.parse(stringifiedRequestHeaders)['expo-channel-name'] ?? null;
+  } catch (err) {
+    console.log({ err });
+    return null;
+  }
+}
+
+async function getAndroidManifestAsync(projectDir: string): Promise<AndroidManifest> {
+  const androidManifestPath = await AndroidConfig.Paths.getAndroidManifestAsync(projectDir);
+  if (!androidManifestPath) {
+    throw new Error(`Could not find AndroidManifest.xml in project directory: "${projectDir}"`);
+  }
+  return AndroidConfig.Manifest.readAndroidManifestAsync(androidManifestPath);
+}
diff --git a/packages/eas-cli/src/build/android/__tests__/UpdatesModule-test.ts b/packages/eas-cli/src/build/android/__tests__/UpdatesModule-test.ts
@@ -0,0 +1,108 @@
+import fs from 'fs-extra';
+import { vol } from 'memfs';
+import os from 'os';
+
+import { readChannelSafelyAsync } from '../UpdatesModule';
+
+jest.mock('fs');
+
+afterAll(() => {
+  // do not remove the following line
+  // this fixes a weird error with tempy in @expo/image-utils
+  fs.removeSync(os.tmpdir());
+});
+
+beforeEach(() => {
+  vol.reset();
+  // do not remove the following line
+  // this fixes a weird error with tempy in @expo/image-utils
+  fs.mkdirpSync(os.tmpdir());
+});
+
+const testChannel = 'test-channel';
+describe(readChannelSafelyAsync, () => {
+  it('retrieves the channel when it is defined natively', async () => {
+    vol.fromJSON(
+      {
+        './android/app/src/main/AndroidManifest.xml': AndroidManifestWithChannel,
+      },
+      '/expo-project'
+    );
+    const channel = await readChannelSafelyAsync('/expo-project');
+    expect(channel).toBe(testChannel);
+  });
+  it('returns null if the channel is not defined natively', async () => {
+    vol.fromJSON(
+      {
+        './android/app/src/main/AndroidManifest.xml': AndroidManifestNoChannel,
+      },
+      '/expo-project'
+    );
+    const channel = await readChannelSafelyAsync('/expo-project');
+    expect(channel).toBeNull();
+  });
+});
+
+const AndroidManifestWithChannel = `
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+  package="com.expo.mycoolapp">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+
+    <application
+      android:name=".MainApplication"
+      android:label="@string/app_name"
+      android:icon="@mipmap/ic_launcher"
+      android:roundIcon="@mipmap/ic_launcher_round"
+      android:allowBackup="true"
+      android:theme="@style/AppTheme">
+      <meta-data android:name="expo.modules.updates.UPDATES_CONFIGURATION_REQUEST_HEADERS_KEY" android:value='{"expo-channel-name":"${testChannel}"}'/>
+
+      <activity
+        android:name=".MainActivity"
+        android:launchMode="singleTask"
+        android:label="@string/app_name"
+        android:configChanges="keyboard|keyboardHidden|orientation|screenSize"
+        android:windowSoftInputMode="adjustResize">
+        <intent-filter>
+            <action android:name="android.intent.action.MAIN" />
+            <category android:name="android.intent.category.LAUNCHER" />
+        </intent-filter>
+      </activity>
+      <activity android:name="com.facebook.react.devsupport.DevSettingsActivity" />
+    </application>
+
+
+</manifest>
+`;
+const AndroidManifestNoChannel = `
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+  package="com.expo.mycoolapp">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+
+    <application
+      android:name=".MainApplication"
+      android:label="@string/app_name"
+      android:icon="@mipmap/ic_launcher"
+      android:roundIcon="@mipmap/ic_launcher_round"
+      android:allowBackup="true"
+      android:theme="@style/AppTheme">
+
+      <activity
+        android:name=".MainActivity"
+        android:launchMode="singleTask"
+        android:label="@string/app_name"
+        android:configChanges="keyboard|keyboardHidden|orientation|screenSize"
+        android:windowSoftInputMode="adjustResize">
+        <intent-filter>
+            <action android:name="android.intent.action.MAIN" />
+            <category android:name="android.intent.category.LAUNCHER" />
+        </intent-filter>
+      </activity>
+      <activity android:name="com.facebook.react.devsupport.DevSettingsActivity" />
+    </application>
+
+
+</manifest>
+`;
diff --git a/packages/eas-cli/src/build/android/graphql.ts b/packages/eas-cli/src/build/android/graphql.ts
@@ -12,6 +12,7 @@ export function transformGenericJob(job: Android.GenericJob): AndroidGenericJobI
     projectArchive: transformProjectArchive(job.projectArchive),
     projectRootDirectory: job.projectRootDirectory,
     releaseChannel: job.releaseChannel,
+    updates: job.updates,
     secrets: job.secrets,
     builderEnvironment: job.builderEnvironment,
     cache: job.cache,
@@ -25,6 +26,7 @@ export function transformManagedJob(job: Android.ManagedJob): AndroidManagedJobI
     projectArchive: transformProjectArchive(job.projectArchive),
     projectRootDirectory: job.projectRootDirectory,
     releaseChannel: job.releaseChannel,
+    updates: job.updates,
     secrets: job.secrets,
     builderEnvironment: job.builderEnvironment,
     cache: job.cache,

diff --git a/packages/eas-cli/src/build/android/prepareJob.ts b/packages/eas-cli/src/build/android/prepareJob.ts
@@ -93,6 +93,7 @@ async function prepareGenericJobAsync(
     gradleCommand: buildProfile.gradleCommand,
     artifactPath: buildProfile.artifactPath,
     releaseChannel: buildProfile.releaseChannel,
+    updates: { channel: buildProfile.channel },
     projectRootDirectory,
   };
 }
@@ -111,6 +112,7 @@ async function prepareManagedJobAsync(
     username,
     buildType: buildProfile.buildType,
     releaseChannel: buildProfile.releaseChannel,
+    updates: { channel: buildProfile.channel },
     projectRootDirectory,
   };
 }
diff --git a/packages/eas-cli/src/build/ios/UpdatesModule.ts b/packages/eas-cli/src/build/ios/UpdatesModule.ts
@@ -95,3 +95,13 @@ export async function readReleaseChannelSafelyAsync(projectDir: string): Promise
     return null;
   }
 }
+
+export async function readChannelSafelyAsync(projectDir: string): Promise<string | null> {
+  try {
+    const expoPlist: any = await readExpoPlistAsync(projectDir); // TODO-JJ remove any once IOSConfig.ExpoPlist is updated to include `EXUpdatesRequestHeaders : Record<string,string>`
+    const updatesRequestHeaders = expoPlist['EXUpdatesRequestHeaders'] ?? {}; //TODO-JJ 'EXUpdatesRequestHeaders' IosConfig.Updates.Config.UPDATES_CONFIGURATION_REQUEST_HEADERS_KEY once https://github.com/expo/expo-cli/pull/3571 is published
+    return updatesRequestHeaders['expo-channel-name'] ?? null;
+  } catch (err) {
+    return null;
+  }
+}