shopify-cli 1.3.1 → 1.7.0

data/lib/shopify-cli/helpers.rb

@@ -1,5 +1,5 @@
 module ShopifyCli
   module Helpers
-    autoload :Haikunator, 'shopify-cli/helpers/haikunator'
+    autoload :Haikunator, "shopify-cli/helpers/haikunator"
   end
 end

data/lib/shopify-cli/helpers/haikunator.rb

@@ -28,7 +28,7 @@ module ShopifyCli
     module Haikunator
       class << self
         def title
-          build(0, ' ')
+          build(0, " ")
         end
 
         def haikunate(token_range = 9999, delimiter = "-")

data/lib/shopify-cli/heroku.rb

@@ -1,9 +1,9 @@
 module ShopifyCli
   class Heroku
     DOWNLOAD_URLS = {
-      linux: 'https://cli-assets.heroku.com/heroku-linux-x64.tar.gz',
-      mac: 'https://cli-assets.heroku.com/heroku-darwin-x64.tar.gz',
-      windows: 'https://cli-assets.heroku.com/heroku-x64.exe',
+      linux: "https://cli-assets.heroku.com/heroku-linux-x64.tar.gz",
+      mac: "https://cli-assets.heroku.com/heroku-darwin-x64.tar.gz",
+      windows: "https://cli-assets.heroku.com/heroku-x64.exe",
     }
 
     def initialize(ctx)
@@ -12,33 +12,33 @@ module ShopifyCli
 
     def app
       return nil unless (app = git_remote)
-      app = app.split('/').last
-      app = app.split('.').first
+      app = app.split("/").last
+      app = app.split(".").first
       app
     end
 
     def authenticate
-      result = @ctx.system(heroku_command, 'login')
-      @ctx.abort(@ctx.message('core.heroku.error.authentication')) unless result.success?
+      result = @ctx.system(heroku_command, "login")
+      @ctx.abort(@ctx.message("core.heroku.error.authentication")) unless result.success?
     end
 
     def create_new_app
-      output, status = @ctx.capture2e(heroku_command, 'create')
-      @ctx.abort(@ctx.message('core.heroku.error.creation')) unless status.success?
+      output, status = @ctx.capture2e(heroku_command, "create")
+      @ctx.abort(@ctx.message("core.heroku.error.creation")) unless status.success?
       @ctx.puts(output)
     end
 
     def deploy(branch_to_deploy)
-      result = @ctx.system('git', 'push', '-u', 'heroku', "#{branch_to_deploy}:master")
-      @ctx.abort(@ctx.message('core.heroku.error.deploy')) unless result.success?
+      result = @ctx.system("git", "push", "-u", "heroku", "#{branch_to_deploy}:master")
+      @ctx.abort(@ctx.message("core.heroku.error.deploy")) unless result.success?
     end
 
     def download
       return if installed?
 
-      result = @ctx.system('curl', '-o', download_path, DOWNLOAD_URLS[@ctx.os], chdir: ShopifyCli.cache_dir)
-      @ctx.abort(@ctx.message('core.heroku.error.download')) unless result.success?
-      @ctx.abort(@ctx.message('core.heroku.error.download')) unless File.exist?(download_path)
+      result = @ctx.system("curl", "-o", download_path, DOWNLOAD_URLS[@ctx.os], chdir: ShopifyCli.cache_dir)
+      @ctx.abort(@ctx.message("core.heroku.error.download")) unless result.success?
+      @ctx.abort(@ctx.message("core.heroku.error.download")) unless File.exist?(download_path)
     end
 
     def install
@@ -47,22 +47,22 @@ module ShopifyCli
       result = if @ctx.windows?
         @ctx.system("\"#{download_path}\"")
       else
-        @ctx.system('tar', '-xf', download_path, chdir: ShopifyCli.cache_dir)
+        @ctx.system("tar", "-xf", download_path, chdir: ShopifyCli.cache_dir)
       end
-      @ctx.abort(@ctx.message('core.heroku.error.install')) unless result.success?
+      @ctx.abort(@ctx.message("core.heroku.error.install")) unless result.success?
 
       @ctx.rm(download_path)
     end
 
     def select_existing_app(app_name)
-      result = @ctx.system(heroku_command, 'git:remote', '-a', app_name)
+      result = @ctx.system(heroku_command, "git:remote", "-a", app_name)
 
-      msg = @ctx.message('core.heroku.error.could_not_select_app', app_name)
+      msg = @ctx.message("core.heroku.error.could_not_select_app", app_name)
       @ctx.abort(msg) unless result.success?
     end
 
     def whoami
-      output, status = @ctx.capture2e(heroku_command, 'whoami')
+      output, status = @ctx.capture2e(heroku_command, "whoami")
       return output.strip if status.success?
       nil
     end
@@ -70,7 +70,7 @@ module ShopifyCli
     private
 
     def download_filename
-      URI.parse(DOWNLOAD_URLS[@ctx.os]).path.split('/').last
+      URI.parse(DOWNLOAD_URLS[@ctx.os]).path.split("/").last
     end
 
     def download_path
@@ -78,33 +78,33 @@ module ShopifyCli
     end
 
     def git_remote
-      output, status = @ctx.capture2e('git', 'remote', 'get-url', 'heroku')
+      output, status = @ctx.capture2e("git", "remote", "get-url", "heroku")
       status.success? ? output : nil
     end
 
     def heroku_command
-      local_path = File.join(ShopifyCli.cache_dir, 'heroku', 'bin', 'heroku').to_s
+      local_path = File.join(ShopifyCli.cache_dir, "heroku", "bin", "heroku").to_s
       if File.exist?(local_path)
         local_path
       elsif @ctx.windows?
         # Check if Heroku exists in the Windows registry and run it from there
-        require 'win32/registry'
+        require "win32/registry"
         begin
           windows_path = Win32::Registry::HKEY_CURRENT_USER.open('SOFTWARE\heroku') do |reg|
-            reg[''] # This reads the 'Default' registry key
+            reg[""] # This reads the 'Default' registry key
           end
 
-          File.join(windows_path, 'bin', 'heroku').to_s
+          File.join(windows_path, "bin", "heroku").to_s
         rescue
-          'heroku'
+          "heroku"
         end
       else
-        'heroku'
+        "heroku"
       end
     end
 
     def installed?
-      _output, status = @ctx.capture2e(heroku_command, '--version')
+      _output, status = @ctx.capture2e(heroku_command, "--version")
       status.success?
     rescue
       false

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

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   ##
@@ -37,9 +37,9 @@ module ShopifyCli
     #   ShopifyCli::JsDeps.new(context).install(true)
     #
     def install(verbose = false)
-      title = ctx.message('core.js_deps.installing', @system.package_manager)
-      success = ctx.message('core.js_deps.installed')
-      failure = ctx.message('core.js_deps.error.install_error', @system.package_manager)
+      title = ctx.message("core.js_deps.installing", @system.package_manager)
+      success = ctx.message("core.js_deps.installed")
+      failure = ctx.message("core.js_deps.error.install_error", @system.package_manager)
 
       CLI::UI::Frame.open(title, success_text: success, failure_text: failure) do
         @system.call(
@@ -53,14 +53,14 @@ module ShopifyCli
 
     def yarn(verbose = false)
       cmd = %w(yarn install)
-      cmd << '--silent' unless verbose
+      cmd << "--silent" unless verbose
 
       run_install_command(cmd)
     end
 
     def npm(verbose = false)
-      cmd = %w(npm install --no-audit --no-optional)
-      cmd << '--quiet' unless verbose
+      cmd = %w(npm install --no-audit)
+      cmd << "--quiet" unless verbose
 
       run_install_command(cmd)
     end
@@ -69,7 +69,7 @@ module ShopifyCli
       deps = parse_dependencies
       errors = nil
 
-      spinner_title = ctx.message('core.js_deps.installing', @system.package_manager)
+      spinner_title = ctx.message("core.js_deps.installing", @system.package_manager)
       success = CLI::UI::Spinner.spin(spinner_title, auto_debrief: false) do |spinner|
         _, errors, status = CLI::Kit::System.capture3(*cmd, env: @ctx.env, chdir: ctx.root)
         update_spinner_title_and_status(spinner, status, deps)
@@ -81,19 +81,19 @@ module ShopifyCli
 
     def update_spinner_title_and_status(spinner, status, deps)
       if status.success?
-        spinner.update_title(ctx.message('core.js_deps.installed', deps.size))
+        spinner.update_title(ctx.message("core.js_deps.installed", deps.size))
       else
-        spinner.update_title(ctx.message('core.js_deps.error.install_spinner_error', deps.size))
+        spinner.update_title(ctx.message("core.js_deps.error.install_spinner_error", deps.size))
         CLI::UI::Spinner::TASK_FAILED
       end
     end
 
     def parse_dependencies
-      package_json = File.join(ctx.root, 'package.json')
+      package_json = File.join(ctx.root, "package.json")
       pkg = begin
               JSON.parse(File.read(package_json))
             rescue Errno::ENOENT, Errno::ENOTDIR
-              ctx.abort(ctx.message('core.js_deps.error.missing_package', package_json))
+              ctx.abort(ctx.message("core.js_deps.error.missing_package", package_json))
             end
 
       %w(dependencies devDependencies).map do |key|
@@ -101,7 +101,7 @@ module ShopifyCli
       end.flatten
     rescue JSON::ParserError
       ctx.puts(
-        ctx.message('core.js_deps.error.invalid_package', File.read(File.join(path, 'package.json'))),
+        ctx.message("core.js_deps.error.invalid_package", File.read(File.join(path, "package.json"))),
         error: true
       )
       raise ShopifyCli::AbortSilent

data/lib/shopify-cli/js_system.rb

@@ -1,4 +1,4 @@
-require 'shopify_cli'
+require "shopify_cli"
 
 module ShopifyCli
   ##
@@ -7,8 +7,8 @@ module ShopifyCli
   class JsSystem
     include SmartProperties
 
-    YARN_CORE_COMMAND = 'yarn'
-    NPM_CORE_COMMAND = 'npm'
+    YARN_CORE_COMMAND = "yarn"
+    NPM_CORE_COMMAND = "npm"
 
     class << self
       ##
@@ -64,8 +64,8 @@ module ShopifyCli
     #
     def yarn?
       @has_yarn ||= begin
-        cmd_path = @ctx.which('yarn')
-        File.exist?(File.join(ctx.root, 'yarn.lock')) && !cmd_path.nil?
+        cmd_path = @ctx.which("yarn")
+        File.exist?(File.join(ctx.root, "yarn.lock")) && !cmd_path.nil?
       end
     end
 

data/lib/shopify-cli/lazy_delegator.rb

@@ -0,0 +1,55 @@
+require "delegate"
+
+module ShopifyCli
+  ##
+  # `LazyDelegator` defers initialization of its underlying delegatee until the
+  # latter is accessed for the first time due to a method call that the
+  # delegator cannot handle itself:
+  #
+  #   result = LazyDelegator.new do
+  #     # carry out costly operation ...
+  #   end
+  #
+  #   result      # referencing the object itself does not result in Proc evaluation
+  #   result.to_h # however, calling a method on it will result in Proc evaluation
+  #
+  # LazyDelegator lends itself to being subclassed in scenarios where some
+  # facts are known and others are costly to compute:
+  #
+  #   class LazySpecificationHandler < ShopifyCli::LazyDelegator
+  #     attr_reader :identifier
+  #
+  #     def initialize(identifier, &initializer)
+  #       super(&initializer)
+  #       @identifier = identifier
+  #     end
+  #   end
+  #
+  #   handler = LazySpecificationHandler.new(:product_subscription) do
+  #      # fetch specification from the Partners Dashboard API ...
+  #   end
+  #
+  #   # Accessing identifier will not result in Proc evaluation as it is
+  #   # available as an attribute of the delegator itself
+  #   handler.identifier # => :product_subscription
+  #
+  #   # Accessing the specification will result in evaluation of the Proc
+  #   # and in our example in a subsequent network call
+  #   handler.specification # => <Extension::Models::Specifcation:...>
+  #
+  class LazyDelegator < SimpleDelegator
+    def initialize(&delegatee_initializer)
+      super([false, delegatee_initializer])
+    end
+
+    protected
+
+    def __getobj__(*)
+      initialized, value_or_initializer = super
+      return value_or_initializer if initialized
+      value_or_initializer.call.tap do |value|
+        __setobj__([true, value])
+      end
+    end
+  end
+end

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",
         },
@@ -113,7 +119,7 @@ module ShopifyCli
             missing_package: "expected to have a file at: %s",
             invalid_package: "{{info:%s}} was not valid JSON. Fix this then try again",
             install_spinner_error: "Unable to install all %d dependencies",
-            install_error: 'An error occurred while installing dependencies',
+            install_error: "An error occurred while installing dependencies",
           },
 
           installing: "Installing dependencies with %s...",
@@ -176,7 +182,9 @@ module ShopifyCli
 
         api: {
           error: {
-            internal_server_error: '{{red:{{x}} An unexpected error occurred on Shopify.}}',
+            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 +259,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: {
@@ -262,7 +272,7 @@ module ShopifyCli
             MESSAGE
             development_store_select: "Which development store would you like to use?",
             app_select: "To which app does this project belong?",
-            no_apps: 'You have no apps to connect to, creating a new app.',
+            no_apps: "You have no apps to connect to, creating a new app.",
             app_name: "App name",
             app_type: {
               select: "What type of app are you building?",
@@ -297,6 +307,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 +320,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 +356,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