@expo/eas-json 0.36.0 → 0.38.3

package/src/__tests__/{EasJsonReader-build-test.ts → reader-build-test.ts}

@@ -2,7 +2,7 @@ import { Platform } from '@expo/eas-build-job';
 import fs from 'fs-extra';
 import { vol } from 'memfs';
 
-import { EasJsonReader } from '../EasJsonReader';
+import { EasJsonReader } from '../reader';
 
 jest.mock('fs');
 
@@ -19,18 +19,18 @@ test('minimal valid eas.json for both platforms', async () => {
   });
 
   const reader = new EasJsonReader('/project');
-  const iosProfile = await reader.readBuildProfileAsync(Platform.IOS, 'production');
-  const androidProfile = await reader.readBuildProfileAsync(Platform.ANDROID, 'production');
+  const iosProfile = await reader.getBuildProfileAsync(Platform.IOS, 'production');
+  const androidProfile = await reader.getBuildProfileAsync(Platform.ANDROID, 'production');
 
-  expect({
+  expect(androidProfile).toEqual({
     distribution: 'store',
     credentialsSource: 'remote',
-  }).toEqual(androidProfile);
+  });
 
-  expect({
+  expect(iosProfile).toEqual({
     distribution: 'store',
     credentialsSource: 'remote',
-  }).toEqual(iosProfile);
+  });
 });
 
 test('valid eas.json for development client builds', async () => {
@@ -47,20 +47,20 @@ test('valid eas.json for development client builds', async () => {
   });
 
   const reader = new EasJsonReader('/project');
-  const iosProfile = await reader.readBuildProfileAsync(Platform.IOS, 'debug');
-  const androidProfile = await reader.readBuildProfileAsync(Platform.ANDROID, 'debug');
-  expect({
+  const iosProfile = await reader.getBuildProfileAsync(Platform.IOS, 'debug');
+  const androidProfile = await reader.getBuildProfileAsync(Platform.ANDROID, 'debug');
+  expect(androidProfile).toEqual({
     credentialsSource: 'remote',
     distribution: 'store',
     developmentClient: true,
     withoutCredentials: true,
-  }).toEqual(androidProfile);
+  });
 
-  expect({
+  expect(iosProfile).toEqual({
     credentialsSource: 'remote',
     distribution: 'store',
     developmentClient: true,
-  }).toEqual(iosProfile);
+  });
 });
 
 test('valid profile for internal distribution on Android', async () => {
@@ -73,11 +73,11 @@ test('valid profile for internal distribution on Android', async () => {
   });
 
   const reader = new EasJsonReader('/project');
-  const profile = await reader.readBuildProfileAsync(Platform.ANDROID, 'internal');
-  expect({
+  const profile = await reader.getBuildProfileAsync(Platform.ANDROID, 'internal');
+  expect(profile).toEqual({
     distribution: 'internal',
     credentialsSource: 'remote',
-  }).toEqual(profile);
+  });
 });
 
 test('valid profile extending other profile', async () => {
@@ -95,18 +95,18 @@ test('valid profile extending other profile', async () => {
   });
 
   const reader = new EasJsonReader('/project');
-  const baseProfile = await reader.readBuildProfileAsync(Platform.ANDROID, 'base');
-  const extendedProfile = await reader.readBuildProfileAsync(Platform.ANDROID, 'extension');
-  expect({
+  const baseProfile = await reader.getBuildProfileAsync(Platform.ANDROID, 'base');
+  const extendedProfile = await reader.getBuildProfileAsync(Platform.ANDROID, 'extension');
+  expect(baseProfile).toEqual({
     distribution: 'store',
     credentialsSource: 'remote',
     node: '12.0.0',
-  }).toEqual(baseProfile);
-  expect({
+  });
+  expect(extendedProfile).toEqual({
     distribution: 'internal',
     credentialsSource: 'remote',
     node: '13.0.0',
-  }).toEqual(extendedProfile);
+  });
 });
 
 test('valid profile extending other profile with platform specific envs', async () => {
@@ -134,33 +134,33 @@ test('valid profile extending other profile with platform specific envs', async
   });
 
   const reader = new EasJsonReader('/project');
-  const baseProfile = await reader.readBuildProfileAsync(Platform.ANDROID, 'base');
-  const extendedAndroidProfile = await reader.readBuildProfileAsync(Platform.ANDROID, 'extension');
-  const extendedIosProfile = await reader.readBuildProfileAsync(Platform.IOS, 'extension');
-  expect({
+  const baseProfile = await reader.getBuildProfileAsync(Platform.ANDROID, 'base');
+  const extendedAndroidProfile = await reader.getBuildProfileAsync(Platform.ANDROID, 'extension');
+  const extendedIosProfile = await reader.getBuildProfileAsync(Platform.IOS, 'extension');
+  expect(baseProfile).toEqual({
     distribution: 'store',
     credentialsSource: 'remote',
     env: {
       BASE_ENV: '1',
       PROFILE: 'base',
     },
-  }).toEqual(baseProfile);
-  expect({
+  });
+  expect(extendedAndroidProfile).toEqual({
     distribution: 'internal',
     credentialsSource: 'remote',
     env: {
       BASE_ENV: '1',
       PROFILE: 'extension:android',
     },
-  }).toEqual(extendedAndroidProfile);
-  expect({
+  });
+  expect(extendedIosProfile).toEqual({
     distribution: 'internal',
     credentialsSource: 'remote',
     env: {
       BASE_ENV: '1',
       PROFILE: 'extension',
     },
-  }).toEqual(extendedIosProfile);
+  });
 });
 
 test('valid profile extending other profile with platform specific caching', async () => {
@@ -188,32 +188,32 @@ test('valid profile extending other profile with platform specific caching', asy
   });
 
   const reader = new EasJsonReader('/project');
-  const baseProfile = await reader.readBuildProfileAsync(Platform.ANDROID, 'base');
-  const extendedAndroidProfile = await reader.readBuildProfileAsync(Platform.ANDROID, 'extension');
-  const extendedIosProfile = await reader.readBuildProfileAsync(Platform.IOS, 'extension');
-  expect({
+  const baseProfile = await reader.getBuildProfileAsync(Platform.ANDROID, 'base');
+  const extendedAndroidProfile = await reader.getBuildProfileAsync(Platform.ANDROID, 'extension');
+  const extendedIosProfile = await reader.getBuildProfileAsync(Platform.IOS, 'extension');
+  expect(baseProfile).toEqual({
     distribution: 'store',
     credentialsSource: 'remote',
     cache: {
       disabled: true,
     },
-  }).toEqual(baseProfile);
-  expect({
+  });
+  expect(extendedAndroidProfile).toEqual({
     distribution: 'internal',
     credentialsSource: 'remote',
     cache: {
       cacheDefaultPaths: false,
       customPaths: ['somefakepath'],
     },
-  }).toEqual(extendedAndroidProfile);
-  expect({
+  });
+  expect(extendedIosProfile).toEqual({
     distribution: 'internal',
     credentialsSource: 'remote',
 
     cache: {
       key: 'extend-key',
     },
-  }).toEqual(extendedIosProfile);
+  });
 });
 
 test('valid eas.json with missing profile', async () => {
@@ -224,8 +224,8 @@ test('valid eas.json with missing profile', async () => {
   });
 
   const reader = new EasJsonReader('/project');
-  const promise = reader.readBuildProfileAsync(Platform.ANDROID, 'debug');
-  await expect(promise).rejects.toThrowError('There is no profile named debug in eas.json');
+  const promise = reader.getBuildProfileAsync(Platform.ANDROID, 'debug');
+  await expect(promise).rejects.toThrowError('Missing build profile in eas.json: debug');
 });
 
 test('invalid eas.json when using wrong buildType', async () => {
@@ -236,7 +236,7 @@ test('invalid eas.json when using wrong buildType', async () => {
   });
 
   const reader = new EasJsonReader('/project');
-  const promise = reader.readBuildProfileAsync(Platform.ANDROID, 'production');
+  const promise = reader.getBuildProfileAsync(Platform.ANDROID, 'production');
   await expect(promise).rejects.toThrowError(
     'eas.json is not valid [ValidationError: "build.production.android.buildType" must be one of [apk, app-bundle]]'
   );
@@ -246,8 +246,8 @@ test('empty json', async () => {
   await fs.writeJson('/project/eas.json', {});
 
   const reader = new EasJsonReader('/project');
-  const promise = reader.readBuildProfileAsync(Platform.ANDROID, 'production');
-  await expect(promise).rejects.toThrowError('There is no profile named production in eas.json');
+  const promise = reader.getBuildProfileAsync(Platform.ANDROID, 'production');
+  await expect(promise).rejects.toThrowError('Missing build profile in eas.json: production');
 });
 
 test('invalid semver value', async () => {
@@ -258,17 +258,29 @@ test('invalid semver value', async () => {
   });
 
   const reader = new EasJsonReader('/project');
-  const promise = reader.readBuildProfileAsync(Platform.ANDROID, 'production');
+  const promise = reader.getBuildProfileAsync(Platform.ANDROID, 'production');
   await expect(promise).rejects.toThrowError(
     'eas.json is not valid [ValidationError: "build.production.node" failed custom validation because 12.0.0-alpha is not a valid version]'
   );
 });
 
+test('invalid release channel', async () => {
+  await fs.writeJson('/project/eas.json', {
+    build: {
+      production: { releaseChannel: 'feature/myfeature' },
+    },
+  });
+
+  const reader = new EasJsonReader('/project');
+  const promise = reader.getBuildProfileAsync(Platform.ANDROID, 'production');
+  await expect(promise).rejects.toThrowError(/fails to match the required pattern/);
+});
+
 test('get profile names', async () => {
   await fs.writeJson('/project/eas.json', {
     build: {
-      production: { node: '12.0.0-alpha' },
-      blah: { node: '12.0.0-alpha' },
+      production: { node: '12.0.0' },
+      blah: { node: '12.0.0' },
     },
   });
 

package/src/__tests__/{EasJsonReader-submit-test.ts → reader-submit-test.ts}

@@ -2,7 +2,7 @@ import { Platform } from '@expo/eas-build-job';
 import fs from 'fs-extra';
 import { vol } from 'memfs';
 
-import { EasJsonReader } from '../EasJsonReader';
+import { EasJsonReader } from '../reader';
 
 jest.mock('fs');
 
@@ -19,8 +19,8 @@ test('minimal allowed eas.json for both platforms', async () => {
   });
 
   const reader = new EasJsonReader('/project');
-  const iosProfile = await reader.readSubmitProfileAsync(Platform.IOS, 'production');
-  const androidProfile = await reader.readSubmitProfileAsync(Platform.ANDROID, 'production');
+  const iosProfile = await reader.getSubmitProfileAsync(Platform.IOS, 'production');
+  const androidProfile = await reader.getSubmitProfileAsync(Platform.ANDROID, 'production');
 
   expect(androidProfile).toEqual({
     changesNotSentForReview: false,
@@ -46,7 +46,7 @@ test('android config with all required values', async () => {
   });
 
   const reader = new EasJsonReader('/project');
-  const androidProfile = await reader.readSubmitProfileAsync(Platform.ANDROID, 'production');
+  const androidProfile = await reader.getSubmitProfileAsync(Platform.ANDROID, 'production');
 
   expect(androidProfile).toEqual({
     serviceAccountKeyPath: './path.json',
@@ -72,7 +72,7 @@ test('android config with serviceAccountKeyPath set to env var', async () => {
   try {
     process.env.GOOGLE_SERVICE_ACCOUNT = './path.json';
     const reader = new EasJsonReader('/project');
-    const androidProfile = await reader.readSubmitProfileAsync(Platform.ANDROID, 'production');
+    const androidProfile = await reader.getSubmitProfileAsync(Platform.ANDROID, 'production');
 
     expect(androidProfile).toEqual({
       serviceAccountKeyPath: './path.json',
@@ -102,7 +102,7 @@ test('ios config with all required values', async () => {
   });
 
   const reader = new EasJsonReader('/project');
-  const iosProfile = await reader.readSubmitProfileAsync(Platform.IOS, 'production');
+  const iosProfile = await reader.getSubmitProfileAsync(Platform.IOS, 'production');
 
   expect(iosProfile).toEqual({
     appleId: 'some@email.com',
@@ -136,7 +136,7 @@ test('ios config with ascApiKey fields set to env var', async () => {
     process.env.ASC_API_KEY_ISSUER_ID = 'abc-123-def-456';
     process.env.ASC_API_KEY_ID = 'ABCD';
     const reader = new EasJsonReader('/project');
-    const iosProfile = await reader.readSubmitProfileAsync(Platform.IOS, 'release');
+    const iosProfile = await reader.getSubmitProfileAsync(Platform.IOS, 'release');
 
     expect(iosProfile).toEqual({
       appleId: 'some@email.com',
@@ -153,3 +153,45 @@ test('ios config with ascApiKey fields set to env var', async () => {
     process.env.ASC_API_KEY_ID = undefined;
   }
 });
+
+test('valid profile extending other profile', async () => {
+  await fs.writeJson('/project/eas.json', {
+    submit: {
+      base: {
+        ios: {
+          appleId: 'some@email.com',
+          ascAppId: '1223423523',
+          appleTeamId: 'QWERTY',
+        },
+      },
+      extension: {
+        extends: 'base',
+        ios: {
+          appleTeamId: 'ABCDEF',
+          ascApiKeyPath: './path-ABCD.p8',
+          ascApiKeyIssuerId: 'abc-123-def-456',
+          ascApiKeyId: 'ABCD',
+        },
+      },
+    },
+  });
+
+  const reader = new EasJsonReader('/project');
+  const baseProfile = await reader.getSubmitProfileAsync(Platform.IOS, 'base');
+  const extendedProfile = await reader.getSubmitProfileAsync(Platform.IOS, 'extension');
+  expect(baseProfile).toEqual({
+    language: 'en-US',
+    appleId: 'some@email.com',
+    ascAppId: '1223423523',
+    appleTeamId: 'QWERTY',
+  });
+  expect(extendedProfile).toEqual({
+    language: 'en-US',
+    appleId: 'some@email.com',
+    ascAppId: '1223423523',
+    appleTeamId: 'ABCDEF',
+    ascApiKeyPath: './path-ABCD.p8',
+    ascApiKeyIssuerId: 'abc-123-def-456',
+    ascApiKeyId: 'ABCD',
+  });
+});

package/src/build/resolver.ts

@@ -0,0 +1,97 @@
+import { Platform } from '@expo/eas-build-job';
+
+import { MissingParentProfileError, MissingProfileError } from '../errors';
+import { EasJson } from '../types';
+import { BuildProfileSchema } from './schema';
+import { BuildProfile, EasJsonBuildProfile } from './types';
+
+type EasJsonBuildProfileResolved = Omit<EasJsonBuildProfile, 'extends'>;
+
+export function resolveBuildProfile<T extends Platform>({
+  easJson,
+  platform,
+  profileName,
+}: {
+  easJson: EasJson;
+  platform: T;
+  profileName: string;
+}): BuildProfile<T> {
+  const easJsonProfile = resolveProfile({
+    easJson,
+    profileName,
+  });
+  const { android, ios, ...base } = easJsonProfile;
+  const withoutDefaults = mergeProfiles(base, easJsonProfile[platform] ?? {});
+  return mergeProfiles(getDefaultProfile(platform), withoutDefaults) as BuildProfile<T>;
+}
+
+function resolveProfile({
+  easJson,
+  profileName,
+  depth = 0,
+}: {
+  easJson: EasJson;
+  profileName: string;
+  depth?: number;
+}): EasJsonBuildProfileResolved {
+  if (depth >= 2) {
+    throw new Error(
+      'Too long chain of profile extensions, make sure "extends" keys do not make a cycle'
+    );
+  }
+
+  const profile = easJson.build?.[profileName];
+  if (!profile) {
+    if (depth === 0) {
+      throw new MissingProfileError(`Missing build profile in eas.json: ${profileName}`);
+    } else {
+      throw new MissingParentProfileError(
+        `Extending non-existent build profile in eas.json: ${profileName}`
+      );
+    }
+  }
+
+  const { extends: baseProfileName, ...rest } = profile;
+  if (baseProfileName) {
+    const baseProfile = resolveProfile({
+      easJson,
+      profileName: baseProfileName,
+      depth: depth + 1,
+    });
+    return mergeProfiles(baseProfile, rest);
+  } else {
+    return rest;
+  }
+}
+
+function mergeProfiles(
+  base: EasJsonBuildProfileResolved,
+  update: EasJsonBuildProfileResolved
+): EasJsonBuildProfileResolved {
+  const result = {
+    ...base,
+    ...update,
+  };
+  if (base.env && update.env) {
+    result.env = {
+      ...base.env,
+      ...update.env,
+    };
+  }
+  if (base.android && update.android) {
+    result.android = mergeProfiles(base.android, update.android);
+  }
+  if (base.ios && update.ios) {
+    result.ios = mergeProfiles(base.ios, update.ios);
+  }
+  return result;
+}
+
+function getDefaultProfile<T extends Platform>(platform: T): EasJsonBuildProfile {
+  const defaultProfile = BuildProfileSchema.validate(
+    {},
+    { allowUnknown: false, abortEarly: false, convert: true }
+  ).value;
+  const { android, ios, ...base } = defaultProfile;
+  return mergeProfiles(base, defaultProfile[platform]);
+}

package/src/{EasJsonSchema.ts → build/schema.ts}

@@ -1,16 +1,6 @@
 import { Android, Ios } from '@expo/eas-build-job';
 import Joi from 'joi';
 
-import { AndroidReleaseStatus, AndroidReleaseTrack } from './EasSubmit.types';
-
-const semverSchemaCheck = (value: any): any => {
-  if (/^[0-9]+\.[0-9]+\.[0-9]+$/.test(value)) {
-    return value;
-  } else {
-    throw new Error(`${value} is not a valid version`);
-  }
-};
-
 const CacheSchema = Joi.object({
   disabled: Joi.boolean(),
   key: Joi.string().max(128),
@@ -19,11 +9,11 @@ const CacheSchema = Joi.object({
 });
 
 const CommonBuildProfileSchema = Joi.object({
-  credentialsSource: Joi.string().valid('local', 'remote'),
-  distribution: Joi.string().valid('store', 'internal'),
+  credentialsSource: Joi.string().valid('local', 'remote').default('remote'),
+  distribution: Joi.string().valid('store', 'internal').default('store'),
   cache: CacheSchema,
-  releaseChannel: Joi.string(),
-  channel: Joi.string(),
+  releaseChannel: Joi.string().regex(/^[a-z\d][a-z\d._-]*$/),
+  channel: Joi.string().regex(/^[a-z\d][a-z\d._-]*$/),
   developmentClient: Joi.boolean(),
 
   node: Joi.string().empty(null).custom(semverSchemaCheck),
@@ -34,6 +24,8 @@ const CommonBuildProfileSchema = Joi.object({
 
 const AndroidBuildProfileSchema = CommonBuildProfileSchema.concat(
   Joi.object({
+    credentialsSource: Joi.string().valid('local', 'remote'),
+    distribution: Joi.string().valid('store', 'internal'),
     withoutCredentials: Joi.boolean(),
 
     image: Joi.string().valid(...Android.builderBaseImages),
@@ -52,6 +44,8 @@ const AndroidBuildProfileSchema = CommonBuildProfileSchema.concat(
 
 const IosBuildProfileSchema = CommonBuildProfileSchema.concat(
   Joi.object({
+    credentialsSource: Joi.string().valid('local', 'remote'),
+    distribution: Joi.string().valid('store', 'internal'),
     enterpriseProvisioning: Joi.string().valid('adhoc', 'universal'),
     autoIncrement: Joi.alternatives().try(
       Joi.boolean(),
@@ -70,7 +64,7 @@ const IosBuildProfileSchema = CommonBuildProfileSchema.concat(
   })
 );
 
-const EasJsonBuildProfileSchema = CommonBuildProfileSchema.concat(
+export const BuildProfileSchema = CommonBuildProfileSchema.concat(
   Joi.object({
     extends: Joi.string(),
     android: AndroidBuildProfileSchema,
@@ -78,48 +72,10 @@ const EasJsonBuildProfileSchema = CommonBuildProfileSchema.concat(
   })
 );
 
-export const AndroidSubmitProfileSchema = Joi.object({
-  serviceAccountKeyPath: Joi.string(),
-  track: Joi.string()
-    .valid(...Object.values(AndroidReleaseTrack))
-    .default(AndroidReleaseTrack.internal),
-  releaseStatus: Joi.string()
-    .valid(...Object.values(AndroidReleaseStatus))
-    .default(AndroidReleaseStatus.completed),
-  changesNotSentForReview: Joi.boolean().default(false),
-});
-
-export const IosSubmitProfileSchema = Joi.object({
-  ascApiKeyPath: Joi.string(),
-  ascApiKeyId: Joi.string(),
-  ascApiKeyIssuerId: Joi.string(),
-  appleId: Joi.string(),
-  ascAppId: Joi.string(),
-  appleTeamId: Joi.string(),
-  sku: Joi.string(),
-  language: Joi.string().default('en-US'),
-  companyName: Joi.string(),
-  appName: Joi.string(),
-});
-
-const EasJsonSubmitConfigurationSchema = Joi.object({
-  android: AndroidSubmitProfileSchema,
-  ios: IosSubmitProfileSchema,
-});
-
-export const CliConfigSchema = Joi.object({
-  version: Joi.string(),
-  requireCommit: Joi.boolean(),
-});
-
-export const MinimalEasJsonSchema = Joi.object({
-  cli: Joi.object(),
-  build: Joi.object().pattern(Joi.string(), Joi.object()),
-  submit: Joi.object().pattern(Joi.string(), Joi.object()),
-});
-
-export const EasJsonSchema = Joi.object({
-  cli: CliConfigSchema,
-  build: Joi.object().pattern(Joi.string(), EasJsonBuildProfileSchema),
-  submit: Joi.object().pattern(Joi.string(), EasJsonSubmitConfigurationSchema),
-});
+function semverSchemaCheck(value: any): any {
+  if (/^[0-9]+\.[0-9]+\.[0-9]+$/.test(value)) {
+    return value;
+  } else {
+    throw new Error(`${value} is not a valid version`);
+  }
+}

package/src/{EasBuild.types.ts → build/types.ts}

@@ -55,8 +55,10 @@ export interface IosBuildProfile extends CommonBuildProfile {
 
 export type BuildProfile<TPlatform extends Platform = Platform> = TPlatform extends Platform.ANDROID
   ? AndroidBuildProfile
-  : TPlatform extends Platform.IOS
-  ? IosBuildProfile
-  : TPlatform extends Platform
-  ? AndroidBuildProfile | IosBuildProfile
-  : never;
+  : IosBuildProfile;
+
+export interface EasJsonBuildProfile extends Partial<CommonBuildProfile> {
+  extends?: string;
+  [Platform.ANDROID]?: Partial<AndroidBuildProfile>;
+  [Platform.IOS]?: Partial<IosBuildProfile>;
+}

package/src/errors.ts

@@ -1 +1,7 @@
 export class InvalidEasJsonError extends Error {}
+
+export class MissingEasJsonError extends Error {}
+
+export class MissingProfileError extends Error {}
+
+export class MissingParentProfileError extends Error {}

package/src/index.ts

@@ -1,20 +1,13 @@
+export { AndroidReleaseStatus, AndroidReleaseTrack, SubmitProfile } from './submit/types';
+export { getDefaultProfile as getDefaultSubmitProfile } from './submit/resolver';
+export { EasJson, ProfileType } from './types';
 export {
-  AndroidSubmitProfile,
-  AndroidReleaseStatus,
-  AndroidReleaseTrack,
-  IosSubmitProfile,
-  SubmitProfile,
-} from './EasSubmit.types';
-export { EasJson } from './EasJson.types';
-export {
-  AndroidBuildProfile,
+  AndroidVersionAutoIncrement,
   BuildProfile,
   CredentialsSource,
   DistributionType,
-  IosBuildProfile,
   IosEnterpriseProvisioning,
   IosVersionAutoIncrement,
-  AndroidVersionAutoIncrement,
-} from './EasBuild.types';
-export { EasJsonReader } from './EasJsonReader';
+} from './build/types';
+export { EasJsonReader } from './reader';
 export * as errors from './errors';