shopify-cli 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df03f65d3f06543a72fff5a777f93b7948aaa97c5ea10b42039d550cb82c0432
-  data.tar.gz: b0741e669b67f6a39e030d7dfb7aa252dcf79ff5b15fd4ad27d543a9ef6347d1
+  metadata.gz: c65ab33bf57676cb65c04773cba1ae81a3852fd516283dde697a74f145c411e6
+  data.tar.gz: f74e40e7dcad523257c9535de75a121044bdc2f98acd1ac13dffd5310c4f9337
 SHA512:
-  metadata.gz: 8ab134a89911c7b4468253efc5798eae0552bcb38099fd8f8aa9aa0a5144efa52cb7cd62d7b4b064b6cf8618ca0dbc7d24572fd2f3e83bb1ffa320bfb7849ab9
-  data.tar.gz: 9db58f843181d955b76a7c48af7663b3ab2327b6884c25ffba9a36a4cf5b1b4d184740c42ee7e2dc6ba6eece85785aa15709df8c3d604610e58f2e5a320ba084
+  metadata.gz: 850bff5ac8a7b39f4574bfd77e6a9a20030a5c6bbc4dd03167839950cb52b8a365c928d54b261992634445eb081addb51103e178840d1899c8e49bf412cbaee2
+  data.tar.gz: 912ddbef4eb07b6a2f7587a64e27425cdf5f821a94bad31f9b56fd021f89960f34a37d885eaa9e04472c95eae56ae43025f414c872805ee935b6556b3e1cca91

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 Unreleased
 ------
 
+Version 2.2.0
+------
+* [#1424](https://github.com/Shopify/shopify-cli/pull/1424/): Add `--resourceUrl` flag to extension serve command
+* [#1419](https://github.com/Shopify/shopify-cli/pull/1419): Remove analytics prompt when used in CI
+* [#1418](https://github.com/Shopify/shopify-cli/pull/1418): Auto configure resource URL for Checkout Extensions
+* [#1399](https://github.com/Shopify/shopify-cli/pull/1399): Fix error when running `shopify extension serve` in a theme app extension project
+
 Version 2.1.0
 -------------
 * [#1357](https://github.com/Shopify/shopify-cli/pull/1357): Update Theme-Check to 1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.1.0)
+    shopify-cli (2.2.0)
       listen (~> 3.5)
       theme-check (~> 1.1)
 
@@ -108,4 +108,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/lib/graphql/get_variant_id.graphql

@@ -0,0 +1,16 @@
+query {
+  products(first: 1) {
+    edges {
+      node {
+        id
+        variants(first: 1) {
+          edges {
+            node {
+              id
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/lib/project_types/extension/cli.rb

@@ -40,12 +40,14 @@ module Extension
     autoload :ChooseNextAvailablePort, Project.project_filepath("tasks/choose_next_available_port")
     autoload :FindNpmPackages, Project.project_filepath("tasks/find_npm_packages")
     autoload :GetExtensions, Project.project_filepath("tasks/get_extensions")
+    autoload :GetProduct, Project.project_filepath("tasks/get_product")
 
     module Converters
       autoload :RegistrationConverter, Project.project_filepath("tasks/converters/registration_converter")
       autoload :VersionConverter, Project.project_filepath("tasks/converters/version_converter")
       autoload :ValidationErrorConverter, Project.project_filepath("tasks/converters/validation_error_converter")
       autoload :AppConverter, Project.project_filepath("tasks/converters/app_converter")
+      autoload :ProductConverter, Project.project_filepath("tasks/converters/product_converter")
     end
   end
 
@@ -63,6 +65,12 @@ module Extension
   end
 
   module Features
+    module Runtimes
+      autoload :Admin, Project.project_filepath("features/runtimes/admin")
+      autoload :Base, Project.project_filepath("features/runtimes/base")
+      autoload :CheckoutPostPurchase, Project.project_filepath("features/runtimes/checkout_post_purchase")
+      autoload :CheckoutUiExtension, Project.project_filepath("features/runtimes/checkout_ui_extension")
+    end
     autoload :ArgoServe, Project.project_filepath("features/argo_serve")
     autoload :ArgoServeOptions, Project.project_filepath("features/argo_serve_options")
     autoload :ArgoSetup, Project.project_filepath("features/argo_setup")
@@ -77,7 +85,6 @@ module Extension
   module Models
     module SpecificationHandlers
       autoload :Default, Project.project_filepath("models/specification_handlers/default")
-      autoload :CheckoutArgoExtension, Project.project_filepath("models/specification_handlers/checkout_ui_extension")
     end
 
     autoload :App, Project.project_filepath("models/app")
@@ -88,6 +95,7 @@ module Extension
     autoload :Specifications, Project.project_filepath("models/specifications")
     autoload :LazySpecificationHandler, Project.project_filepath("models/lazy_specification_handler")
     autoload :NpmPackage, Project.project_filepath("models/npm_package")
+    autoload :Product, Project.project_filepath("models/product")
   end
 
   autoload :ExtensionProjectKeys, Project.project_filepath("extension_project_keys")

data/lib/project_types/extension/commands/serve.rb

@@ -9,19 +9,24 @@ module Extension
 
       options do |parser, flags|
         parser.on("-t", "--[no-]tunnel", "Establish an ngrok tunnel") { |tunnel| flags[:tunnel] = tunnel }
+        parser.on("--resourceUrl=RESOURCE_URL", "Provide a resource URL") do |resource_url|
+          flags[:resource_url] = resource_url
+        end
       end
 
       class RuntimeConfiguration
         include SmartProperties
 
         property :tunnel_url, accepts: String, default: nil
+        property :resource_url, accepts: String, default: nil
         property! :tunnel_requested, accepts: [true, false], reader: :tunnel_requested?, default: true
         property! :port, accepts: (1...(2**16)), default: DEFAULT_PORT
       end
 
       def call(_args, _command_name)
         config = RuntimeConfiguration.new(
-          tunnel_requested: tunnel_requested?
+          tunnel_requested: tunnel_requested?,
+          resource_url: options.flags[:resource_url]
         )
 
         ShopifyCli::Result
@@ -74,7 +79,8 @@ module Extension
         specification_handler.serve(
           context: @ctx,
           tunnel_url: runtime_configuration.tunnel_url,
-          port: runtime_configuration.port
+          port: runtime_configuration.port,
+          resource_url: runtime_configuration.resource_url
         )
         runtime_configuration
       end

data/lib/project_types/extension/extension_project.rb

@@ -14,6 +14,24 @@ module Extension
         )
       end
 
+      def update_env_file(context:, **updates)
+        current_config = {
+          title: current.title,
+          shop: current.env.shop,
+          api_key: current.app.api_key,
+          api_secret: current.app.secret,
+          registration_id: current.registration_id,
+          registration_uuid: current.registration_uuid,
+          resource_url: current.resource_url,
+        }
+
+        write_env_file(
+          context: context,
+          **current_config,
+          **updates
+        )
+      end
+
       def write_env_file(
         context:,
         title:,
@@ -21,11 +39,13 @@ module Extension
         api_secret: "",
         registration_id: nil,
         registration_uuid: nil,
-        resource_url: nil
+        resource_url: nil,
+        shop: nil
       )
         ShopifyCli::Resources::EnvFile.new(
           api_key: api_key,
           secret: api_secret,
+          shop: shop,
           extra: {
             ExtensionProjectKeys::TITLE_KEY => title,
             ExtensionProjectKeys::REGISTRATION_ID_KEY => registration_id,

data/lib/project_types/extension/features/argo_runtime.rb

@@ -1,46 +1,14 @@
 module Extension
   module Features
     class ArgoRuntime
-      include SmartProperties
-
-      UI_EXTENSIONS_CHECKOUT_RUN = "@shopify/checkout-ui-extensions-run"
-      UI_EXTENSIONS_ADMIN_RUN = "@shopify/admin-ui-extensions-run"
-
-      ADMIN_RUN_FLAGS = [
-        :api_key,
-        :name,
-        :port,
-        :public_url,
-        :renderer_version,
-        :shop,
-        :uuid,
+      RUNTIMES = [
+        Runtimes::Admin.new,
+        Runtimes::CheckoutPostPurchase.new,
+        Runtimes::CheckoutUiExtension.new,
       ]
 
-      CHECKOUT_RUN_FLAGS = [
-        :port,
-        :public_url,
-      ]
-
-      property! :renderer, accepts: Models::NpmPackage
-      property! :cli, accepts: Models::NpmPackage
-
-      def supports?(flag)
-        case cli
-        when admin?
-          ADMIN_RUN_FLAGS.include?(flag.to_sym)
-        when checkout?
-          CHECKOUT_RUN_FLAGS.include?(flag.to_sym)
-        end
-      end
-
-      private
-
-      def admin?
-        ->(cli) { cli.name == UI_EXTENSIONS_ADMIN_RUN }
-      end
-
-      def checkout?
-        ->(cli) { cli.name == UI_EXTENSIONS_CHECKOUT_RUN }
+      def self.find(cli_package:, identifier:)
+        RUNTIMES.find { |runtime| runtime.active_runtime?(cli_package, identifier) }
       end
     end
   end

data/lib/project_types/extension/features/argo_serve.rb

@@ -7,11 +7,12 @@ module Extension
       NPM_SERVE_COMMAND = %w(run-script server)
 
       property! :specification_handler, accepts: Extension::Models::SpecificationHandlers::Default
-      property! :argo_runtime, accepts: Features::ArgoRuntime
+      property! :argo_runtime, accepts: -> (runtime) { runtime.class < Features::Runtimes::Base }
       property! :context, accepts: ShopifyCli::Context
       property! :port, accepts: Integer, default: 39351
       property  :tunnel_url, accepts: String, default: nil
       property! :js_system, accepts: ->(jss) { jss.respond_to?(:call) }, default: ShopifyCli::JsSystem
+      property :resource_url, accepts: String, default: nil
 
       def call
         validate_env!
@@ -22,6 +23,10 @@ module Extension
         end
       end
 
+      def resource_url
+        super || ExtensionProject.current(force_reload: true).resource_url
+      end
+
       private
 
       def start_server
@@ -57,6 +62,7 @@ module Extension
         ShopifyCli::Tasks::EnsureDevStore.call(context) if required_fields.include?(:shop)
 
         project = ExtensionProject.current
+        ensure_resource_resource_url! if specification_handler.supplies_resource_url?
 
         return if required_fields.all? do |field|
           value = project.env.public_send(field)
@@ -77,8 +83,31 @@ module Extension
           options << "--uuid=#{project.registration_uuid}" if argo_runtime.supports?(:uuid)
           options << "--publicUrl=#{tunnel_url}" if !tunnel_url.nil? && argo_runtime.supports?(:public_url)
           options << "--name=#{project.title}" if argo_runtime.supports?(:name)
+          options << "--resourceUrl=#{resource_url}" if !resource_url.nil? && argo_runtime.supports?(:resource_url)
         end
       end
+
+      def ensure_resource_resource_url!
+        project = ExtensionProject.current(force_reload: true)
+
+        ShopifyCli::Result
+          .wrap(project.resource_url)
+          .rescue { specification_handler.build_resource_url(shop: project.env.shop, context: context) }
+          .then(&method(:persist_resource_url))
+          .unwrap do |nil_or_exception|
+            case nil_or_exception
+            when nil
+              context.warn(context.message("warnings.resource_url_auto_generation_failed", project.env.shop))
+            else
+              context.abort(nil_or_exception)
+            end
+          end
+      end
+
+      def persist_resource_url(resource_url)
+        ExtensionProject.update_env_file(context: context, resource_url: resource_url)
+        resource_url
+      end
     end
   end
 end

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

@@ -0,0 +1,29 @@
+module Extension
+  module Features
+    module Runtimes
+      class Admin < Base
+        ADMIN_UI_EXTENSIONS_RUN = "@shopify/admin-ui-extensions-run"
+        PRODUCT_SUBSCRIPTION = "PRODUCT_SUBSCRIPTION"
+
+        AVAILABLE_FLAGS = [
+          :api_key,
+          :name,
+          :port,
+          :public_url,
+          :renderer_version,
+          :resource_url,
+          :shop,
+          :uuid,
+        ]
+
+        def available_flags
+          AVAILABLE_FLAGS
+        end
+
+        def active_runtime?(cli_package, identifier)
+          cli_package.name == ADMIN_UI_EXTENSIONS_RUN && identifier == PRODUCT_SUBSCRIPTION
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Extension
+  module Features
+    module Runtimes
+      class Base
+        def available_flags
+          []
+        end
+
+        def supports?(flag)
+          available_flags.include?(flag)
+        end
+
+        def active_runtime?(cli_package, identifier)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Extension
+  module Features
+    module Runtimes
+      class CheckoutPostPurchase < Base
+        CHECKOUT_UI_EXTENSIONS_RUN = "@shopify/checkout-ui-extensions-run"
+        CHECKOUT_POST_PURCHASE = "CHECKOUT_POST_PURCHASE"
+
+        AVAILABLE_FLAGS = [
+          :port,
+          :public_url,
+        ]
+
+        def available_flags
+          AVAILABLE_FLAGS
+        end
+
+        def active_runtime?(cli_package, identifier)
+          cli_package.name == CHECKOUT_UI_EXTENSIONS_RUN && identifier == CHECKOUT_POST_PURCHASE
+        end
+      end
+    end
+  end
+end

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_ui_extension.rb

@@ -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/theme/forms/select.rb

@@ -43,7 +43,7 @@ module Theme
         when "development"
           "blue"
         else
-          "grey"
+          "italic"
         end
 
         tags = ["{{#{color}:[#{theme.role}]}}"]

data/lib/shopify-cli/core/monorail.rb

@@ -46,7 +46,7 @@ module ShopifyCli
 
         # we only want to send Monorail events in production or when explicitly developing
         def enabled?
-          Context.new.system? || ENV["MONORAIL_REAL_EVENTS"] == "1"
+          (Context.new.system? || ENV["MONORAIL_REAL_EVENTS"] == "1") && !Context.new.ci?
         end
 
         def consented?
@@ -54,6 +54,7 @@ module ShopifyCli
         end
 
         def prompt_for_consent
+          return if Context.new.ci?
           return unless enabled?
           return if ShopifyCli::Config.get_section("analytics").key?("enabled")
           msg = Context.message("core.monorail.consent_prompt")

data/lib/shopify-cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCli
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-cli
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,6 +159,7 @@ files:
 - lib/graphql/find_organization.graphql
 - lib/graphql/get_app_by_api_key.graphql
 - lib/graphql/get_app_urls.graphql
+- lib/graphql/get_variant_id.graphql
 - lib/graphql/update_dashboard_urls.graphql
 - lib/project_types/extension/cli.rb
 - lib/project_types/extension/commands/build.rb
@@ -182,6 +183,10 @@ files:
 - lib/project_types/extension/features/argo_setup.rb
 - lib/project_types/extension/features/argo_setup_step.rb
 - lib/project_types/extension/features/argo_setup_steps.rb
+- lib/project_types/extension/features/runtimes/admin.rb
+- lib/project_types/extension/features/runtimes/base.rb
+- lib/project_types/extension/features/runtimes/checkout_post_purchase.rb
+- lib/project_types/extension/features/runtimes/checkout_ui_extension.rb
 - lib/project_types/extension/forms/connect.rb
 - lib/project_types/extension/forms/create.rb
 - lib/project_types/extension/forms/questions/ask_app.rb
@@ -193,6 +198,7 @@ files:
 - lib/project_types/extension/models/app.rb
 - lib/project_types/extension/models/lazy_specification_handler.rb
 - lib/project_types/extension/models/npm_package.rb
+- lib/project_types/extension/models/product.rb
 - lib/project_types/extension/models/registration.rb
 - lib/project_types/extension/models/specification.rb
 - lib/project_types/extension/models/specification_handlers/checkout_post_purchase.rb
@@ -206,6 +212,7 @@ files:
 - lib/project_types/extension/tasks/configure_features.rb
 - lib/project_types/extension/tasks/configure_options.rb
 - lib/project_types/extension/tasks/converters/app_converter.rb
+- lib/project_types/extension/tasks/converters/product_converter.rb
 - lib/project_types/extension/tasks/converters/registration_converter.rb
 - lib/project_types/extension/tasks/converters/validation_error_converter.rb
 - lib/project_types/extension/tasks/converters/version_converter.rb
@@ -215,6 +222,7 @@ files:
 - lib/project_types/extension/tasks/get_app.rb
 - lib/project_types/extension/tasks/get_apps.rb
 - lib/project_types/extension/tasks/get_extensions.rb
+- lib/project_types/extension/tasks/get_product.rb
 - lib/project_types/extension/tasks/update_draft.rb
 - lib/project_types/extension/tasks/user_errors.rb
 - lib/project_types/node/cli.rb