Add action to get latest release (#252)

Add action to get latest release.

Author: lfkellogg

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_action.rb

@@ -89,10 +89,6 @@ def self.app_id_from_params(params)
         app_id
       end
 
-      def self.app_name_from_app_id(app_id)
-        "projects/#{app_id.split(':')[1]}/apps/#{app_id}"
-      end
-
       def self.xcode_archive_path
         # prevents issues on cross-platform build environments where an XCode build happens within
         # the same lane
@@ -230,7 +226,7 @@ def self.available_options
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
-                                       description: "Auth token for firebase cli",
+                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or the Firebase CLI's login:ci command",
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :debug,

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_add_testers_action.rb

@@ -71,7 +71,7 @@ def self.available_options
                                       optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
-                                       description: "Auth token for firebase cli",
+                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or the Firebase CLI's login:ci command",
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :debug,

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_get_latest_release.rb

@@ -0,0 +1,111 @@
+require 'fastlane/action'
+require_relative '../client/firebase_app_distribution_api_client'
+require_relative '../helper/firebase_app_distribution_auth_client'
+require_relative '../helper/firebase_app_distribution_helper'
+
+module Fastlane
+  module Actions
+    class FirebaseAppDistributionGetLatestReleaseAction < Action
+      extend Auth::FirebaseAppDistributionAuthClient
+      extend Helper::FirebaseAppDistributionHelper
+
+      def self.run(params)
+        auth_token = fetch_auth_token(params[:service_credentials_file], params[:firebase_cli_token])
+        fad_api_client = Client::FirebaseAppDistributionApiClient.new(auth_token, params[:debug])
+
+        UI.message("⏳ Fetching latest release for app #{params[:app]}...")
+
+        releases = fad_api_client.list_releases(app_name_from_app_id(params[:app]), 1)[:releases] || []
+        if releases.empty?
+          latest_release = nil
+          UI.important("No releases for app #{params[:app]} found in App Distribution. Returning nil and setting Actions.lane_context[:FIREBASE_APP_DISTRO_LATEST_RELEASE].")
+        else
+          latest_release = releases[0]
+          UI.success("✅ Latest release fetched successfully. Returning release and setting Actions.lane_context[:FIREBASE_APP_DISTRO_LATEST_RELEASE].")
+        end
+        Actions.lane_context[:FIREBASE_APP_DISTRO_LATEST_RELEASE] = latest_release
+        return latest_release
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Fetches the latest release in Firebase App Distribution"
+      end
+
+      def self.details
+        [
+          "Fetches information about the most recently created release in App Distribution, including the version and release notes. Returns nil if no releases are found."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :app,
+                                       env_name: "FIREBASEAPPDISTRO_APP",
+                                       description: "Your app's Firebase App ID. You can find the App ID in the Firebase console, on the General Settings page",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
+                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or the Firebase CLI's login:ci command",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :service_credentials_file,
+                                       description: "Path to Google service account json",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :debug,
+                                       description: "Print verbose debug output",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['FIREBASE_APP_DISTRO_LATEST_RELEASE', 'A hash representing the lastest release created in Firebase App Distribution']
+        ]
+      end
+
+      def self.return_value
+        "Hash representation of the lastest release created in Firebase App Distribution (see https://firebase.google.com/docs/reference/app-distribution/rest/v1/projects.apps.releases#resource:-release)"
+      end
+
+      def self.return_type
+        :hash
+      end
+
+      def self.authors
+        ["lkellogg@google.com"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'release = firebase_app_distribution_get_latest_release(app: "1:1234567890:ios:0a1b2c3d4e5f67890")',
+          'increment_build_number({
+            build_number: firebase_app_distribution_get_latest_release(app: "1:1234567890:ios:0a1b2c3d4e5f67890")[:buildVersion].to_i + 1
+          })'
+        ]
+      end
+
+      def self.sample_return_value
+        {
+          name: "projects/123456789/apps/1:1234567890:ios:0a1b2c3d4e5f67890/releases/0a1b2c3d4",
+          releaseNotes: {
+            text: "Here are some release notes!"
+          },
+          displayVersion: "1.2.3",
+          buildVersion: "10",
+          createTime: "2021-10-06T15:01:23Z"
+        }
+      end
+    end
+  end
+end

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_get_udids.rb

@@ -63,7 +63,7 @@ def self.available_options
                                        optional: false,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
-                                       description: "Auth token for firebase cli",
+                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or the Firebase CLI's login:ci command",
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :service_credentials_file,

lib/fastlane/plugin/firebase_app_distribution/actions/firebase_app_distribution_remove_testers_action.rb

@@ -68,7 +68,7 @@ def self.available_options
                                       optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :firebase_cli_token,
-                                       description: "Auth token for firebase cli",
+                                       description: "Auth token generated using 'fastlane run firebase_app_distribution_login', or the Firebase CLI's login:ci command",
                                        optional: true,
                                        type: String),
           FastlaneCore::ConfigItem.new(key: :debug,

lib/fastlane/plugin/firebase_app_distribution/client/firebase_app_distribution_api_client.rb

@@ -220,7 +220,7 @@ def add_testers(project_number, emails)
       rescue Faraday::ResourceNotFound
         UI.user_error!(ErrorMessage::INVALID_PROJECT)
       rescue Faraday::ClientError => e
-        if e.response_status == 429
+        if e.response[:status] == 429
           UI.user_error!(ErrorMessage::TESTER_LIMIT_VIOLATION)
         else
           raise e
@@ -247,6 +247,27 @@ def remove_testers(project_number, emails)
         UI.user_error!(ErrorMessage::INVALID_PROJECT)
       end
 
+      # List releases
+      #
+      # args
+      #   app_name - Firebase App resource name
+      #   page_size - The number of releases to return in the page
+      #   page_token - A page token, received from a previous call
+      #
+      # Returns the response body. Throws a user_error if the app hasn't been onboarded to App Distribution.
+      def list_releases(app_name, page_size = 100, page_token = nil)
+        begin
+          response = connection.get(list_releases_url(app_name), { pageSize: page_size.to_s, pageToken: page_token }) do |request|
+            request.headers[AUTHORIZATION] = "Bearer " + @auth_token
+            request.headers[CLIENT_VERSION] = client_version_header_value
+          end
+        rescue Faraday::ResourceNotFound
+          UI.user_error!("#{ErrorMessage::INVALID_APP_ID}: #{app_name}")
+        end
+
+        return response.body
+      end
+
       private
 
       def client_version_header_value
@@ -281,6 +302,10 @@ def upload_status_url(operation_name)
         "/v1/#{operation_name}"
       end
 
+      def list_releases_url(app_name)
+        "#{v1_apps_url(app_name)}/releases"
+      end
+
       def get_udids_url(app_id)
         "#{v1alpha_apps_url(app_id)}/testers:getTesterUdids"
       end

lib/fastlane/plugin/firebase_app_distribution/helper/firebase_app_distribution_helper.rb

@@ -53,6 +53,10 @@ def blank?(value)
       def present?(value)
         !blank?(value)
       end
+
+      def app_name_from_app_id(app_id)
+        "projects/#{app_id.split(':')[1]}/apps/#{app_id}"
+      end
     end
   end
 end

spec/firebase_app_distribution_api_client_spec.rb

@@ -393,6 +393,73 @@
     end
   end
 
+  describe '#list_releases' do
+    let(:release1) do
+      {
+        name: "#{app_name}/releases/2c3d40a1b",
+        releaseNotes: {
+          text: "Here are some release notes!"
+        },
+        displayVersion: "1.2.2",
+        buildVersion: "9",
+        createTime: "2021-10-05T15:01:23Z"
+      }
+    end
+    let(:release2) do
+      {
+        name: "#{app_name}/releases/0a1b2c3d4",
+        releaseNotes: {
+          text: "Here are some newer release notes!"
+        },
+        displayVersion: "1.2.3",
+        buildVersion: "10",
+        createTime: "2021-10-06T15:01:23Z"
+      }
+    end
+    let(:list_releases_headers) do
+      {
+        'Authorization' => 'Bearer auth_token',
+        'X-Client-Version' => "fastlane/#{Fastlane::FirebaseAppDistribution::VERSION}"
+      }
+    end
+
+    it 'sets the page size and returns the response body' do
+      stubs.get("/v1/#{app_name}/releases?pageSize=2", list_releases_headers) do |env|
+        [
+          200,
+          {}, # response headers
+          { releases: [release2, release1] }
+        ]
+      end
+      result = api_client.list_releases(app_name, 2)
+      expect(result).to eq({ releases: [release2, release1] })
+    end
+
+    it 'sets the page size and token and returns the response body' do
+      stubs.get("/v1/#{app_name}/releases?pageSize=2&pageToken=the-token", list_releases_headers) do |env|
+        [
+          200,
+          {}, # response headers
+          { releases: [release2, release1] }
+        ]
+      end
+      result = api_client.list_releases(app_name, 2, 'the-token')
+      expect(result).to eq({ releases: [release2, release1] })
+    end
+
+    it 'fails and prints correct error message for a 404' do
+      stubs.get("/v1/#{app_name}/releases?pageSize=2", list_releases_headers) do |env|
+        [
+          404,
+          {}, # response headers
+          {}
+        ]
+      end
+      expect { api_client.list_releases(app_name, 2) }
+        .to raise_error("#{ErrorMessage::INVALID_APP_ID}: #{app_name}")
+    end
+  end
+
   describe '#distribute' do
     it 'posts successfuly when tester emails and groupIds are defined' do
       payload = { testerEmails: ["testers"], groupAliases: ["groups"] }

spec/firebase_app_distribution_get_latest_release_spec.rb

@@ -0,0 +1,33 @@
+require 'fastlane/action'
+
+describe Fastlane::Actions::FirebaseAppDistributionGetLatestReleaseAction do
+  let(:action) { Fastlane::Actions::FirebaseAppDistributionGetLatestReleaseAction }
+  describe '#run' do
+    before(:each) do
+      allow(action).to receive(:fetch_auth_token).and_return('fake-auth-token')
+    end
+
+    it 'returns nil if the app does not have any releases' do
+      allow_any_instance_of(Fastlane::Client::FirebaseAppDistributionApiClient).to receive(:list_releases).with('projects/1234567890/apps/1:1234567890:ios:321abc456def7890', 1).and_return({})
+
+      expect(action.run({ app: '1:1234567890:ios:321abc456def7890' })).to eq(nil)
+      expect(Fastlane::Actions.lane_context[:FIREBASE_APP_DISTRO_LATEST_RELEASE]).to eq(nil)
+    end
+
+    it 'returns the release if the app has at least one release' do
+      release = {
+          name: "projects/1234567890/apps/1:1234567890:ios:321abc456def7890/releases/0a1b2c3d4",
+        releaseNotes: {
+          text: "Here are some release notes!"
+        },
+        displayVersion: "1.2.3",
+        buildVersion: "10",
+        createTime: "2021-10-06T15:01:23Z"
+      }
+      allow_any_instance_of(Fastlane::Client::FirebaseAppDistributionApiClient).to receive(:list_releases).with('projects/1234567890/apps/1:1234567890:ios:321abc456def7890', 1).and_return({ releases: [release] })
+
+      expect(action.run({ app: '1:1234567890:ios:321abc456def7890' })).to eq(release)
+      expect(Fastlane::Actions.lane_context[:FIREBASE_APP_DISTRO_LATEST_RELEASE]).to eq(release)
+    end
+  end
+end