shopify-cli 2.1.0 → 2.3.0

data/lib/project_types/extension/features/runtimes/checkout_ui_extension.rb

@@ -0,0 +1,29 @@
+module Extension
+  module Features
+    module Runtimes
+      class CheckoutUiExtension < Base
+        CHECKOUT_UI_EXTENSIONS_RUN = "@shopify/checkout-ui-extensions-run"
+
+        IDENTIFIERS = [
+          "CHECKOUT_ARGO_EXTENSION",
+          "CHECKOUT_UI_EXTENSION",
+        ]
+
+        AVAILABLE_FLAGS = [
+          :port,
+          :public_url,
+          :resource_url,
+          :shop,
+        ]
+
+        def available_flags
+          AVAILABLE_FLAGS
+        end
+
+        def active_runtime?(cli_package, identifier)
+          cli_package.name == CHECKOUT_UI_EXTENSIONS_RUN && IDENTIFIERS.include?(identifier)
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/messages/messages.rb

@@ -166,12 +166,18 @@ module Extension
       tasks: {
         errors: {
           parse_error: "Unable to parse response from Partners Dashboard.",
+          store_error: "There was an error getting store data. Try again later.",
         },
       },
       errors: {
         unknown_type: "Unknown extension type %s",
         package_not_found: "`%s` package not found.",
       },
+      warnings: {
+        resource_url_auto_generation_failed: "{{*}} {{yellow:Warning:}} Unable to auto generate " \
+        "the extension resource URL because %s does not have any products. " \
+        "Please run {{bold:shopify populate products}} to generate sample products.",
+      },
     }
 
     TYPES = {
@@ -200,6 +206,9 @@ module Extension
               {{*}} You’re ready to start building {{green:%s}}!
             MESSAGE
           },
+          serve: {
+            unsupported: "shopify extension serve is not supported for theme app extensions",
+          },
         },
       },
     }

data/lib/project_types/extension/models/product.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    class Product
+      include SmartProperties
+
+      property :variant_id, accepts: Integer, converts: :to_i
+      property :quantity, accepts: Integer, default: 1
+    end
+  end
+end

data/lib/project_types/extension/models/specification_handlers/checkout_post_purchase.rb

@@ -6,6 +6,7 @@ module Extension
     module SpecificationHandlers
       class CheckoutPostPurchase < Default
         PERMITTED_CONFIG_KEYS = [:metafields]
+        RENDERER_PACKAGE_NAME = "@shopify/post-purchase-ui-extensions"
 
         def config(context)
           {
@@ -13,6 +14,15 @@ module Extension
             **argo.config(context),
           }
         end
+
+        protected
+
+        def argo
+          Features::Argo.new(
+            git_template: specification.features.argo.git_template,
+            renderer_package_name: RENDERER_PACKAGE_NAME
+          )
+        end
       end
     end
   end

data/lib/project_types/extension/models/specification_handlers/checkout_ui_extension.rb

@@ -4,7 +4,7 @@ module Extension
   module Models
     module SpecificationHandlers
       class CheckoutUiExtension < Default
-        PERMITTED_CONFIG_KEYS = [:metafields, :extension_points]
+        PERMITTED_CONFIG_KEYS = [:extension_points, :metafields, :name]
 
         def config(context)
           {
@@ -12,9 +12,17 @@ module Extension
             **argo.config(context),
           }
         end
-      end
 
-      CheckoutArgoExtension = CheckoutUiExtension
+        def supplies_resource_url?
+          true
+        end
+
+        def build_resource_url(context:, shop:)
+          product = Tasks::GetProduct.call(context, shop)
+          return unless product
+          format("/cart/%<variant_id>d:%<quantity>d", variant_id: product.variant_id, quantity: 1)
+        end
+      end
     end
   end
 end

data/lib/project_types/extension/models/specification_handlers/default.rb

@@ -50,13 +50,14 @@ module Extension
           argo_runtime(context).supports?(:public_url)
         end
 
-        def serve(context:, port:, tunnel_url:)
+        def serve(context:, port:, tunnel_url:, resource_url:)
           Features::ArgoServe.new(
             specification_handler: self,
             argo_runtime: argo_runtime(context),
             context: context,
             port: port,
             tunnel_url: tunnel_url,
+            resource_url: resource_url
           ).call
         end
 
@@ -65,9 +66,9 @@ module Extension
         end
 
         def argo_runtime(context)
-          @argo_runtime ||= Features::ArgoRuntime.new(
-            renderer: renderer_package(context),
-            cli: cli_package(context),
+          @argo_runtime ||= Features::ArgoRuntime.find(
+            cli_package: cli_package(context),
+            identifier: identifier
           )
         end
 
@@ -90,6 +91,14 @@ module Extension
           end
         end
 
+        def supplies_resource_url?
+          false
+        end
+
+        def build_resource_url(shop)
+          raise NotImplementedError
+        end
+
         protected
 
         def argo

data/lib/project_types/extension/models/specification_handlers/theme_app_extension.rb

@@ -60,6 +60,18 @@ module Extension
           "Theme App Extension"
         end
 
+        def choose_port?(ctx)
+          ctx.abort(ctx.message("serve.unsupported"))
+        end
+
+        def establish_tunnel?(ctx)
+          ctx.abort(ctx.message("serve.unsupported"))
+        end
+
+        def serve(ctx)
+          ctx.abort(ctx.message("serve.unsupported"))
+        end
+
         private
 
         def validate(filename)

data/lib/project_types/extension/tasks/configure_features.rb

@@ -46,6 +46,7 @@ module Extension
           checkout: {
             git_template: "https://github.com/Shopify/checkout-ui-extensions-template",
             renderer_package_name: "@shopify/checkout-ui-extensions",
+            required_fields: [:shop],
             cli_package_name: "@shopify/checkout-ui-extensions-run",
           },
         }

data/lib/project_types/extension/tasks/converters/product_converter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    module Converters
+      module ProductConverter
+        VARIANT_PATH = ["data", "products", "edges", 0, "node", "variants", "edges", 0, "node", "id"]
+
+        def self.from_hash(hash)
+          return nil if hash.nil?
+          variant = hash.dig(*VARIANT_PATH)
+          return unless variant
+          Models::Product.new(
+            variant_id: ShopifyCli::API.gid_to_id(variant)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/tasks/get_product.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    class GetProduct < ShopifyCli::Task
+      API_VERSION = "2021-07"
+      GRAPHQL_FILE = "get_variant_id"
+
+      def call(context, shop)
+        response = ShopifyCli::AdminAPI.query(
+          context,
+          GRAPHQL_FILE,
+          shop: shop,
+          api_version: API_VERSION
+        )
+        context.abort(context.message("tasks.errors.store_error")) if response.nil?
+        Converters::ProductConverter.from_hash(response)
+      end
+    end
+  end
+end

data/lib/project_types/script/commands/create.rb

@@ -34,7 +34,7 @@ module Script
       end
 
       def self.help
-        allowed_values = Script::Layers::Application::ExtensionPoints.types.map { |type| "{{cyan:#{type}}}" }
+        allowed_values = Script::Layers::Application::ExtensionPoints.available_types.map { |type| "{{cyan:#{type}}}" }
         ShopifyCli::Context.message("script.create.help", ShopifyCli::TOOL_NAME, allowed_values.join(", "))
       end
     end

data/lib/project_types/script/graphql/app_script_set.graphql

@@ -0,0 +1,40 @@
+mutation AppScriptSet(
+  $uuid: String
+  $extensionPointName: ExtensionPointName!,
+  $title: String!,
+  $description: String,
+  $force: Boolean,
+  $schemaMajorVersion: String,
+  $schemaMinorVersion: String,
+  $scriptJsonVersion: String!,
+  $configurationUi: Boolean!,
+  $configurationDefinition: String!,
+  $moduleUploadUrl: String!,
+) {
+  appScriptSet(
+    uuid: $uuid
+    extensionPointName: $extensionPointName
+    title: $title
+    description: $description
+    force: $force
+    schemaMajorVersion: $schemaMajorVersion
+    schemaMinorVersion: $schemaMinorVersion,
+    scriptJsonVersion: $scriptJsonVersion,
+    configurationUi: $configurationUi,
+    configurationDefinition: $configurationDefinition,
+    moduleUploadUrl: $moduleUploadUrl,
+) {
+    userErrors {
+      field
+      message
+      tag
+    }
+    appScript {
+      uuid
+      appKey
+      configSchema
+      extensionPointName
+      title
+    }
+  }
+}

data/lib/project_types/script/graphql/app_script_update_or_create.graphql

@@ -1,44 +0,0 @@
-mutation AppScriptUpdateOrCreate(
-  $extensionPointName: ExtensionPointName!,
-  $title: String,
-  $description: String,
-  $sourceCode: String,
-  $language: String,
-  $force: Boolean,
-  $schemaMajorVersion: String,
-  $schemaMinorVersion: String,
-  $useMsgpack: Boolean,
-  $uuid: String,
-  $configurationUi: Boolean!,
-  $scriptJsonVersion: String!,
-  $configurationDefinition: String!,
-) {
-  appScriptUpdateOrCreate(
-    extensionPointName: $extensionPointName
-    title: $title
-    description: $description
-    sourceCode: $sourceCode
-    language: $language
-    force: $force
-    schemaMajorVersion: $schemaMajorVersion
-    schemaMinorVersion: $schemaMinorVersion
-    useMsgpack: $useMsgpack,
-    uuid: $uuid
-    configurationUi: $configurationUi
-    scriptJsonVersion: $scriptJsonVersion
-    configurationDefinition: $configurationDefinition
-) {
-    userErrors {
-      field
-      message
-      tag
-    }
-    appScript {
-      uuid
-      appKey
-      configSchema
-      extensionPointName
-      title
-    }
-  }
-}

data/lib/project_types/script/graphql/module_upload_url_generate.graphql

@@ -0,0 +1,9 @@
+mutation moduleUploadUrlGenerate {
+  moduleUploadUrlGenerate {
+    url
+    userErrors {
+      field
+      message
+    }
+  }
+}

data/lib/project_types/script/layers/domain/push_package.rb

@@ -17,7 +17,7 @@ module Script
           uuid:,
           extension_point_type:,
           script_content:,
-          compiled_type:,
+          compiled_type: nil,
           metadata:,
           script_json:
         )
@@ -35,7 +35,6 @@ module Script
             uuid: @uuid,
             extension_point_type: @extension_point_type,
             script_content: @script_content,
-            compiled_type: @compiled_type,
             api_key: api_key,
             force: force,
             metadata: @metadata,

data/lib/project_types/script/layers/infrastructure/errors.rb

@@ -93,6 +93,8 @@ module Script
             super("WebAssembly binary not found")
           end
         end
+
+        class ScriptUploadError < ScriptProjectError; end
       end
     end
   end

data/lib/project_types/script/layers/infrastructure/push_package_repository.rb

@@ -32,7 +32,6 @@ module Script
             uuid: script_project.uuid,
             extension_point_type: script_project.extension_point_type,
             script_content: script_content,
-            compiled_type: compiled_type,
             metadata: metadata,
             script_json: script_project.script_json,
           )

data/lib/project_types/script/layers/infrastructure/script_service.rb

@@ -14,32 +14,31 @@ module Script
           uuid:,
           extension_point_type:,
           script_content:,
-          compiled_type:,
           api_key: nil,
           force: false,
           metadata:,
           script_json:
         )
-          query_name = "app_script_update_or_create"
+          url = UploadScript.new(ctx).call(api_key, script_content)
+
+          query_name = "app_script_set"
           variables = {
             uuid: uuid,
             extensionPointName: extension_point_type.upcase,
             title: script_json.title,
             description: script_json.description,
-            sourceCode: Base64.encode64(script_content),
-            language: compiled_type,
             force: force,
             schemaMajorVersion: metadata.schema_major_version.to_s, # API expects string value
             schemaMinorVersion: metadata.schema_minor_version.to_s, # API expects string value
-            useMsgpack: metadata.use_msgpack,
             scriptJsonVersion: script_json.version,
             configurationUi: script_json.configuration_ui,
             configurationDefinition: script_json.configuration&.to_json,
+            moduleUploadUrl: url,
           }
-          resp_hash = script_service_request(query_name: query_name, api_key: api_key, variables: variables)
-          user_errors = resp_hash["data"]["appScriptUpdateOrCreate"]["userErrors"]
+          resp_hash = MakeRequest.new(ctx).call(query_name: query_name, api_key: api_key, variables: variables)
+          user_errors = resp_hash["data"]["appScriptSet"]["userErrors"]
 
-          return resp_hash["data"]["appScriptUpdateOrCreate"]["appScript"]["uuid"] if user_errors.empty?
+          return resp_hash["data"]["appScriptSet"]["appScript"]["uuid"] if user_errors.empty?
 
           if user_errors.any? { |e| e["tag"] == "already_exists_error" }
             raise Errors::ScriptRepushError, uuid
@@ -67,11 +66,14 @@ module Script
         def get_app_scripts(api_key:, extension_point_type:)
           query_name = "get_app_scripts"
           variables = { appKey: api_key, extensionPointName: extension_point_type.upcase }
-          script_service_request(query_name: query_name, api_key: api_key, variables: variables)["data"]["appScripts"]
+          response = MakeRequest.new(ctx).call(
+            query_name: query_name,
+            api_key: api_key,
+            variables: variables
+          )
+          response["data"]["appScripts"]
         end
 
-        private
-
         class ScriptServiceAPI < ShopifyCli::API
           property(:api_key, accepts: String)
 
@@ -114,47 +116,95 @@ module Script
         end
         private_constant(:PartnersProxyAPI)
 
-        def script_service_request(query_name:, variables: nil, **options)
-          resp = if bypass_partners_proxy
-            ScriptServiceAPI.query(ctx, query_name, variables: variables, **options)
-          else
-            proxy_through_partners(query_name: query_name, variables: variables, **options)
+        class MakeRequest
+          attr_reader :ctx
+
+          def initialize(ctx)
+            @ctx = ctx
           end
-          raise_if_graphql_failed(resp)
-          resp
-        end
 
-        def bypass_partners_proxy
-          !ENV["BYPASS_PARTNERS_PROXY"].nil?
-        end
+          def self.bypass_partners_proxy
+            !ENV["BYPASS_PARTNERS_PROXY"].nil?
+          end
 
-        def proxy_through_partners(query_name:, variables: nil, **options)
-          options[:variables] = variables.to_json if variables
-          resp = PartnersProxyAPI.query(ctx, query_name, **options)
-          raise_if_graphql_failed(resp)
-          JSON.parse(resp["data"]["scriptServiceProxy"])
-        end
+          def call(query_name:, variables: nil, **options)
+            resp = if MakeRequest.bypass_partners_proxy
+              ScriptServiceAPI.query(ctx, query_name, variables: variables, **options)
+            else
+              proxy_through_partners(query_name: query_name, variables: variables, **options)
+            end
+            raise_if_graphql_failed(resp)
+            resp
+          end
 
-        def raise_if_graphql_failed(response)
-          raise Errors::EmptyResponseError if response.nil?
-
-          return unless response.key?("errors")
-          case error_code(response["errors"])
-          when "forbidden"
-            raise Errors::ForbiddenError
-          when "forbidden_on_shop"
-            raise Errors::ShopAuthenticationError
-          when "app_not_installed_on_shop"
-            raise Errors::AppNotInstalledError
-          else
-            raise Errors::GraphqlError, response["errors"]
+          def proxy_through_partners(query_name:, variables: nil, **options)
+            options[:variables] = variables.to_json if variables
+            resp = PartnersProxyAPI.query(ctx, query_name, **options)
+            raise_if_graphql_failed(resp)
+            JSON.parse(resp["data"]["scriptServiceProxy"])
+          end
+
+          def raise_if_graphql_failed(response)
+            raise Errors::EmptyResponseError if response.nil?
+
+            return unless response.key?("errors")
+            case error_code(response["errors"])
+            when "forbidden"
+              raise Errors::ForbiddenError
+            when "forbidden_on_shop"
+              raise Errors::ShopAuthenticationError
+            when "app_not_installed_on_shop"
+              raise Errors::AppNotInstalledError
+            else
+              raise Errors::GraphqlError, response["errors"]
+            end
+          end
+
+          def error_code(errors)
+            errors.map do |e|
+              code = e.dig("extensions", "code")
+              return code if code
+            end
           end
         end
 
-        def error_code(errors)
-          errors.map do |e|
-            code = e.dig("extensions", "code")
-            return code if code
+        class UploadScript
+          attr_reader :ctx
+
+          def initialize(ctx)
+            @ctx = ctx
+          end
+
+          def call(api_key, script_content)
+            apply_module_upload_url(api_key).tap do |url|
+              upload(url, script_content)
+            end
+          end
+
+          private
+
+          def apply_module_upload_url(api_key)
+            query_name = "module_upload_url_generate"
+            variables = {}
+            resp_hash = MakeRequest.new(ctx).call(query_name: query_name, api_key: api_key, variables: variables)
+            user_errors = resp_hash["data"]["moduleUploadUrlGenerate"]["userErrors"]
+
+            raise Errors::GraphqlError, user_errors if user_errors.any?
+            resp_hash["data"]["moduleUploadUrlGenerate"]["url"]
+          end
+
+          def upload(url, script_content)
+            url = URI(url)
+
+            https = Net::HTTP.new(url.host, url.port)
+            https.use_ssl = true
+
+            request = Net::HTTP::Put.new(url)
+            request["Content-Type"] = "application/wasm"
+            request.body = script_content
+
+            response = https.request(request)
+            raise Errors::ScriptUploadError unless response.code == "200"
           end
         end
       end