shopify-cli 1.4.1 → 1.5.0

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),
@@ -111,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'),
@@ -150,6 +160,21 @@ module Script
               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
     end

data/lib/shopify-cli/api.rb

@@ -91,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

@@ -7,6 +7,7 @@ module ShopifyCli
 
       subcommand :Feature, 'feature'
       subcommand :Analytics, 'analytics'
+      subcommand :ShopifolkBeta, 'shopifolk-beta'
 
       def call(*)
         @ctx.puts(self.class.help)
@@ -71,6 +72,29 @@ module ShopifyCli
           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/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,6 +101,7 @@ 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[:api_key] = metadata.delete(:api_key)
               payload[:partner_id] = metadata.delete(:organization_id)

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/messages/messages.rb

@@ -3,6 +3,16 @@
 module ShopifyCli
   module Messages
     MESSAGES = {
+      apps: {
+        create: {
+          info: {
+            created: "{{v}} {{green:%s}} was created in the organization's Partner Dashboard {{underline:%s}}",
+            serve: "{{*}} Change directories to your new project folder {{green:%s}} and run {{command:%s serve}} " \
+            "to start a local server",
+            install: "{{*}} Then, visit {{underline:%s/test}} to install {{green:%s}} on your Dev Store",
+          },
+        },
+      },
       core: {
         connect: {
           help: <<~HELP,
@@ -10,11 +20,7 @@ module ShopifyCli
             Usage: {{command:%s connect}}
           HELP
 
-          production_warning: <<~MESSAGE,
-          {{yellow:! Warning: if you have connected to an {{bold:app in production}}, running {{command:serve}} may update the app URL and cause an outage.
-          MESSAGE
           already_connected_warning: "{{yellow:! This app appears to be already connected}}",
-          connected: "{{v}} Project now connected to {{green:%s}}",
           project_type_select: "What type of project would you like to connect?",
           cli_yml_saved: ".shopify-cli.yml saved to project root",
         },
@@ -70,6 +76,16 @@ module ShopifyCli
             is_enabled: "{{v}} analytics are currently enabled",
             is_disabled: "{{v}} analytics are currently disabled",
           },
+          shopifolk_beta: {
+            help: <<~HELP,
+            Opt in/out of shopifolk beta
+              Usage: {{command:%s config [ analytics ] }}
+            HELP
+            enabled: "{{v}} shopifolk-beta has been enabled",
+            disabled: "{{v}} shopifolk-beta has been disabled",
+            is_enabled: "{{v}} shopifolk-beta is currently enabled",
+            is_disabled: "{{v}} shopifolk-beta is currently disabled",
+          },
         },
 
         git: {
@@ -300,6 +316,8 @@ module ShopifyCli
               organization_not_found: "Cannot find a partner organization with that ID",
               partners_notice: "Please visit https://partners.shopify.com/ to create a partners account",
             },
+            first_party: "Are you working on a 1P (1st Party) app?",
+            identified_as_shopify: "We've identified you as a {{green:Shopify}} employee.",
             organization: "Partner organization {{green:%s (%s)}}",
             organization_select: "Select partner organization",
           },

data/lib/shopify-cli/partners_api.rb

@@ -27,7 +27,7 @@ module ShopifyCli
       # #### Parameters
       # - `ctx`: running context from your command
       # - `query_name`: name of the query you want to use, loaded from the `lib/graphql` directory.
-      # - `**variable`: a hash of variables to be supplied to the query ro mutation
+      # - `**variables`: a hash of variables to be supplied to the query or mutation
       #
       # #### Raises
       #
@@ -50,6 +50,13 @@ module ShopifyCli
         end
       end
 
+      def partners_url_for(organization_id, api_client_id, local_debug)
+        if ShopifyCli::Shopifolk.acting_as_shopify_organization?
+          organization_id = 'internal'
+        end
+        "#{partners_endpoint(local_debug)}/#{organization_id}/apps/#{api_client_id}"
+      end
+
       private
 
       def authenticated_req(ctx)
@@ -105,6 +112,15 @@ module ShopifyCli
         return 'https://partners.shopify.com' if ENV[LOCAL_DEBUG].nil?
         'https://partners.myshopify.io/'
       end
+
+      def partners_endpoint(local_debug)
+        domain = if local_debug
+          'partners.myshopify.io'
+        else
+          'partners.shopify.com'
+        end
+        "https://#{domain}"
+      end
     end
 
     def auth_headers(token)

data/lib/shopify-cli/process_supervision.rb

@@ -206,7 +206,7 @@ module ShopifyCli
       unless ctx.windows?
         Process.kill('TERM', id)
         50.times do
-          sleep 0.1
+          sleep(0.1)
           break unless stat(id)
         end
       end

data/lib/shopify-cli/project.rb

@@ -34,7 +34,8 @@ module ShopifyCli
       #   project = ShopifyCli::Project.current
       #
       def current(force_reload: false)
-        at(Dir.pwd, force_reload: force_reload)
+        clear if force_reload
+        at(Dir.pwd)
       end
 
       ##
@@ -87,27 +88,30 @@ module ShopifyCli
         content = Hash[{ project_type: project_type, organization_id: organization_id.to_i }
           .merge(identifiers)
           .collect { |k, v| [k.to_s, v] }]
+        content['shopify_organization'] = true if Shopifolk.acting_as_shopify_organization?
 
         ctx.write('.shopify-cli.yml', YAML.dump(content))
+        clear
       end
 
       def project_name
         File.basename(current.directory)
       end
 
-      private
+      def clear
+        @at = nil
+        @dir = nil
+      end
 
-      def directory(dir, force_reload: false)
-        @dir = nil if force_reload
+      private
 
+      def directory(dir)
         @dir ||= Hash.new { |h, k| h[k] = __directory(k) }
         @dir[dir]
       end
 
-      def at(dir, force_reload: false)
-        @at = nil if force_reload
-
-        proj_dir = directory(dir, force_reload: force_reload)
+      def at(dir)
+        proj_dir = directory(dir)
         unless proj_dir
           raise(ShopifyCli::Abort, Context.message('core.project.error.not_in_project'))
         end

data/lib/shopify-cli/project_type.rb

@@ -45,8 +45,11 @@ module ShopifyCli
         File.join(ShopifyCli::PROJECT_TYPES_DIR, project_type.to_s, path)
       end
 
-      def creator(name, command_const)
+      def title(name)
         @project_name = name
+      end
+
+      def creator(command_const)
         @project_creator_command_class = command_const
         ShopifyCli::Commands::Create.subcommand(command_const, @project_type)
       end
@@ -55,6 +58,19 @@ module ShopifyCli
         const_get(@project_creator_command_class)
       end
 
+      def connector(command_const)
+        @project_connector_command_class = command_const
+        ShopifyCli::Commands::Connect.subcommand(command_const, @project_type)
+      end
+
+      def connect_command
+        if @project_connector_command_class.nil?
+          nil
+        else
+          const_get(@project_connector_command_class)
+        end
+      end
+
       def register_command(const, cmd)
         return if project_load_shallow
         Context.new.abort(

data/lib/shopify-cli/shopifolk.rb

@@ -10,19 +10,36 @@ module ShopifyCli
     SECTION = 'core'
     FEATURE_NAME = 'shopifolk'
 
-    ##
-    # will return if the user appears to be a Shopify employee, based on several heuristics
-    #
-    # #### Returns
-    #
-    # * `is_shopifolk` - returns true if the user is a Shopify Employee
-    #
-    # #### Example
-    #
-    #     ShopifyCli::Shopifolk.check
-    #
-    def self.check
-      ShopifyCli::Shopifolk.new.shopifolk?
+    class << self
+      attr_writer :acting_as_shopify_organization
+
+      ##
+      # will return if the user appears to be a Shopify employee, based on several heuristics
+      #
+      # #### Returns
+      #
+      # * `is_shopifolk` - returns true if the user is a Shopify Employee
+      #
+      # #### Example
+      #
+      #     ShopifyCli::Shopifolk.check
+      #
+      def check
+        return false unless Feature.enabled?('shopifolk-beta')
+        ShopifyCli::Shopifolk.new.shopifolk?
+      end
+
+      def act_as_shopify_organization
+        @acting_as_shopify_organization = true
+      end
+
+      def acting_as_shopify_organization?
+        !!@acting_as_shopify_organization || (Project.has_current? && Project.current.config['shopify_organization'])
+      end
+
+      def reset
+        @acting_as_shopify_organization = nil
+      end
     end
 
     ##
@@ -34,7 +51,9 @@ module ShopifyCli
     # a valid google cloud config file with email ending in "@shopify.com"
     #
     def shopifolk?
+      return false unless Feature.enabled?('shopifolk-beta')
       return true if Feature.enabled?(FEATURE_NAME)
+
       if shopifolk_by_gcloud? && shopifolk_by_dev?
         ShopifyCli::Feature.enable(FEATURE_NAME)
         true

data/lib/shopify-cli/task.rb

@@ -6,5 +6,13 @@ module ShopifyCli
       task = new
       task.call(*args, **kwargs)
     end
+
+    private
+
+    def wants_to_run_against_shopify_org?
+      @ctx.puts(@ctx.message('core.tasks.select_org_and_shop.identified_as_shopify'))
+      message = @ctx.message('core.tasks.select_org_and_shop.first_party')
+      CLI::UI::Prompt.confirm(message, default: false)
+    end
   end
 end