shopify-cli 2.31.0 → 2.32.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 671907fe67b2c0ee4ff9c99a55bfbf53562f15f7540c23c6fb07ddb9b46398df
-  data.tar.gz: 5a327f5060b50fa1761a20d5ca1601cab1fc44e7f3e1b7ab62e6747b9a92a164
+  metadata.gz: cedba2d3c1257478768278fcf18b239d18d49b56dd11ce9cb4eb60810f9bd46c
+  data.tar.gz: 252212433092e2df2f821782a58b57f8864bac936d04cac6f51a74a1891b3e59
 SHA512:
-  metadata.gz: 2baa5372dc8502fe0764378b556b043eb136415ee9f94f1ea42fead7e367f46bdc0114b6e79f0eef99cb92270117561f004d09157e9bce3b45912aaead4bd20a
-  data.tar.gz: 42819560813ed73fc39d09e68d5e7d07a68ca6b70af5666abca8741740f6d2fb912d500a28bd5ba9dbcb076ad0f9444097157a778cabd506abca06c6db302021
+  metadata.gz: c8d241e1d4353e2dd8e750fb81b47f936a9c35e7117e785ca50444acbf918956925a04657229b2afd84e8bad930d7bdd9cfe5cd0e67f6cf055f6899f91f27d0a
+  data.tar.gz: b3eb6d62f7fbc3c566161a8a1c09ed5d7679eda82a81eb0622fe7cc7ef9af391677f8281795fbff40ddec5b63fc529381165de02a91103fc851e96b2baa84d7c

data/CHANGELOG.md

@@ -2,6 +2,20 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 
 ## [Unreleased]
 
+## Version 2.32.1 - 2022-12-05
+
+### Fixed
+* [#2694](https://github.com/Shopify/shopify-cli/pull/2694): Add sunset warnings
+
+## Version 2.32.0 - 2022-11-14
+
+### Added
+* [#2680](https://github.com/Shopify/shopify-cli/pull/2680): Validate on `shopify theme share/pull/push/serve` if users are running the command in a theme/empty directory
+
+### Fixed
+* [#2683](https://github.com/Shopify/shopify-cli/pull/2683): Fix timeout issue with the `shopify theme push` command and the `--json` flag
+* [#2688](https://github.com/Shopify/shopify-cli/pull/2688): Fix `shopify theme push` to report pushes with errors
+
 ## Version 2.31.0 - 2022-11-07
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.31.0)
+    shopify-cli (2.32.1)
       bugsnag (~> 6.22)
       listen (~> 3.7.0)
       theme-check (~> 1.11.0)
@@ -101,7 +101,7 @@ GEM
     mocha (1.13.0)
     multi_test (0.1.2)
     multipart-post (2.1.1)
-    nokogiri (1.13.8)
+    nokogiri (1.13.9)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     octokit (4.22.0)

data/README.md

@@ -11,17 +11,11 @@
   <img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License">
   <img src="https://img.shields.io/badge/Powered%20by-Ruby-red" alt="Powered by Ruby">
 
-
 Shopify CLI 2.0 is a command line to help you build on Shopify. It's available as a Ruby gem and can be run and installed on Mac, Linux, and Windows systems.
 
-## Note on Shopify CLI 2.0 versus Shopify CLI 3.0 ##
-
-Use 2.0 for developing themes. For developing apps and custom storefronts, we recommend using [Shopify CLI 3.0](https://github.com/Shopify/cli).
-
-
-## Installation 
+## CLI Deprecation & Sunset
 
-Check out our [installation steps](docs/users/installation.md).
+Note that Shopify 2.0 is deprecated and will be [sunset on May 31, 2023](https://shopify.dev/changelog/cli-2-0-to-be-sunset-on-may-31-2023). We encourage using [Shopify CLI 3.0](https://github.com/Shopify/cli) to develop apps, custom storefronts, and themes. 
 
 ## Contributing 👩‍💻
 

data/lib/project_types/theme/commands/common/root_helper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "project_types/theme/models/specification_handlers/theme"
+
 module Theme
   class Command
     module Common
@@ -35,8 +37,28 @@ module Theme
           "."
         end
 
+        def valid_theme_directory?(root)
+          Theme::Models::SpecificationHandlers::Theme.new(root).valid? ||
+            current_directory_confirmed?
+        end
+
+        def exist_and_not_empty?(root)
+          Dir.exist?(root) && !Dir[File.join(root, "*")].empty?
+        end
+
         private
 
+        def current_directory_confirmed?
+          raise "Current theme directory can't be confirmed during tests" if @ctx.testing?
+
+          Forms::ConfirmStore.ask(
+            @ctx,
+            [],
+            title: @ctx.message("theme.confirm_current_directory"),
+            force: options.flags[:force],
+          ).confirmed?
+        end
+
         def default_argv(options)
           options.parser.default_argv.compact
         end

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

@@ -34,10 +34,13 @@ module Theme
           flags[:ignores] ||= []
           flags[:ignores] |= pattern
         end
+        parser.on("-f", "--force") { flags[:force] = true }
       end
 
       def call(_args, name)
         root = root_value(options, name)
+        return if exist_and_not_empty?(root) && !valid_theme_directory?(root)
+
         delete = !options.flags[:nodelete]
         theme = find_theme(root, **options.flags)
         return if theme.nil?

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

@@ -39,10 +39,13 @@ module Theme
           flags[:ignores] ||= []
           flags[:ignores] |= pattern
         end
+        parser.on("-f", "--force") { flags[:force] = true }
       end
 
       def call(_args, name)
         root = root_value(options, name)
+        return unless valid_theme_directory?(root)
+
         delete = !options.flags[:nodelete]
         theme = find_theme(root, **options.flags)
         return if theme.nil?

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

@@ -34,12 +34,15 @@ module Theme
           flags[:ignores] ||= []
           flags[:ignores] |= pattern
         end
+        parser.on("-f", "--force") { flags[:force] = true }
       end
 
       def call(_args, name)
         valid_authentication_method!
 
         root = root_value(options, name)
+        return unless valid_theme_directory?(root)
+
         flags = options.flags.dup
         host = flags[:host] || DEFAULT_HTTP_HOST
 

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

@@ -11,8 +11,14 @@ module Theme
 
       recommend_default_ruby_range
 
+      options do |parser, flags|
+        parser.on("-f", "--force") { flags[:force] = true }
+      end
+
       def call(_args, name)
         root = root_value(options, name)
+        return unless valid_theme_directory?(root)
+
         theme = create_theme(root)
 
         upload(theme)

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

@@ -18,6 +18,8 @@ module Theme
         ENSURE_USER
         stable_flag_suggestion: "If the current command isn't working as expected," \
           " we suggest re-running the command with the {{command: --stable}} flag",
+        confirm_current_directory: "It doesn’t seem like you’re running this command in a theme directory. " \
+          "Are you sure you want to proceed?",
         init: {
           help: <<~HELP,
             {{command:%s theme init}}: Clones a Git repository to use as a starting point for building a new theme.

data/lib/project_types/theme/models/specification_handlers/theme.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Theme
+  module Models
+    module SpecificationHandlers
+      class Theme
+        REQUIRED_FOLDERS = %w(config layout sections templates)
+
+        def initialize(root)
+          @root = root
+        end
+
+        def valid?
+          REQUIRED_FOLDERS.all? { |required_folder| Dir.exist?(File.join(@root, required_folder)) }
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/core/entry_point.rb

@@ -5,28 +5,7 @@ module ShopifyCLI
     module EntryPoint
       class << self
         def call(args, ctx = Context.new)
-          # Only instruct the user to update the CLI, or warn them that they're
-          # using CLI2 not CLI3, if they're running CLI2 directly. Otherwise the
-          # warnings will be confusing and/or incorrect.
-          unless Environment.run_as_subprocess?
-            if ctx.development? && !ctx.testing?
-              ctx.warn(
-                ctx.message(
-                  "core.warning.development_version",
-                  File.join(ShopifyCLI::ROOT, "bin", ShopifyCLI::TOOL_NAME)
-                )
-              )
-              # because `!ctx.new_version.nil?` will change the config by calling ::Config.set
-              # it's important to keep the checks in this order so that we don't trigger it while testing
-              # since changing the config will throw errors
-            elsif !ctx.testing? && !ctx.new_version.nil?
-              ctx.warn(ctx.message("core.warning.new_version", ShopifyCLI::VERSION, ctx.new_version))
-            end
-
-            if ShopifyCLI::Core::CliVersion.using_3_0?
-              ctx.warn(ctx.message("core.warning.in_3_0_directory"))
-            end
-          end
+          show_warnings(ctx, args.join(" "))
 
           ProjectType.load_all
 
@@ -38,6 +17,47 @@ module ShopifyCLI
             executor.call(command, command_name, args)
           end
         end
+
+        def show_warnings(ctx, args)
+          # Only instruct the user to update the CLI, or warn them that they're
+          # using CLI2 not CLI3, if they're running CLI2 directly. Otherwise the
+          # warnings will be confusing and/or incorrect.
+          return if Environment.run_as_subprocess?
+
+          show_sunset_warning(ctx, args)
+
+          if ctx.development? && !ctx.testing?
+            ctx.warn(
+              ctx.message(
+                "core.warning.development_version",
+                File.join(ShopifyCLI::ROOT, "bin", ShopifyCLI::TOOL_NAME)
+              )
+            )
+            # because `!ctx.new_version.nil?` will change the config by calling ::Config.set
+            # it's important to keep the checks in this order so that we don't trigger it while testing
+            # since changing the config will throw errors
+          elsif !ctx.testing? && !ctx.new_version.nil?
+            ctx.warn(ctx.message("core.warning.new_version", ShopifyCLI::VERSION, ctx.new_version))
+          end
+
+          if ShopifyCLI::Core::CliVersion.using_3_0?
+            ctx.warn(ctx.message("core.warning.in_3_0_directory"))
+          end
+        end
+
+        def show_sunset_warning(ctx, args)
+          return if ctx.testing?
+
+          if args.start_with?("app create") || args.start_with?("app extension create")
+            ctx.warn(ctx.message("core.warning.sunset_create_app"))
+          elsif args.start_with?("app")
+            ctx.warn(ctx.message("core.warning.sunset_app"))
+          elsif args.start_with?("theme")
+            ctx.warn(ctx.message("core.warning.sunset_theme"))
+          else
+            ctx.warn(ctx.message("core.warning.sunset"))
+          end
+        end
       end
     end
   end

data/lib/shopify_cli/messages/messages.rb

@@ -804,6 +804,22 @@ module ShopifyCLI
               Already have CLI 3.0 installed? Run it using your node package manager, as explained here:
               {{underline:https://shopify.dev/apps/tools/cli/cli-2#running-shopify-cli-2-x-and-3-x-in-the-same-environment}}
           MESSAGE
+
+          sunset: <<~MESSAGE,
+            {{*}} {{yellow:Note that CLI 2.x will be sunset on May 31, 2023.}}
+          MESSAGE
+
+          sunset_create_app: <<~MESSAGE,
+            {{*}} {{yellow:Note that this CLI 2.x command will be sunset on April 28, 2023. Check here for instructions on how to migrate over to CLI 3.x: {{underline:https://shopify.dev/apps/tools/cli/migrate}}.}}
+          MESSAGE
+
+          sunset_app: <<~MESSAGE,
+            {{*}} {{yellow:Note that CLI 2.x will be sunset on May 31, 2023. Check here for instructions on how to migrate over to CLI 3.x: {{underline:https://shopify.dev/apps/tools/cli/migrate}}.}}
+          MESSAGE
+
+          sunset_theme: <<~MESSAGE,
+            {{*}} {{yellow:Note that CLI 2.x will be sunset on May 31, 2023. Check here for instructions on how to migrate over to CLI 3.x: {{underline:https://shopify.dev/themes/tools/cli/migrate}}.}}
+          MESSAGE
         },
         reporting: {
           help: <<~HELP,

data/lib/shopify_cli/theme/syncer/uploader.rb

@@ -26,13 +26,11 @@ module ShopifyCLI
           :ignore_file?,
           :overwrite_json?,
           :bulk_updates_activated?,
-
           # enqueue
           :enqueue_deletes,
           :enqueue_get,
           :enqueue_union_merges,
           :enqueue_updates,
-
           # checksums
           :checksums,
           :update_checksums,
@@ -112,7 +110,7 @@ module ShopifyCLI
           retries = 0
           pending_items = files.map { |file| bulk_item(file) }
 
-          while pending_items.any? && retries < 4
+          while pending_items.any? && retries < 2
             bulk = Bulk.new(ctx, theme, api_client)
 
             files
@@ -183,7 +181,7 @@ module ShopifyCLI
             [
               theme["config/settings_schema.json"],
               theme["config/settings_data.json"],
-            ]
+            ],
           )
         end
 
@@ -212,13 +210,19 @@ module ShopifyCLI
         end
 
         def update_progress_bar(size, total)
-          @update_progress_bar_block.call(size, total)
+          @update_progress_bar_block&.call(size, total)
         end
 
         # Handler errors
 
-        def report(file, _error)
-          error_message = "The asset #{file.relative_path} could not be uploaded.\n#{e.inspect}"
+        def report(file, error)
+          file_path = file.relative_path
+
+          error_message = syncer
+            .parse_api_errors(file, error)
+            .map { |msg| "#{file_path}: #{msg}" }
+            .join("\n")
+
           syncer.report_file_error(file, error_message)
         end
       end

data/lib/shopify_cli/theme/syncer.rb

@@ -121,6 +121,7 @@ module ShopifyCLI
 
       def wait!
         raise ThreadError, "No syncer threads" if @threads.empty?
+
         total = size
         last_size = size
         until empty? || @queue.closed?
@@ -134,7 +135,7 @@ module ShopifyCLI
 
       def fetch_checksums!
         _status, response = api_client.get(
-          path: "themes/#{@theme.id}/assets.json"
+          path: "themes/#{@theme.id}/assets.json",
         )
         update_checksums(response)
       end
@@ -151,6 +152,7 @@ module ShopifyCLI
             loop do
               operation = @queue.pop
               break if operation.nil? # shutdown was called
+
               perform(operation)
             rescue Exception => e # rubocop:disable Lint/RescueException
               error_suffix = ": #{e}"
@@ -195,7 +197,7 @@ module ShopifyCLI
       end
 
       def handle_operation_error(operation, error)
-        error_suffix = ":\n  " + parse_api_errors(operation, error).join("\n  ")
+        error_suffix = ":\n  " + parse_api_errors(operation.file, error).join("\n  ")
         report_error(operation, error_suffix)
       end
 
@@ -206,6 +208,7 @@ module ShopifyCLI
       def update_checksums(api_response)
         api_response.values.flatten.each do |asset|
           next unless asset["key"]
+
           checksums[asset["key"]] = asset["checksum"]
         end
 
@@ -219,6 +222,33 @@ module ShopifyCLI
         @error_reporter.report(error_message)
       end
 
+      def parse_api_errors(file, exception)
+        parsed_body = {}
+
+        if exception.respond_to?(:response)
+          response = exception.response
+
+          parsed_body = if response&.is_a?(Hash)
+            response&.[](:body)
+          else
+            JSON.parse(response&.body)
+          end
+        end
+
+        errors = parsed_body.dig("errors") # either nil or another type
+        errors = errors.dig("asset") if errors&.is_a?(Hash)
+
+        message = errors || parsed_body["message"] || exception.message
+        # Truncate to first lines
+        [message].flatten.map { |m| m.split("\n", 2).first }
+      rescue JSON::ParserError
+        [exception.message]
+      rescue StandardError => e
+        cause = "(cause: #{e.message})"
+        backtrace = e.backtrace.join("\n")
+        ["The asset #{file} could not be synced #{cause} #{backtrace}"]
+      end
+
       private
 
       def report_error(operation, error_suffix = "")
@@ -256,6 +286,7 @@ module ShopifyCLI
 
       def perform(operation)
         return if @queue.closed?
+
         wait_for_backoff!
         @ctx.debug(operation.to_s)
 
@@ -263,7 +294,6 @@ module ShopifyCLI
 
         report_performed_operation(operation)
         backoff_if_near_limit!(response)
-
       rescue StandardError => error
         handle_operation_error(operation, error)
       ensure
@@ -283,7 +313,7 @@ module ShopifyCLI
 
         _status, body, response = api_client.put(
           path: path,
-          body: JSON.generate(asset: asset)
+          body: JSON.generate(asset: asset),
         )
         file.warnings = body.dig("asset", "warnings")
 
@@ -315,7 +345,7 @@ module ShopifyCLI
           path: "themes/#{@theme.id}/assets.json",
           body: JSON.generate(asset: {
             key: file.relative_path,
-          })
+          }),
         )
 
         response
@@ -342,33 +372,6 @@ module ShopifyCLI
         response
       end
 
-      def parse_api_errors(operation, exception)
-        parsed_body = {}
-
-        if exception.respond_to?(:response)
-          response = exception.response
-
-          parsed_body = if response&.is_a?(Hash)
-            response&.[](:body)
-          else
-            JSON.parse(response&.body)
-          end
-        end
-
-        errors = parsed_body.dig("errors") # either nil or another type
-        errors = errors.dig("asset") if errors&.is_a?(Hash)
-
-        message = errors || parsed_body["message"] || exception.message
-        # Truncate to first lines
-        [message].flatten.map { |m| m.split("\n", 2).first }
-      rescue JSON::ParserError
-        [exception.message]
-      rescue StandardError => e
-        cause = "(cause: #{e.message})"
-        backtrace = e.backtrace.join("\n")
-        ["The asset #{operation.file} could not be synced #{cause} #{backtrace}"]
-      end
-
       def theme_created_at_runtime?
         @theme.created_at_runtime?
       end

data/lib/shopify_cli/theme/theme_admin_api.rb

@@ -61,6 +61,7 @@ module ShopifyCLI
         if empty_response?(error)
           return permission_error
         elsif unauthorized_response?(error)
+          @ctx.debug("[#{self.class}] (#{error.class}) cause: #{response_body(error)}")
           raise ShopifyCLI::Abort, @ctx.message("theme.unauthorized_error", @shop)
         end
 

data/lib/shopify_cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCLI
-  VERSION = "2.31.0"
+  VERSION = "2.32.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-cli
 version: !ruby/object:Gem::Version
-  version: 2.31.0
+  version: 2.32.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -328,6 +328,7 @@ files:
 - lib/project_types/theme/forms/confirm_store.rb
 - lib/project_types/theme/forms/select.rb
 - lib/project_types/theme/messages/messages.rb
+- lib/project_types/theme/models/specification_handlers/theme.rb
 - lib/project_types/theme/presenters/theme_presenter.rb
 - lib/project_types/theme/presenters/themes_presenter.rb
 - lib/project_types/theme/ui/sync_progress_bar.rb