shopify-cli 2.23.0 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db890ff22a5395154b92a4cf782ad621c2462b8aac8cc843c102be2a388a098b
-  data.tar.gz: e1ce745c465a52a84b33075e0b7ba8ffe15a10397061a9a5bea5bc1bd3669618
+  metadata.gz: dadea44d5b05c23d4e74988aac50cae2713ee0809ad3b92b0a32a2ae51915a35
+  data.tar.gz: efaccb6aee8feb1bd714f4b6d2fa2ded67e522ac49eedaaa592fc3dbc066b04d
 SHA512:
-  metadata.gz: 506f249416682dda65299eaf0dd6d589f1dea1fbb2097f92f4738e5ad529184aabeb3b84387ed8d012db60da271e28ef53df24a9c49a85bdcfab0d722be23459
-  data.tar.gz: 7fdb0b575be5f09c9185479a04313bb16f0144e21316ebe48e17e98ef80d9766d765760c6d65fdcca1611eb367f2a3b59153c60f6406f92e5c98fa4cd1c36b58
+  metadata.gz: d283f76d8b288ad25487a50f86ff9482abef14f4d9ad7d95e006ea36a976f4cfb2410235e5a18cf12ea5c19d225117fd0516735b574c7c63551809422a102e19
+  data.tar.gz: 63e45bf4543a6743859c02a766e8b61c682703145d6230410d5200f76d9ca207c7ae996a1dc89dd8e918dfbb21d17aa17dd834f694df274f96a9fab29a4af606

data/.github/workflows/shopify.yml

@@ -19,12 +19,11 @@ jobs:
         version:
           - 3.1.0
           - 3.0.2
-          - 2.6.6
           - 2.7.5
         os:
           - macos-11
           - ubuntu-20.04
-          - ubuntu-18.04
+          - ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
       - name: Set Git configuration

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.25.0 - 2022-09-14
+
+### Added
+* [#2600](https://github.com/Shopify/shopify-cli/pull/2600): Add support to the `SIGTERM` signal
+* [#2602](https://github.com/Shopify/shopify-cli/pull/2602): Add `--only/--ignore` support to the `theme serve` command
+
+### Fixed
+* [#2607](https://github.com/Shopify/shopify-cli/pull/2607): Fix proxy to redirect to host and port set by cli
+
+## Version 2.24.0 - 2022-08-29
+
+### Fixed
+* [#2572](https://github.com/Shopify/shopify-cli/pull/2572): **Breaking** Update theme-check to 1.11.0 (dropped support for ruby 2.6)
+
 ## Version 2.23.0 - 2022-08-22
 
 ### Fixed

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.23.0)
+    shopify-cli (2.25.0)
       bugsnag (~> 6.22)
       listen (~> 3.7.0)
-      theme-check (~> 1.10.3)
+      theme-check (~> 1.11.0)
 
 GEM
   remote: https://rubygems.org/
@@ -81,7 +81,7 @@ GEM
     ffi (1.15.4)
     hashdiff (1.0.1)
     iniparse (1.5.0)
-    liquid (5.3.0)
+    liquid (5.4.0)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -101,14 +101,14 @@ GEM
     mocha (1.13.0)
     multi_test (0.1.2)
     multipart-post (2.1.1)
-    nokogiri (1.13.6)
+    nokogiri (1.13.8)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     octokit (4.22.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     parallel (1.21.0)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -150,8 +150,8 @@ GEM
       faraday (> 0.8, < 2.0)
     sys-uname (1.2.2)
       ffi (~> 1.1)
-    theme-check (1.10.3)
-      liquid (>= 5.1.0)
+    theme-check (1.11.0)
+      liquid (>= 5.4.0)
       nokogiri (>= 1.12)
       parser (~> 3)
     timecop (0.9.4)
@@ -187,4 +187,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.3.11
+   2.3.20

data/README.md

@@ -1,6 +1,6 @@
 # Shopify CLI 2.0
   
-  <a href=""><img src="https://github.com/shopify/shopify-cli/workflows/CI/badge.svg" alt="Shopify"></a>
+  <a href="https://github.com/Shopify/shopify-cli/actions/workflows/shopify.yml"><img src="https://github.com/shopify/shopify-cli/actions/workflows/shopify.yml/badge.svg" alt="Shopify"></a>
   <img src="https://img.shields.io/github/v/release/shopify/shopify-cli?include_prereleases&style=flat-square" alt="Latest Version">
   <img src="https://img.shields.io/github/forks/shopify/shopify-cli?style=flat-square" alt="GitHub forks">
   <img src="https://img.shields.io/github/stars/shopify/shopify-cli?style=flat-square" alt="GitHub stars">

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

@@ -17,6 +17,24 @@ module Extension
         parser.on("-p", "--port=PORT", "Specify the port to use") do |port|
           flags[:port] = port.to_i
         end
+        parser.on("-T", "--theme=NAME_OR_ID", "Theme ID or name of the theme app extension host theme.") do |theme|
+          flags[:theme] = theme
+        end
+        parser.on("--api-key=API_KEY", "Connect your extension and app by inserting your app's API key") do |api_key|
+          flags[:api_key] = api_key.gsub('"', "")
+        end
+        parser.on("--api-secret=API_SECRET", "The API secret of the app the script is registered with.") do |api_secret|
+          flags[:api_secret] = api_secret.gsub('"', "")
+        end
+        parser.on("--extension-id=EXTENSION_ID", "The id of the extension's registration.") do |registration_id|
+          flags[:registration_id] = registration_id.gsub('"', "")
+        end
+        parser.on("--extension-title=EXTENSION_TITLE", "The title of the extension") do |extension_title|
+          flags[:extension_title] = extension_title.gsub('"', "")
+        end
+        parser.on("--extension-type=EXTENSION_TYPE", "The type of the extension") do |extension_type|
+          flags[:extension_type] = extension_type.gsub('"', "")
+        end
       end
 
       class RuntimeConfiguration
@@ -26,13 +44,27 @@ module Extension
         property :resource_url, accepts: String, default: nil
         property! :tunnel_requested, accepts: [true, false], reader: :tunnel_requested?, default: true
         property :port, accepts: (1...(2**16))
+        property :theme, accepts: String, default: nil
+        property :api_key, accepts: String, default: nil
+        property :api_secret, accepts: String, default: nil
+        property :registration_id, accepts: String, default: nil
+        property :extension_title, accepts: String, default: nil
+        property :extension_type, accepts: String, default: nil
       end
 
-      def call(_args, _command_name)
+      def call(args, _command_name)
+        @ctx.root = args.first || @ctx.root
+
         config = RuntimeConfiguration.new(
           tunnel_requested: tunnel_requested?,
           resource_url: options.flags[:resource_url],
-          port: options.flags[:port]
+          port: options.flags[:port],
+          theme: options.flags[:theme],
+          api_key: options.flags[:api_key],
+          api_secret: options.flags[:api_secret],
+          registration_id: options.flags[:registration_id],
+          extension_title: options.flags[:extension_title],
+          extension_type: options.flags[:extension_type],
         )
 
         ShopifyCLI::Result
@@ -49,6 +81,23 @@ module Extension
 
       private
 
+      def project
+        return super unless options.flags[:extension_type]
+
+        @project ||= Extension::Loaders::Project.load(
+          context: options.flags[:context],
+          directory: @ctx.root,
+          api_key: options.flags[:api_key],
+          api_secret: options.flags[:api_secret],
+          registration_id: options.flags[:registration_id],
+          env: {
+            ExtensionProjectKeys::TITLE_KEY => options.flags[:extension_title],
+            ExtensionProjectKeys::REGISTRATION_ID_KEY => options.flags[:registration_id],
+            ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY => options.flags[:extension_type],
+          }
+        )
+      end
+
       def tunnel_requested?
         tunnel = options.flags[:tunnel]
         tunnel.nil? || !!tunnel
@@ -87,7 +136,12 @@ module Extension
           context: @ctx,
           tunnel_url: runtime_configuration.tunnel_url,
           port: runtime_configuration.port,
-          resource_url: runtime_configuration.resource_url
+          theme: runtime_configuration.theme,
+          api_key: runtime_configuration.api_key,
+          api_secret: runtime_configuration.api_secret,
+          registration_id: runtime_configuration.registration_id,
+          resource_url: runtime_configuration.resource_url,
+          project: project,
         )
         runtime_configuration
       end

data/lib/project_types/extension/extension_project.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require "shopify_cli"
+require "shopify_cli/environment"
 require "securerandom"
 
 module Extension
@@ -82,7 +83,13 @@ module Extension
     end
 
     def specification_identifier
-      config[ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY]
+      key = ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY
+
+      if ShopifyCLI::Environment.run_as_subprocess?
+        get_extra_field(key)
+      else
+        config[key]
+      end
     end
 
     def registration_id?

data/lib/project_types/extension/loaders/project.rb

@@ -3,12 +3,13 @@
 module Extension
   module Loaders
     module Project
-      def self.load(context:, directory:, api_key:, registration_id:, api_secret:)
+      def self.load(context:, directory:, api_key:, registration_id:, api_secret:, env: {})
         env_overrides = {
           "SHOPIFY_API_KEY" => api_key,
           "SHOPIFY_API_SECRET" => api_secret,
           "EXTENSION_ID" => registration_id,
-        }.compact
+        }.compact.merge(env)
+
         env_file_present = env_file_exists?(directory)
         env = if env_file_present
           ShopifyCLI::Resources::EnvFile.read(directory, overrides: env_overrides)

data/lib/project_types/extension/messages/messages.rb

@@ -102,15 +102,32 @@ module Extension
       serve: {
         help: <<~HELP,
           Serve your extension in a local simulator for development.
-            Usage: {{command:%s extension serve}}
+            Usage: {{command:%s extension serve [ ROOT ]}}
             Options:
-            {{command:--tunnel=TUNNEL}} Establish an ngrok tunnel (default: false)
+              {{command:-p, --port=PORT}}             Local port of the development serve.
+              {{command:-T, --theme=NAME_OR_ID}}      Theme ID or name of the host theme.
+              {{command:--tunnel=TUNNEL}}             Establish an ngrok tunnel (default: false).
+              {{command:--api-key=API_KEY}}           Connect your extension and app by inserting your app's API key (which you can get from your app setup page on shopify.dev).
+              {{command:--api-secret=API_SECRET}}     The API secret of the app the script is registered with.
+              {{command:--extension-id=EXTENSION_ID}} The id of the extension's registration.
         HELP
-        frame_title: "Serving extension…",
+        frame_title: "Viewing extension…",
         no_available_ports_found: "No available ports found to run extension.",
         serve_failure_message: "Failed to run extension code.",
         serve_missing_information: "Missing shop or api_key.",
         tunnel_already_running: "A tunnel running on another port has been detected. Close the tunnel and try again.",
+        preview_message: <<~PREVIEW_MESSAGE,
+          Enable your theme app extension:
+          {{green:%s}}
+
+          Setup your theme app extension in the host theme:
+          {{green:%s}}
+
+          Preview your theme app extension:
+          {{green:%s}}
+
+          (Use Ctrl-C to stop)
+        PREVIEW_MESSAGE
       },
       tunnel: {
         duplicate_session: <<~MESSAGE,
@@ -267,9 +284,7 @@ module Extension
               {{*}} You’re ready to start building {{green:%s}}!
             MESSAGE
           },
-          serve: {
-            unsupported: "shopify extension serve is not supported for theme app extensions",
-          },
+
         },
       },
     }

data/lib/project_types/extension/models/server_config/development_renderer.rb

@@ -25,7 +25,7 @@ module Extension
           when "checkout_post_purchase"
             new(name: "@shopify/post-purchase-ui-extensions", version: "^0.13.2")
           when "pos_ui_extension"
-            new(name: "@shopify/retail-ui-extensions", version: "^0.1.0")
+            new(name: "@shopify/retail-ui-extensions", version: "^0.12.0")
           when "web_pixel_extension"
             nil
           else

data/lib/project_types/extension/models/specification_handlers/theme_app_extension.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require "base64"
 require "json"
+require "shopify_cli/theme/extension/dev_server"
 
 module Extension
   module Models
@@ -64,16 +65,27 @@ module Extension
           "Theme App Extension"
         end
 
-        def choose_port?(ctx)
-          ctx.abort(ctx.message("serve.unsupported"))
+        def choose_port?(_ctx)
+          false
         end
 
-        def establish_tunnel?(ctx)
-          ctx.abort(ctx.message("serve.unsupported"))
+        def establish_tunnel?(_ctx)
+          false
         end
 
-        def serve(ctx)
-          ctx.abort(ctx.message("serve.unsupported"))
+        def serve(**options)
+          @ctx = options[:context]
+          root = options[:context]&.root
+          project = options[:project]
+          properties = options
+            .slice(:port, :theme)
+            .compact
+            .merge({
+              project: project,
+              specification_handler: self,
+            })
+
+          ShopifyCLI::Theme::Extension::DevServer.start(@ctx, root, **properties)
         end
 
         private

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

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 require "shopify_cli/theme/dev_server"
 require "project_types/theme/commands/common/root_helper"
+require "shopify_cli/theme/ignore_filter"
+require "shopify_cli/theme/include_filter"
+require "project_types/theme/conversions/include_glob"
+require "project_types/theme/conversions/ignore_glob"
 
 module Theme
   class Command
@@ -12,6 +16,9 @@ module Theme
       DEFAULT_HTTP_HOST = "127.0.0.1"
 
       options do |parser, flags|
+        Conversions::IncludeGlob.register(parser)
+        Conversions::IgnoreGlob.register(parser)
+
         parser.on("--host=HOST") { |host| flags[:host] = host.to_s }
         parser.on("--port=PORT") { |port| flags[:port] = port.to_i }
         parser.on("--poll") { flags[:poll] = true }
@@ -19,6 +26,14 @@ module Theme
         parser.on("--theme-editor-sync") { flags[:editor_sync] = true }
         parser.on("--stable") { flags[:stable] = true }
         parser.on("-t", "--theme=NAME_OR_ID") { |theme| flags[:theme] = theme }
+        parser.on("-o", "--only=PATTERN", Conversions::IncludeGlob) do |pattern|
+          flags[:includes] ||= []
+          flags[:includes] |= pattern
+        end
+        parser.on("-x", "--ignore=PATTERN", Conversions::IgnoreGlob) do |pattern|
+          flags[:ignores] ||= []
+          flags[:ignores] |= pattern
+        end
       end
 
       def call(_args, name)
@@ -31,9 +46,6 @@ module Theme
         ShopifyCLI::Theme::DevServer.start(@ctx, root, host: host, **flags) do |syncer|
           UI::SyncProgressBar.new(syncer).progress(:upload_theme!, delay_low_priority_files: true)
         end
-      rescue ShopifyCLI::Theme::DevServer::AddressBindingError
-        raise ShopifyCLI::Abort,
-          ShopifyCLI::Context.message("theme.serve.error.address_binding_error", ShopifyCLI::TOOL_NAME)
       end
 
       def self.as_reload_mode(mode)

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

@@ -138,6 +138,8 @@ module Theme
           viewing_theme: "Viewing theme…",
           syncing_theme: "Syncing theme #%s on %s",
           open_fail: "Couldn't open the theme",
+          stop_signal: "Stop signal: \"%s\"",
+          stopping: "Stopping…",
           auth: {
             error_message: <<~ERROR_MESSAGE,
               It looks like you are using credentials that do not work with {{command:%s theme serve}}.
@@ -230,8 +232,6 @@ module Theme
             },
           },
           error: {
-            address_binding_error: "Couldn't bind to localhost."\
-              " To serve your theme, set a different address with {{command:%s theme serve --host=<address>}}",
             invalid_subdirectory: <<~MESSAGE,
               The presence of %s in the directory structure isn't supported.
 
@@ -262,6 +262,8 @@ module Theme
           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.",
+          binding_error: "Couldn't bind to localhost." \
+            " To serve your theme, set a different address with {{command:%s theme serve --host=<address>}}",
         },
         check: {
           help: <<~HELP,

data/lib/shopify_cli/commands/logout.rb

@@ -1,11 +1,14 @@
 require "shopify_cli"
 require "shopify_cli/theme/development_theme"
+require "shopify_cli/theme/extension/host_theme"
 
 module ShopifyCLI
   module Commands
     class Logout < ShopifyCLI::Command
       def call(*)
         try_delete_development_theme
+        try_delete_host_theme
+
         ShopifyCLI::IdentityAuth.delete_tokens_and_keys
         ShopifyCLI::DB.del(:shop) if has_shop?
         ShopifyCLI::DB.del(:organization_id) if has_organization_id?
@@ -31,8 +34,16 @@ module ShopifyCLI
         return unless has_shop?
 
         ShopifyCLI::Theme::DevelopmentTheme.delete(@ctx)
-      rescue ShopifyCLI::API::APIRequestError, ShopifyCLI::Abort, ShopifyCLI::AbortSilent
-        # Ignore since we can't delete it
+      rescue ShopifyCLI::API::APIRequestError, ShopifyCLI::Abort, ShopifyCLI::AbortSilent => e
+        @ctx.debug("[Logout Error]: #{e.message}")
+      end
+
+      def try_delete_host_theme
+        return unless has_shop?
+
+        ShopifyCLI::Theme::Extension::HostTheme.delete(@ctx)
+      rescue ShopifyCLI::API::APIRequestError, ShopifyCLI::Abort, ShopifyCLI::AbortSilent => e
+        @ctx.debug("[Logout Error]: #{e.message}")
       end
     end
   end

data/lib/shopify_cli/constants.rb

@@ -64,7 +64,7 @@ module ShopifyCLI
 
     module SupportedVersions
       module Ruby
-        FROM = "2.6.6"
+        FROM = "2.7.5"
         TO = "3.2.0"
       end
 

data/lib/shopify_cli/environment.rb

@@ -159,7 +159,7 @@ module ShopifyCLI
       env_variable_truthy?(
         Constants::EnvironmentVariables::MONORAIL_REAL_EVENTS,
         env_variables: env_variables
-      )
+      ) && !run_as_subprocess?(env_variables: env_variables)
     end
 
     def self.auth_token(env_variables: ENV)

data/lib/shopify_cli/file_system_listener.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require "listen"
+require "observer"
+
+module ShopifyCLI
+  class FileSystemListener
+    include Observable
+
+    def initialize(root:, force_poll:, ignore_regex:)
+      @root = root
+      @force_poll = force_poll
+      @ignore_regex = ignore_regex
+
+      @listener = Listen.to(@root, force_polling: @force_poll, ignore: @ignore_regex) do |updated, added, removed|
+        changed
+        notify_observers(updated, added, removed)
+      end
+    end
+
+    def start
+      @listener.start
+    rescue ArgumentError
+      # Ignore errors during the transition of 'listen' events
+    end
+
+    def stop
+      @listener.stop
+    end
+  end
+end