shopify-cli 2.15.2 → 2.15.3

data/lib/project_types/script/layers/infrastructure/languages/project_creator.rb

@@ -10,9 +10,7 @@ module Script
           property! :type, accepts: String
           property! :project_name, accepts: String
           property! :path_to_project, accepts: String
-          property! :sparse_checkout_repo, accepts: String
-          property! :sparse_checkout_branch, accepts: String
-          property! :sparse_checkout_set_path, accepts: String
+          property! :sparse_checkout_details, accepts: SparseCheckoutDetails
 
           def self.for(
             ctx:,
@@ -20,9 +18,7 @@ module Script
             type:,
             project_name:,
             path_to_project:,
-            sparse_checkout_repo:,
-            sparse_checkout_branch:,
-            sparse_checkout_set_path:
+            sparse_checkout_details:
           )
 
             project_creators = {
@@ -36,33 +32,22 @@ module Script
               type: type,
               project_name: project_name,
               path_to_project: path_to_project,
-              sparse_checkout_repo: sparse_checkout_repo,
-              sparse_checkout_branch: sparse_checkout_branch,
-              sparse_checkout_set_path: sparse_checkout_set_path
+              sparse_checkout_details: sparse_checkout_details,
             )
           end
 
           # the sparse checkout process is common to all script types
           def setup_dependencies
-            setup_sparse_checkout
+            sparse_checkout_details.setup(ctx)
             clean
           end
 
           private
 
-          def setup_sparse_checkout
-            ShopifyCLI::Git.sparse_checkout(
-              sparse_checkout_repo,
-              sparse_checkout_set_path,
-              sparse_checkout_branch,
-              ctx
-            )
-          end
-
           def clean
-            source = File.join(path_to_project, sparse_checkout_set_path, ".")
+            source = File.join(path_to_project, sparse_checkout_details.path, ".")
             FileUtils.cp_r(source, path_to_project)
-            ctx.rm_rf(sparse_checkout_set_path.split("/")[0])
+            ctx.rm_rf(sparse_checkout_details.path.split("/")[0])
             ctx.rm_rf(".git")
           end
 

data/lib/project_types/script/layers/infrastructure/sparse_checkout_details.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      class SparseCheckoutDetails
+        include SmartProperties
+        property! :repo, accepts: String
+        property! :branch, accepts: String
+        property! :path, accepts: String
+        property! :input_queries_enabled, accepts: [true, false]
+
+        def ==(other)
+          self.class == other.class &&
+            self.class.properties.all? { |name, _| self[name] == other[name] }
+        end
+
+        def setup(ctx)
+          ShopifyCLI::Git.sparse_checkout(repo, patterns_to_checkout, branch, ctx)
+        end
+
+        private
+
+        def patterns_to_checkout
+          paths = [path]
+          unless input_queries_enabled
+            paths << "!#{path}/#{ScriptProjectRepository::INPUT_QUERY_PATH}"
+            paths << "!#{path}/schema.graphql"
+          end
+          paths.join(" ")
+        end
+      end
+    end
+  end
+end

data/lib/project_types/theme/cli.rb

@@ -16,6 +16,7 @@ module Theme
     subcommand :Package, "package", Project.project_filepath("commands/package")
     subcommand :Open, "open", Project.project_filepath("commands/open")
     subcommand :List, "list", Project.project_filepath("commands/list")
+    subcommand :Share, "share", Project.project_filepath("commands/share")
     subcommand :LanguageServer, "language-server", Project.project_filepath("commands/language_server")
   end
   ShopifyCLI::Commands.register("Theme::Command", "theme")

data/lib/project_types/theme/commands/check.rb

@@ -24,7 +24,10 @@ module Theme
       end
 
       def call(*)
-        @theme_check.run
+        @theme_check.run!
+      rescue ThemeCheck::Cli::Abort, ThemeCheck::ThemeCheckError => e
+        raise ShopifyCLI::Abort,
+          ShopifyCLI::Context.message("theme.check.error", e.full_message)
       end
 
       def self.help

data/lib/project_types/theme/commands/open.rb

@@ -17,8 +17,8 @@ module Theme
       def call(_args, _name)
         theme = find_theme(**options.flags)
 
-        @ctx.puts(@ctx.message("theme.open.details", theme.name, theme.editor_url))
-        @ctx.open_url!(theme.preview_url)
+        @ctx.puts(@ctx.message("theme.open.details", theme.name, theme.preview_url, theme.editor_url))
+        @ctx.open_browser_url!(theme.preview_url)
       end
 
       def self.help

data/lib/project_types/theme/commands/push.rb

@@ -104,9 +104,7 @@ module Theme
 
         if unpublished
           name = theme || ask_theme_name
-          new_theme = ShopifyCLI::Theme::Theme.new(@ctx, root: root, name: name, role: "unpublished")
-          new_theme.create
-          return new_theme
+          return ShopifyCLI::Theme::Theme.create_unpublished(@ctx, root: root, name: name)
         end
 
         if theme

data/lib/project_types/theme/commands/share.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "shopify_cli/theme/theme"
+require "shopify_cli/theme/syncer"
+require "project_types/theme/commands/common/root_helper"
+
+module Theme
+  class Command
+    class Share < ShopifyCLI::Command::SubCommand
+      include Common::RootHelper
+
+      recommend_default_ruby_range
+
+      def call(_args, name)
+        root = root_value(options, name)
+        theme = create_theme(root)
+
+        upload(theme)
+
+        @ctx.done(done_message(theme))
+      end
+
+      def self.help
+        tool = ShopifyCLI::TOOL_NAME
+        @ctx.message("theme.share.help", tool, tool)
+      end
+
+      private
+
+      def create_theme(root)
+        ShopifyCLI::Theme::Theme.create_unpublished(@ctx, root: root)
+      end
+
+      def upload(theme)
+        syncer = ShopifyCLI::Theme::Syncer.new(@ctx, theme: theme)
+        syncer.start_threads
+
+        CLI::UI::Frame.open(upload_message(theme)) do
+          UI::SyncProgressBar.new(syncer).progress(:upload_theme!)
+        end
+
+        raise ShopifyCLI::AbortSilent if syncer.has_any_error?
+      ensure
+        syncer.shutdown
+      end
+
+      def upload_message(theme)
+        @ctx.message("theme.share.upload", theme.name, theme.id, theme.shop)
+      end
+
+      def done_message(theme)
+        @ctx.message("theme.share.done", theme.name, theme.preview_url, theme.editor_url)
+      end
+    end
+  end
+end

data/lib/project_types/theme/messages/messages.rb

@@ -8,8 +8,9 @@ module Theme
             Usage: {{command:%1$s theme [ %2$s ]}}
         HELP
         ensure_user_error: "You are not authorized to edit themes on %s.",
-        ensure_user_try_this: "Make sure you are a user of that store, and allowed to edit themes.",
-
+        ensure_user_try_this: <<~ENSURE_USER,
+          Check if your user is activated, has permission to edit themes at the store, and try to re-login.
+        ENSURE_USER
         init: {
           help: <<~HELP,
             {{command:%s theme init}}: Clones a Git repository to use as a starting point for building a new theme.
@@ -181,7 +182,7 @@ module Theme
           CUSTOMIZE_OR_PREVIEW
           ensure_user: <<~ENSURE_USER,
             You are not authorized to edit themes on %s.
-            Make sure you are a user of that store, and allowed to edit themes.
+            Check if your user is activated, has permission to edit themes at the store, and try to re-login.
           ENSURE_USER
           address_already_in_use: "The address \"%s\" is already in use.",
           try_port_option: "Use the --port=PORT option to serve the theme in a different port.",
@@ -191,6 +192,7 @@ module Theme
             Check your theme for errors, suggestions, and best practices.
             Usage: {{command:%s check}}
           HELP
+          error: "Theme check failed with error:\n%s",
         },
         delete: {
           help: <<~HELP,
@@ -262,6 +264,9 @@ module Theme
           details: <<~DETAILS,
             {{*}} {{bold:%s}}
 
+            Preview your theme:
+            {{green:%s}}
+
             Customize your theme in the Theme Editor:
             {{green:%s}}
 
@@ -285,6 +290,22 @@ module Theme
             Usage: {{command:%s theme list}}
           HELP
         },
+        share: {
+          help: <<~HELP,
+            {{command:%s theme share}}: Creates a shareable, unpublished, and new theme on your theme library with a randomized name.
+                                 Works like an alias to {{command:theme push -u -t=RANDOMIZED_NAME}}.
+
+            Usage: {{command:%s theme share [ ROOT ]}}
+          HELP
+          done: <<~DONE,
+            {{green:The {{bold:%s}} theme was pushed successfully}}
+
+              {{info:Share your theme preview:}}
+              {{underline:%s}}
+
+          DONE
+          upload: "Pushing theme files to %s (#%s) on %s",
+        },
       },
     }.freeze
   end

data/lib/shopify_cli/changelog.rb

@@ -1,23 +1,32 @@
+require "date"
 require "shopify_cli/sed"
+require "octokit"
 
 module ShopifyCLI
   class Changelog
     CHANGELOG_FILE = File.join(ShopifyCLI::ROOT, "CHANGELOG.md")
+    CHANGE_CATEGORIES = %w(Added Changed Deprecated Removed Fixed Security)
 
     def initialize
       load(File.read(CHANGELOG_FILE))
     end
 
     def update_version!(new_version)
-      Sed.new.replace_inline(
-        CHANGELOG_FILE,
-        "## \\[Unreleased\\]",
-        "## [Unreleased]\\n\\n## Version #{new_version}"
-      )
+      changes[new_version] = changes["Unreleased"]
+      changes[new_version][:date] = Date.today.iso8601
+      changes["Unreleased"] = { changes: [], date: nil }
+      save!
+    end
+
+    def update!
+      pr = pr_for_current_branch
+      category = CLI::UI::Prompt.ask("What type of change?", options: CHANGE_CATEGORIES)
+      add_change(category, { pr_id: pr.number, desc: pr.title })
+      save!
     end
 
     def release_notes(version)
-      changes[version].map do |change_category, changes|
+      changes[version][:changes].map do |change_category, changes|
         <<~CHANGES
           ### #{change_category}
           #{changes.map { |change| entry(**change) }.join("\n")}
@@ -25,17 +34,61 @@ module ShopifyCLI
       end.join("\n")
     end
 
+    def add_change(category, change)
+      changes["Unreleased"][:changes][category] << change
+    end
+
     def entry(pr_id:, desc:)
       "* [##{pr_id}](https://github.com/Shopify/shopify-cli/pull/#{pr_id}): #{desc}"
     end
 
+    def full_contents
+      sorted_changes = changes.each_key.sort_by do |change|
+        if change == "Unreleased"
+          [Float::INFINITY] * 3 # end of the list
+        else
+          major, minor, patch = change.split(".").map(&:to_i)
+          [major, minor, patch]
+        end
+      end.reverse
+      [
+        heading,
+        *sorted_changes.each.map { |version| release_notes_with_header(version) }.join,
+        remainder,
+      ].map { |section| section.chomp << "\n" }.join
+    end
+
+    def save!
+      File.write(CHANGELOG_FILE, full_contents)
+    end
+
     private
 
+    attr_reader :heading, :remainder
+
+    def release_notes_with_header(version)
+      header_line =
+        if version == "Unreleased"
+          "[Unreleased]"
+        else
+          date = changes[version][:date]
+          "Version #{version}#{" - #{date}" if date}"
+        end
+
+      [
+        "## #{header_line}",
+        release_notes(version),
+      ].reject(&:empty?).map { |section| section.chomp << "\n\n" }.join
+    end
+
     def changes
       @changes ||= Hash.new do |h, k|
-        h[k] = Hash.new do |h2, k2|
-          h2[k2] = []
-        end
+        h[k] = {
+          date: nil,
+          changes: Hash.new do |h2, k2|
+            h2[k2] = []
+          end,
+        }
       end
     end
 
@@ -43,34 +96,53 @@ module ShopifyCLI
       state = :initial
       change_category = nil
       current_version = nil
+      @heading = ""
       @remainder = ""
       log.each_line do |line|
         case state
         when :initial
-          next unless line.chomp == "\#\# [Unreleased]"
-          state = :unreleased
-          current_version = "Unreleased"
-        when :unreleased, :last_version
+          if line.chomp == "\#\# [Unreleased]"
+            state = :unreleased
+            current_version = "Unreleased"
+            # Ensure Unreleased changeset exists even if no changes have happened yet
+            changes["Unreleased"]
+          else
+            @heading << line
+          end
+        when :unreleased, :prior_versions
           if /\A\#\#\# (?<category>\w+)/ =~ line
             change_category = category
-          elsif %r{\A\* \[\#(?<pr_id>\d+)\]\(https://github.com/Shopify/shopify-cli/pull/\d+\): (?<desc>.+)\n} =~ line
-            changes[current_version][change_category] << { pr_id: pr_id, desc: desc }
-          elsif /\A\#\# Version (?<version>\d+\.\d+\.\d+)/ =~ line
+          elsif %r{\A\* \[\#(?<id>\d+)\]\(https://github.com/Shopify/shopify-cli/pull/\k<id>\): (?<desc>.+)\n} =~ line
+            changes[current_version][:changes][change_category] << { pr_id: id, desc: desc }
+          elsif /\A\#\# Version (?<version>\d+\.\d+\.\d+)( - (?<date>\d{4}-\d{2}-\d{2}))?/ =~ line
             current_version = version
-            state =
-              case state
-              when :unreleased
-                :last_version
-              else
-                :finished
-              end
+            state = :prior_versions
+            major, minor, _patch = current_version.split(".")
+            if major.to_i <= 2 && minor.to_i < 7
+              # Changelog starts to become irregular in 2.6.x
+              state = :finished
+            end
+            changes[current_version][:date] = date unless state == :finished
           elsif !line.match?(/\s*\n/)
             raise "Unrecognized line: #{line.inspect}"
           end
-        when :finished
-          @remainder << line
         end
+        @remainder << line if state == :finished
       end
     end
+
+    def pr_for_current_branch
+      current_branch = %x(git branch --show-current).chomp
+      search_term = "repo:Shopify/shopify-cli is:pr is:open head:#{current_branch}"
+      results = Octokit::Client.new.search_issues(search_term)
+      case results.total_count
+      when 0
+        raise "PR not opened yet!"
+      when (2..)
+        raise "Multiple open PRs, not sure which one to use for changelog!"
+      end
+
+      results.items.first
+    end
   end
 end

data/lib/shopify_cli/command_options/command_serve_options.rb

@@ -20,6 +20,10 @@ module ShopifyCLI
             end
             host
           end
+
+          def no_update
+            options.flags[:no_update] || false
+          end
         end
       end
 
@@ -37,6 +41,12 @@ module ShopifyCLI
             parser.on("--port=PORT") { |port| flags[:port] = port }
           end
         end
+
+        def parse_no_update_option
+          options do |parser, flags|
+            parser.on("--no-update") { flags[:no_update] = true }
+          end
+        end
       end
     end
   end

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/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`",
                 },
@@ -447,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: {
@@ -714,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",

data/lib/shopify_cli/release.rb

@@ -90,7 +90,7 @@ module ShopifyCLI
         "main",
         release_branch_name,
         "Packaging for release v#{new_version}",
-        release_notes("Unreleased")
+        release_notes(new_version)
       ).tap { |results| puts "Created #{repo} PR ##{results["number"]}" }
     end