@expo/eas-json 0.30.0 → 0.34.0

package/src/DeprecatedConfig.types.ts

@@ -1,58 +0,0 @@
-import { Android, Cache, Ios } from '@expo/eas-build-job';
-
-export enum CredentialsSource {
-  LOCAL = 'local',
-  REMOTE = 'remote',
-}
-
-export type AndroidDistributionType = 'store' | 'internal';
-export type IosDistributionType = 'store' | 'internal' | 'simulator';
-export type DistributionType = AndroidDistributionType | IosDistributionType;
-
-export type IosEnterpriseProvisioning = 'adhoc' | 'universal';
-
-export type VersionAutoIncrement = boolean | 'version' | 'buildNumber';
-
-interface IosBuilderEnvironment extends Omit<Ios.BuilderEnvironment, 'image'> {
-  image?: Ios.BuilderEnvironment['image'];
-}
-
-export interface AndroidBuildProfile extends Android.BuilderEnvironment {
-  credentialsSource: CredentialsSource;
-  releaseChannel?: string;
-  channel?: string;
-  distribution: AndroidDistributionType;
-  cache: Cache;
-  withoutCredentials?: boolean;
-
-  buildType?: Android.BuildType;
-
-  gradleCommand?: string;
-  artifactPath?: string;
-}
-
-export interface IosBuildProfile extends IosBuilderEnvironment {
-  credentialsSource: CredentialsSource;
-  releaseChannel?: string;
-  channel?: string;
-  distribution: IosDistributionType;
-  enterpriseProvisioning?: IosEnterpriseProvisioning;
-  autoIncrement: VersionAutoIncrement;
-  cache: Cache;
-
-  artifactPath?: string;
-  scheme?: string;
-  schemeBuildConfiguration?: string;
-
-  buildType?: Ios.BuildType;
-}
-
-export type BuildProfile = AndroidBuildProfile | IosBuildProfile;
-
-// EasConfig represents eas.json with one specific profile
-export interface EasConfig {
-  builds: {
-    android?: AndroidBuildProfile;
-    ios?: IosBuildProfile;
-  };
-}

package/src/DeprecatedEasJsonReader.ts

@@ -1,190 +0,0 @@
-import { Platform, Workflow } from '@expo/eas-build-job';
-import fs from 'fs-extra';
-import path from 'path';
-
-import {
-  AndroidBuildProfile,
-  BuildProfile,
-  EasConfig,
-  IosBuildProfile,
-} from './DeprecatedConfig.types';
-import { EasJsonSchema, schemaBuildProfileMap } from './DeprecatedEasJsonSchema';
-
-export interface EasJson {
-  builds: {
-    android?: { [key: string]: BuildProfilePreValidation };
-    ios?: { [key: string]: BuildProfilePreValidation };
-  };
-}
-
-interface BuildProfilePreValidation {
-  workflow?: Workflow;
-  extends?: string;
-}
-
-function intersect<T>(setA: Set<T>, setB: Set<T>): Set<T> {
-  return new Set([...setA].filter(i => setB.has(i)));
-}
-
-export class EasJsonReader {
-  constructor(private projectDir: string, private platform: 'android' | 'ios' | 'all') {}
-
-  /**
-   * Return build profile names for a particular platform.
-   * If platform is 'all', return common build profiles for all platforms
-   */
-  public async getBuildProfileNamesAsync(): Promise<string[]> {
-    const easJson = await this.readRawAsync();
-    if (this.platform === 'android') {
-      return Object.keys(easJson?.builds?.android ?? {});
-    } else if (this.platform === 'ios') {
-      return Object.keys(easJson?.builds?.ios ?? {});
-    } else {
-      const intersectingProfileNames = intersect(
-        new Set(Object.keys(easJson?.builds?.ios ?? {})),
-        new Set(Object.keys(easJson?.builds?.android ?? {}))
-      );
-      return Array.from(intersectingProfileNames);
-    }
-  }
-
-  public async readAsync(buildProfileName: string): Promise<EasConfig> {
-    const easJson = await this.readRawAsync();
-
-    let androidConfig;
-    if (['android', 'all'].includes(this.platform)) {
-      androidConfig = this.validateBuildProfile<AndroidBuildProfile>(
-        Platform.ANDROID,
-        buildProfileName,
-        easJson.builds?.android || {}
-      );
-    }
-    let iosConfig;
-    if (['ios', 'all'].includes(this.platform)) {
-      iosConfig = this.validateBuildProfile<IosBuildProfile>(
-        Platform.IOS,
-        buildProfileName,
-        easJson.builds?.ios || {}
-      );
-    }
-    return {
-      builds: {
-        ...(androidConfig ? { android: androidConfig } : {}),
-        ...(iosConfig ? { ios: iosConfig } : {}),
-      },
-    };
-  }
-
-  public async validateAsync(): Promise<void> {
-    const easJson = await this.readRawAsync();
-
-    const androidProfiles = easJson.builds?.android ?? {};
-    for (const name of Object.keys(androidProfiles)) {
-      try {
-        this.validateBuildProfile(Platform.ANDROID, name, androidProfiles);
-      } catch (err: any) {
-        err.message = `Failed to validate Android build profile "${name}"\n${err.message}`;
-        throw err;
-      }
-    }
-    const iosProfiles = easJson.builds?.ios ?? {};
-    for (const name of Object.keys(iosProfiles)) {
-      try {
-        this.validateBuildProfile(Platform.IOS, name, iosProfiles);
-      } catch (err: any) {
-        err.message = `Failed to validate iOS build profile "${name}"\n${err.message}`;
-        throw err;
-      }
-    }
-  }
-
-  public async readRawAsync(): Promise<EasJson> {
-    const rawFile = await fs.readFile(path.join(this.projectDir, 'eas.json'), 'utf8');
-    const json = JSON.parse(rawFile);
-
-    const { value, error } = EasJsonSchema.validate(json, {
-      abortEarly: false,
-    });
-
-    if (error) {
-      throw new Error(`eas.json is not valid [${error.toString()}]`);
-    }
-    return value;
-  }
-
-  private validateBuildProfile<T extends BuildProfile>(
-    platform: Platform,
-    buildProfileName: string,
-    buildProfiles: Record<string, BuildProfilePreValidation>
-  ): T {
-    const buildProfile = this.resolveBuildProfile(platform, buildProfileName, buildProfiles);
-    const schema = schemaBuildProfileMap[platform];
-    const { value, error } = schema.validate(buildProfile, {
-      stripUnknown: true,
-      convert: true,
-      abortEarly: false,
-    });
-
-    if (error) {
-      throw new Error(
-        `Object "${platform}.${buildProfileName}" in eas.json is not valid [${error.toString()}]`
-      );
-    }
-    return value;
-  }
-
-  private resolveBuildProfile(
-    platform: Platform,
-    buildProfileName: string,
-    buildProfiles: Record<string, BuildProfilePreValidation>,
-    depth: number = 0
-  ): Record<string, any> {
-    if (depth >= 2) {
-      throw new Error(
-        'Too long chain of build profile extensions, make sure "extends" keys do not make a cycle'
-      );
-    }
-    const buildProfile = buildProfiles[buildProfileName];
-    if (!buildProfile) {
-      throw new Error(`There is no profile named ${buildProfileName} for platform ${platform}`);
-    }
-    const { extends: baseProfileName, ...buildProfileRest } = buildProfile;
-    if (baseProfileName) {
-      return deepMerge(
-        this.resolveBuildProfile(platform, baseProfileName, buildProfiles, depth + 1),
-        buildProfileRest
-      );
-    } else {
-      return buildProfileRest;
-    }
-  }
-}
-
-function isObject(value: any): boolean {
-  return typeof value === 'object' && value !== null;
-}
-
-export function deepMerge(
-  base: Record<string, any>,
-  update: Record<string, any>
-): Record<string, any> {
-  const result: Record<string, any> = {};
-  Object.keys(base).forEach(key => {
-    const oldValue = base[key];
-    const newValue = update[key];
-    if (isObject(newValue) && isObject(oldValue)) {
-      result[key] = deepMerge(oldValue, newValue);
-    } else if (newValue !== undefined) {
-      result[key] = isObject(newValue) ? deepMerge({}, newValue) : newValue;
-    } else {
-      result[key] = isObject(oldValue) ? deepMerge({}, oldValue) : oldValue;
-    }
-  });
-  Object.keys(update).forEach(key => {
-    const newValue = update[key];
-    if (result[key] === undefined) {
-      result[key] = isObject(newValue) ? deepMerge({}, newValue) : newValue;
-    }
-  });
-  return result;
-}

package/src/DeprecatedEasJsonSchema.ts

@@ -1,95 +0,0 @@
-import { Android, Ios } from '@expo/eas-build-job';
-import Joi, { CustomHelpers } from 'joi';
-
-const semverSchemaCheck = (value: any, helpers: CustomHelpers): any => {
-  if (/^[0-9]+\.[0-9]+\.[0-9]+$/.test(value)) {
-    return value;
-  } else {
-    throw new Error(`${value} is not a valid version`);
-  }
-};
-
-const AndroidBuilderEnvironmentSchema = Joi.object({
-  image: Joi.string()
-    .valid(...Android.builderBaseImages)
-    .default('default'),
-  node: Joi.string().empty(null).custom(semverSchemaCheck),
-  yarn: Joi.string().empty(null).custom(semverSchemaCheck),
-  ndk: Joi.string().empty(null).custom(semverSchemaCheck),
-  expoCli: Joi.string().empty(null).custom(semverSchemaCheck),
-  env: Joi.object().pattern(Joi.string(), Joi.string().empty(null)).default({}),
-});
-
-const IosBuilderEnvironmentSchema = Joi.object({
-  image: Joi.string().valid(...Ios.builderBaseImages),
-  node: Joi.string().empty(null).custom(semverSchemaCheck),
-  yarn: Joi.string().empty(null).custom(semverSchemaCheck),
-  bundler: Joi.string().empty(null).custom(semverSchemaCheck),
-  fastlane: Joi.string().empty(null).custom(semverSchemaCheck),
-  cocoapods: Joi.string().empty(null).custom(semverSchemaCheck),
-  expoCli: Joi.string().empty(null).custom(semverSchemaCheck),
-  env: Joi.object().pattern(Joi.string(), Joi.string().empty(null)).default({}),
-});
-
-const CacheSchema = Joi.object({
-  disabled: Joi.boolean().default(false),
-  key: Joi.string().max(128),
-  cacheDefaultPaths: Joi.boolean().default(true),
-  customPaths: Joi.array().items(Joi.string()).default([]),
-});
-
-const AndroidSchema = Joi.object({
-  workflow: Joi.string(),
-  credentialsSource: Joi.string().valid('local', 'remote').default('remote'),
-  releaseChannel: Joi.string(),
-  channel: Joi.string(),
-  distribution: Joi.string().valid('store', 'internal').default('store'),
-  cache: CacheSchema.default(),
-  withoutCredentials: Joi.boolean().default(false),
-
-  artifactPath: Joi.string(),
-  gradleCommand: Joi.string(),
-
-  buildType: Joi.alternatives().conditional('distribution', {
-    is: 'internal',
-    then: Joi.string().valid('apk', 'development-client'),
-    otherwise: Joi.string().valid('apk', 'app-bundle', 'development-client'),
-  }),
-}).concat(AndroidBuilderEnvironmentSchema);
-
-const IosSchema = Joi.object({
-  workflow: Joi.string(),
-  credentialsSource: Joi.string().valid('local', 'remote').default('remote'),
-  releaseChannel: Joi.string(),
-  channel: Joi.string(),
-  distribution: Joi.string().valid('store', 'internal', 'simulator').default('store'),
-  enterpriseProvisioning: Joi.string().valid('adhoc', 'universal'),
-  autoIncrement: Joi.alternatives()
-    .try(Joi.boolean(), Joi.string().valid('version', 'buildNumber'))
-    .default(false),
-  cache: CacheSchema.default(),
-
-  artifactPath: Joi.string(),
-  scheme: Joi.string(),
-  schemeBuildConfiguration: Joi.string(),
-
-  buildType: Joi.string().valid('release', 'development-client'),
-}).concat(IosBuilderEnvironmentSchema);
-
-export const schemaBuildProfileMap: Record<string, Joi.Schema> = {
-  android: AndroidSchema,
-  ios: IosSchema,
-};
-
-export const EasJsonSchema = Joi.object({
-  builds: Joi.object({
-    android: Joi.object().pattern(
-      Joi.string(),
-      Joi.object({}).unknown(true) // profile is validated further only if build is for that platform
-    ),
-    ios: Joi.object().pattern(
-      Joi.string(),
-      Joi.object({}).unknown(true) // profile is validated further only if build is for that platform
-    ),
-  }),
-});

package/src/__tests__/migrate-test.ts

@@ -1,297 +0,0 @@
-import { EasJson as DeprecatedEasJson } from '../DeprecatedEasJsonReader';
-import { migrateProfile } from '../migrate';
-
-test('migration for default manged eas.json', async () => {
-  const easJson = {
-    builds: {
-      android: {
-        release: {
-          buildType: 'app-bundle',
-        },
-        development: {
-          buildType: 'development-client',
-          distribution: 'internal',
-        },
-      },
-      ios: {
-        release: {
-          buildType: 'release',
-        },
-        development: {
-          buildType: 'development-client',
-          distribution: 'internal',
-        },
-      },
-    },
-  } as DeprecatedEasJson;
-  expect(migrateProfile(easJson, 'release')).toEqual({
-    android: {
-      buildType: 'app-bundle',
-    },
-  });
-  expect(migrateProfile(easJson, 'development')).toEqual({
-    developmentClient: true,
-    distribution: 'internal',
-  });
-});
-
-test('migration for default generic eas.json', async () => {
-  const easJson = {
-    builds: {
-      android: {
-        release: {
-          gradleCommand: ':app:bundleRelease',
-        },
-        development: {
-          gradleCommand: ':app:assembleDebug',
-          distribution: 'internal',
-        },
-      },
-      ios: {
-        release: {
-          schemeBuildConfiguration: 'Release',
-        },
-        development: {
-          schemeBuildConfiguration: 'Debug',
-          distribution: 'internal',
-        },
-      },
-    },
-  } as DeprecatedEasJson;
-  expect(migrateProfile(easJson, 'release')).toEqual({
-    android: {
-      gradleCommand: ':app:bundleRelease',
-    },
-    ios: {
-      buildConfiguration: 'Release',
-    },
-  });
-  expect(migrateProfile(easJson, 'development')).toEqual({
-    distribution: 'internal',
-    android: {
-      gradleCommand: ':app:assembleDebug',
-    },
-    ios: {
-      buildConfiguration: 'Debug',
-    },
-  });
-});
-
-test('migration for example manged eas.json', async () => {
-  const easJson = {
-    builds: {
-      android: {
-        base: {
-          image: 'default',
-          env: {
-            EXAMPLE_ENV: 'example value',
-          },
-        },
-        release: {
-          extends: 'base',
-          env: {
-            ENVIRONMENT: 'production',
-          },
-          buildType: 'app-bundle',
-        },
-        staging: {
-          extends: 'base',
-          env: {
-            ENVIRONMENT: 'staging',
-          },
-          distribution: 'internal',
-          buildType: 'apk',
-        },
-        debug: {
-          extends: 'base',
-          withoutCredentials: true,
-          env: {
-            ENVIRONMENT: 'staging',
-          },
-          distribution: 'internal',
-          buildType: 'development-client',
-        },
-      },
-      ios: {
-        base: {
-          image: 'latest',
-          node: '12.13.0',
-          yarn: '1.22.5',
-        },
-        release: {
-          extends: 'base',
-          buildType: 'release',
-          env: {
-            ENVIRONMENT: 'production',
-          },
-        },
-        inhouse: {
-          extends: 'base',
-          distribution: 'internal',
-          enterpriseProvisioning: 'universal',
-          env: {
-            ENVIRONMENT: 'staging',
-          },
-        },
-        adhoc: {
-          extends: 'base',
-          distribution: 'internal',
-          env: {
-            ENVIRONMENT: 'staging',
-          },
-        },
-        client: {
-          extends: 'adhoc',
-          buildType: 'development-client',
-        },
-      },
-    },
-  } as DeprecatedEasJson;
-  expect(migrateProfile(easJson, 'base')).toEqual({
-    android: {
-      env: {
-        EXAMPLE_ENV: 'example value',
-      },
-      image: 'default',
-    },
-    ios: {
-      image: 'latest',
-      node: '12.13.0',
-      yarn: '1.22.5',
-    },
-  });
-  expect(migrateProfile(easJson, 'release')).toEqual({
-    extends: 'base',
-    android: {
-      buildType: 'app-bundle',
-      env: {
-        ENVIRONMENT: 'production',
-      },
-    },
-    ios: {
-      env: {
-        ENVIRONMENT: 'production',
-      },
-    },
-  });
-  expect(migrateProfile(easJson, 'staging')).toEqual({
-    android: {
-      buildType: 'apk',
-      distribution: 'internal',
-      env: {
-        ENVIRONMENT: 'staging',
-      },
-    },
-  });
-  expect(migrateProfile(easJson, 'inhouse')).toEqual({
-    ios: {
-      distribution: 'internal',
-      enterpriseProvisioning: 'universal',
-      env: {
-        ENVIRONMENT: 'staging',
-      },
-    },
-  });
-});
-
-test('migration for example generic eas.json', async () => {
-  const easJson = {
-    builds: {
-      android: {
-        base: {
-          image: 'ubuntu-18.04-android-30-ndk-r19c',
-          ndk: '21.4.7075529',
-          env: {
-            EXAMPLE_ENV: 'example value',
-          },
-        },
-        release: {
-          extends: 'base',
-          env: {
-            ENVIRONMENT: 'production',
-          },
-          gradleCommand: ':app:bundleRelease',
-        },
-        staging: {
-          extends: 'base',
-          env: {
-            ENVIRONMENT: 'staging',
-          },
-          distribution: 'internal',
-          gradleCommand: ':app:assembleRelease',
-        },
-        debug: {
-          extends: 'base',
-          withoutCredentials: true,
-          env: {
-            ENVIRONMENT: 'staging',
-          },
-          distribution: 'internal',
-          gradleCommand: ':app:assembleDebug',
-        },
-      },
-      ios: {
-        base: {
-          image: 'latest',
-          node: '12.13.0',
-          yarn: '1.22.5',
-        },
-        release: {
-          extends: 'base',
-          schemeBuildConfiguration: 'Release',
-          scheme: 'testapp',
-          env: {
-            ENVIRONMENT: 'production',
-          },
-        },
-        inhouse: {
-          extends: 'base',
-          distribution: 'internal',
-          enterpriseProvisioning: 'universal',
-          scheme: 'testapp-enterprise',
-          env: {
-            ENVIRONMENT: 'staging',
-          },
-        },
-        adhoc: {
-          extends: 'base',
-          distribution: 'internal',
-          scheme: 'testapp',
-          env: {
-            ENVIRONMENT: 'staging',
-          },
-        },
-      },
-    },
-  } as DeprecatedEasJson;
-  expect(migrateProfile(easJson, 'base')).toEqual({
-    android: {
-      env: {
-        EXAMPLE_ENV: 'example value',
-      },
-      image: 'ubuntu-18.04-android-30-ndk-r19c',
-      ndk: '21.4.7075529',
-    },
-    ios: {
-      image: 'latest',
-      node: '12.13.0',
-      yarn: '1.22.5',
-    },
-  });
-  expect(migrateProfile(easJson, 'release')).toEqual({
-    extends: 'base',
-    android: {
-      env: {
-        ENVIRONMENT: 'production',
-      },
-      gradleCommand: ':app:bundleRelease',
-    },
-    ios: {
-      buildConfiguration: 'Release',
-      env: {
-        ENVIRONMENT: 'production',
-      },
-      scheme: 'testapp',
-    },
-  });
-});