Refactor the action to auto-extract most of the info

AliSoftware · AliSoftware · commit 1d9938313bef · 2023-02-07T23:51:42.000+01:00
From values provided in the `lane_context` by the `appcenter_upload` action – if it was used to distribute the Prototype build
diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/prototype_build_details_comment_action.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/prototype_build_details_comment_action.rb
@@ -2,37 +2,49 @@ module Fastlane
   module Actions
     class PrototypeBuildDetailsCommentAction < Action
       def self.run(params)
-        # Get Input Parameters
-        appcenter_org_name = params[:appcenter_org_name]
-        appcenter_app_name = params[:appcenter_app_name]
-        appcenter_release_id = params[:appcenter_release_id]
-        commit = params[:commit] || other_action.last_git_commit[:abbreviated_commit_hash]
-
-        metadata = params[:metadata] # e.g. {'Build Config':… , 'Version': …, 'Short Version': …}
-        direct_link = params[:download_url]
-        unless direct_link.nil?
-          metadata['Direct Link'] = "<a href='#{direct_link}'><code>#{File.basename(direct_link)}</code></a>"
-        end
+        app_display_name = params[:app_display_name]
 
-        # Build the comment parts
-        install_url = "https://install.appcenter.ms/orgs/#{appcenter_org_name}/apps/#{appcenter_app_name}/releases/#{appcenter_release_id}"
-        qr_code_url = "https://chart.googleapis.com/chart?chs=500x500&cht=qr&chl=#{CGI.escape(install_url)}&choe=UTF-8"
-        metadata_rows = metadata.compact.map do |key, value|
-          "<tr><td><b>#{key}</b></td><td>#{value}</td></tr>"
+        app_center_org_name = params[:app_center_org_name]
+        app_center_info = app_center_org_name.nil? ? {} : lane_context[SharedValues::APPCENTER_BUILD_INFORMATION] || {}
+        app_center_app_name = params[:app_center_app_name] || app_center_info['app_name']
+        app_center_app_display_name = app_center_info['app_display_name'] || app_center_app_name
+        app_center_release_id = params[:app_center_release_id] || app_center_info['id']
+
+        # Consolidate the list of Metadata to display with some implicit metadata if available
+        metadata = params[:metadata] || {}
+        metadata['Build Number'] ||= app_center_info['version']
+        metadata['Version'] ||= app_center_info['short_version']
+        metadata[app_center_info['app_os'] == 'Android' ? 'Application ID' : 'Bundle ID'] = app_center_info['bundle_identifier']
+        # (Feel free to add more CI-specific env vars in the line below to support other CI providers if you need)
+        metadata['Commit'] ||= ENV.fetch('BUILDKITE_COMMIT', nil) || other_action.last_git_commit[:abbreviated_commit_hash]
+
+        # Installation Link(s) -- either download_url param, or App Center Build link, or both
+        install_url = nil
+        if params[:download_url]
+          install_url = params[:download_url]
+          metadata['Direct Download'] = "<a href='#{install_url}'><code>#{File.basename(install_url)}</code></a>"
         end
+        if app_center_org_name && app_center_app_name
+          install_url = "https://install.appcenter.ms/orgs/#{app_center_org_name}/apps/#{app_center_app_name}/releases/#{app_center_release_id}"
+          metadata['App Center Build'] = "<a href='#{install_url}'>#{app_center_app_display_name} \##{app_center_release_id}</a>"
+        end
+        UI.user_error!(NO_INSTALL_URL_ERROR_MESSAGE) if install_url.nil?
+        qr_code_url = "https://chart.googleapis.com/chart?chs=500x500&cht=qr&chl=#{CGI.escape(install_url)}&choe=UTF-8"
 
-        intro = "📲 You can test the changes from this Pull Request in <b>#{appcenter_app_name}</b> by scanning the QR code below to install the corresponding build via App Center."
+        # Build the comment parts
+        icon_img_tag = img_tag(params[:app_icon] || app_center_info['app_icon_url'], alt: app_display_name)
+        metadata_rows = metadata.compact.map { |key, value| "<tr><td><b>#{key}</b></td><td>#{value}</td></tr>" }
+        intro = "#{icon_img_tag}📲 You can test the changes from this Pull Request in <b>#{app_display_name}</b> by scanning the QR code below to install the corresponding build."
+        footnote = params[:footnote] || (app_center_info.nil? ? '' : '<em>Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.</em>')
         body = <<~COMMENT_BODY
           <table>
           <tr>
-            <td rowspan='#{metadata.count + 3}'><img src='#{qr_code_url}' width='250' height='250' /></td>
-            <td width='150px'><b>App Name</b></td><td>#{appcenter_app_name}</td>
+            <td rowspan='#{metadata.count + 1}' width='260px'><img src='#{qr_code_url}' width='250' height='250' /></td>
+            <td width='150px'><b>App Name</b></td><td>#{icon_img_tag} #{app_display_name}</td>
           </tr>
           #{metadata_rows.join("\n")}
-          <tr><td><b>App Center Build</b></td><td><a href='#{install_url}'>Build \##{appcenter_release_id}</a></td></tr>
-          <tr><td><b>Commit</b></td><td>#{commit}</td></tr>
           </table>
-          #{params[:footnote]}
+          #{footnote}
         COMMENT_BODY
 
         if params[:fold]
@@ -42,6 +54,28 @@ def self.run(params)
         end
       end
 
+      #####################################################
+      # @!group Helpers
+      #####################################################
+
+      NO_INSTALL_URL_ERROR_MESSAGE = <<~NO_URL_ERROR.freeze
+        No URL provided to download or install the app.
+         - Either use this action right after using `appcenter_upload` and provide an `app_center_org_name` (so that this action can use the link to the App Center build)
+         - Or provide an explicit value for the `download_url` parameter
+      NO_URL_ERROR
+
+      def self.img_tag(url_or_emoji, alt: '')
+        return nil if url_or_emoji.nil?
+
+        emoji = url_or_emoji.match(/:(.*):/)&.captures&.first
+        app_icon_url = if emoji
+                         "https://raw.githubusercontent.com/buildkite/emojis/main/img-buildkite-64/#{emoji}.png"
+                       elsif URI(url_or_emoji)
+                         url_or_emoji
+                       end
+        app_icon_url ? "<img alt='#{alt}' align='top' src='#{app_icon_url}' width='20px' />" : ''
+      end
+
       #####################################################
       # @!group Documentation
       #####################################################
@@ -50,30 +84,75 @@ def self.description
         'Generates a string providing all the details of a prototype build, nicely-formatted and ready to be used as a PR comment (e.g. via `comment_on_pr`).'
       end
 
+      def self.details
+        <<~DESC
+          Generates a string providing all the details of a prototype build, nicely-formatted as HTML.
+          The returned string will typically be subsequently used by the `comment_on_pr` action to post that HTML as comment on a PR.
+
+          If you used the `appcenter_upload` lane (to upload the Prototype build to App Center) before calling this action, and pass
+          a value to the `app_center_org_name` parameter, then many of the parameters and metadata will be automatically extracted
+          from the `lane_context` provided by `appcenter_upload`, including:
+
+           - The `app_center_app_name`, `app_center_release_id` and installation URL to use for the QR code to point to that release in App Center
+           - The `app_icon`
+           - The app's Build Number / versionCode
+           - The app's Version / versionName
+           - The app's Bundle ID / Application ID
+           - A `footnote` mentioning the MC tool for Automatticians to add themselves to App Center
+
+          This means that if you are using App Center to distribute your Prototype Build, the only parameters you *have* to provide
+          to this action are `app_display_name` and `app_center_org_name`; plus, for `metadata` most of the interesting values will already be pre-filled.
+
+          Any of those implicit default values/metadata can of course be overridden by passing an explicit value to the appropriate parameter(s).
+        DESC
+      end
+
       def self.available_options
+        app_center_auto = '(will be automatically extracted from `lane_context if you used `appcenter_upload` to distribute your Prototype build)'
         [
           FastlaneCore::ConfigItem.new(
-            key: :appcenter_org_name,
-            env_name: 'APPCENTER_OWNER_NAME', # Same as the one used by the `appcenter_upload` action
-            description: 'The name of the organization in App Center',
+            key: :app_display_name,
+            env_name: 'FL_PROTOTYPE_BUILD_DETAILS_COMMENT_APP_DISPLAY_NAME',
+            description: 'The display name to use for the app in the comment message',
+            optional: false,
             type: String
           ),
           FastlaneCore::ConfigItem.new(
-            key: :appcenter_app_name,
-            env_name: 'APPCENTER_APP_NAME', # Same as the one used by the `appcenter_upload` action
-            description: 'The name of the app in App Center',
-            type: String
+            key: :app_center_org_name,
+            env_name: 'APPCENTER_OWNER_NAME', # Intentionally the same as the one used by the `appcenter_upload` action
+            description: 'The name of the organization in App Center (if you used `appcenter_upload` to distribute your Prototype build)',
+            type: String,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :app_center_app_name,
+            env_name: 'APPCENTER_APP_NAME', # Intentionally the same as the one used by the `appcenter_upload` action
+            description: "The name of the app in App Center #{app_center_auto}",
+            type: String,
+            optional: true,
+            default_value_dynamic: true # As it will be extracted from the `lane_context`` if you used `appcenter_upload``
           ),
           FastlaneCore::ConfigItem.new(
-            key: :appcenter_release_id,
-            env_name: 'FL_PROTOTYPE_BUILD_APPCENTER_RELEASE_ID',
-            description: "The release ID/Number in App Center; can be obtained using `lane_context[SharedValues::APPCENTER_BUILD_INFORMATION]['id']`",
-            type: Integer
+            key: :app_center_release_id,
+            env_name: 'APPCENTER_RELEASE_ID',
+            description: "The release ID/Number in App Center #{app_center_auto}",
+            type: String,
+            optional: true,
+            default_value_dynamic: true # As it will be extracted from the `lane_context`` if you used `appcenter_upload``
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :app_icon,
+            env_name: 'FL_PROTOTYPE_BUILD_DETAILS_COMMENT_APP_ICON',
+            description: "An `:emojicode:` or URL to use for the icon of the app in the message. #{app_center_auto}",
+            type: String,
+            optional: true,
+            default_value_dynamic: true # As it will be extracted from the `lane_context`` if you used `appcenter_upload``
           ),
           FastlaneCore::ConfigItem.new(
             key: :download_url,
-            env_name: 'FL_PROTOTYPE_BUILD_DOWNLOAD_URL',
-            description: 'The URL to download the build directly; e.g. a public link to the `.apk` file; you might use `lane_context[SharedValues::APPCENTER_DOWNLOAD_LINK]` for this for example',
+            env_name: 'FL_PROTOTYPE_BUILD_DETAILS_COMMENT_DOWNLOAD_URL',
+            description: 'The URL to download the build as a direct download. ' \
+             + 'If you uploaded the build to App Center, we recommend leaving this nil (the comment will use the URL to the App Center build for the QR code)',
             type: String,
             optional: true,
             default_value: nil
@@ -88,25 +167,20 @@ def self.available_options
           FastlaneCore::ConfigItem.new(
             key: :metadata,
             env_name: 'FL_PROTOTYPE_BUILD_DETAILS_COMMENT_METADATA',
-            description: 'All additional metadata (as key/value pairs) you want to include in the HTML table of the comment',
+            description: 'All additional metadata (as key/value pairs) you want to include in the HTML table of the comment. ' \
+             + 'If you are running this action after `appcenter_upload`, some metadata will automatically be added to this list too',
             type: Hash,
             optional: true,
-            default_value: {}
+            default_value_dynamic: true # As some metadata will be auto-filled if you used `appcenter_upload`
           ),
           FastlaneCore::ConfigItem.new(
             key: :footnote,
             env_name: 'FL_PROTOTYPE_BUILD_DETAILS_COMMENT_FOOTNOTE',
-            description: 'Optional footnote to add below the HTML table of the comment',
+            description: 'Optional footnote to add below the HTML table of the comment. ' \
+             + 'If you are running this action after `appcenter_upload`, a default footnote for Automatticians will be used unless you provide an explicit value',
             type: String,
-            default_value: '<em>Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.</em>'
-          ),
-          FastlaneCore::ConfigItem.new(
-            key: :commit,
-            # Buildkite ENV var: https://buildkite.com/docs/pipelines/environment-variables#BUILDKITE_COMMIT
-            env_names: ['BUILDKITE_COMMIT'], # Feel free to add more CI-specific env vars for other CI providers
-            description: 'The commit this prototype build was build from; usually not passed explicitly, but derived from the environment variable instead',
-            type: String,
-            optional: true
+            optional: true,
+            default_value_dynamic: true # We have a default footnote for the case when you used App Center
           ),
         ]
       end
@@ -116,7 +190,7 @@ def self.return_type
       end
 
       def self.return_value
-        'The HTML comment containing all the relevant info about a Prototype build published to App Center'
+        'The HTML comment containing all the relevant info about a Prototype build and links to install it'
       end
 
       def self.authors
