shopify-cli 2.28.0 → 2.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9563000eff4fb285eefdc448c66f51c45cb40b7119870a17994d87e0c037160
-  data.tar.gz: 6cb8dbe46c0b825679e8a301206869d6cd523c4881235e220d966a753f477d5e
+  metadata.gz: 5f07c45a6fc9d6b93d9f2826a7ad9eb139842d8b7f35717ca5fb17291285c330
+  data.tar.gz: 774e222e76f9a8d30b68e8b0756ed4cecbc8281d302d94c131d072c123b19f8c
 SHA512:
-  metadata.gz: 6f67ca0fc39a81731a425e5e7a8bd848d50f7ed698b31f6529b18af0365ab7ca2a8072cada700b0e98028c0d42b3b3cbfcae7108bc30a038d265f85d18b06ed8
-  data.tar.gz: afc2b9be9d9b59eca388fe71946ed696ed1e7faf28833468217f0933af1f4fac9ea9f08613cf08ec2b379886b06702641703790762323b8f58e5a40fccff1cb1
+  metadata.gz: eab29689be4de3a23b0b9dd14401a130d6f37cc1064c02f16bbce0656d378d487666bd964dfa673b8fcc48344b01acf8d10899e4fb3755c7f5f46c5dd8c46385
+  data.tar.gz: 01d9830606768a70de1de312527875d997dce26f1913c44fd6ffd82407afc7962931fe38dd7568e49c899438e33bf3f1b465b6b5d73bb0585d25643c0d26d5a2

data/CHANGELOG.md

@@ -2,6 +2,11 @@ From version 2.6.0, the sections in this file adhere to the [keep a changelog](h
 
 ## [Unreleased]
 
+## Version 2.29.0 - 2022-10-19
+
+### Added
+* [#2664](https://github.com/Shopify/shopify-cli/pull/2664): Enable Theme Kit Access passwords
+
 ## Version 2.28.0 - 2022-10-17
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.28.0)
+    shopify-cli (2.29.0)
       bugsnag (~> 6.22)
       listen (~> 3.7.0)
       theme-check (~> 1.11.0)

data/lib/project_types/theme/commands/common/shop_helper.rb

@@ -5,7 +5,7 @@ module Theme
     module Common
       module ShopHelper
         def shop
-          ShopifyCLI::AdminAPI.get_shop_or_abort(@ctx)
+          ShopifyCLI::Theme::ThemeAdminAPI.new(@ctx).get_shop_or_abort
         end
       end
     end

data/lib/shopify_cli/constants.rb

@@ -59,7 +59,8 @@ module ShopifyCLI
 
       # Monorail
       MONORAIL_REAL_EVENTS = "MONORAIL_REAL_EVENTS"
-      STORE = "SHOPIFY_CLI_STORE"
+
+      STORE = "SHOPIFY_SHOP"
     end
 
     module SupportedVersions

data/lib/shopify_cli/environment.rb

@@ -10,6 +10,8 @@ module ShopifyCLI
       Constants::EnvironmentVariables::SPIN_NAMESPACE,
       Constants::EnvironmentVariables::SPIN_HOST,
     ]
+    # https://github.com/Shopify/themekit-access/blob/4c3c917d78443160dcf24376a8b5ac6b9bef0bcd/app/models/password_token.rb#L8
+    THEME_ACCESS_PASSWORD_PREFIX = "shptka_"
 
     def self.ruby_version(context: Context.new)
       output, status = context.capture2e("ruby", "--version")
@@ -188,5 +190,9 @@ module ShopifyCLI
         env_variables: env_variables
       )
     end
+
+    def self.theme_access_password?
+      admin_auth_token&.start_with?(THEME_ACCESS_PASSWORD_PREFIX)
+    end
   end
 end

data/lib/shopify_cli/messages/messages.rb

@@ -541,6 +541,9 @@ module ShopifyCLI
             forbidden: <<~FORBIDDEN,
               Command not allowed with current login. Please check your login details with {{command:%s whoami}}. You may need to request additional permissions for this action.
             FORBIDDEN
+            theme_access_invalid_password: "Invalid password. Please check that it was generated from Theme Access app"\
+              " for the current store.",
+            theme_access_no_store: "No store found. Please pass it through the environment variable SHOPIFY_SHOP",
             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",

data/lib/shopify_cli/theme/syncer.rb

@@ -69,11 +69,15 @@ module ShopifyCLI
         # Checksums of assets with errors.
         @error_checksums = []
 
+        # Do not use the throttler when --stable is passed or a Theme Access password is set
+        # (Theme Access API is not compatible yet with bulks)
+        throttler_enabled = !stable && !Environment.theme_access_password?
+
         # Initialize `api_client` on main thread
         @api_client = ThemeAdminAPIThrottler.new(
           @ctx,
           ThemeAdminAPI.new(@ctx, @theme.shop),
-          !stable
+          throttler_enabled
         )
       end
 

data/lib/shopify_cli/theme/theme_access_api.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "shopify_cli"
+
+module ShopifyCLI
+  module Theme
+    ##
+    # ShopifyCLI::ThemeAccessAPI is a wrapper to use Shopify Theme Access API, which allows using passwords
+    # generated from Shopify Theme Access app to access the Shopify Admin API (for theme operations)
+    #
+    class ThemeAccessAPI < API
+      BASE_URL = "theme-kit-access.shopifyapps.com"
+
+      class << self
+        ##
+        # #### 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`: an api version string to specify version. Default value: unstable
+        #
+        # #### 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
+        #
+        #   ThemeAccessAPI.rest_request(@ctx, shop: 'shop.myshopify.com', path: 'data.json')
+        #
+        def rest_request(ctx, shop:, path:, query: nil, body: nil, method: "GET", api_version: "unstable")
+          client = api_client(ctx, api_version, shop, path: path)
+          url = build_url(api_version, path, query)
+          client.request(url: url, body: body, headers: headers(shop), method: method)
+        rescue ShopifyCLI::API::APIRequestForbiddenError,
+               ShopifyCLI::API::APIRequestUnauthorizedError
+          ctx.abort(ctx.message("core.api.error.theme_access_invalid_password"))
+        end
+
+        def get_shop_or_abort(ctx)
+          env_store = Environment.store
+          return env_store unless env_store.nil?
+          ctx.abort(
+            ctx.message("core.api.error.theme_access_no_store")
+          )
+        end
+
+        private
+
+        def build_url(api_version, path, query = nil)
+          URI::HTTPS.build(
+            host: BASE_URL,
+            path: "/cli/admin/api/#{api_version}/#{path}",
+            query: query
+          ).to_s
+        end
+
+        def api_client(ctx, api_version, _shop, path: "graphql.json")
+          new(
+            ctx: ctx,
+            token: Environment.admin_auth_token,
+            url: build_url(api_version, path),
+          )
+        end
+
+        def headers(shop)
+          {
+            "X-Shopify-Shop" => shop,
+          }
+        end
+      end
+
+      def auth_headers(token)
+        {
+          "X-Shopify-Access-Token" => token,
+        }
+      end
+    end
+  end
+end

data/lib/shopify_cli/theme/theme_admin_api.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "theme_access_api"
+
 module ShopifyCLI
   module Theme
     class ThemeAdminAPI
@@ -29,11 +31,11 @@ module ShopifyCLI
       end
 
       def get_shop_or_abort # rubocop:disable Naming/AccessorMethodName
-        ShopifyCLI::AdminAPI.get_shop_or_abort(@ctx)
+        api_client.get_shop_or_abort(@ctx)
       end
 
       def rest_request(**args)
-        status, body, response = ShopifyCLI::AdminAPI.rest_request(
+        status, body, response = api_client.rest_request(
           @ctx,
           shop: @shop,
           api_version: API_VERSION,
@@ -67,6 +69,10 @@ module ShopifyCLI
 
       private
 
+      def api_client
+        @api_client ||= Environment.theme_access_password? ? ThemeAccessAPI : ShopifyCLI::AdminAPI
+      end
+
       def permission_error
         ensure_user_error = @ctx.message("theme.ensure_user_error", shop)
         ensure_user_try_this = @ctx.message("theme.ensure_user_try_this")

data/lib/shopify_cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCLI
-  VERSION = "2.28.0"
+  VERSION = "2.29.0"
 end

data/lib/shopify_cli.rb

@@ -97,18 +97,18 @@ module ShopifyCLI
     )
   end
 
-  autoload :AppTypeDetector, "shopify_cli/app_type_detector"
-  autoload :Constants, "shopify_cli/constants"
-  autoload :Environment, "shopify_cli/environment"
   autoload :AdminAPI, "shopify_cli/admin_api"
   autoload :API, "shopify_cli/api"
+  autoload :AppTypeDetector, "shopify_cli/app_type_detector"
   autoload :Command, "shopify_cli/command"
   autoload :CommandOptions, "shopify_cli/command_options"
   autoload :Commands, "shopify_cli/commands"
   autoload :Connect, "shopify_cli/connect"
+  autoload :Constants, "shopify_cli/constants"
   autoload :Context, "shopify_cli/context"
   autoload :Core, "shopify_cli/core"
   autoload :DB, "shopify_cli/db"
+  autoload :Environment, "shopify_cli/environment"
   autoload :Feature, "shopify_cli/feature"
   autoload :Form, "shopify_cli/form"
   autoload :Git, "shopify_cli/git"
@@ -118,11 +118,11 @@ module ShopifyCLI
   autoload :IdentityAuth, "shopify_cli/identity_auth"
   autoload :JsDeps, "shopify_cli/js_deps"
   autoload :JsSystem, "shopify_cli/js_system"
-  autoload :PHPDeps, "shopify_cli/php_deps"
   autoload :LazyDelegator, "shopify_cli/lazy_delegator"
   autoload :MethodObject, "shopify_cli/method_object"
   autoload :Options, "shopify_cli/options"
   autoload :PartnersAPI, "shopify_cli/partners_api"
+  autoload :PHPDeps, "shopify_cli/php_deps"
   autoload :ProcessSupervision, "shopify_cli/process_supervision"
   autoload :Project, "shopify_cli/project"
   autoload :ProjectType, "shopify_cli/project_type"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-cli
 version: !ruby/object:Gem::Version
-  version: 2.28.0
+  version: 2.29.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -517,6 +517,7 @@ files:
 - lib/shopify_cli/theme/syncer/standard_reporter.rb
 - lib/shopify_cli/theme/syncer/unsupported_script_warning.rb
 - lib/shopify_cli/theme/theme.rb
+- lib/shopify_cli/theme/theme_access_api.rb
 - lib/shopify_cli/theme/theme_admin_api.rb
 - lib/shopify_cli/theme/theme_admin_api_throttler.rb
 - lib/shopify_cli/theme/theme_admin_api_throttler/bulk.rb