shopify-cli 1.2.0 → 1.5.0

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

@@ -18,6 +18,10 @@ module Script
           invalid_context_cause: "Your .shopify-cli.yml file is not correct.",
           invalid_context_help: "See https://help.shopify.com",
 
+          invalid_config_props_cause: "{{command:--config_props}} is formatted incorrectly.",
+          invalid_config_props_help: "Try again using this format: "\
+                                     "{{cyan:--config_props='name1:value1, name2:value2'}}",
+
           invalid_script_name_cause: "Invalid script name.",
           invalid_script_name_help: "Replace or remove unsupported characters. Valid characters "\
                                     "are numbers, letters, hyphens, or underscores.",
@@ -45,9 +49,7 @@ module Script
 
           app_not_installed_cause: "App not installed on store.",
 
-          app_script_not_pushed_help: "Push the script and then try this command again.",
-
-          app_script_undefined_help: "Push script to app.",
+          app_script_not_pushed_help: "Script isn't on the app. Run {{command:shopify push}}, and then try again.",
 
           build_error_cause: "Something went wrong while building the script.",
           build_error_help: "Correct the errors and try again.",
@@ -55,6 +57,9 @@ module Script
           dependency_install_cause: "Something went wrong while installing the dependencies that are needed.",
           dependency_install_help: "Correct the errors and try again.",
 
+          failed_api_request_cause: "Something went wrong while communicating with Shopify.",
+          failed_api_request_help: "Try again.",
+
           forbidden_error_cause: "You do not have permission to do this action.",
 
           graphql_error_cause: "An error was returned: %s.",
@@ -72,8 +77,21 @@ module Script
 
           shop_script_undefined_cause: "Script is already turned off in store.",
 
-          packages_outdated_cause: "The following npm packages are out of date: %s.",
-          packages_outdated_help: "Run `npm update` to update them.",
+          packages_outdated_cause: "These npm packages are out of date: %s.",
+          packages_outdated_help: "To update them, run {{cyan:npm install --save-dev %s}}.",
+
+          invalid_build_script: "Invalid build script.",
+          build_script_not_found: "Build script not found.",
+          # rubocop:disable Layout/LineLength
+          build_script_suggestion: "Root package.json needs a script named build, which" \
+            "uses @shopify/scripts-toolchain-as to compile to WebAssembly.\n" \
+            "Example:\n" \
+            "build: npx shopify-scripts-toolchain-as build --src src/script.ts --binary <script_name>.wasm -- --lib node_modules --optimize --use Date=",
+
+          web_assembly_binary_not_found: "WebAssembly binary not found.",
+          web_assembly_binary_not_found_suggestion: "No WebAssembly binary found." \
+            "Check that your build npm script outputs the generated binary to the root of the directory." \
+            "Generated binary should match the script name: <script_name>.wasm",
         },
 
         create: {

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

@@ -44,6 +44,11 @@ module Script
             cause_of_error: ShopifyCli::Context.message('script.error.invalid_context_cause'),
             help_suggestion: ShopifyCli::Context.message('script.error.invalid_context_help'),
           }
+        when Errors::InvalidConfigProps
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.invalid_config_props_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.invalid_config_props_help'),
+          }
         when Errors::InvalidConfigYAMLError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.invalid_config', e.config_file),
@@ -96,14 +101,11 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message('script.error.app_not_installed_cause'),
           }
-        when Layers::Infrastructure::Errors::AppScriptNotPushedError
+        when Layers::Infrastructure::Errors::AppScriptNotPushedError,
+          Layers::Infrastructure::Errors::AppScriptUndefinedError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.app_script_not_pushed_help'),
           }
-        when Layers::Infrastructure::Errors::AppScriptUndefinedError
-          {
-            help_suggestion: ShopifyCli::Context.message('script.error.app_script_undefined_help'),
-          }
         when Layers::Infrastructure::Errors::BuildError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.build_error_cause'),
@@ -114,6 +116,11 @@ module Script
             cause_of_error: ShopifyCli::Context.message('script.error.dependency_install_cause'),
             help_suggestion: ShopifyCli::Context.message('script.error.dependency_install_help'),
           }
+        when Layers::Infrastructure::Errors::EmptyResponseError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.failed_api_request_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.failed_api_request_help'),
+          }
         when Layers::Infrastructure::Errors::ForbiddenError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.forbidden_error_cause'),
@@ -148,7 +155,25 @@ module Script
               'script.error.packages_outdated_cause',
               e.outdated_packages.join(', ')
             ),
-            help_suggestion: ShopifyCli::Context.message('script.error.packages_outdated_help'),
+            help_suggestion: ShopifyCli::Context.message(
+              'script.error.packages_outdated_help',
+              e.outdated_packages.collect { |package| "#{package}@latest" }.join(' ')
+            ),
+          }
+        when Layers::Infrastructure::Errors::BuildScriptNotFoundError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.build_script_not_found'),
+            help_suggestion: ShopifyCli::Context.message('script.error.build_script_suggestion'),
+          }
+        when Layers::Infrastructure::Errors::InvalidBuildScriptError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.invalid_build_script'),
+            help_suggestion: ShopifyCli::Context.message('script.error.build_script_suggestion'),
+          }
+        when Layers::Infrastructure::Errors::WebAssemblyBinaryNotFoundError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.web_assembly_binary_not_found'),
+            help_suggestion: ShopifyCli::Context.message('script.error.web_assembly_binary_not_found_suggestion'),
           }
         end
       end

data/lib/shopify-cli/api.rb

@@ -1,5 +1,4 @@
 require 'shopify_cli'
-require 'net/http'
 
 module ShopifyCli
   class API
@@ -32,8 +31,9 @@ module ShopifyCli
       )
       ctx.debug(resp)
       resp
-    rescue API::APIRequestServerError, API::APIRequestUnexpectedError
+    rescue API::APIRequestServerError, API::APIRequestUnexpectedError => e
       ctx.puts(ctx.message('core.api.error.internal_server_error'))
+      ctx.debug(ctx.message('core.api.error.internal_server_error_debug', e.message))
     end
 
     protected
@@ -58,14 +58,10 @@ module ShopifyCli
         unless uri.is_a?(URI::HTTP)
           ctx.abort("Invalid URL: #{graphql_url}")
         end
-        http = ::Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
 
-        req = ::Net::HTTP::Post.new(uri.request_uri)
-        req.body = JSON.dump(query: body.tr("\n", ""), variables: variables)
-        req['Content-Type'] = 'application/json'
-        headers.each { |header, value| req[header] = value }
-        response = http.request(req)
+        # we delay this require so as to avoid a performance hit on starting the CLI
+        require 'shopify-cli/http_request'
+        response = HttpRequest.call(uri, body, variables, headers)
 
         case response.code.to_i
         when 200..399
@@ -95,7 +91,9 @@ module ShopifyCli
     def default_headers
       {
         'User-Agent' => "Shopify App CLI #{ShopifyCli::VERSION} #{current_sha} | #{ctx.uname}",
-      }.merge(auth_headers(token))
+      }.tap do |headers|
+        headers['X-Shopify-Cli-Employee'] = '1' if Shopifolk.acting_as_shopify_organization?
+      end.merge(auth_headers(token))
     end
 
     def auth_headers(token)

data/lib/shopify-cli/commands/config.rb

@@ -6,6 +6,8 @@ module ShopifyCli
       hidden_feature(feature_set: :debug)
 
       subcommand :Feature, 'feature'
+      subcommand :Analytics, 'analytics'
+      subcommand :ShopifolkBeta, 'shopifolk-beta'
 
       def call(*)
         @ctx.puts(self.class.help)
@@ -16,6 +18,10 @@ module ShopifyCli
       end
 
       class Feature < ShopifyCli::SubCommand
+        def self.help
+          ShopifyCli::Context.message('core.config.feature.help', ShopifyCli::TOOL_NAME)
+        end
+
         options do |parser, flags|
           parser.on('--enable') { flags[:action] = 'enable' }
           parser.on('--disable') { flags[:action] = 'disable' }
@@ -28,7 +34,7 @@ module ShopifyCli
           is_enabled = ShopifyCli::Feature.enabled?(feature_name)
           if options.flags[:action] == 'disable' && is_enabled
             ShopifyCli::Feature.disable(feature_name)
-            @ctx.puts(@ctx.message('core.config.feature.disabled', is_enabled))
+            @ctx.puts(@ctx.message('core.config.feature.disabled', feature_name))
           elsif options.flags[:action] == 'enable' && !is_enabled
             ShopifyCli::Feature.enable(feature_name)
             @ctx.puts(@ctx.message('core.config.feature.enabled', feature_name))
@@ -39,6 +45,56 @@ module ShopifyCli
           end
         end
       end
+
+      class Analytics < ShopifyCli::SubCommand
+        def self.help
+          ShopifyCli::Context.message('core.config.analytics.help', ShopifyCli::TOOL_NAME)
+        end
+
+        options do |parser, flags|
+          parser.on('--enable') { flags[:action] = 'enable' }
+          parser.on('--disable') { flags[:action] = 'disable' }
+          parser.on('--status') { flags[:action] = 'status' }
+        end
+
+        def call(_args, _name)
+          is_enabled = ShopifyCli::Config.get_bool('analytics', 'enabled')
+          if options.flags[:action] == 'disable' && is_enabled
+            ShopifyCli::Config.set('analytics', 'enabled', false)
+            @ctx.puts(@ctx.message('core.config.analytics.disabled'))
+          elsif options.flags[:action] == 'enable' && !is_enabled
+            ShopifyCli::Config.set('analytics', 'enabled', true)
+            @ctx.puts(@ctx.message('core.config.analytics.enabled'))
+          elsif is_enabled
+            @ctx.puts(@ctx.message('core.config.analytics.is_enabled'))
+          else
+            @ctx.puts(@ctx.message('core.config.analytics.is_disabled'))
+          end
+        end
+      end
+
+      class ShopifolkBeta < ShopifyCli::SubCommand
+        options do |parser, flags|
+          parser.on('--enable') { flags[:action] = 'enable' }
+          parser.on('--disable') { flags[:action] = 'disable' }
+          parser.on('--status') { flags[:action] = 'status' }
+        end
+
+        def call(_args, _name)
+          is_enabled = ShopifyCli::Config.get_bool('shopifolk-beta', 'enabled')
+          if options.flags[:action] == 'disable' && is_enabled
+            ShopifyCli::Config.set('shopifolk-beta', 'enabled', false)
+            @ctx.puts(@ctx.message('core.config.shopifolk_beta.disabled'))
+          elsif options.flags[:action] == 'enable' && !is_enabled
+            ShopifyCli::Config.set('shopifolk-beta', 'enabled', true)
+            @ctx.puts(@ctx.message('core.config.shopifolk_beta.enabled'))
+          elsif is_enabled
+            @ctx.puts(@ctx.message('core.config.shopifolk_beta.is_enabled'))
+          else
+            @ctx.puts(@ctx.message('core.config.shopifolk_beta.is_disabled'))
+          end
+        end
+      end
     end
   end
 end

data/lib/shopify-cli/commands/connect.rb

@@ -3,23 +3,33 @@ require 'shopify_cli'
 module ShopifyCli
   module Commands
     class Connect < ShopifyCli::Command
-      def call(*)
-        project_type = ask_project_type unless Project.has_current?
-
-        if Project.has_current? && Project.current && Project.current.env
-          @ctx.puts @ctx.message('core.connect.already_connected_warning')
-          prod_warning = @ctx.message('core.connect.production_warning')
-          @ctx.puts prod_warning if [:rails, :node].include?(Project.current_project_type)
+      class << self
+        def call(args, command_name)
+          ProjectType.load_type(args[0]) unless args.empty?
+          super
         end
 
-        org = ShopifyCli::Tasks::EnsureEnv.call(@ctx, regenerate: true)
-        write_cli_yml(project_type, org['id']) unless Project.has_current?
-        api_key = Project.current(force_reload: true).env['api_key']
-        @ctx.puts(@ctx.message('core.connect.connected', get_app(org['apps'], api_key).first["title"]))
+        def help
+          ShopifyCli::Context.message('core.connect.help', ShopifyCli::TOOL_NAME)
+        end
       end
 
-      def get_app(apps, api_key)
-        apps.select { |app| app["apiKey"] == api_key }
+      def call(args, command_name)
+        if Project.current&.env
+          @ctx.puts(@ctx.message('core.connect.already_connected_warning'))
+        end
+
+        project_type = ask_project_type
+
+        klass = ProjectType.load_type(project_type)&.connect_command
+
+        if klass
+          klass.ctx = @ctx
+          klass.call(args, command_name, 'connect')
+        else
+          app = default_connect(project_type)
+          @ctx.done(@ctx.message('core.connect.connected', app))
+        end
       end
 
       def ask_project_type
@@ -30,6 +40,13 @@ module ShopifyCli
         end
       end
 
+      def default_connect(project_type)
+        org = ShopifyCli::Tasks::EnsureEnv.call(@ctx, regenerate: true)
+        write_cli_yml(project_type, org['id']) unless Project.has_current?
+        api_key = Project.current(force_reload: true).env['api_key']
+        get_app(org['apps'], api_key).first['title']
+      end
+
       def write_cli_yml(project_type, org_id)
         ShopifyCli::Project.write(
           @ctx,
@@ -39,8 +56,8 @@ module ShopifyCli
         @ctx.done(@ctx.message('core.connect.cli_yml_saved'))
       end
 
-      def self.help
-        ShopifyCli::Context.message('core.connect.help', ShopifyCli::TOOL_NAME)
+      def get_app(apps, api_key)
+        apps.select { |app| app["apiKey"] == api_key }
       end
     end
   end

data/lib/shopify-cli/commands/system.rb

@@ -23,6 +23,7 @@ module ShopifyCli
         display_cli_ruby(show_all_details)
         display_utility_commands(show_all_details)
         display_project_commands(show_all_details)
+        display_shopify_staff_identity if show_all_details
       end
 
       def self.help
@@ -139,6 +140,14 @@ module ShopifyCli
         end
         @ctx.puts("")
       end
+
+      def display_shopify_staff_identity
+        is_shopifolk = ShopifyCli::Shopifolk.check
+        if is_shopifolk
+          @ctx.puts("\n" + @ctx.message('core.system.identity_header'))
+          @ctx.puts("  " + @ctx.message('core.system.identity_is_shopifolk'))
+        end
+      end
     end
   end
 end

data/lib/shopify-cli/core/entry_point.rb

@@ -28,7 +28,7 @@ module ShopifyCli
             ctx.puts(
               ctx.message('core.warning.development_version', File.join(ShopifyCli::ROOT, 'bin', ShopifyCli::TOOL_NAME))
             )
-          else
+          elsif !ctx.testing?
             new_version = ctx.new_version
             ctx.puts(ctx.message('core.warning.new_version', ShopifyCli::VERSION, new_version)) unless new_version.nil?
           end

data/lib/shopify-cli/core/monorail.rb

@@ -7,7 +7,7 @@ module ShopifyCli
   module Core
     module Monorail
       ENDPOINT_URI = URI.parse('https://monorail-edge.shopifycloud.com/v1/produce')
-      INVOCATIONS_SCHEMA = 'app_cli_command/4.0'
+      INVOCATIONS_SCHEMA = 'app_cli_command/5.0'
 
       # Extra hash of data that will be sent in the payload
       @metadata = {}
@@ -101,14 +101,16 @@ module ShopifyCli
               uname: RbConfig::CONFIG["host"],
               cli_version: ShopifyCli::VERSION,
               ruby_version: RUBY_VERSION,
+              is_employee: ShopifyCli::Shopifolk.acting_as_shopify_organization?,
             }.tap do |payload|
-              payload[:metadata] = JSON.dump(metadata) unless metadata.empty?
-
+              payload[:api_key] = metadata.delete(:api_key)
+              payload[:partner_id] = metadata.delete(:organization_id)
               if Project.has_current?
-                project = Project.current
+                project = Project.current(force_reload: true)
                 payload[:api_key] = project.env&.api_key
                 payload[:partner_id] = project.config['organization_id']
               end
+              payload[:metadata] = JSON.dump(metadata) unless metadata.empty?
             end,
           }
         end

data/lib/shopify-cli/http_request.rb

@@ -0,0 +1,15 @@
+require 'net/http'
+
+module ShopifyCli
+  class HttpRequest
+    def self.call(uri, body, variables, headers)
+      http = ::Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      req = ::Net::HTTP::Post.new(uri.request_uri)
+      req.body = JSON.dump(query: body.tr("\n", ""), variables: variables)
+      req['Content-Type'] = 'application/json'
+      headers.each { |header, value| req[header] = value }
+      http.request(req)
+    end
+  end
+end

data/lib/shopify-cli/js_deps.rb

@@ -59,7 +59,7 @@ module ShopifyCli
     end
 
     def npm(verbose = false)
-      cmd = %w(npm install --no-audit --no-optional)
+      cmd = %w(npm install --no-audit)
       cmd << '--quiet' unless verbose
 
       run_install_command(cmd)

data/lib/shopify-cli/js_system.rb

@@ -76,23 +76,40 @@ module ShopifyCli
     # - `ctx`: running context from your command
     # - `yarn`: The proc, array, or string command to run if yarn is available
     # - `npm`: The proc, array, or string command to run if npm is available
+    # - `capture_response`: The boolean flag to capture the output of the running command if it is set to true
     #
     # #### Example
     #
-    #   ShopifyCli::JsSystem.new(ctx: ctx).call(yarn: ['install', '--silent'], npm: ['install', '--no-audit'])
+    #   ShopifyCli::JsSystem.new(ctx: ctx).call(
+    #     yarn: ['install', '--silent'],
+    #     npm: ['install', '--no-audit'],
+    #     capture_response: false
+    #   )
     #
-    def call(yarn:, npm:)
-      yarn? ? call_command(yarn, YARN_CORE_COMMAND) : call_command(npm, NPM_CORE_COMMAND)
+    def call(yarn:, npm:, capture_response: false)
+      if yarn?
+        call_command(yarn, YARN_CORE_COMMAND, capture_response)
+      else
+        call_command(npm, NPM_CORE_COMMAND, capture_response)
+      end
     end
 
     private
 
-    def call_command(command, core_command)
+    def call_command(command, core_command, capture_response)
       if command.is_a?(String) || command.is_a?(Array)
-        CLI::Kit::System.system(core_command, *command, chdir: ctx.root).success?
+        capture_response ? call_with_capture(command, core_command) : call_without_capture(command, core_command)
       else
         command.call
       end
     end
+
+    def call_with_capture(command, core_command)
+      CLI::Kit::System.capture3(core_command, *command, chdir: ctx.root)
+    end
+
+    def call_without_capture(command, core_command)
+      CLI::Kit::System.system(core_command, *command, chdir: ctx.root).success?
+    end
   end
 end