shopify-cli 2.24.0 → 2.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b181be543b5e3f2d630f728672a49eba4ca45a2bf3515cb795ba4d3ffd816d5a
-  data.tar.gz: ebe6ae92838de46c6ffbb3d0b311a6bf9f84619908e0fbd4dad0fdba84f5adba
+  metadata.gz: 1947b9e99b60efb4eb548badb8f41ee520f17ed0025a2666ec58a62594964abc
+  data.tar.gz: b7b7714ce470469573282c561c335103cb8471319785fd327a7f7e8442eb71d2
 SHA512:
-  metadata.gz: b8ebcc3d7cc5d7e4ef5c30ff3286a9a853d5b7b8144b8c7f00adb844a4ebaad93b6b5cf9d66ddcd2a33b94378f7b66a0c9a4966c5d5687588dc867769f0d4cd0
-  data.tar.gz: d5d6c740f02d5e0b6fb40a7c357347a08ef770355908d4418959e89e6b016075bb638722abaa8649ee3a6475391885016e373ea9624459b2a63ce8c8f7891d7f
+  metadata.gz: 82a5eeb29ba45bf1e7eb407371c07922f14c3a7fe8ed0777b555ebbfa952a3dc35b303e0e477abe5c467bd01112e678ce31804051a52b92beb0bea2a323c5264
+  data.tar.gz: e24d863f0a3649d729242bd6104403d5642a6e04c44fc52adb6856d98c55e20c06ff4b13e4ca553ba01299b726ad89193ee97bcd322709deb060f681bbfeae6d

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.26.0 - 2022-10-03
+
+### Added
+* [#2636](https://github.com/Shopify/shopify-cli/pull/2636): Show store when the CLI prompts users to select a theme
+
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.24.0)
+    shopify-cli (2.26.0)
       bugsnag (~> 6.22)
       listen (~> 3.7.0)
       theme-check (~> 1.11.0)

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/dev.yml

@@ -27,6 +27,3 @@ test:
 commands:
   style:
     run: bundle exec rubocop .
-  test:script:
-    desc: "Run all script-related tests"
-    run: TEST='test/project_types/script/**/*.rb' bundle exec rake test $@

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

@@ -18,85 +18,6 @@ module Script
   end
   ShopifyCLI::Commands.register("Script::Command", "script")
 
-  # define/autoload project specific Forms
-  module Forms
-    autoload :AskOrg, Project.project_filepath("forms/ask_org")
-    autoload :AskApp, Project.project_filepath("forms/ask_app")
-    autoload :AskScriptUuid, Project.project_filepath("forms/ask_script_uuid")
-    autoload :RunAgainstShopifyOrg, Project.project_filepath("forms/run_against_shopify_org")
-    autoload :Create, Project.project_filepath("forms/create")
-    autoload :Connect, Project.project_filepath("forms/connect")
-    autoload :ScriptForm, Project.project_filepath("forms/script_form")
-  end
-
-  module Tasks
-    autoload :EnsureEnv, Project.project_filepath("tasks/ensure_env")
-  end
-
-  module Layers
-    module Application
-      autoload :BuildScript, Project.project_filepath("layers/application/build_script")
-      autoload :ConnectApp, Project.project_filepath("layers/application/connect_app")
-      autoload :CreateScript, Project.project_filepath("layers/application/create_script")
-      autoload :PushScript, Project.project_filepath("layers/application/push_script")
-      autoload :ExtensionPoints, Project.project_filepath("layers/application/extension_points")
-      autoload :ProjectDependencies, Project.project_filepath("layers/application/project_dependencies")
-    end
-
-    module Domain
-      autoload :Errors, Project.project_filepath("layers/domain/errors")
-      autoload :PushPackage, Project.project_filepath("layers/domain/push_package")
-      autoload :Metadata, Project.project_filepath("layers/domain/metadata")
-      autoload :ExtensionPoint, Project.project_filepath("layers/domain/extension_point")
-      autoload :ScriptConfig, Project.project_filepath("layers/domain/script_config")
-      autoload :ScriptProject, Project.project_filepath("layers/domain/script_project")
-      autoload :AppBridge, Project.project_filepath("layers/domain/app_bridge")
-    end
-
-    module Infrastructure
-      autoload :Errors, Project.project_filepath("layers/infrastructure/errors")
-      autoload :CommandRunner, Project.project_filepath("layers/infrastructure/command_runner")
-      autoload :PushPackageRepository, Project.project_filepath("layers/infrastructure/push_package_repository")
-      autoload :ExtensionPointRepository, Project.project_filepath("layers/infrastructure/extension_point_repository")
-      autoload :MetadataRepository, Project.project_filepath("layers/infrastructure/metadata_repository")
-      autoload :ScriptProjectRepository, Project.project_filepath("layers/infrastructure/script_project_repository")
-      autoload :ScriptService, Project.project_filepath("layers/infrastructure/script_service")
-      autoload :ScriptUploader, Project.project_filepath("layers/infrastructure/script_uploader")
-      autoload :ServiceLocator, Project.project_filepath("layers/infrastructure/service_locator")
-      autoload :SparseCheckoutDetails, Project.project_filepath("layers/infrastructure/sparse_checkout_details")
-
-      module Languages
-        autoload :ProjectCreator, Project.project_filepath("layers/infrastructure/languages/project_creator")
-        autoload :TaskRunner, Project.project_filepath("layers/infrastructure/languages/task_runner")
-        autoload :TypeScriptProjectCreator,
-          Project.project_filepath("layers/infrastructure/languages/typescript_project_creator.rb")
-        autoload :TypeScriptTaskRunner,
-          Project.project_filepath("layers/infrastructure/languages/typescript_task_runner.rb")
-        autoload :WasmProjectCreator,
-          Project.project_filepath("layers/infrastructure/languages/wasm_project_creator.rb")
-        autoload :WasmTaskRunner,
-          Project.project_filepath("layers/infrastructure/languages/wasm_task_runner.rb")
-        autoload :ToolVersionChecker,
-          Project.project_filepath("layers/infrastructure/languages/tool_version_checker.rb")
-      end
-
-      module ApiClients
-        autoload :PartnersProxyApiClient,
-          Project.project_filepath("layers/infrastructure/api_clients/partners_proxy_api_client")
-        autoload :ScriptServiceApiClient,
-          Project.project_filepath("layers/infrastructure/api_clients/script_service_api_client")
-      end
-    end
-  end
-
-  module UI
-    autoload :ErrorHandler, Project.project_filepath("ui/error_handler")
-    autoload :PrintingSpinner, Project.project_filepath("ui/printing_spinner")
-    autoload :StrictSpinner, Project.project_filepath("ui/strict_spinner")
-  end
-
-  autoload :Errors, Project.project_filepath("errors")
-
   module Loaders
     autoload :Project, Script::Project.project_filepath("loaders/project")
     autoload :SpecificationHandler, Script::Project.project_filepath("loaders/specification_handler")

data/lib/project_types/script/commands/connect.rb

@@ -2,19 +2,14 @@
 module Script
   class Command
     class Connect < ShopifyCLI::Command::SubCommand
-      prerequisite_task :ensure_authenticated
-      prerequisite_task ensure_project_type: :script
-
-      recommend_default_ruby_range
+      hidden_feature
 
       def call(_args, _)
-        Layers::Application::ConnectApp.call(ctx: @ctx, force: true)
-      rescue StandardError => e
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message("script.connect.error.operation_failed"))
+        @ctx.abort(@ctx.message("script.deprecated"))
       end
 
       def self.help
-        ShopifyCLI::Context.new.message("script.connect.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+        ShopifyCLI::Context.new.message("script.deprecated")
       end
     end
   end

data/lib/project_types/script/commands/create.rb

@@ -3,9 +3,7 @@
 module Script
   class Command
     class Create < ShopifyCLI::Command::SubCommand
-      prerequisite_task :ensure_authenticated
-
-      recommend_default_ruby_range
+      hidden_feature
 
       options do |parser, flags|
         parser.on("--title=TITLE") { |title| flags[:title] = title }
@@ -14,35 +12,12 @@ module Script
         parser.on("--branch=BRANCH") { |branch| flags[:branch] = branch }
       end
 
-      def call(args, _name)
-        form = Forms::Create.ask(@ctx, args, options.flags)
-        return @ctx.puts(self.class.help) if form.nil?
-
-        unless !form.title.empty? && form.extension_point
-          return @ctx.puts(self.class.help)
-        end
-
-        project = Layers::Application::CreateScript.call(
-          ctx: @ctx,
-          language: options.flags[:language]&.downcase || "wasm",
-          sparse_checkout_branch: options.flags[:branch] || "main",
-          title: form.title,
-          extension_point_type: form.extension_point,
-        )
-        @ctx.puts(@ctx.message("script.create.change_directory_notice", project.title))
-      rescue StandardError => e
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message("script.create.error.operation_failed"))
+      def call(_args, _)
+        @ctx.abort(@ctx.message("script.deprecated"))
       end
 
       def self.help
-        allowed_apis = Layers::Application::ExtensionPoints.available_types.map { |type| "{{cyan:#{type}}}" }
-        allowed_languages = Layers::Application::ExtensionPoints.all_languages.map { |lang| "{{cyan:#{lang}}}" }
-        ShopifyCLI::Context.message(
-          "script.create.help",
-          ShopifyCLI::TOOL_NAME,
-          allowed_apis.join(", "),
-          allowed_languages.join(", ")
-        )
+        ShopifyCLI::Context.new.message("script.deprecated")
       end
     end
   end

data/lib/project_types/script/commands/javy.rb

@@ -12,17 +12,12 @@ module Script
         parser.on("--out=OUT") { |out_file| flags[:out_file] = out_file }
       end
 
-      def call(*)
-        source = options.flags[:in_file]
-        dest = options.flags[:out_file]
-
-        @ctx.abort(@ctx.message("script.javy.errors.invalid_arguments", ShopifyCLI::TOOL_NAME)) unless source
-
-        ::Javy.build(source: source, dest: dest).unwrap { |e| @ctx.abort(e.message) }
+      def call(_args, _)
+        @ctx.abort(@ctx.message("script.deprecated"))
       end
 
       def self.help
-        ShopifyCLI::Context.message("script.javy.help", ShopifyCLI::TOOL_NAME)
+        ShopifyCLI::Context.new.message("script.deprecated")
       end
     end
   end

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

@@ -3,9 +3,7 @@
 module Script
   class Command
     class Push < ShopifyCLI::Command::SubCommand
-      prerequisite_task ensure_project_type: :script
-
-      recommend_default_ruby_range
+      hidden_feature
 
       options do |parser, flags|
         parser.on("--force") { |t| flags[:force] = t }
@@ -16,47 +14,12 @@ module Script
         end
       end
 
-      def call(_args, _name)
-        connect_to_app
-        project = load_project
-        push(project: project)
-      rescue StandardError => e
-        UI::ErrorHandler.pretty_print_and_raise(e,
-          failed_op: @ctx.message("script.push.error.operation_failed"))
-      end
-
-      def push(project:)
-        force = options.flags.key?(:force)
-        api_key = project.env[:api_key]
-        uuid = project.env[:extra]["UUID"]
-
-        if ShopifyCLI::Environment.interactive? || (uuid && !uuid.empty?)
-          Layers::Application::PushScript.call(ctx: @ctx, force: force, project: project)
-          @ctx.puts(@ctx.message("script.push.script_pushed", api_key: api_key))
-        else
-          message = @ctx.message("script.error.missing_push_options_ci", "--uuid")
-          message += @ctx.message("script.error.missing_push_options_ci_solution", ShopifyCLI::TOOL_NAME)
-          raise ShopifyCLI::Abort, message
-        end
-      end
-
-      def load_project
-        Script::Loaders::Project.load(
-          directory: Dir.pwd,
-          api_key: options.flags[:api_key],
-          api_secret: options.flags[:api_secret],
-          uuid: options.flags[:uuid]
-        )
-      end
-
-      def connect_to_app
-        if ShopifyCLI::Environment.interactive?
-          Layers::Application::ConnectApp.call(ctx: @ctx)
-        end
+      def call(_args, _)
+        @ctx.abort(@ctx.message("script.deprecated"))
       end
 
       def self.help
-        ShopifyCLI::Context.message("script.push.help", ShopifyCLI::TOOL_NAME)
+        ShopifyCLI::Context.new.message("script.deprecated")
       end
     end
   end