shopify-cli 2.15.1 → 2.15.4

data/lib/shopify_cli/commands/app/serve.rb

@@ -8,12 +8,9 @@ module ShopifyCLI
 
         recommend_default_ruby_range
 
-        options do |parser, flags|
-          parser.on("--host=HOST") do |h|
-            flags[:host] = h.gsub('"', "")
-          end
-          parser.on("--port=PORT") { |port| flags[:port] = port }
-        end
+        parse_host_option
+        parse_port_option
+        parse_no_update_option
 
         def call(*)
           case detect_app
@@ -21,18 +18,21 @@ module ShopifyCLI
             Services::App::Serve::RailsService.call(
               host: host,
               port: port,
+              no_update: no_update,
               context: @ctx
             )
           when :node
             Services::App::Serve::NodeService.call(
               host: host,
               port: port,
+              no_update: no_update,
               context: @ctx
             )
           when :php
             Services::App::Serve::PHPService.call(
               host: host,
               port: port,
+              no_update: no_update,
               context: @ctx
             )
           end
@@ -43,7 +43,7 @@ module ShopifyCLI
         end
 
         def self.extended_help
-          ShopifyCLI::Context.message("app.core.serve.extended_help")
+          ShopifyCLI::Context.message("core.app.serve.extended_help")
         end
       end
     end

data/lib/shopify_cli/commands/login.rb

@@ -30,7 +30,7 @@ module ShopifyCLI
         if @ctx.ci? && (password = options.flags[:password] || @ctx.getenv("SHOPIFY_PASSWORD"))
           ShopifyCLI::DB.set(shopify_exchange_token: password)
         else
-          IdentityAuth.new(ctx: @ctx).authenticate
+          IdentityAuth.new(ctx: @ctx).authenticate(spinner: true)
           org = select_organization
           ShopifyCLI::DB.set(organization_id: org["id"].to_i) unless org.nil?
           Whoami.call([], "whoami")
@@ -75,7 +75,10 @@ module ShopifyCLI
       private
 
       def select_organization
-        organizations = ShopifyCLI::PartnersAPI::Organizations.fetch_all(@ctx)
+        organizations = []
+        CLI::UI::Spinner.spin(@ctx.message("core.login.spinner.loading_organizations")) do
+          organizations = ShopifyCLI::PartnersAPI::Organizations.fetch_all(@ctx)
+        end
 
         if organizations.count == 0
           nil

data/lib/shopify_cli/context.rb

@@ -4,6 +4,7 @@ require "fileutils"
 require "rbconfig"
 require "net/http"
 require "json"
+require "bundler"
 
 module ShopifyCLI
   ##
@@ -642,6 +643,18 @@ module ShopifyCLI
       end
     end
 
+    # Uses bundle to grab the version of a gem
+    #
+    # #### Parameters
+    # - gem: the name of the gem to check
+    #
+    # #### Returns
+    # - version: a Semantic::Version object with the gem version
+    def ruby_gem_version(gem)
+      version = Bundler.load.specs.find { |s| s.name == gem }.version
+      ::Semantic::Version.new(version.to_s)
+    end
+
     private
 
     def ctx_path(fname)

data/lib/shopify_cli/git.rb

@@ -102,6 +102,42 @@ module ShopifyCLI
         branches
       end
 
+      ##
+      # Run git three-way file merge (it doesn't require an initialized git repository)
+      #
+      # #### Parameters
+      #
+      # * `current_file  - string path of the current file
+      # * `base_file`    - string path of the base file
+      # * `other_file`   - string path of the other file
+      # * `opts`         - list of "git merge-file" options. Valid values:
+      #                    - "-q"       - do not warn about conflicts
+      #                    - "--diff3"  - show conflicts
+      #                    - "--ours"   - resolve conflicts favoring lines from `current_file`
+      #                    - "--theirs" - resolve conflicts favoring lines from `other_file`
+      #                    - "--union"  - resolve conflicts favoring lines from both files
+      #                    - "-p"       - send results to standard output instead of
+      #                                 overwriting the `current_file`
+      # * `ctx`          - the current running context of your command, defaults to a new context
+      #
+      # #### Returns
+      #
+      # * standard output from git
+      #
+      # #### Example
+      #
+      #   output = ShopifyCLI::Git.merge_file(current_file, base_file, other_file, opts, ctx: ctx)
+      #
+      def merge_file(current_file, base_file, other_file, opts = [], ctx: Context.new)
+        output, status = ctx.capture2e("git", "merge-file", current_file, base_file, other_file, *opts)
+
+        unless status.success?
+          ctx.abort(ctx.message("core.git.error.merge_failed"))
+        end
+
+        output
+      end
+
       ##
       # will initialize a new repo in the current directory. This will output
       # if it was successful or not.

data/lib/shopify_cli/identity_auth.rb

@@ -56,8 +56,10 @@ module ShopifyCLI
 
     attr_accessor :response_query
 
-    def authenticate
-      return if refresh_exchange_tokens || refresh_access_tokens
+    def authenticate(spinner: false)
+      return if with_spinner(spinner, ctx.message("core.login.spinner.initiating")) do
+        attempt_reauthenticate
+      end
 
       initiate_authentication
 
@@ -66,7 +68,21 @@ module ShopifyCLI
       rescue IdentityAuth::Timeout => e
         ctx.abort(e.message)
       end
-      request_exchange_tokens
+      with_spinner(spinner, ctx.message("core.login.spinner.finalizing")) do
+        request_exchange_tokens
+      end
+    end
+
+    def with_spinner(spinner, message, &block)
+      result = nil
+      if spinner
+        CLI::UI::Spinner.spin(message) do
+          result = block.call
+        end
+      else
+        result = block.call
+      end
+      result
     end
 
     def fetch_or_auth_partners_token
@@ -100,10 +116,14 @@ module ShopifyCLI
     end
 
     def reauthenticate
-      return if refresh_exchange_tokens || refresh_access_tokens
+      return if attempt_reauthenticate
       ctx.abort(ctx.message("core.identity_auth.error.reauthenticate", ShopifyCLI::TOOL_NAME))
     end
 
+    def attempt_reauthenticate
+      refresh_exchange_tokens || refresh_access_tokens
+    end
+
     def code_challenge
       @code_challenge ||= Base64.urlsafe_encode64(
         OpenSSL::Digest::SHA256.digest(code_verifier),

data/lib/shopify_cli/messages/messages.rb

@@ -18,6 +18,7 @@ module ShopifyCLI
           missing_node: "Node.js is required to continue. Install Node.js here: https://nodejs.org/en/download.",
           missing_npm: "npm is required to continue. Install npm here: https://www.npmjs.com/get-npm.",
           missing_ruby: "Ruby is required to continue. Install Ruby here: https://www.ruby-lang.org/en/downloads.",
+          bundle_info_failure: "Error getting version for %s gem",
           option_parser: {
             invalid_option: "The option {{command:%s}} is not supported.",
             invalid_option_store_equals: <<~MESSAGE,
@@ -263,6 +264,7 @@ module ShopifyCLI
               {{bold:Options:}}
                 {{cyan:--host=HOST}}: Bypass running tunnel and use custom host. HOST must be HTTPS url.
                 {{cyan:--port=PORT}}: Use custom port.
+                {{cyan:--no-update}}: Skips the dashboard URL update step
             HELP
             open_info: <<~MESSAGE,
               {{*}} To install and start using your app, open this URL in your browser:
@@ -283,6 +285,13 @@ module ShopifyCLI
         },
         extension: {
           push: {
+            beacon_extension: {
+              error: {
+                file_read_error: "There was a problem reading %s",
+                missing_config_key_error: "Configuration is missing key: %s",
+                invalid_config_value_error: "Configuration value is invalid: %s",
+              },
+            },
             checkout_ui_extension: {
               localization: {
                 error: {
@@ -294,6 +303,7 @@ module ShopifyCLI
                   invalid_file_extension: "Invalid locale filename: `%s`; only .json files are allowed.",
                   invalid_locale_code: "Invalid locale filename: `%s`; locale code should be 2 or 3 letters,"\
                     " optionally followed by a two-letter region code, e.g. `fr-CA`.",
+                  invalid_file_encoding: "Invalid file encoding for `%s`; file encoding should be UTF-8.",
                   single_default_locale: "There must be one and only one locale identified as the default locale,"\
                     " e.g. `en.default.json`",
                 },
@@ -388,6 +398,7 @@ module ShopifyCLI
             sparse_checkout_not_set: "Sparse checkout set command failed.",
             pull_failed: "Pull failed.",
             pull_failed_bad_branch: "Pull failed. Branch %s cannot be found. Check the branch name and try again.",
+            merge_failed: "The file %s merge failed.",
           },
 
           cloning: "Cloning %s into %s…",
@@ -438,7 +449,7 @@ module ShopifyCLI
         login: {
           help: <<~HELP,
             Log in to the Shopify CLI by authenticating with a store or partner organization
-              Usage: {{command:%s login [--store=STORE]}}
+              Usage: {{command:%s login [--store STORE]}}
           HELP
           invalid_shop: <<~MESSAGE,
             Invalid store provided (%s). Please provide the store in the following format: my-store.myshopify.com
@@ -446,6 +457,11 @@ module ShopifyCLI
           shop_prompt: <<~PROMPT,
             What store are you connecting to? (e.g. my-store.myshopify.com; do {{bold:NOT}} include protocol part, e.g., https://)
           PROMPT
+          spinner: {
+            initiating: "Initiating authentication",
+            finalizing: "Finalizing authentication",
+            loading_organizations: "Loading available partner organizations",
+          },
         },
 
         logout: {
@@ -460,7 +476,7 @@ module ShopifyCLI
         switch: {
           help: <<~HELP,
             Switch between development stores in your partner organization
-              Usage: {{command:%s switch [--store=STORE]}}
+              Usage: {{command:%s switch [--store STORE]}}
           HELP
           disabled_as_shopify_org: "Can't switch development stores logged in as {{green:Shopify partners org}}",
           success: "Switched development store to {{green:%s}}",
@@ -573,7 +589,7 @@ module ShopifyCLI
           HELP
 
           error: {
-            no_shop: "No store found. Please run {{command:%s login --store=STORE}} to login to a specific store",
+            no_shop: "No store found. Please run {{command:%s login --store STORE}} to login to a specific store",
           },
 
           customer: {
@@ -713,7 +729,6 @@ module ShopifyCLI
             updated: "{{v}} Whitelist URLS updated in Partners Dashboard}}",
             update_error:
               "{{x}} error: For authentication issues, run {{command:%s logout}} to clear invalid credentials",
-            update_prompt: "Do you want to update your application url?",
           },
           select_org_and_shop: {
             authentication_issue: "For authentication issues, run {{command:%s logout}} to clear invalid credentials",
@@ -745,16 +760,12 @@ module ShopifyCLI
               " package manager for your system.",
             ngrok: "Something went wrong with ngrok installation,"\
               "please make sure %s exists within %s before trying again",
+            signup_required: "A free ngrok account is required: {{underline:https://ngrok.com/signup}}. After you "\
+              "signup, install your personal authorization token using {{command:%s app tunnel auth <token>}}.",
           },
           installing: "Installing ngrok…",
           not_running: "{{green:x}} ngrok tunnel not running",
           prereq_command_location: "%s @ %s",
-          signup_suggestion: <<~MESSAGE,
-            {{*}} To avoid tunnels that timeout, it is recommended to signup for a free ngrok
-            account at {{underline:https://ngrok.com/signup}}. After you signup, install your
-            personalized authorization token using {{command:%s app tunnel auth <token>}}.
-          MESSAGE
-          start: "{{v}} ngrok tunnel running at {{underline:%s}}",
           start_with_account: "{{v}} ngrok tunnel running at {{underline:%s}}, with account %s",
           stopped: "{{green:x}} ngrok tunnel stopped",
           timed_out: "{{x}} ngrok tunnel has timed out, restarting…",
@@ -809,7 +820,7 @@ module ShopifyCLI
           not_logged_in: <<~MESSAGE,
             It doesn't appear that you're logged in. You must log into a partner organization or a store staff account.
 
-            If trying to log into a store staff account, please use {{command:%s login --store=STORE}} to log in.
+            If trying to log into a store staff account, please use {{command:%s login --store STORE}} to log in.
           MESSAGE
           logged_in_shop_only: <<~MESSAGE,
             Logged into store {{green:%s}} as staff (no partner organizations available for this login)

data/lib/shopify_cli/release.rb

@@ -1,3 +1,5 @@
+require "net/http"
+require "fileutils"
 require "shopify_cli/sed"
 require "shopify_cli/changelog"
 require "octokit"
@@ -15,20 +17,34 @@ module ShopifyCLI
       create_release_branch
       update_changelog
       update_versions_in_files
-      commit
+      commit_packaging
       pr = create_pr
       system("open #{pr["html_url"]}")
     end
 
+    def package!
+      ensure_updated_main
+      ensure_correct_gem_version
+      Rake::Task["package"].invoke
+      update_homebrew
+      create_github_release
+    end
+
     private
 
     attr_reader :new_version, :changelog, :github
 
     def ensure_updated_main
-      current_branch = %x(git branch --show-current)
-      unless current_branch == "main"
-        raise "Must be on the main branch to package a release!"
+      # We can't be sure what is the correct action to take if changes have been
+      # made but not committed. Ensure the user handles the situation before
+      # moving on.
+      unless %x(git status --porcelain).empty?
+        raise <<~MESSAGE
+          Uncommitted changes have been made to the repository.
+          Please make sure `git status` does not show any changes before continuing.
+        MESSAGE
       end
+      system_or_fail("git checkout main", "check out main branch")
       unless system("git pull")
         raise "git pull failed, cannot be sure there aren't new commits!"
       end
@@ -36,13 +52,11 @@ module ShopifyCLI
 
     def create_release_branch
       puts "Checking out release branch"
-      unless system("git checkout -b #{release_branch_name}")
-        puts "Cannot check out release branch!"
-      end
+      system_or_fail("git checkout -b #{release_branch_name}", "check out release branch")
     end
 
     def update_changelog
-      if release_notes.empty?
+      if release_notes("Unreleased").empty?
         puts "No unreleased CHANGELOG updates found!"
       else
         puts "Updating CHANGELOG"
@@ -63,32 +77,118 @@ module ShopifyCLI
       )
     end
 
-    def commit
+    def commit_packaging
       puts "Committing"
-      unless system("git commit -am 'Packaging for release v#{new_version}'")
-        puts "Commit failed!"
-      end
-      unless system("git push -u origin #{release_branch_name}")
-        puts "Failed to push branch!"
-      end
+      system_or_fail("git commit -am 'Packaging for release v#{new_version}'", "commit")
+      system_or_fail("git push -u origin #{release_branch_name}", "push branch")
     end
 
     def create_pr
+      repo = "Shopify/shopify-cli"
       github.create_pull_request(
-        "Shopify/shopify-cli",
+        repo,
         "main",
         release_branch_name,
         "Packaging for release v#{new_version}",
-        release_notes
-      ).tap { |results| puts "Created PR ##{results["number"]}" }
+        release_notes(new_version)
+      ).tap { |results| puts "Created #{repo} PR ##{results["number"]}" }
+    end
+
+    def ensure_correct_gem_version
+      response = Net::HTTP.get(URI("https://rubygems.org/api/v1/versions/shopify-cli/latest.json"))
+      latest_version = JSON.parse(response)["version"]
+      unless latest_version == new_version
+        raise "Attempted to update to #{new_version}, but latest on RubyGems is #{latest_version}"
+      end
+    end
+
+    def update_homebrew
+      ensure_updated_homebrew_repo
+      update_homebrew_repo
+      pr = create_homebrew_pr
+      system("open #{pr["html_url"]}")
+    end
+
+    def ensure_updated_homebrew_repo
+      unless File.exist?(homebrew_path)
+        system_or_fail("/opt/dev/bin/dev clone homebrew-shopify", "clone homebrew-shopify repo")
+      end
+
+      Dir.chdir(homebrew_path) do
+        system_or_fail("git checkout master && git pull", "pull latest homebrew-shopify")
+        system_or_fail("git checkout -b #{homebrew_release_branch}", "check out homebrew branch")
+      end
+    end
+
+    def update_homebrew_repo
+      source_file = File.join(package_dir, "shopify-cli.rb")
+      FileUtils.copy(source_file, homebrew_path)
+      Dir.chdir(homebrew_path) do
+        system_or_fail("git commit -am '#{homebrew_update_message}'", "commit homebrew update")
+        system_or_fail("git push -u origin #{homebrew_release_branch}", "push homebrew branch")
+      end
+    end
+
+    def create_homebrew_pr
+      repo = "Shopify/homebrew-shopify"
+      github.create_pull_request(
+        repo,
+        "master",
+        homebrew_release_branch,
+        homebrew_update_message,
+        homebrew_release_notes
+      ).tap { |results| puts "Created #{repo} PR ##{results["number"]}" }
+    end
+
+    def create_github_release
+      release = github.create_release(
+        "Shopify/shopify-cli",
+        "v#{new_version}",
+        {
+          name: "Version #{new_version}",
+          body: release_notes(new_version),
+        }
+      )
+      %w(.deb -1.noarch.rpm).each do |suffix|
+        github.upload_asset(
+          release["url"],
+          File.join(package_dir, "shopify-cli-#{new_version}#{suffix}")
+        )
+      end
+      system("open #{release["html_url"]}")
+    end
+
+    def homebrew_path
+      @homebrew_path ||= %x(/opt/dev/bin/dev project-path homebrew-shopify).chomp
+    end
+
+    def homebrew_update_message
+      @homebrew_update_message ||= "Update Shopify CLI to #{new_version}"
+    end
+
+    def package_dir
+      @package_dir ||= File.join(ShopifyCLI::ROOT, "packaging", "builds", new_version)
+    end
+
+    def homebrew_release_branch
+      "release_#{new_version.split(".").join("_")}_of_shopify-cli"
+    end
+
+    def homebrew_release_notes
+      "I'm releasing a new version of the Shopify CLI, " \
+        "[#{new_version}](https://github.com/Shopify/shopify-cli/releases/tag/v#{new_version})"
     end
 
     def release_branch_name
       @release_branch_name ||= "release_#{new_version.split(".").join("_")}"
     end
 
-    def release_notes
-      @release_notes ||= changelog.release_notes("Unreleased")
+    def release_notes(version)
+      changelog.release_notes(version)
+    end
+
+    def system_or_fail(command, action)
+      raise "Failed to #{action}!" unless system(command)
     end
   end
 end

data/lib/shopify_cli/services/app/create/rails_service.rb

@@ -109,7 +109,9 @@ module ShopifyCLI
 
           def check_ruby
             ruby_version = Environment.ruby_version(context: context)
-            return if ruby_version.satisfies?("~>2.5") || ruby_version.satisfies?("~>3.1.0")
+            return if ruby_version.satisfies?("~>2.5") ||
+              ruby_version.satisfies?("~>3.0.0") ||
+              ruby_version.satisfies?("~>3.1.0")
             context.abort(context.message("core.app.create.rails.error.invalid_ruby_version"))
           end
 
@@ -205,6 +207,12 @@ module ShopifyCLI
           end
 
           def set_custom_ua
+            requires_ua_file = Dir.chdir(context.root) do
+              context.ruby_gem_version("shopify_app") < ::Semantic::Version.new("19.0.0")
+            end
+
+            return unless requires_ua_file
+
             ua_path = File.join("config", "initializers", "user_agent.rb")
             context.write(ua_path, USER_AGENT_CODE)
           end

data/lib/shopify_cli/services/app/serve/node_service.rb

@@ -2,32 +2,9 @@ module ShopifyCLI
   module Services
     module App
       module Serve
-        class NodeService < BaseService
-          attr_accessor :host, :port, :context
-
-          def initialize(host:, port:, context:)
-            @host = host
-            @port = port
-            @context = context
-            super()
-          end
-
+        class NodeService < ServeService
           def call
-            project = ShopifyCLI::Project.current
-            url = host || ShopifyCLI::Tunnel.start(context, port: port)
-            raise ShopifyCLI::Abort,
-              context.message("core.app.serve.error.host_must_be_https") if url.match(/^https/i).nil?
-            project.env.update(context, :host, url)
-            ShopifyCLI::Tasks::UpdateDashboardURLS.call(
-              context,
-              url: url,
-              callback_url: "/auth/callback",
-            )
-
-            if project.env.shop
-              project_url = "#{project.env.host}/auth?shop=#{project.env.shop}"
-              context.puts("\n" + context.message("core.app.serve.open_info", project_url) + "\n")
-            end
+            generate_url
 
             CLI::UI::Frame.open(context.message("core.app.serve.running_server")) do
               env = project.env.to_h

data/lib/shopify_cli/services/app/serve/php_service.rb

@@ -2,32 +2,9 @@ module ShopifyCLI
   module Services
     module App
       module Serve
-        class PHPService < BaseService
-          attr_accessor :host, :port, :context
-
-          def initialize(host:, port:, context:)
-            @host = host
-            @port = port
-            @context = context
-            super()
-          end
-
+        class PHPService < ServeService
           def call
-            project = ShopifyCLI::Project.current
-            url = host || ShopifyCLI::Tunnel.start(context, port: port)
-            raise ShopifyCLI::Abort,
-              context.message("core.app.serve.error.host_must_be_https") if url.match(/^https/i).nil?
-            project.env.update(context, :host, url)
-            ShopifyCLI::Tasks::UpdateDashboardURLS.call(
-              context,
-              url: url,
-              callback_url: "/auth/callback",
-            )
-
-            if project.env.shop
-              project_url = "#{project.env.host}/login?shop=#{project.env.shop}"
-              context.puts("\n" + context.message("core.app.serve.open_info", project_url) + "\n")
-            end
+            generate_url
 
             CLI::UI::Frame.open(context.message("core.app.serve.running_server")) do
               if ShopifyCLI::ProcessSupervision.running?(:npm_watch)

data/lib/shopify_cli/services/app/serve/rails_service.rb

@@ -2,38 +2,18 @@ module ShopifyCLI
   module Services
     module App
       module Serve
-        class RailsService < BaseService
-          attr_accessor :host, :port, :context
-
-          def initialize(host:, port:, context:)
-            @host = host
-            @port = port
-            @context = context
-            super()
-          end
-
+        class RailsService < ServeService
           def call
-            project = ShopifyCLI::Project.current
-            url = host || ShopifyCLI::Tunnel.start(context, port: port)
-            raise ShopifyCLI::Abort,
-              context.message("core.app.serve.error.host_must_be_https") if url.match(/^https/i).nil?
-            project.env.update(context, :host, url)
-            ShopifyCLI::Tasks::UpdateDashboardURLS.call(
-              context,
-              url: url,
-              callback_url: "/auth/shopify/callback",
-            )
-
-            if project.env.shop
-              project_url = "#{project.env.host}/login?shop=#{project.env.shop}"
-              context.puts("\n" + context.message("core.app.serve.open_info", project_url) + "\n")
-            end
+            generate_url
 
             CLI::UI::Frame.open(context.message("core.app.serve.running_server")) do
-              env = ShopifyCLI::Project.current.env.to_h
-              env.delete("HOST")
+              original_env = JSON.parse(ENV["ORIGINAL_ENV"] || "{}")
+              env = original_env.merge(ShopifyCLI::Project.current.env.to_h)
+              env.delete("HOST") if context.ruby_gem_version("shopify_app") < ::Semantic::Version.new("19.0.0")
               env["PORT"] = port.to_s
-              env["GEM_PATH"] = Rails::Gem.gem_path(context)
+              env["GEM_PATH"] =
+                [env["GEM_PATH"], Rails::Gem.gem_path(context)].compact
+                  .join(CLI::UI::OS.current.path_separator)
               if context.windows?
                 context.system("ruby bin\\rails server", env: env)
               else