shopify-cli 2.6.0 → 2.6.4

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

@@ -2,20 +2,17 @@
 module PHP
   class Command
     class Serve < ShopifyCLI::SubCommand
-      PORT = 3000
+      include ShopifyCLI::CommandOptions::CommandServeOptions
 
       prerequisite_task :ensure_env, :ensure_dev_store
 
-      options do |parser, flags|
-        parser.on("--host=HOST") do |h|
-          flags[:host] = h.gsub('"', "")
-        end
-      end
+      parse_host_option
+      parse_port_option
 
       def call(*)
         project = ShopifyCLI::Project.current
-        url = options.flags[:host] || ShopifyCLI::Tunnel.start(@ctx, port: PORT)
-        @ctx.abort(@ctx.message("php.serve.error.host_must_be_https")) if url.match(/^https/i).nil?
+        tunnel_port = port.to_s
+        url = host || ShopifyCLI::Tunnel.start(@ctx, port: tunnel_port)
         project.env.update(@ctx, :host, url)
         ShopifyCLI::Tasks::UpdateDashboardURLS.call(
           @ctx,
@@ -35,7 +32,7 @@ module PHP
           ShopifyCLI::ProcessSupervision.start(:npm_watch, "npm run watch", force_spawn: true)
 
           env = project.env.to_h
-          @ctx.system("php", "artisan", "serve", "--port", PORT.to_s, env: env)
+          @ctx.system("php", "artisan", "serve", "--port", tunnel_port, env: env)
         end
       end
 

data/lib/project_types/php/messages/messages.rb

@@ -133,12 +133,9 @@ module PHP
           extended_help: <<~HELP,
             {{bold:Options:}}
               {{cyan:--host=HOST}}: Bypass running tunnel and use custom host. HOST must be HTTPS url.
+              {{cyan:--port=PORT}}: Use custom port.
             HELP
 
-          error: {
-            host_must_be_https: "HOST must be a HTTPS url.",
-          },
-
           open_info: <<~MESSAGE,
             {{*}} To install and start using your app, open this URL in your browser:
             {{green:%s}}

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

@@ -2,19 +2,18 @@
 module Rails
   class Command
     class Serve < ShopifyCLI::SubCommand
+      include ShopifyCLI::CommandOptions::CommandServeOptions
+
       prerequisite_task ensure_project_type: :rails
       prerequisite_task :ensure_env, :ensure_dev_store
 
-      options do |parser, flags|
-        parser.on("--host=HOST") do |h|
-          flags[:host] = h.gsub('"', "")
-        end
-      end
+      parse_host_option
+      parse_port_option
 
       def call(*)
         project = ShopifyCLI::Project.current
-        url = options.flags[:host] || ShopifyCLI::Tunnel.start(@ctx)
-        @ctx.abort(@ctx.message("rails.serve.error.host_must_be_https")) if url.match(/^https/i).nil?
+        tunnel_port = port.to_s
+        url = host || ShopifyCLI::Tunnel.start(@ctx, port: tunnel_port)
         project.env.update(@ctx, :host, url)
         ShopifyCLI::Tasks::UpdateDashboardURLS.call(
           @ctx,
@@ -30,7 +29,7 @@ module Rails
         CLI::UI::Frame.open(@ctx.message("rails.serve.running_server")) do
           env = ShopifyCLI::Project.current.env.to_h
           env.delete("HOST")
-          env["PORT"] = ShopifyCLI::Tunnel::PORT.to_s
+          env["PORT"] = tunnel_port
           env["GEM_PATH"] = Gem.gem_path(@ctx)
           if @ctx.windows?
             @ctx.system("ruby bin\\rails server", env: env)

data/lib/project_types/rails/messages/messages.rb

@@ -170,12 +170,9 @@ module Rails
           extended_help: <<~HELP,
             {{bold:Options:}}
               {{cyan:--host=HOST}}: Bypass running tunnel and use custom host. HOST must be HTTPS url.
+              {{cyan:--port=PORT}}: Use custom port.
           HELP
 
-          error: {
-            host_must_be_https: "{{red:HOST must be a HTTPS url.}}",
-          },
-
           open_info: <<~MESSAGE,
             {{*}} To install and start using your app, open this URL in your browser:
             {{green:%s}}

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

@@ -3,7 +3,9 @@
 module Script
   class Command
     class Create < ShopifyCLI::SubCommand
-      prerequisite_task :ensure_authenticated
+      unless ShopifyCLI::Environment.acceptance_test?
+        prerequisite_task :ensure_authenticated
+      end
 
       options do |parser, flags|
         parser.on("--name=NAME") { |name| flags[:name] = name }

data/lib/project_types/script/config/extension_points.yml

@@ -42,3 +42,10 @@ shipping_methods:
     typescript:
       beta: true
       repo: "https://github.com/Shopify/scripts-apis-examples"
+discount_types:
+  beta: true
+  domain: 'discounts'
+  libraries:
+    typescript:
+      beta: true
+      repo: "https://github.com/Shopify/scripts-apis-examples"

data/lib/project_types/script/graphql/app_script_set.graphql

@@ -10,6 +10,7 @@ mutation AppScriptSet(
   $configurationUi: Boolean!,
   $configurationDefinition: String!,
   $moduleUploadUrl: String!,
+  $library: LibraryInput,
 ) {
   appScriptSet(
     uuid: $uuid
@@ -23,6 +24,7 @@ mutation AppScriptSet(
     configurationUi: $configurationUi,
     configurationDefinition: $configurationDefinition,
     moduleUploadUrl: $moduleUploadUrl,
+    library: $library,
 ) {
     userErrors {
       field

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

@@ -5,7 +5,7 @@ module Script
     module Application
       class BuildScript
         class << self
-          def call(ctx:, task_runner:, script_project:)
+          def call(ctx:, task_runner:, script_project:, library:)
             CLI::UI::Frame.open(ctx.message("script.application.building")) do
               begin
                 UI::StrictSpinner.spin(ctx.message("script.application.building_script")) do |spinner|
@@ -14,6 +14,7 @@ module Script
                     script_content: task_runner.build,
                     compiled_type: task_runner.compiled_type,
                     metadata: task_runner.metadata,
+                    library: library,
                   )
                   spinner.update_title(ctx.message("script.application.built"))
                 end

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

@@ -11,14 +11,27 @@ module Script
             task_runner = Infrastructure::Languages::TaskRunner
               .for(ctx, script_project.language, script_project.script_name)
 
+            extension_point = ExtensionPoints.get(type: script_project.extension_point_type)
+            library_name = extension_point.libraries.for(script_project.language)&.package
+            raise Infrastructure::Errors::LanguageLibraryForAPINotFoundError.new(
+              language: script_project.language,
+              api: script_project.extension_point_type
+            ) unless library_name
+
+            library = {
+              language: script_project.language,
+              version: task_runner.library_version(library_name),
+            }
+
             ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
-            BuildScript.call(ctx: ctx, task_runner: task_runner, script_project: script_project)
+            BuildScript.call(ctx: ctx, task_runner: task_runner, script_project: script_project, library: library)
 
             UI::PrintingSpinner.spin(ctx, ctx.message("script.application.pushing")) do |p_ctx, spinner|
               package = Infrastructure::PushPackageRepository.new(ctx: p_ctx).get_push_package(
                 script_project: script_project,
                 compiled_type: task_runner.compiled_type,
                 metadata: task_runner.metadata,
+                library: library,
               )
               script_service = Infrastructure::ServiceLocator.script_service(
                 ctx: p_ctx,
@@ -32,6 +45,7 @@ module Script
                 metadata: package.metadata,
                 script_json: package.script_json,
                 module_upload_url: module_upload_url,
+                library: package.library,
               )
               script_project_repo.update_env(uuid: uuid)
               spinner.update_title(p_ctx.message("script.application.pushed"))

data/lib/project_types/script/layers/domain/push_package.rb

@@ -10,7 +10,8 @@ module Script
           :script_json,
           :script_content,
           :compiled_type,
-          :metadata
+          :metadata,
+          :library
 
         def initialize(
           id:,
@@ -19,7 +20,8 @@ module Script
           script_content:,
           compiled_type: nil,
           metadata:,
-          script_json:
+          script_json:,
+          library:
         )
           @id = id
           @uuid = uuid
@@ -28,6 +30,7 @@ module Script
           @compiled_type = compiled_type
           @metadata = metadata
           @script_json = script_json
+          @library = library
         end
       end
     end

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

@@ -40,6 +40,23 @@ module Script
           end
         end
 
+        class APILibraryNotFoundError < ScriptProjectError
+          attr_reader :library_name
+          def initialize(library_name)
+            super()
+            @library_name = library_name
+          end
+        end
+
+        class LanguageLibraryForAPINotFoundError < ScriptProjectError
+          attr_reader :language, :api
+          def initialize(language:, api:)
+            super()
+            @language = language
+            @api = api
+          end
+        end
+
         class DependencyInstallError < ScriptProjectError; end
         class DeprecatedEPError < ScriptProjectError; end
         class EmptyResponseError < ScriptProjectError; end

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

@@ -5,7 +5,7 @@ module Script
     module Infrastructure
       module Languages
         class AssemblyScriptTaskRunner
-          BYTECODE_FILE = "build/%{name}.wasm"
+          BYTECODE_FILE = "build/script.wasm"
           METADATA_FILE = "build/metadata.json"
           SCRIPT_SDK_BUILD = "npm run build"
 
@@ -47,6 +47,12 @@ module Script
             Domain::Metadata.create_from_json(@ctx, raw_contents)
           end
 
+          def library_version(library_name)
+            output = JSON.parse(CommandRunner.new(ctx: ctx).call("npm list --json"))
+            raise Errors::APILibraryNotFoundError.new(library_name), output unless output["dependencies"][library_name]
+            output["dependencies"][library_name]["version"]
+          end
+
           private
 
           def check_node_version!
@@ -80,19 +86,10 @@ module Script
           end
 
           def bytecode
-            legacy_filename = format(BYTECODE_FILE, name: script_name)
-            filename = format(BYTECODE_FILE, name: "script")
-
-            bytecode_file = if ctx.file_exist?(filename)
-              filename
-            elsif ctx.file_exist?(legacy_filename)
-              legacy_filename
-            else
-              raise Errors::WebAssemblyBinaryNotFoundError
-            end
+            raise Errors::WebAssemblyBinaryNotFoundError unless ctx.file_exist?(BYTECODE_FILE)
 
-            contents = ctx.binread(bytecode_file)
-            ctx.rm(bytecode_file)
+            contents = ctx.binread(BYTECODE_FILE)
+            ctx.rm(BYTECODE_FILE)
 
             contents
           end

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

@@ -5,7 +5,7 @@ module Script
     module Infrastructure
       module Languages
         class TypeScriptTaskRunner
-          BYTECODE_FILE = "build/%{name}.wasm"
+          BYTECODE_FILE = "build/index.wasm"
           METADATA_FILE = "build/metadata.json"
           SCRIPT_SDK_BUILD = "npm run build"
           GEN_METADATA = "npm run gen-metadata"
@@ -82,19 +82,10 @@ module Script
           end
 
           def bytecode
-            legacy_filename = format(BYTECODE_FILE, name: script_name)
-            filename = format(BYTECODE_FILE, name: "index")
-
-            bytecode_file = if ctx.file_exist?(filename)
-              filename
-            elsif ctx.file_exist?(legacy_filename)
-              legacy_filename
-            else
-              raise Errors::WebAssemblyBinaryNotFoundError
-            end
+            raise Errors::WebAssemblyBinaryNotFoundError unless ctx.file_exist?(BYTECODE_FILE)
 
-            contents = ctx.binread(bytecode_file)
-            ctx.rm(bytecode_file)
+            contents = ctx.binread(BYTECODE_FILE)
+            ctx.rm(BYTECODE_FILE)
 
             contents
           end

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

@@ -7,7 +7,7 @@ module Script
         include SmartProperties
         property! :ctx, accepts: ShopifyCLI::Context
 
-        def create_push_package(script_project:, script_content:, compiled_type:, metadata:)
+        def create_push_package(script_project:, script_content:, compiled_type:, metadata:, library:)
           build_file_path = file_path(script_project.id, compiled_type)
           write_to_path(build_file_path, script_content)
 
@@ -19,10 +19,11 @@ module Script
             compiled_type: compiled_type,
             metadata: metadata,
             script_json: script_project.script_json,
+            library: library
           )
         end
 
-        def get_push_package(script_project:, compiled_type:, metadata:)
+        def get_push_package(script_project:, compiled_type:, metadata:, library:)
           build_file_path = file_path(script_project.id, compiled_type)
           raise Domain::PushPackageNotFoundError unless ctx.file_exist?(build_file_path)
 
@@ -34,6 +35,7 @@ module Script
             script_content: script_content,
             metadata: metadata,
             script_json: script_project.script_json,
+            library: library
           )
         end
 

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

@@ -18,7 +18,8 @@ module Script
           force: false,
           metadata:,
           script_json:,
-          module_upload_url:
+          module_upload_url:,
+          library:
         )
           query_name = "app_script_set"
           variables = {
@@ -33,6 +34,10 @@ module Script
             configurationUi: script_json.configuration_ui,
             configurationDefinition: script_json.configuration&.to_json,
             moduleUploadUrl: module_upload_url,
+            library: {
+              language: library[:language],
+              version: library[:version],
+            },
           }
           resp_hash = make_request(query_name: query_name, variables: variables)
           user_errors = resp_hash["data"]["appScriptSet"]["userErrors"]

data/lib/project_types/script/messages/messages.rb

@@ -148,6 +148,12 @@ module Script
 
           script_upload_cause: "Fail to upload script.",
           script_upload_help: "Try again.",
+
+          api_library_not_found_cause: "Script can't be created because API library %{library_name} is missing from the dependencies",
+          api_library_not_found_help: "This error can occur because the API library was removed from your system or there is a problem with dependencies in the repository.",
+
+          language_library_for_api_not_found_cause: "Script can’t be pushed because the %{language} library for API %{api} is missing.",
+          language_library_for_api_not_found_help: "Make sure extension_point.yml contains the correct API library.",
         },
 
         create: {

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

@@ -250,6 +250,22 @@ module Script
             cause_of_error: ShopifyCLI::Context.message("script.error.script_upload_cause"),
             help_suggestion: ShopifyCLI::Context.message("script.error.script_upload_help"),
           }
+        when Layers::Infrastructure::Errors::APILibraryNotFoundError
+          {
+            cause_of_error: ShopifyCLI::Context
+              .message("script.error.api_library_not_found_cause", library_name: e.library_name),
+            help_suggestion: ShopifyCLI::Context.message("script.error.api_library_not_found_help"),
+          }
+        when Layers::Infrastructure::Errors::LanguageLibraryForAPINotFoundError
+          {
+            cause_of_error: ShopifyCLI::Context
+              .message(
+                "script.error.language_library_for_api_not_found_cause",
+                language: e.language,
+                api: e.api
+              ),
+            help_suggestion: ShopifyCLI::Context.message("script.error.language_library_for_api_not_found_help"),
+          }
         end
       end
     end

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

@@ -6,6 +6,7 @@ module Theme
     class Serve < ShopifyCLI::SubCommand
       options do |parser, flags|
         parser.on("--port=PORT") { |port| flags[:port] = port.to_i }
+        parser.on("--poll") { flags[:poll] = true }
       end
 
       def call(*)

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

@@ -88,7 +88,12 @@ module Theme
         serve: {
           help: <<~HELP,
             Uploads the current theme as a development theme to the connected store, then prints theme editor and preview URLs to your terminal. While running, changes will push to the store in real time.
+
             Usage: {{command:%s theme serve}}
+
+            Options:
+              {{command:--port=PORT}} Local port to serve theme preview from
+              {{command:--poll}}      Force polling to detect file changes
           HELP
           serve: "Viewing theme…",
           open_fail: "Couldn't open the theme",

data/lib/shopify_cli/api.rb

@@ -1,4 +1,5 @@
 require "shopify_cli"
+require "securerandom"
 
 module ShopifyCLI
   class API
@@ -54,6 +55,7 @@ module ShopifyCLI
         # we delay this require so as to avoid a performance hit on starting the CLI
         require "shopify_cli/http_request"
         headers = default_headers.merge(headers)
+        ctx.debug("#{method} #{uri} with X-Request-Id: #{headers["X-Request-Id"]}")
         response = if method == "POST"
           HttpRequest.post(uri, body, headers)
         elsif method == "PUT"
@@ -82,6 +84,7 @@ module ShopifyCLI
           raise APIRequestUnexpectedError.new("#{response.code}\n#{response.body}", response: response)
         end
       rescue Errno::ETIMEDOUT, Timeout::Error
+        ctx.debug("timeout in #{method} #{uri} with X-Request-Id: #{headers["X-Request-Id"]}")
         raise APIRequestTimeoutError.new("Timeout")
       end.retry_after(APIRequestRetriableError, retries: 3) do |e|
         sleep(1) if e.is_a?(APIRequestThrottledError)
@@ -109,6 +112,7 @@ module ShopifyCLI
         "User-Agent" => "Shopify CLI; v=#{ShopifyCLI::VERSION}",
         "Sec-CH-UA" => "Shopify CLI; v=#{ShopifyCLI::VERSION} sha=#{ShopifyCLI.sha}",
         "Sec-CH-UA-PLATFORM" => ctx.os.to_s,
+        "X-Request-Id" => SecureRandom.uuid,
       }.tap do |headers|
         headers["X-Shopify-Cli-Employee"] = "1" if Shopifolk.acting_as_shopify_organization?
       end.merge(auth_headers(token))

data/lib/shopify_cli/app_type_detector.rb

@@ -0,0 +1,32 @@
+require "json"
+
+module ShopifyCLI
+  class AppTypeDetector
+    Error = Class.new(StandardError)
+    TypeNotFoundError = Class.new(Error)
+
+    def self.detect(project_directory:)
+      return :node if node?(project_directory: project_directory)
+      return :rails if rails?(project_directory: project_directory)
+      return :php if php?(project_directory: project_directory)
+      raise TypeNotFoundError, "Couldn't detect the project type in directory: #{project_directory}"
+    end
+
+    def self.node?(project_directory:)
+      package_json_path = File.join(project_directory, "package.json")
+      return false unless File.exist?(package_json_path)
+      package_json = JSON.parse(File.read(package_json_path))
+      !package_json.dig("scripts", "dev").nil?
+    end
+
+    def self.rails?(project_directory:)
+      rails_binstub_path = File.join(project_directory, "bin/rails")
+      File.exist?(rails_binstub_path)
+    end
+
+    def self.php?(project_directory:)
+      bootstrap_app_path = File.join(project_directory, "bootstrap/app.php")
+      File.exist?(bootstrap_app_path)
+    end
+  end
+end

data/lib/shopify_cli/command.rb

@@ -27,7 +27,12 @@ module ShopifyCLI
       end
 
       def options(&block)
-        @_options = block
+        existing_options = @_options
+        # We prevent new options calls to override existing blocks by nesting them.
+        @_options = ->(parser, flags) {
+          existing_options&.call(parser, flags)
+          block.call(parser, flags)
+        }
       end
 
       def subcommand(const, cmd, path = nil)

data/lib/shopify_cli/command_options/command_serve_options.rb

@@ -0,0 +1,43 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module CommandOptions
+    module CommandServeOptions
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.class_eval do
+          def port
+            return ShopifyCLI::Tunnel::PORT.to_s unless options.flags.key?(:port)
+            port = options.flags[:port].to_i
+            @ctx.abort(@ctx.message("core.app.serve.error.invalid_port", options.flags[:port])) unless port > 0
+            port
+          end
+
+          def host
+            host = options.flags[:host]
+            unless host.nil?
+              @ctx.abort(@ctx.message("core.app.serve.error.host_must_be_https")) if host.match(/^https/i).nil?
+            end
+            host
+          end
+        end
+      end
+
+      module ClassMethods
+        def parse_host_option
+          options do |parser, flags|
+            parser.on("--host=HOST") do |h|
+              flags[:host] = h.gsub('"', "")
+            end
+          end
+        end
+
+        def parse_port_option
+          options do |parser, flags|
+            parser.on("--port=PORT") { |port| flags[:port] = port }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/command_options.rb

@@ -0,0 +1,7 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module CommandOptions
+    autoload :CommandServeOptions, "shopify_cli/command_options/command_serve_options"
+  end
+end

data/lib/shopify_cli/commands/login.rb

@@ -15,7 +15,7 @@ module ShopifyCLI
 
       def call(*)
         shop = (options.flags[:shop] || @ctx.getenv("SHOPIFY_SHOP" || nil))
-        ShopifyCLI::DB.set(shop: self.class.validate_shop(shop)) unless shop.nil?
+        ShopifyCLI::DB.set(shop: self.class.validate_shop(shop, context: @ctx)) unless shop.nil?
 
         if shop.nil? && Shopifolk.check
           Shopifolk.reset
@@ -41,9 +41,9 @@ module ShopifyCLI
         ShopifyCLI::Context.message("core.login.help", ShopifyCLI::TOOL_NAME)
       end
 
-      def self.validate_shop(shop)
+      def self.validate_shop(shop, context:)
         permanent_domain = shop_to_permanent_domain(shop)
-        @ctx.abort(@ctx.message("core.login.invalid_shop", shop)) unless permanent_domain
+        context.abort(context.message("core.login.invalid_shop", shop)) unless permanent_domain
         permanent_domain
       end
 

data/lib/shopify_cli/commands/reporting.rb

@@ -0,0 +1,38 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module Commands
+    class Reporting < ShopifyCLI::Command
+      def call(args, _name)
+        enable_reporting = reporting_enabled?(args)
+        Services::ReportingService.call(enable: enable_reporting)
+
+        message = if enable_reporting
+          @ctx.message("core.reporting.turned_on_message")
+        else
+          @ctx.message("core.reporting.turned_off_message", ShopifyCLI::TOOL_NAME)
+        end
+        @ctx.puts(message)
+      end
+
+      def reporting_enabled?(args)
+        case args.first
+        when nil
+          @ctx.abort(@ctx.message("core.reporting.missing_argument", ShopifyCLI::TOOL_NAME))
+        when "on"
+          true
+        when "off"
+          false
+        else
+          @ctx.abort(
+            @ctx.message("core.reporting.invalid_argument", ShopifyCLI::TOOL_NAME, args.first)
+          )
+        end
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("core.reporting.help", ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end

data/lib/shopify_cli/commands/switch.rb

@@ -16,7 +16,7 @@ module ShopifyCLI
         end
 
         shop = if options.flags[:shop]
-          Login.validate_shop(options.flags[:shop])
+          Login.validate_shop(options.flags[:shop], context: @ctx)
         elsif (org_id = DB.get(:organization_id))
           res = ShopifyCLI::Tasks::SelectOrgAndShop.call(@ctx, organization_id: org_id)
           res[:shop_domain]

data/lib/shopify_cli/commands.rb

@@ -23,6 +23,7 @@ module ShopifyCLI
     register :Login, "login", "shopify_cli/commands/login", true
     register :Logout, "logout", "shopify_cli/commands/logout", true
     register :Populate, "populate", "shopify_cli/commands/populate", true
+    register :Reporting, "reporting", "shopify_cli/commands/reporting", true
     register :Store, "store", "shopify_cli/commands/store", true
     register :Switch, "switch", "shopify_cli/commands/switch", true
     register :System, "system", "shopify_cli/commands/system", true