shopify-cli 2.15.1 → 2.15.4

data/lib/project_types/script/layers/application/create_script.rb

@@ -23,19 +23,23 @@ module Script
               )
 
               # remove the need to pass the whole extension-point object to the infra layer
-              sparse_checkout_repo = extension_point.libraries.for(language).repo
               type = extension_point.dasherize_type
               domain = extension_point.domain
 
+              sparse_checkout_details = Infrastructure::SparseCheckoutDetails.new(
+                repo: extension_point.libraries.for(language).repo,
+                branch: sparse_checkout_branch,
+                path: "#{domain}/#{language}/#{type}/default",
+                input_queries_enabled: input_queries_enabled?,
+              )
+
               project_creator = Infrastructure::Languages::ProjectCreator.for(
                 ctx: ctx,
                 language: language,
                 type: type,
                 project_name: title,
                 path_to_project: project.id,
-                sparse_checkout_repo: sparse_checkout_repo,
-                sparse_checkout_branch: sparse_checkout_branch,
-                sparse_checkout_set_path: "#{domain}/#{language}/#{type}/default"
+                sparse_checkout_details: sparse_checkout_details,
               )
 
               install_dependencies(ctx, language, title, project_creator)
@@ -49,12 +53,12 @@ module Script
             task_runner = Infrastructure::Languages::TaskRunner.for(ctx, language)
             CLI::UI::Frame.open(ctx.message(
               "core.git.pulling_from_to",
-              project_creator.sparse_checkout_repo,
+              project_creator.sparse_checkout_details.repo,
               title,
             )) do
               UI::StrictSpinner.spin(ctx.message(
                 "core.git.pulling",
-                project_creator.sparse_checkout_repo,
+                project_creator.sparse_checkout_details.repo,
                 title,
               )) do |spinner|
                 project_creator.setup_dependencies
@@ -75,6 +79,10 @@ module Script
           ensure
             script_project_repo.change_to_initial_directory
           end
+
+          def input_queries_enabled?
+            ShopifyCLI::Feature.enabled?(:scripts_beta_input_queries)
+          end
         end
       end
     end

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

@@ -180,6 +180,23 @@ module Script
             @max_size = max_size
           end
         end
+
+        class InvalidInputQueryErrors < ScriptProjectError
+          attr_reader :messages
+
+          def initialize(messages)
+            @messages = messages
+            super()
+          end
+
+          def input_query_path
+            ScriptProjectRepository::INPUT_QUERY_PATH
+          end
+
+          def message
+            messages.join("\n")
+          end
+        end
       end
     end
   end

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/script_service.rb

@@ -83,6 +83,8 @@ module Script
               valid_types: e["message"],
               filename: script_config.filename,
             )
+          elsif (errors = user_errors.filter { |err| err["tag"] == "input_query_validation_error" }).any?
+            raise Errors::InvalidInputQueryErrors, errors.map { |err| err["message"] }
           elsif user_errors.find { |err| %w(not_use_msgpack_error schema_version_argument_error).include?(err["tag"]) }
             raise Domain::Errors::MetadataValidationError
           else

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/script/messages/messages.rb

@@ -86,6 +86,9 @@ module Script
                                                      "type(s): %{valid_types}.",
           configuration_schema_field_invalid_value_error_help: "Change the value of the type.",
 
+          input_query_error_cause: "Input query is invalid:\n%{messages}\n\n",
+          input_query_error_help: "Fix the query in the `%{input_query_path}` file.",
+
           script_not_found_cause: "Can't find script %s for Script API %s",
 
           system_call_failure_cause: "Something went wrong while running: {{command:%{cmd}}}.",

data/lib/project_types/script/ui/error_handler.rb

@@ -216,6 +216,17 @@ module Script
               "script.error.configuration_schema_field_invalid_value_error_help"
             ),
           }
+        when Layers::Infrastructure::Errors::InvalidInputQueryErrors
+          {
+            cause_of_error: ShopifyCLI::Context.message(
+              "script.error.input_query_error_cause",
+              messages: e.messages.map { |message| "  {{x}} #{message}." }.join("\n"),
+            ),
+            help_suggestion: ShopifyCLI::Context.message(
+              "script.error.input_query_error_help",
+              input_query_path: e.input_query_path,
+            ),
+          }
         when Layers::Infrastructure::Errors::DependencyInstallError
           {
             cause_of_error: ShopifyCLI::Context.message("script.error.dependency_install_cause"),

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/serve.rb

@@ -16,6 +16,7 @@ module Theme
         parser.on("--port=PORT") { |port| flags[:port] = port.to_i }
         parser.on("--poll") { flags[:poll] = true }
         parser.on("--live-reload=MODE") { |mode| flags[:mode] = as_reload_mode(mode) }
+        parser.on("--theme-editor-sync") { flags[:editor_sync] = true }
       end
 
       def call(_args, name)

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.
@@ -101,13 +102,14 @@ module Theme
             Usage: {{command:%s theme serve [ ROOT ]}}
 
             Options:
-              {{command:--port=PORT}}        Local port to serve theme preview from.
-              {{command:--poll}}             Force polling to detect file changes.
-              {{command:--host=HOST}}        Set which network interface the web server listens on. The default value is 127.0.0.1.
-              {{command:--live-reload=MODE}} The live reload mode switches the server behavior when a file is modified:
-                                 - {{command:hot-reload}} Hot reloads local changes to CSS and sections (default)
-                                 - {{command:full-page}}  Always refreshes the entire page
-                                 - {{command:off}}        Deactivate live reload
+              {{command:--port=PORT}}         Local port to serve theme preview from.
+              {{command:--poll}}              Force polling to detect file changes.
+              {{command:--host=HOST}}         Set which network interface the web server listens on. The default value is 127.0.0.1.
+              {{command:--theme-editor-sync}} Synchronize Theme Editor updates in the local theme files.
+              {{command:--live-reload=MODE}}  The live reload mode switches the server behavior when a file is modified:
+                                  - {{command:hot-reload}} Hot reloads local changes to CSS and sections (default)
+                                  - {{command:full-page}}  Always refreshes the entire page
+                                  - {{command:off}}        Deactivate live reload
           HELP
           reload_mode_is_not_valid: "The live reload mode `%s` is not valid.",
           try_a_valid_reload_mode: "Try a valid live reload mode: %s.",
@@ -121,6 +123,36 @@ module Theme
               fixed: "Fixed",
             },
           },
+          syncer: {
+            forms: {
+              apply_to_all: {
+                title: "Would like apply this to all the other %s files?",
+                yes: "Yes",
+                no: "No",
+              },
+              update_strategy: {
+                title_context: <<~TITLE,
+
+                  The local file {{command:%s}} is different from the remote version in the development theme."
+                TITLE
+                title_question: "What would you like to do?",
+                keep_remote: "Keep the remote version",
+                keep_local: "Keep the local version",
+                union_merge: "Merge files (it may break the local file)",
+                exit: "Exit",
+              },
+              delete_strategy: {
+                title_context: <<~TITLE,
+
+                  The local file {{command:%s}} has been recently removed, but it's present on your remote development theme.",
+                TITLE
+                title_question: "What would you like to do?",
+                delete: "Delete permanently",
+                restore: "Restore with the remote version",
+                exit: "Exit",
+              },
+            },
+          },
           error: {
             address_binding_error: "Couldn't bind to localhost."\
               " To serve your theme, set a different address with {{command:%s theme serve --host=<address>}}",
@@ -137,9 +169,10 @@ module Theme
             Serving %s
 
           SERVING
+          download_changes: ", and use 'theme pull' to get the changes",
           customize_or_preview: <<~CUSTOMIZE_OR_PREVIEW,
 
-            Customize this theme in the Theme Editor:
+            Customize this theme in the Theme Editor%s:
             {{green:%s}}
 
             Share this theme preview:
@@ -149,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.",
@@ -159,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,
@@ -230,6 +264,9 @@ module Theme
           details: <<~DETAILS,
             {{*}} {{bold:%s}}
 
+            Preview your theme:
+            {{green:%s}}
+
             Customize your theme in the Theme Editor:
             {{green:%s}}
 
@@ -253,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