shopify-cli 1.5.0 → 1.6.0

data/lib/project_types/theme/tasks/ensure_themekit_installed.rb

@@ -0,0 +1,78 @@
+module Theme
+  module Tasks
+    class EnsureThemekitInstalled < ShopifyCli::Task
+      URL = 'https://shopify-themekit.s3.amazonaws.com/releases/latest.json'
+      OSMAP = {
+        mac: 'darwin-amd64',
+        linux: 'linux-amd64',
+        windows: 'windows-amd64',
+      }
+      VERSION_CHECK_INTERVAL = 604800
+      VERSION_CHECK_SECTION = 'themekit_version_check'
+      LAST_CHECKED_AT_FIELD = 'last_checked_at'
+
+      def call(ctx)
+        _out, stat = ctx.capture2e(Themekit::THEMEKIT)
+        unless stat.success?
+          CLI::UI::Frame.open(ctx.message('theme.tasks.ensure_themekit_installed.installing_themekit')) do
+            install_themekit(ctx)
+          end
+        end
+
+        now = Time.now.to_i
+        if ShopifyCli::Feature.enabled?(:themekit_auto_update) && (time_of_last_check + VERSION_CHECK_INTERVAL) < now
+          CLI::UI::Frame.open(ctx.message('theme.tasks.ensure_themekit_installed.updating_themekit')) do
+            unless Themekit.update(ctx)
+              ctx.abort(ctx.message('theme.tasks.ensure_themekit_installed.errors.update_fail'))
+            end
+            update_time_of_last_check(now)
+          end
+        end
+      end
+
+      private
+
+      def install_themekit(ctx)
+        require 'json'
+        require 'fileutils'
+        require 'digest'
+        require 'open-uri'
+
+        begin
+          begin
+            releases = JSON.parse(Net::HTTP.get(URI(URL)))
+            release = releases["platforms"].find { |r| r["name"] == OSMAP[ctx.os] }
+          rescue
+            ctx.abort(ctx.message('theme.tasks.ensure_themekit_installed.errors.releases_fail'))
+          end
+
+          ctx.puts(ctx.message('theme.tasks.ensure_themekit_installed.downloading', releases['version']))
+          _out, stat = ctx.capture2e('curl', '-o', Themekit::THEMEKIT, release["url"])
+          ctx.abort(ctx.message('theme.tasks.ensure_themekit_installed.errors.write_fail')) unless stat.success?
+
+          ctx.puts(ctx.message('theme.tasks.ensure_themekit_installed.verifying'))
+          if Digest::MD5.file(Themekit::THEMEKIT) == release['digest']
+            FileUtils.chmod("+x", Themekit::THEMEKIT)
+            ctx.puts(ctx.message('theme.tasks.ensure_themekit_installed.successful'))
+
+            auto = CLI::UI.confirm(ctx.message('theme.tasks.ensure_themekit_installed.auto_update'))
+            ShopifyCli::Feature.set(:themekit_auto_update, auto)
+          else
+            ctx.abort(ctx.message('theme.tasks.ensure_themekit_installed.errors.digest_fail'))
+          end
+        rescue StandardError, ShopifyCli::Abort => e
+          FileUtils.rm(Themekit::THEMEKIT) if File.exist?(Themekit::THEMEKIT)
+          raise e
+        end
+      end
+
+      def time_of_last_check
+        (val = ShopifyCli::Config.get(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD)) ? val.to_i : 0
+      end
+
+      def update_time_of_last_check(time)
+        ShopifyCli::Config.set(VERSION_CHECK_SECTION, LAST_CHECKED_AT_FIELD, time)
+      end
+    end
+  end
+end

data/lib/project_types/theme/themekit.rb

@@ -0,0 +1,113 @@
+module Theme
+  class Themekit
+    THEMEKIT = File.join(ShopifyCli.cache_dir, "themekit")
+
+    class << self
+      def add_flags(flags)
+        flags.map do |key, value|
+          flag = "--#{key}"
+          flag += "=#{value}" if value.is_a?(String)
+          flag
+        end
+      end
+
+      def connect(ctx, store:, password:, themeid:, env:)
+        command = build_command('get', env)
+        command << "--password=#{password}"
+        command << "--store=#{store}"
+        command << "--themeid=#{themeid}"
+
+        stat = ctx.system(*command)
+        stat.success?
+      end
+
+      def create(ctx, password:, store:, name:, env:)
+        command = build_command('new', env)
+        command << "--password=#{password}"
+        command << "--store=#{store}"
+        command << "--name=#{name}"
+
+        stat = ctx.system(*command)
+        stat.success?
+      end
+
+      def deploy(ctx, flags: nil, env:)
+        unless push(ctx, flags: flags, env: env)
+          ctx.abort(ctx.message('theme.deploy.push_fail'))
+        end
+        ctx.done(ctx.message('theme.deploy.info.pushed'))
+
+        command = build_command('publish', env)
+        (command << flags).compact!
+        command.flatten!
+
+        stat = ctx.system(*command)
+        stat.success?
+      end
+
+      def generate_env(ctx, store:, password:, themeid:, env:)
+        command = build_command('configure', env)
+        command << "--password=#{password}"
+        command << "--store=#{store}"
+        command << "--themeid=#{themeid}"
+
+        stat = ctx.system(*command)
+        stat.success?
+      end
+
+      def push(ctx, files: nil, flags: nil, remove: false, env:)
+        action = remove ? 'remove' : 'deploy'
+        command = build_command(action, env)
+
+        (command << files << flags).compact!
+        command.flatten!
+
+        stat = ctx.system(*command)
+        stat.success?
+      end
+
+      def query_themes(ctx, store:, password:)
+        begin
+          resp = ::ShopifyCli::AdminAPI.rest_request(
+            ctx,
+            shop: store,
+            token: password,
+            path: "themes.json",
+          )
+        rescue ShopifyCli::API::APIRequestUnauthorizedError
+          ctx.abort(ctx.message('theme.themekit.query_themes.bad_password'))
+        rescue StandardError
+          ctx.abort(ctx.message('theme.themekit.query_themes.not_connect'))
+        end
+
+        resp[1]['themes'].map { |theme| [theme['name'], theme['id']] }.to_h
+      end
+
+      def serve(ctx, flags: nil, env:)
+        command = build_command('open', env)
+        out, stat = ctx.capture2e(*command)
+        ctx.puts(out)
+        ctx.abort(ctx.message('theme.serve.open_fail')) unless stat.success?
+
+        command = build_command('watch', env)
+        (command << flags).compact!
+        command.flatten!
+        ctx.system(*command)
+      end
+
+      def update(ctx)
+        command = build_command('update')
+        ctx.system(*command)
+      end
+
+      private
+
+      def build_command(action, env = nil)
+        command = [THEMEKIT, action]
+        command << '--no-update-notifier'
+        command << "--env=#{env}" if env
+        command
+      end
+    end
+  end
+end

data/lib/shopify-cli/admin_api.rb

@@ -43,6 +43,46 @@ module ShopifyCli
         end
       end
 
+      ##
+      #
+      #
+      #
+      # #### Parameters
+      # - `ctx`: running context from your command
+      # - `shop`: shop domain string for shop whose admin you are calling
+      # - `path`: path string (excluding prefixes and API version) for specific JSON that you are requesting
+      #     ex. "data.json" instead of "/admin/api/unstable/data.json"
+      # - `body`: data string for corresponding REST request types
+      # - `method`: REST request string for the type of request; if nil, will perform GET request
+      # - `api_version`: API version string to specify version; if nil, latest will be used
+      # - `token`: shop password string for authentication to shop
+      #
+      # #### Raises
+      #
+      # * http 404 will raise a ShopifyCli::API::APIRequestNotFoundError
+      # * http 400..499 will raise a ShopifyCli::API::APIRequestClientError
+      # * http 500..599 will raise a ShopifyCli::API::APIRequestServerError
+      # * All other codes will raise ShopifyCli::API::APIRequestUnexpectedError
+      #
+      # #### Returns
+      #
+      # * `resp` - JSON response array
+      #
+      # #### Example
+      #
+      #   ShopifyCli::AdminAPI.rest_request(@ctx,
+      #                                     shop: 'shop.myshopify.com',
+      #                                     path: 'data.json',
+      #                                     token: 'password')
+      #
+      def rest_request(ctx, shop:, path:, body: nil, method: "GET", api_version: nil, token: nil)
+        ShopifyCli::DB.set(admin_access_token: token) unless token.nil?
+        url = URI::HTTPS.build(host: shop, path: "/admin/api/#{fetch_api_version(ctx, api_version, shop)}/#{path}")
+        resp = api_client(ctx, api_version, shop, path: path).request(url: url.to_s, body: body, method: method)
+        ShopifyCli::DB.set(admin_access_token: nil) unless token.nil?
+        resp
+      end
+
       private
 
       def authenticated_req(ctx, shop)
@@ -65,12 +105,12 @@ module ShopifyCli
         ).authenticate("https://#{shop}/admin/oauth")
       end
 
-      def api_client(ctx, api_version, shop)
+      def api_client(ctx, api_version, shop, path: 'graphql.json')
         new(
           ctx: ctx,
           auth_header: 'X-Shopify-Access-Token',
           token: admin_access_token(ctx, shop),
-          url: "https://#{shop}/admin/api/#{fetch_api_version(ctx, api_version, shop)}/graphql.json",
+          url: "https://#{shop}/admin/api/#{fetch_api_version(ctx, api_version, shop)}/#{path}",
         )
       end
 

data/lib/shopify-cli/api.rb

@@ -24,10 +24,8 @@ module ShopifyCli
 
     def query(query_name, variables: {})
       _, resp = request(
-        load_query(query_name),
-        variables: variables,
-        headers: default_headers,
-        graphql_url: url,
+        body: JSON.dump(query: load_query(query_name).tr("\n", ""), variables: variables),
+        url: url,
       )
       ctx.debug(resp)
       resp
@@ -36,32 +34,21 @@ module ShopifyCli
       ctx.debug(ctx.message('core.api.error.internal_server_error_debug', e.message))
     end
 
-    protected
-
-    def load_query(name)
-      project_type = ShopifyCli::Project.current_project_type
-      project_file_path = File.join(
-        ShopifyCli::ROOT, 'lib', 'project_types', project_type.to_s, 'graphql', "#{name}.graphql"
-      )
-      if !project_type.nil? && File.exist?(project_file_path)
-        File.read(project_file_path)
-      else
-        File.read(File.join(ShopifyCli::ROOT, 'lib', 'graphql', "#{name}.graphql"))
-      end
-    end
-
-    private
-
-    def request(body, graphql_url:, variables: {}, headers: {})
+    def request(url:, body: nil, headers: {}, method: "POST")
       CLI::Kit::Util.begin do
-        uri = URI.parse(graphql_url)
+        uri = URI.parse(url)
         unless uri.is_a?(URI::HTTP)
-          ctx.abort("Invalid URL: #{graphql_url}")
+          ctx.abort(ctx.message('core.api.error.invalid_url', url))
         end
 
         # 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)
+        headers = default_headers.merge(headers)
+        response = if method == "POST"
+          HttpRequest.post(uri, body, headers)
+        elsif method == "GET"
+          HttpRequest.get(uri, body, headers)
+        end
 
         case response.code.to_i
         when 200..399
@@ -84,6 +71,22 @@ module ShopifyCli
       end
     end
 
+    protected
+
+    def load_query(name)
+      project_type = ShopifyCli::Project.current_project_type
+      project_file_path = File.join(
+        ShopifyCli::ROOT, 'lib', 'project_types', project_type.to_s, 'graphql', "#{name}.graphql"
+      )
+      if !project_type.nil? && File.exist?(project_file_path)
+        File.read(project_file_path)
+      else
+        File.read(File.join(ShopifyCli::ROOT, 'lib', 'graphql', "#{name}.graphql"))
+      end
+    end
+
+    private
+
     def current_sha
       @current_sha ||= Git.sha(dir: ShopifyCli::ROOT)
     end

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

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

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/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

@@ -2,14 +2,26 @@ 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)
+    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/messages/messages.rb

@@ -194,6 +194,7 @@ module ShopifyCli
           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',
           },
         },
 
@@ -329,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",
@@ -363,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
         },