shopify-cli 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44313f65cde9217bac879066a57be593752c7d791d272d1ada078bc4a876f24c
-  data.tar.gz: bcb6ac1b939ee13ccec83eb74814ceddb1cb2d11661f516327ca2f0d294795a3
+  metadata.gz: 3126bd5c9f4667732d248380f29b84fcac3bab1e3c944748b18dd3b0a639301d
+  data.tar.gz: 8c6ffbcf72d7360e227178f970c63a6041ee6c7f61b0ea22a9d6747f163f5b6b
 SHA512:
-  metadata.gz: 77f0ea5bef5ce778e87c9414c4ec1712795ef144e603bf22f88975d5f86dab2f4d43052522f18302be1ac836b3b2b98cb2f66ea9d413d93214da365895d3a2b5
-  data.tar.gz: 7cc5de0ba35117ae63a6cbb9e6d761695a75166cb15a996fd6545ba981e1809f60e9e42ad2d13e59a837310b11328b693744eb9547e90a0a8f537fd6640ba206
+  metadata.gz: 2a21a55b5b258fa6c5037fff6652c43ba09a207e7f2b313b52a950b7a1d221e41d7edf719ce66c089200c1f2fba577e412fb985420c872ee83a4d40ef0cd05be
+  data.tar.gz: 338348f5e2220ef8b307e619981cc16985f012ecafc09c2d2eb232c2639ca65a11df12249f0d64fea5839b9015e1e31f0617eae84b82b4e530df587969b5fcc8

data/CHANGELOG.md

@@ -2,6 +2,24 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 
 ## [Unreleased]
 
+## 2.9.0
+
+### Fixed
+* [#1922](https://github.com/Shopify/shopify-cli/pull/1922): Respect RUBY_BINDIR from Homebrew for installing gem
+* [#1906](https://github.com/Shopify/shopify-cli/pull/1906): Fix Ngrok incompatibility with some Apple ARM environments
+* [#1873](https://github.com/Shopify/shopify-cli/pull/1873): Fix partners ability to login to external shops.
+* [#1909](https://github.com/Shopify/shopify-cli/pull/1909): Fix `theme serve` on Safari
+
+### Added
+* [#1900](https://github.com/Shopify/shopify-cli/pull/1900): Add `-d`/`--development` flag to Shopify theme pull command
+* [#1896](https://github.com/Shopify/shopify-cli/pull/1896): Release Typescript options for payment_methods and shipping_methods scripts
+* [#1891](https://github.com/Shopify/shopify-cli/pull/1891): Allow for additional arguments in `shopify push script` on CI.
+* [#1877](https://github.com/Shopify/shopify-cli/pull/1877): Add theme (`-t`/`--theme=NAME_OR_ID`) parameter to `theme push`/`theme pull` commands
+* [#1871](https://github.com/Shopify/shopify-cli/pull/1871): Add a new `--live-reload` parameter to the `theme serve` command
+
+### Changed
+- [#1929](https://github.com/Shopify/shopify-cli/pull/1929): Rename `--registration-id` to `--extension-id` in `shopify extension push`.
+
 ## Version 2.8.0
 ### Fixed
 * [#1879](https://github.com/Shopify/shopify-cli/pull/1879): Disambiguate -s as store option

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.8.0)
+    shopify-cli (2.9.0)
       bugsnag (~> 6.22)
       listen (~> 3.7.0)
       theme-check (~> 1.9.0)

data/RELEASING.md

@@ -23,21 +23,22 @@
    ```
 
 9. Open a PR for the branch, get necessary approvals from code owners and merge into main branch. Note that the PR title will be the release note in Shipit, so make sure it mentions the release
-10. Deploy using Shipit
+10. Deploy to RubyGems using [Shipit](https://shipit.shopify.io/shopify/shopify-cli/rubygems)
 11. Update your `main` branch to the latest version
    ```
    $ git checkout main
    $ git pull
    ```
    
-12. On local machine and _AFTER_ gem has been published to https://rubygems.org, run
+12. On local machine and _AFTER_ gem has been published to https://rubygems.org/gems/shopify-cli, run
    ```
    $ rake package
    ```
    This will generate the `.deb`, `.rpm` and brew formula files, which will be located in `packaging/builds/X.Y.Z/`.
 
 13. Clone the `Shopify/homebrew-shopify` repository (if not already cloned), and then
-    * create a branch named `release_X_Y_Z_of_shopify-cli`
+    * update your `master` branch to the latest version: `git checkout master && git pull`
+    * create a new branch: `git checkout -b release_X_Y_Z_of_shopify-cli`
     * update the brew formula in `shopify-cli.rb` with the generated formula in `packaging/builds/X.Y.Z/` in the `Shopify/shopify-cli` repo (from the `rake package` step above)
     * commit the change and create a PR on the [Shopify Homebrew repository](https://github.com/Shopify/homebrew-shopify)
     * when PR is approved, merge into main branch

data/ext/javy/javy.rb

@@ -5,7 +5,7 @@ require "digest/sha2"
 
 module Javy
   ROOT = __dir__
-  BIN_FOLDER = File.join(ROOT, "bin")
+  BIN_FOLDER = File.join(ShopifyCLI.cache_dir, "javy", "bin")
   HASH_FOLDER = File.join(ROOT, "hashes")
   VERSION = File.read(File.join(ROOT, "version")).strip
   TARGET = File.join(BIN_FOLDER, "javy-#{VERSION}")

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

@@ -9,7 +9,7 @@ module Extension
       options do |parser, flags|
         parser.on("--api-key=API_KEY") { |api_key| flags[:api_key] = api_key.gsub('"', "") }
         parser.on("--api-secret=API_SECRET") { |api_secret| flags[:api_secret] = api_secret.gsub('"', "") }
-        parser.on("--registration-id=REGISTRATION_ID") do |registration_id|
+        parser.on("--extension-id=EXTENSION_ID") do |registration_id|
           flags[:registration_id] = registration_id.gsub('"', "")
         end
       end
@@ -35,7 +35,7 @@ module Extension
       end
 
       def register_if_necessary(project:, args:, name:)
-        if @ctx.tty? && !project.registered?
+        if ShopifyCLI::Environment.interactive? && !project.registered?
           Command::Register.new(@ctx).call(args, name)
         end
       end

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

@@ -91,7 +91,7 @@ module Extension
             Usage: {{command:%s extension push}}
             Options:
               {{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:--registration-id=REGISTRATION_ID}} The id of the extension's registration.
+              {{command:--extension-id=EXTENSION_ID}} The id of the extension's registration.
         HELP
         frame_title: "Pushing your extension to Shopify",
         waiting_text: "Pushing code to Shopify…",

data/lib/project_types/extension/models/development_server.rb

@@ -40,7 +40,7 @@ module Extension
 
       def serve(context, server_config)
         CLI::Kit::System.popen3(executable, "serve", "-") do |input, out, err, status|
-          context.puts("Sending configuration data …")
+          context.debug("Sending configuration data to extension development server …")
           input << server_config.to_yaml
           input.close
 
@@ -57,17 +57,15 @@ module Extension
       private
 
       def forward_output_to_user(out, err, ctx)
-        ctx.puts("Starting monitoring threads …")
+        ctx.debug("Starting message processing threads to relay output produced by the extension development server …")
 
         Thread.new do
-          ctx.puts("Ready to process standard output")
           while (line = out.gets)
             ctx.puts(line)
           end
         end
 
         Thread.new do
-          ctx.puts("Ready to process standard error")
           while (error = err.gets)
             ctx.puts(error)
           end

data/lib/project_types/rails/gem.rb

@@ -79,8 +79,7 @@ module Rails
     def install!
       spin = CLI::UI::SpinGroup.new
       spin.add(ctx.message("rails.gem.installing", name)) do |spinner|
-        args = %w(gem install)
-        args.push(name)
+        args = ["#{ENV["RUBY_BINDIR"]}gem", "install", name]
         unless version.nil?
           if ctx.windows? && version.include?("~")
             args.push("-v", "\"#{version}\"")

data/lib/project_types/script/cli.rb

@@ -92,5 +92,10 @@ module Script
 
   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")
+  end
+
   class ScriptProjectError < StandardError; end
 end

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

@@ -6,7 +6,7 @@ module Script
       prerequisite_task ensure_project_type: :script
 
       def call(_args, _)
-        Layers::Application::ConnectApp.call(ctx: @ctx, force: true, strict: true)
+        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"))
       end

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

@@ -33,8 +33,14 @@ module Script
       end
 
       def self.help
-        allowed_values = Script::Layers::Application::ExtensionPoints.available_types.map { |type| "{{cyan:#{type}}}" }
-        ShopifyCLI::Context.message("script.create.help", ShopifyCLI::TOOL_NAME, allowed_values.join(", "))
+        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(", ")
+        )
       end
     end
   end

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

@@ -7,25 +7,48 @@ module Script
 
       options do |parser, flags|
         parser.on("--force") { |t| flags[:force] = t }
+        parser.on("--api-key=API_KEY") { |api_key| flags[:api_key] = api_key.gsub('"', "") }
+        parser.on("--api-secret=API_SECRET") { |api_secret| flags[:api_secret] = api_secret.gsub('"', "") }
+        parser.on("--uuid=UUID") do |uuid|
+          flags[:uuid] = uuid.gsub('""', "")
+        end
       end
 
       def call(_args, _name)
-        fresh_env = Layers::Application::ConnectApp.call(ctx: @ctx)
-
-        force = options.flags.key?(:force) || !!fresh_env
+        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_no_api_key"))
+      end
 
-        api_key = Layers::Infrastructure::ScriptProjectRepository.new(ctx: @ctx).get.api_key
-        return @ctx.puts(self.class.help) unless api_key
+      def push(project:)
+        force = options.flags.key?(:force)
+        api_key = project.env[:api_key]
+        uuid = project.env[:extra]["UUID"]
 
-        Layers::Application::PushScript.call(ctx: @ctx, force: force)
-        @ctx.puts(@ctx.message("script.push.script_pushed", api_key: api_key))
-      rescue StandardError => e
-        msg = if api_key
-          @ctx.message("script.push.error.operation_failed_with_api_key", api_key: api_key)
+        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
-          @ctx.message("script.push.error.operation_failed_no_api_key")
+          raise ShopifyCLI::Abort, @ctx.message("script.push.error.operation_failed_no_uuid")
+        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
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: msg)
       end
 
       def self.help

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

@@ -7,7 +7,7 @@ module Script
     module Application
       class ConnectApp
         class << self
-          def call(ctx:, force: false, strict: false)
+          def call(ctx:, force: false)
             script_project_repo = Layers::Infrastructure::ScriptProjectRepository.new(ctx: ctx)
             script_project = script_project_repo.get
 
@@ -40,10 +40,6 @@ module Script
 
             uuid = Forms::AskScriptUuid.ask(ctx, scripts, nil)&.uuid
 
-            if strict && uuid.nil?
-              ctx.abort(ctx.message("script.connect.missing_script"))
-            end
-
             script_project_repo.create_env(
               api_key: app["apiKey"],
               secret: app["apiSecretKeys"].first["secret"],
@@ -52,6 +48,16 @@ module Script
             ctx.done(ctx.message("script.connect.connected", app["title"]))
 
             true
+          rescue SmartProperties::InitializationError, SmartProperties::InvalidValueError => error
+            handle_error(error, context: ctx)
+          end
+
+          def handle_error(error, context:)
+            properties_hash = { api_key: "SHOPIFY_API_KEY", secret: "SHOPIFY_API_SECRET" }
+            missing_env_variables = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
+            raise ShopifyCLI::Abort,
+              context.message("script.connect.error.missing_env_file_variables", missing_env_variables,
+                ShopifyCLI::TOOL_NAME)
           end
 
           private

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

@@ -4,37 +4,61 @@ module Script
   module Layers
     module Application
       class ExtensionPoints
-        def self.get(type:)
-          Infrastructure::ExtensionPointRepository.new.get_extension_point(type)
-        end
+        class << self
+          def get(type:)
+            extension_point_repository.get_extension_point(type)
+          end
 
-        def self.types
-          Infrastructure::ExtensionPointRepository.new.extension_point_types
-        end
+          def types
+            extension_point_repository.extension_point_types
+          end
 
-        def self.available_types
-          Infrastructure::ExtensionPointRepository.new.extension_points.select do |ep|
-            next false if ep.deprecated?
-            !ep.beta? || ShopifyCLI::Feature.enabled?(:scripts_beta_extension_points)
-          end.map(&:type)
-        end
+          def available_types
+            available_extension_points.map(&:type)
+          end
 
-        def self.deprecated_types
-          Infrastructure::ExtensionPointRepository.new
-            .extension_points
-            .select(&:deprecated?)
-            .map(&:type)
-        end
+          def deprecated_types
+            extension_point_repository
+              .extension_points
+              .select(&:deprecated?)
+              .map(&:type)
+          end
 
-        def self.languages(type:)
-          get(type: type).libraries.all.map do |library|
-            next nil if library.beta? && !ShopifyCLI::Feature.enabled?(:scripts_beta_languages)
-            library.language
-          end.compact
-        end
+          def all_languages
+            available_extension_points
+              .map { |ep| ep.library_languages(include_betas: include_beta_languages?) }
+              .flatten
+              .uniq
+          end
+
+          def languages(type:)
+            get(type: type).library_languages(include_betas: include_beta_languages?)
+          end
+
+          def supported_language?(type:, language:)
+            languages(type: type).include?(language.downcase)
+          end
+
+          private
+
+          def available_extension_points
+            extension_point_repository.extension_points.select do |ep|
+              next false if ep.deprecated?
+              ep.stable? || include_beta_extension_points?
+            end
+          end
+
+          def extension_point_repository
+            Infrastructure::ExtensionPointRepository.new
+          end
+
+          def include_beta_languages?
+            ShopifyCLI::Feature.enabled?(:scripts_beta_languages)
+          end
 
-        def self.supported_language?(type:, language:)
-          languages(type: type).include?(language.downcase)
+          def include_beta_extension_points?
+            ShopifyCLI::Feature.enabled?(:scripts_beta_extension_points)
+          end
         end
       end
     end

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

@@ -5,9 +5,10 @@ module Script
     module Application
       class PushScript
         class << self
-          def call(ctx:, force:)
+          def call(ctx:, force:, project:)
             script_project_repo = Infrastructure::ScriptProjectRepository.new(ctx: ctx)
             script_project = script_project_repo.get
+            script_project.env = project.env
             task_runner = Infrastructure::Languages::TaskRunner
               .for(ctx, script_project.language, script_project.script_name)
 
@@ -47,7 +48,9 @@ module Script
                 module_upload_url: module_upload_url,
                 library: package.library,
               )
-              script_project_repo.update_env(uuid: uuid)
+              if ShopifyCLI::Environment.interactive?
+                script_project_repo.update_env(uuid: uuid)
+              end
               spinner.update_title(p_ctx.message("script.application.pushed"))
             end
           end

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

@@ -18,6 +18,10 @@ module Script
           @beta
         end
 
+        def stable?
+          !beta?
+        end
+
         def deprecated?
           @deprecated
         end
@@ -26,6 +30,12 @@ module Script
           @type.gsub("_", "-")
         end
 
+        def library_languages(include_betas: false)
+          @libraries.all.map do |library|
+            include_betas || library.stable? ? library.language : nil
+          end.compact
+        end
+
         class ExtensionPointLibraries
           def initialize(config)
             @config = config
@@ -57,6 +67,10 @@ module Script
             @beta
           end
 
+          def stable?
+            !beta?
+          end
+
           def versioned?
             @version
           end

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

@@ -39,6 +39,8 @@ module Script
           end
         end
 
+        class ScriptEnvAppNotConnectedError < ScriptProjectError; end
+
         class InvalidScriptConfigYmlDefinitionError < ScriptProjectError; end
 
         class InvalidScriptJsonDefinitionError < ScriptProjectError; end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Script
+  module Loaders
+    module Project
+      def self.load(directory:, api_key:, uuid:, api_secret:, context: ShopifyCLI::Context.new)
+        env_overrides = {
+          "SHOPIFY_API_KEY" => api_key,
+          "SHOPIFY_API_SECRET" => api_secret,
+          "UUID" => uuid,
+        }.compact
+        env_file_present = env_file_exists?(directory)
+        env = if env_file_present
+          ShopifyCLI::Resources::EnvFile.read(directory, overrides: env_overrides)
+        else
+          ShopifyCLI::Resources::EnvFile.from_hash(env_overrides)
+        end
+
+        project = ShopifyCLI::Project.at(directory)
+        project.env = env
+        project
+      rescue SmartProperties::InitializationError, SmartProperties::InvalidValueError => error
+        handle_error(error, context: context, env_file_present: env_file_present)
+      end
+
+      def self.handle_error(error, context:, env_file_present:)
+        if env_file_present
+          properties_hash = { api_key: "SHOPIFY_API_KEY", secret: "SHOPIFY_API_SECRET" }
+          missing_env_variables = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
+          raise ShopifyCLI::Abort,
+            context.message("script.error.missing_env_file_variables", missing_env_variables, ShopifyCLI::TOOL_NAME)
+        else
+          properties_hash = { api_key: "--api-key", secret: "--api-secret" }
+          missing_options = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
+          raise ShopifyCLI::Abort, context.message("script.error.missing_push_options", missing_options)
+        end
+      end
+
+      def self.env_file_exists?(directory)
+        File.exist?(ShopifyCLI::Resources::EnvFile.path(directory))
+      end
+    end
+  end
+end

data/lib/project_types/script/loaders/specification_handler.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Script
+  module Loaders
+    module SpecificationHandler
+      def self.load(project:, context:)
+        identifier = project.specification_identifier
+        Models::LazySpecificationHandler.new(identifier) do
+          specifications = Models::Specifications.new(
+            fetch_specifications: Tasks::FetchSpecifications.new(api_key: project.app.api_key, context: context)
+          )
+
+          unless specifications.valid?(identifier)
+            context.abort(context.message("errors.unknown_type", project.specification_identifier))
+          end
+
+          specifications[identifier]
+        end
+      end
+    end
+  end
+end

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

@@ -62,6 +62,9 @@ module Script
           no_script_config_yml_file_cause: "The script.config.yml file is missing.",
           no_script_config_yml_file_help: "Create this file and try again.",
 
+          app_not_connected_cause: "Script is not connected to an app.",
+          app_not_connected_help: "Run shopify connect or enter fields for api-key and api-secret.",
+
           configuration_syntax_error_cause: "The script.json is not formatted properly.",
           configuration_syntax_error_help: "Fix the errors and try again.",
 
@@ -145,6 +148,11 @@ module Script
           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.",
           no_scripts_found_in_app: "The selected apps have no scripts. Please, create them first on the partners' dashboard.",
+          missing_env_file_variables: "The following variables are missing in the .env file: %s."\
+            " It might happen when the script hasn't been previously connected to an app."\
+            " To connect the script to an app, run {{command:%s script connect}}",
+          missing_push_options: "The following options are required: %s."\
+            " You can obtain them from the .env file generated after connecting the script to an app.",
         },
 
         create: {
@@ -154,6 +162,7 @@ module Script
               Options:
                 {{command:--name=NAME}} Script project name. Use any string.
                 {{command:--api=TYPE}} Script API name. Allowed values: %2$s.
+                {{command:--language=LANGUAGE}} Programming language. Allowed values: %3$s.
           HELP
 
           error: {
@@ -171,9 +180,13 @@ module Script
               Usage: {{command:%s script push}}
               Options:
                 {{command:[--force]}} Replaces the existing script on the app with this version.
+                {{command:[--api-key=API_KEY]}} The API key used to register an app with the script. This can be found on the app page on Partners Dashboard. Overrides the value in the .env file, if present.
+                {{command:[--api-secret=API_SECRET]}} The API secret of the app the script is registered with. Overrides the value in the .env file, if present.
+                {{command:[--uuid=UUID]}} The uuid of the script. Overrides the value in the .env file, if present.
           HELP
 
           error: {
+            operation_failed_no_uuid: "UUID is required to push in a CI environment.",
             operation_failed_with_api_key: "Couldn't push script to app (API key: %{api_key}).",
             operation_failed_no_api_key: "Couldn't push script to app.",
           },
@@ -182,13 +195,14 @@ module Script
         },
         connect: {
           connected: "Connected! Your project is now connected to {{green:%s}}",
-          missing_script: "No script has been selected.",
           help: <<~HELP,
             {{command:%s script connect}}: Connects an existing script to an app.
               Usage: {{command:%s script connect}}
           HELP
           error: {
             operation_failed: "Couldn't connect script to app.",
+            missing_env_file_variables: "The following variables are missing in the .env file: %s."\
+            " To connect the script to an app, either enter the value into the .env file or delete the .env file, then run {{command:%s script connect}}",
           },
         },
         javy: {

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

@@ -143,6 +143,11 @@ module Script
             cause_of_error: ShopifyCLI::Context.message("script.error.configuration_syntax_error_cause"),
             help_suggestion: ShopifyCLI::Context.message("script.error.configuration_syntax_error_help"),
           }
+        when Layers::Infrastructure::Errors::ScriptEnvAppNotConnectedError
+          {
+            cause_of_error: ShopifyCLI::Context.message("script.error.app_not_connected_cause"),
+            help_suggestion: ShopifyCLI::Context.message("script.error.app_not_connected_help"),
+          }
         when Layers::Infrastructure::Errors::ScriptConfigMissingKeysError
           {
             cause_of_error: ShopifyCLI::Context.message(