fastlane/ci

require "json"
require_relative "../shared/logging_module"
require_relative "../shared/github_handler"

module FastlaneCI
  # Provides operations to create and mutate the FastlaneCI configuration
  # repository
  class ConfigurationRepositoryService
    include FastlaneCI::Logging
    include FastlaneCI::GitHubHandler

    # An octokit client authenticated with the onboarding user's API token
    #
    # @return [Octokit::Client]
    attr_reader :onboarding_user_client

    # An octokit client authenticated with the bot user's API token
    #
    # @return [Octokit::Client]
    attr_reader :bot_user_client

    # Instantiates new `ConfigurationRepositoryService` class
    #
    # @param  [ProviderCredential] provider_credential
    def initialize(provider_credential:)
      @onboarding_user_client = Octokit::Client.new(access_token: provider_credential.api_token)
      @bot_user_client = Octokit::Client.new(access_token: FastlaneCI.dot_keys.ci_user_api_token)
    end

    # Sets up the `fastlane.ci` configuration repository, with the necessary
    # configuration files
    #
    #   i.   Creates the remote repository
    #   ii.  Adds the bot user as a collaborator and accepts the invitation as
    #        the bot user
    #   iii. Creates the necessary remote configuration files as the bot user
    #
    def setup_private_configuration_repo
      create_private_remote_configuration_repo
      add_bot_user_as_collaborator
      create_remote_configuration_files
    end

    # Returns `true` if the configuration repository is in proper format:
    #
    #   i.   The repository exists
    #   ii.  The `users.json` file exists and is a JSON array
    #   iii. The `projects.json` file exists and is a JSON array
    #
    # @return [Boolean]
    def configuration_repository_valid?
      # Return cached true value, if it was successful, otherwise keep checking because it might have been fixed
      return @config_repo_exists unless @config_repo_exists.nil? || (@config_repo_exists == false)

      valid = configuration_repository_exists?
      logger.debug("Configuration repo #{repo_shortform} doesn't exist") unless valid

      if valid
        valid = remote_file_a_json_array?("users.json")
        logger.debug("users.json file is not correct, it should be a json array") unless valid
      end

      if valid
        valid = remote_file_a_json_array?("projects.json")
        logger.debug("projects.json file is not correct, it should be a json array") unless valid
      end

      return valid
    end

    # Returns `true` if the remote configuration repository exists
    #
    # @return [Boolean]
    def configuration_repository_exists?
      # Return cached true value, if it was successful, otherwise keep checking because it might have been fixed
      return @config_repo_exists unless @config_repo_exists.nil? || (@config_repo_exists == false)

      github_action(onboarding_user_client) do |client|
        @config_repo_exists = client.repository?(repo_shortform)
      end

      return @config_repo_exists
    end

    private

    # Creates a remote repository if it does not already exist as the onboarding
    # user
    def create_private_remote_configuration_repo
      logger.debug("Creating private remote configuration repository #{repo_shortform}.")

      github_action(onboarding_user_client) do |client|
        # TODO: Handle the common case of when provided account can't create a new private repo
        client.create_repository(repo_name, private: true) unless configuration_repository_exists?
      end
    end

    # Adds the bot user as a collaborator to the fastlane.ci configuration
    # repository
    #
    # @return [Boolean] If the user was added successfully
    def add_bot_user_as_collaborator
      already_exists = github_action(onboarding_user_client) { |c| c.collaborator?(repo_shortform, bot_user_login) }

      if already_exists
        logger.debug("Bot user is already a collaborator to #{repo_shortform}, not adding as collaborator.")
        return true
      end

      logger.debug("Adding bot user as collaborator to #{repo_shortform}.")

      invitation_id = invite_bot_user_to_configuration_repository

      if !invitation_id.nil?
        return accept_invitation_to_repository_as_bot_user(invitation_id)
      else
        raise "Could not add bot user as a collaborator. Invitation was not sent to collaborate on #{repo_shortform}."
      end
    end

    # Creates the `users.json` and `projects.json` configuration files to the
    # remote configuration repository as the bot user
    def create_remote_configuration_files
      logger.debug("Creating remote configuration files `users.json` and `projects.json`")
      create_remote_json_file("users.json", json_string: serialized_users)
      create_remote_json_file("projects.json")
      create_remote_json_file("environment_variables.json")
    end

    # Adds the bot user as a collaborator to the fastlane.ci configuration
    # repository
    #
    # @return [Integer] `invitation.id`
    def invite_bot_user_to_configuration_repository
      logger.debug("Adding the bot user as a collaborator for #{repo_shortform}.")

      return github_action(onboarding_user_client) do |client|
        invitation = client.invite_user_to_repository(repo_shortform, bot_user_login)

        if invitation
          logger.debug("Added bot user as collaborator for #{repo_shortform}.")
          invitation.id
        else
          logger.error("ERROR: Couldn't add bot user as collaborator for #{repo_shortform}.")
          nil
        end
      end
    end

    # Accepts the invitation to the fastlane.ci repository as the bot user
    #
    # @param  [Integer] invitation_id
    # @return [Boolean] `true` if the invitation was successfully accepted
    def accept_invitation_to_repository_as_bot_user(invitation_id)
      logger.debug("Accepting invitation as bot user for #{repo_shortform}.")

      return github_action(bot_user_client) do |client|
        bot_accepted = client.accept_repository_invitation(invitation_id)

        if bot_accepted
          logger.debug("Bot user accepted invitation to #{repo_shortform}.")
        else
          logger.error("ERROR: Bot user didn't accept invitation to #{repo_shortform}.")
        end

        bot_accepted
      end
    end

    # Serializes CI user and its provider credentials to a JSON format.
    #
    # After creating the private remote configuration repository, the server
    # will stop redirecting the user to the `/configuration` page. In the
    # `/dashboard` page, there's a requirement the current user has a
    # provider credential , or it will raise an exception. By writing the
    # provider credentials to the private configuration repo for the CI User,
    # it prevents this issue
    #
    # @return [String]
    def serialized_users
      users = [
        User.new(
          email: bot_user_email,
          password_hash: BCrypt::Password.create(FastlaneCI.dot_keys.ci_user_password),
          provider_credentials: [
            FastlaneCI::GitHubProviderCredential.new(
              email: initial_onboarding_user_email,
              api_token: FastlaneCI.dot_keys.initial_onboarding_user_api_token,
              full_name: "Initial Onboarding User credentials"
            )
          ]
        )
      ]

      users.each do |user|
        # Fist need to serialize the provider credentials and ignore the `ci_user`
        # instance variable. The reasoning is since if you serialize the `user`
        # first, you will call `to_object_map` on the `ci_user`, which holds
        # reference to a user. This will go on indefinitely
        user.provider_credentials.map! do |credential|
          credential.to_object_dictionary(ignore_instance_variables: [:@ci_user])
        end
      end

      JSON.pretty_generate(users.map(&:to_object_dictionary))
    end

    # Creates an empty json array file in the configuration repository
    #
    # @raise  [Octokit::UnprocessableEntity] when file already exists
    # @param  [String] file_path
    def create_remote_json_file(file_path, json_string: "[]")
      github_action(bot_user_client) do |client|
        client.contents(repo_shortform, path: file_path)
      end
    rescue Octokit::NotFound
      bot_user_client.create_contents(
        repo_shortform, file_path, "Add initial #{file_path}", json_string
      )
    rescue Octokit::UnprocessableEntity
      # rubocop:disable Metrics/LineLength
      logger.debug("The file #{file_path} already exists in remote configuration repo: #{repo_shortform}. Not overwriting the file.")
      # rubocop:enable Metrics/LineLength
    end

    #####################################################
    # @!group Boolean Helpers
    #####################################################

    # Configuration will fail if the `file_path` file contents are not a
    # JSON array
    #
    # @param  [String] file_path
    # @raise  [JSON::ParserError] if the JSON in the file contents is not valid
    # @raise  [Octokit::NotFound] if the file_path is not found
    # @return [Boolean]
    def remote_file_a_json_array?(file_path)
      return false unless configuration_repository_exists?
      logger.debug("Checking that #{repo_shortform}/#{file_path} is a json array")

      contents_map = {}
      github_action(bot_user_client) do |client|
        contents_map = client.contents(repo_shortform, path: file_path)
      end
      contents_json =
        contents_map[:encoding] == "base64" ? Base64.decode64(contents_map[:content]) : contents_map[:content]
      contents = JSON.parse(contents_json)

      return contents.kind_of?(Array)
    rescue TypeError
      if contents.nil?
        logger.debug("#{repo_shortform}/#{file_path} has no content")
      else
        logger.debug("#{repo_shortform}/#{file_path} is type #{contents.type}, should be Array")
      end
      return false
    rescue Octokit::NotFound
      logger.debug("#{repo_shortform}/#{file_path} couldn't be found")
      return false
    rescue JSON::ParserError
      logger.debug("#{repo_shortform}/#{file_path} couldn't be json-parsed, object type: #{contents.type}")
      return false
    end

    ####################################################
    # @!group String Helpers
    #####################################################

    # The login of the fastlane.ci bot account
    #
    # @return [String]
    def bot_user_login
      return github_action(bot_user_client, &:login)
    end

    # The email of the fastlane.ci bot account
    #
    # @return [String]
    def bot_user_email
      return github_action(bot_user_client) do |client|
        client.emails.find(&:primary).email
      end
    end

    # The email of the initial onboarding user
    #
    # @return [String]
    def initial_onboarding_user_email
      return github_action(onboarding_user_client) do |client|
        client.emails.find(&:primary).email
      end
    end

    # The name of the configuration repository URL `repo`
    #
    # @return [String]
    def repo_name
      return "" unless FastlaneCI.dot_keys.repo_url
      return FastlaneCI.dot_keys.repo_url.split("/").last
    end

    # The short-form of the configuration repository URL `user/repo`
    #
    # @return [String]
    def repo_shortform
      return "" unless FastlaneCI.dot_keys.repo_url
      return FastlaneCI.dot_keys.repo_url.split("/").last(2).join("/")
    end
  end
end