feat(appflow): Support downloading all artifact types from appflow builds

Author: jlane9

packages/@ionic/cli/src/commands/package/build.ts

@@ -22,6 +22,9 @@ const ANDROID_BUILD_TYPES = ['debug', 'release'];
 const IOS_BUILD_TYPES = ['development', 'ad-hoc', 'app-store', 'enterprise'];
 const APP_STORE_COMPATIBLE_TYPES = ['release', 'app-store', 'enterprise'];
 const BUILD_TYPES = ANDROID_BUILD_TYPES.concat(IOS_BUILD_TYPES);
+const ANDROID_ARTIFACT_TYPES = ['aab', 'apk'];
+const IOS_ARTIFACT_TYPES = ['ipa', 'dsym'];
+const ARTIFACT_TYPES = ANDROID_ARTIFACT_TYPES.concat(IOS_ARTIFACT_TYPES);
 const TARGET_PLATFORM = ['Android', 'iOS - Xcode 11 (Preferred)', 'iOS - Xcode 10'];
 
 export interface PackageBuild {
@@ -74,6 +77,12 @@ Customizing the build:
 Deploying the build to an App Store:
 - The ${input('--destination')} option can be used to deliver the app created by the build to the configured App Store. \
 This can be used only together with build type ${input('release')} for Android and build types ${input('app-store')} or ${input('enterprise')} for iOS.
+
+Downloading build artifacts:
+- By default once the build is complete, all artifacts are downloaded for the selected platform. ${input('aab')} and ${input('apk')} for Android \
+${input('ipa')} and ${input('dsym')} for iOS.
+- The ${input('--artifact-type')} option can be used to limit artifact downloads to only of that type. For instance, with Android, you can specify ${input('aab')} \
+if you do not wish to download ${input('apk')}.
 `,
       footnotes: [
         {
@@ -87,8 +96,10 @@ This can be used only together with build type ${input('release')} for Android a
         'android debug --environment="My Custom Environment Name"',
         'android debug --native-config="My Custom Native Config Name"',
         'android debug --commit=2345cd3305a1cf94de34e93b73a932f25baac77c',
+        'android debug --artifact-type=aab',
+        'android debug --aab-name="my-app-prod.aab" --apk-name="my-app-prod.apk"',
         'ios development --signing-certificate="iOS Signing Certificate Name" --build-stack="iOS - Xcode 9"',
-        'ios development --signing-certificate="iOS Signing Certificate Name" --build-file-name=my_custom_file_name.ipa',
+        'ios development --signing-certificate="iOS Signing Certificate Name" --ipa-name=my_custom_file_name.ipa',
         'ios app-store --signing-certificate="iOS Signing Certificate Name" --destination="Apple App Store Destination"',
       ],
       inputs: [
@@ -146,9 +157,43 @@ This can be used only together with build type ${input('release')} for Android a
           name: 'build-file-name',
           summary: 'The name for the downloaded build file',
           type: String,
+          groups: [MetadataGroup.DEPRECATED],
+          spec: { value: 'name' },
+        },
+        {
+          name: 'ipa-name',
+          summary: 'The name for the downloaded ipa file',
+          type: String,
           groups: [MetadataGroup.ADVANCED],
           spec: { value: 'name' },
         },
+        {
+          name: 'dsym-name',
+          summary: 'The name for the downloaded dsym file',
+          type: String,
+          groups: [MetadataGroup.ADVANCED],
+          spec: { value: 'name' },
+        },
+        {
+          name: 'apk-name',
+          summary: 'The name for the downloaded apk file',
+          type: String,
+          groups: [MetadataGroup.ADVANCED],
+          spec: { value: 'name' },
+        },
+        {
+          name: 'aab-name',
+          summary: 'The name for the downloaded aab file',
+          type: String,
+          groups: [MetadataGroup.ADVANCED],
+          spec: { value: 'name' },
+        },
+        {
+          name: 'artifact-type',
+          summary: `The artifact type (${ARTIFACT_TYPES.map(v => input(v)).join(', ')})`,
+          type: String,
+          spec: { value: 'name' },
+        },
       ],
     };
   }
@@ -169,14 +214,14 @@ This can be used only together with build type ${input('release')} for Android a
     const buildTypes = inputs[0] === 'ios' ? IOS_BUILD_TYPES : ANDROID_BUILD_TYPES;
 
     // validate that the build type is valid for the platform
-    let reenterBuilType = false;
+    let reenterBuildType = false;
     if (inputs[1] && !buildTypes.includes(inputs[1])) {
-      reenterBuilType = true;
+      reenterBuildType = true;
       this.env.log.nl();
       this.env.log.warn(`Build type ${strong(inputs[1])} incompatible for ${strong(inputs[0])}; please choose a correct one`);
     }
 
-    if (!inputs[1] || reenterBuilType) {
+    if (!inputs[1] || reenterBuildType) {
       const typeInput = await this.env.prompt({
         type: 'list',
         name: 'type',
@@ -218,6 +263,26 @@ This can be used only together with build type ${input('release')} for Android a
     if (options['destination'] && !APP_STORE_COMPATIBLE_TYPES.includes(inputs[1])) {
       throw new FatalException(`Build with type ${strong(String(inputs[1]))} cannot be deployed to App Store`);
     }
+
+    if (options['artifact-type'] && (Array.isArray(options['artifact-type']) || typeof options['artifact-type'] === 'string')) {
+      const artifactTypes = Array.isArray(options['artifact-type']) ? options['artifact-type'] : [options['artifact-type']];
+      let unsupported: string[];
+
+      switch (inputs[0]) {
+        case 'android':
+          unsupported = artifactTypes.filter(type => !ANDROID_ARTIFACT_TYPES.includes(type));
+          break;
+        case 'ios':
+          unsupported = artifactTypes.filter(type => !IOS_ARTIFACT_TYPES.includes(type));
+          break;
+        default:
+          throw new FatalException(`Unsupported platform ${inputs[0]}`);
+      }
+
+      if (unsupported.length) {
+        throw new FatalException(`Unsupported artifact types for platform ${inputs[0]}: ${[...unsupported]}`);
+      }
+    }
   }
 
   async run(inputs: CommandLineInputs, options: CommandLineOptions): Promise<void> {
@@ -228,6 +293,16 @@ This can be used only together with build type ${input('release')} for Android a
     const token = await this.env.session.getUserToken();
     const appflowId = await this.project.requireAppflowId();
     const [ platform, buildType ] = inputs;
+    let artifactTypes;
+
+    if (Array.isArray(options['artifact-type'])) {
+      artifactTypes = options['artifact-type'].map(val => val.toUpperCase());
+    } else if (typeof options['artifact-type'] == 'string' && ARTIFACT_TYPES.includes(options['artifact-type'])) {
+      artifactTypes = [options['artifact-type'].toUpperCase()]
+    } else {
+      const useOriginalDefault = !!(options['build-file-name']);
+      artifactTypes = await this.getDefaultArtifactType(platform, useOriginalDefault);
+    }
 
     if (!options.commit) {
       options.commit = (await this.env.shell.output('git', ['rev-parse', 'HEAD'], { cwd: this.project.directory })).trim();
@@ -237,20 +312,13 @@ This can be used only together with build type ${input('release')} for Android a
     let build = await this.createPackageBuild(appflowId, token, platform, buildType, options);
     const buildId = build.job_id;
 
-    let customBuildFileName = '';
-    if (options['build-file-name']) {
-      if (typeof (options['build-file-name']) !== 'string' || !fileUtils.isValidFileName(options['build-file-name'])) {
-        throw new FatalException(`${strong(String(options['build-file-name']))} is not a valid file name`);
-      }
-      customBuildFileName = String(options['build-file-name']);
-    }
-
     const details = columnar([
       ['App ID', strong(appflowId)],
       ['Build ID', strong(buildId.toString())],
       ['Commit', strong(`${build.commit.sha.substring(0, 6)} ${build.commit.note}`)],
       ['Target Platform', strong(build.stack.friendly_name)],
       ['Build Type', strong(build.build_type)],
+      ['Artifact Type(s)', strong(`${artifactTypes}`)],
       ['Security Profile', build.profile_tag ? strong(build.profile_tag) : weak('not set')],
       ['Environment', build.environment_name ? strong(build.environment_name) : weak('not set')],
       ['Native Config', build.native_config_name ? strong(build.native_config_name) : weak('not set')],
@@ -267,13 +335,49 @@ This can be used only together with build type ${input('release')} for Android a
       throw new Error(`Build ${build.state}`);
     }
 
-    const url = await this.getDownloadUrl(appflowId, buildId, token);
-    if (!url.url) {
-      throw new Error('Missing URL in response');
+    for (const artifactType of artifactTypes) {
+      const url = await this.getDownloadUrl(appflowId, buildId, artifactType, token);
+
+      if (!url.url) {
+        throw new Error('Missing URL in response');
+      }
+
+      let customBuildFileName = '';
+
+      if (options['build-file-name']) {
+        this.env.log.warn(`The ${input('--build-file-name')} option has been deprecated. Please use ${input('--ipa-name')}, ${input('--apk-name')} or ${input('--{ artifact }-name')}.`);
+        customBuildFileName = await this.sanitizeString(options['build-file-name']);
+      } else {
+        customBuildFileName = await this.sanitizeString(options[`${artifactType.toLowerCase()}-name`]);
+      }
+
+      const filename = await this.downloadBuild(url.url, customBuildFileName);
+      this.env.log.ok(`Artifact downloaded: ${filename}`);
+    }
+  }
+
+  async sanitizeString(value: string | string[] | boolean | null | undefined): Promise<string> {
+
+    if (!value || typeof (value) !== 'string') {
+      return '';
+    }
+
+    if (!fileUtils.isValidFileName(value)) {
+      throw new FatalException(`${strong(String(value))} is not a valid file name`);
     }
 
-    const filename = await this.downloadBuild(url.url, customBuildFileName);
-    this.env.log.ok(`Build completed: ${filename}`);
+    return String(value);
+  }
+
+  async getDefaultArtifactType(platform: string, useOriginalDefault?: boolean): Promise<Array<string>> {
+    switch (platform) {
+      case 'ios':
+        return useOriginalDefault ? ['IPA'] : ['IPA', 'DSYM'];
+      case 'android':
+        return useOriginalDefault ? ['APK'] : ['APK', 'AAB'] ;
+      default:
+        throw new Error(`No default artifact type for platform '${platform}'`);
+    }
   }
 
   async createPackageBuild(appflowId: string, token: string, platform: string, buildType: string, options: CommandLineOptions): Promise<PackageBuild> {
@@ -325,8 +429,8 @@ This can be used only together with build type ${input('release')} for Android a
     }
   }
 
-  async getDownloadUrl(appflowId: string, buildId: number, token: string): Promise<DownloadUrl> {
-    const { req } = await this.env.client.make('GET', `/apps/${appflowId}/packages/${buildId}/download`);
+  async getDownloadUrl(appflowId: string, buildId: number, artifactType: string, token: string): Promise<DownloadUrl> {
+    const { req } = await this.env.client.make('GET', `/apps/${appflowId}/packages/${buildId}/download?artifact_type=${artifactType}`);
     req.set('Authorization', `Bearer ${token}`).send();
 
     try {