shopify-cli 1.3.0 → 1.6.0

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
@@ -83,7 +84,7 @@ module ShopifyCli
       end
 
       def display_ngrok
-        ngrok_location = File.join(ShopifyCli.cache_dir, @ctx.windows? ? 'ngrok.exe' : 'ngrok')
+        ngrok_location = File.join(ShopifyCli.cache_dir, "ngrok#{@ctx.executable_file_extension}")
         if File.exist?(ngrok_location)
           @ctx.puts("  " + @ctx.message('core.system.ngrok_available', ngrok_location))
         else
@@ -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/context.rb

@@ -329,14 +329,18 @@ module ShopifyCli
     # - `**kwargs`: additional keyword arguments to pass to Process.spawn
     #
     # #### Returns
-    # - `status`: boolean success status of the command execution
+    # - `status`: The `Process::Status` result of the command execution.
     #
     # #### Usage
     #
     #   stat = @ctx.system('ls', 'a_folder')
     #
     def system(*args, **kwargs)
-      CLI::Kit::System.system(*args, env: @env, **kwargs)
+      process_status = CLI::Kit::System.system(*args, env: @env, **kwargs)
+      unless process_status.success?
+        abort("System call failed: #{args.join(' ')}")
+      end
+      process_status
     end
 
     # Execute a command in the user's environment
@@ -470,6 +474,23 @@ module ShopifyCli
       end
     end
 
+    # Returns file extension depending on OS
+    # since windows has multiple extensions, the default is .exe unless otherwise specified
+    #
+    # #### Parameters
+    # - ext: optional extension for windows file
+    #
+    # #### Returns
+    # - ext: string for file extension on windows
+    #      : empty string otherwise
+    def executable_file_extension(ext = '.exe')
+      if windows?
+        ext
+      else
+        ''
+      end
+    end
+
     private
 
     def ctx_path(fname)

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

@@ -87,8 +87,6 @@ module ShopifyCli
         ShopifyCli::Config.get_bool(SECTION, feature.to_s)
       end
 
-      private
-
       def set(feature, value)
         ShopifyCli::Config.set(SECTION, feature.to_s, value)
       end

data/lib/shopify-cli/http_request.rb

@@ -0,0 +1,27 @@
+require 'net/http'
+
+module ShopifyCli
+  class HttpRequest
+    class << self
+      def post(uri, body, headers)
+        req = ::Net::HTTP::Post.new(uri.request_uri)
+        request(uri, body, headers, req)
+      end
+
+      def get(uri, body, headers)
+        req = ::Net::HTTP::Get.new(uri.request_uri)
+        request(uri, body, headers, req)
+      end
+
+      def request(uri, body, headers, req)
+        http = ::Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+
+        req.body = body unless body.nil?
+        req['Content-Type'] = 'application/json'
+        headers.each { |header, value| req[header] = value }
+        http.request(req)
+      end
+    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/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: {
@@ -177,6 +193,8 @@ module ShopifyCli
         api: {
           error: {
             internal_server_error: '{{red:{{x}} An unexpected error occurred on Shopify.}}',
+            internal_server_error_debug: "\n{{red:Response details:}}\n%s\n\n",
+            invalid_url: 'Invalid URL: %s',
           },
         },
 
@@ -251,6 +269,8 @@ module ShopifyCli
           },
           environment_header: "{{bold:Environment}}",
           env: "%-17s = %s",
+          identity_header: "{{bold:Identity}}",
+          identity_is_shopifolk: "{{v}} Checked user settings: you’re Shopify staff!",
         },
 
         tasks: {
@@ -297,6 +317,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",
           },
@@ -308,6 +330,8 @@ module ShopifyCli
             url_fetch_failure: "Unable to fetch external url",
             prereq_command_required: "%1$s is required for installing ngrok. Please install %1$s using the appropriate"\
               " package manager for your system.",
+            ngrok: "Something went wrong with ngrok installation,"\
+              "please make sure %s exists within %s before trying again",
           },
 
           not_running: "{{green:x}} ngrok tunnel not running",
@@ -342,15 +366,15 @@ module ShopifyCli
           {{x}} This version of Shopify App CLI is no longer supported. You’ll need to migrate to the new CLI version to continue.
 
             Please visit this page for complete instructions:
-            {{underline:https://shopify.github.io/shopify-app-cli/migrate/}}
+            {{underline:https://shopify.dev/tools/cli/troubleshooting#migrate-from-a-legacy-version}}
 
           MESSAGE
 
           new_version: <<~MESSAGE,
-          {{*}} {{yellow:A new version of the Shopify App CLI is available! You have version %s and the latest version is %s.
+          {{*}} {{yellow:A new version of Shopify App CLI is available! You have version %s and the latest version is %s.
 
             To upgrade, follow the instructions for the package manager you’re using:
-            {{underline:https://shopify.github.io/shopify-app-cli/getting-started/upgrade/}}}}
+            {{underline:https://shopify.dev/tools/cli/troubleshooting#upgrade-shopify-app-cli}}}}
 
           MESSAGE
         },

data/lib/shopify-cli/method_object.rb

@@ -0,0 +1,104 @@
+module ShopifyCli
+  ##
+  # The `MethodObject` mixin can be included in any class that implements `call`
+  # to ensure that
+  #
+  # * `call` will always return a `ShopifyCli::Result` by prepending a module
+  #   that takes care of the result wrapping and
+  # * a `to_proc` method that allows instances of this class to be passed as a
+  #   block.
+  #
+  # For convenience, this mixin also adds the corresponding class methods:
+  # `call` and `to_proc`. Method and result objects pair nicely as they greatly
+  # simplify the creation of complex processing chains:
+  #
+  #   class Serialize
+  #     include MethodObject
+  #
+  #     def call(attrs)
+  #       attrs.to_json
+  #     end
+  #   end
+  #
+  #   class Deserialize
+  #     include MethodObject
+  #
+  #     def call(json)
+  #       JSON.parse(json)
+  #     end
+  #   end
+  #
+  #   Serialize
+  #     .call(firstname: "John", lastname: "Doe")
+  #     .then(&Deserialize)
+  #     .map { |attrs| OpenStruct.new(attrs) }
+  #     .unwrap(nil)
+  #
+  # While this example is contrived, it still illustrates some key advantages of
+  # this programming paradigm:
+  #
+  # * chaining operations is as simple as repeatedly calling `then` or `map`,
+  # * method objects don't have to be manually instantiated but can be
+  #   constructed using the `&` operator,
+  # * error handling is deferred until the result is unwrapped.
+  #
+  # Please see the section for `ShopifyCli::Result`,
+  # `ShopifyCli::Result::Success`, and `ShopifyCli::Result::Failure` for more
+  # information on the API of result objects.
+  #
+  module MethodObject
+    module AutoCreateResultObject
+      ##
+      # invokes the original `call` implementation and wraps its return value
+      # into a result object.
+      #
+      def call(*args, **kwargs)
+        Result.wrap { super(*args, **kwargs) }.call
+      end
+    end
+
+    module ClassMethods
+      ##
+      # creates a new instance and invokes `call`. Any positional argument
+      # is forward to `call`. Keyword arguments are either forwarded to the
+      # inializer or to `call`. If the keyword argument matches the name of
+      # property, it is forwarded to the initializer, otherwise to call.
+      #
+      def call(*args, **kwargs)
+        properties.keys.yield_self do |properties|
+          new(**kwargs.slice(*properties))
+            .call(*args, **kwargs.slice(*(kwargs.keys - properties)))
+        end
+      end
+
+      ##
+      # returns a proc that invokes `call` with all arguments it receives when
+      # called itself.
+      #
+      def to_proc
+        method(:call).to_proc
+      end
+    end
+
+    ##
+    # is invoked when this mixin is included into a class. This results in
+    #
+    # * including `SmartProperties`,
+    # * prepending the result wrapping mechanism, and
+    # * adding the class methods `.call` and `.to_proc`.
+    #
+    def self.included(method_object_implementation)
+      method_object_implementation.prepend(AutoCreateResultObject)
+      method_object_implementation.include(SmartProperties)
+      method_object_implementation.extend(ClassMethods)
+    end
+
+    ##
+    # returns a proc that invokes `call` with all arguments it receives when
+    # called itself.
+    #
+    def to_proc
+      method(:call).to_proc
+    end
+  end
+end

data/lib/shopify-cli/partners_api.rb

@@ -10,7 +10,7 @@ module ShopifyCli
 
     # Defines the environment variable that this API looks for to operate on local
     # services. If you set this environment variable in your shell then the partners
-    # api will operation on your local instance
+    # API will operate on your local instance
     #
     # #### Example
     #
@@ -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)
@@ -81,7 +88,7 @@ module ShopifyCli
           ctx: ctx,
           service: 'identity',
           client_id: cli_id,
-          scopes: 'openid https://api.shopify.com/auth/partners.app.cli.access',
+          scopes: scopes.join(" "),
           request_exchange: partners_id,
         ).authenticate("#{auth_endpoint}/oauth")
       end
@@ -105,6 +112,21 @@ 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
+
+      def scopes
+        %w[openid https://api.shopify.com/auth/partners.app.cli.access].tap do |result|
+          result << "employee" if ShopifyCli::Shopifolk.acting_as_shopify_organization?
+        end
+      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