shopify-cli 1.8.0 → 1.9.0

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

@@ -15,7 +15,6 @@ module Script
           script_name:,
           script_content:,
           compiled_type:,
-          description: nil,
           api_key: nil,
           force: false,
           metadata:,
@@ -25,7 +24,6 @@ module Script
           variables = {
             extensionPointName: extension_point_type.upcase,
             title: script_name,
-            description: description,
             configUi: config_ui&.content,
             sourceCode: Base64.encode64(script_content),
             language: compiled_type,
@@ -47,94 +45,33 @@ module Script
             raise Errors::ConfigUiMissingKeysError.new(config_ui&.filename, e["message"])
           elsif (e = user_errors.find { |err| err["tag"] == "config_ui_fields_missing_keys_error" })
             raise Errors::ConfigUiFieldsMissingKeysError.new(config_ui&.filename, e["message"])
+          elsif user_errors.find { |err| %w(not_use_msgpack_error schema_version_argument_error).include?(err["tag"]) }
+            raise Domain::Errors::MetadataValidationError
           else
-            raise Errors::ScriptServiceUserError.new(query_name, user_errors.to_s)
-          end
-        end
-
-        def enable(api_key:, shop_domain:, configuration:, extension_point_type:, title:)
-          query_name = "shop_script_update_or_create"
-          variables = {
-            extensionPointName: extension_point_type.upcase,
-            configuration: configuration,
-            title: title,
-          }
-
-          resp_hash = script_service_request(
-            query_name: query_name,
-            api_key: api_key,
-            shop_domain: format_shop_domain(shop_domain),
-            variables: variables,
-          )
-          user_errors = resp_hash["data"]["shopScriptUpdateOrCreate"]["userErrors"]
-
-          return resp_hash if user_errors.empty?
-
-          if user_errors.any? { |e| e["tag"] == "app_script_not_found" }
-            raise Errors::AppScriptUndefinedError, api_key
-          elsif user_errors.any? { |e| e["tag"] == "shop_script_conflict" }
-            raise Errors::ShopScriptConflictError
-          elsif user_errors.any? { |e| e["tag"] == "app_script_not_pushed" }
-            raise Errors::AppScriptNotPushedError
-          else
-            raise Errors::ScriptServiceUserError.new(query_name, user_errors.to_s)
-          end
-        end
-
-        def disable(api_key:, shop_domain:, extension_point_type:)
-          query_name = "shop_script_delete"
-          variables = {
-            extensionPointName: extension_point_type.upcase,
-          }
-
-          resp_hash = script_service_request(
-            query_name: query_name,
-            api_key: api_key,
-            shop_domain: format_shop_domain(shop_domain),
-            variables: variables,
-          )
-          user_errors = resp_hash["data"]["shopScriptDelete"]["userErrors"]
-          return resp_hash if user_errors.empty?
-
-          if user_errors.any? { |e| e["tag"] == "shop_script_not_found" }
-            raise Errors::ShopScriptUndefinedError, api_key
-          else
-            raise Errors::ScriptServiceUserError.new(query_name, user_errors.to_s)
+            raise Errors::GraphqlError, user_errors
           end
         end
 
         private
 
-        def format_shop_domain(shop_domain)
-          shop_domain.delete_suffix("/")
-        end
-
         class ScriptServiceAPI < ShopifyCli::API
           property(:api_key, accepts: String)
-          property(:shop_id, accepts: Integer)
 
-          def self.query(ctx, query_name, api_key: nil, shop_domain: nil, variables: {})
-            api_client(ctx, api_key, shop_domain).query(query_name, variables: variables)
+          def self.query(ctx, query_name, api_key: nil, variables: {})
+            api_client(ctx, api_key).query(query_name, variables: variables)
           end
 
-          def self.api_client(ctx, api_key, shop_domain)
+          def self.api_client(ctx, api_key)
             new(
               ctx: ctx,
               url: "https://script-service.myshopify.io/graphql",
               token: "",
-              api_key: api_key,
-              shop_id: infer_shop_id(shop_domain)
+              api_key: api_key
             )
           end
 
-          def self.infer_shop_id(shop_domain)
-            return unless shop_domain
-
-            [shop_domain.to_i, 1].max
-          end
-
           def auth_headers(*)
-            tokens = { "APP_KEY" => api_key, "SHOP_ID" => shop_id }.compact.to_json
+            tokens = { "APP_KEY" => api_key }.compact.to_json
             { "X-Shopify-Authenticated-Tokens" => tokens }
           end
         end
@@ -177,7 +114,7 @@ module Script
           when "app_not_installed_on_shop"
             raise Errors::AppNotInstalledError
           else
-            raise Errors::GraphqlError, response["errors"].map { |e| e["message"] }
+            raise Errors::GraphqlError, response["errors"]
           end
         end
 

data/lib/project_types/script/messages/messages.rb

@@ -73,9 +73,6 @@ module Script
           service_failure_cause: "Internal service error.",
           service_failure_help: "Ensure the 'shopify/scripts-toolchain-as' package is up to date.",
 
-          user_error_cause: "Invalid script extension metadata.",
-          user_error_help: "Ensure the 'shopify/scripts-toolchain-as' package is up to date.",
-
           metadata_validation_cause: "Invalid script extension metadata.",
           metadata_validation_help: "Ensure the 'shopify/scripts-toolchain-as' package is up to date.",
 
@@ -94,8 +91,6 @@ module Script
                                      "'--metadata build/metadata.json' argument",
           app_not_installed_cause: "App not installed on store.",
 
-          app_script_not_pushed_help: "Script isn't on the app. Run {{command:shopify push}}, and then try again.",
-
           build_error_cause: "Something went wrong while building the script.",
           build_error_help: "Correct the errors and try again.",
 
@@ -116,12 +111,6 @@ module Script
           shop_auth_cause: "Unable to authenticate with the store.",
           shop_auth_help: "Try again.",
 
-          shop_script_conflict_cause: "Another app in this store has already enabled a script "\
-                                      "on this extension point.",
-          shop_script_conflict_help: "Disable that script or uninstall that app and try again.",
-
-          shop_script_undefined_cause: "Script is already turned off in store.",
-
           invalid_build_script: "The root package.json contains an invalid build command that " \
                                 "is needed to compile your script to WebAssembly.",
           build_script_not_found: "The root package.json is missing the build command that " \
@@ -142,7 +131,6 @@ module Script
             Usage: {{command:%1$s create script}}
             Options:
               {{command:--name=NAME}} Script project name. Use any string.
-              {{command:--description=DESCRIPTION}} Description of the project. Use any string.
               {{command:--extension-point=TYPE}} Extension point name. Allowed values: %2$s.
               {{command:--no-config-ui}} Specify this option if you don’t want Scripts to render an interface in the Shopify admin.
           HELP
@@ -171,40 +159,6 @@ module Script
           script_pushed: "{{v}} Script pushed to app (API key: %{api_key}).",
         },
 
-        disable: {
-          help: <<~HELP,
-          Turn off script in store.
-            Usage: {{command:%s disable}}
-          HELP
-
-          error: {
-            operation_failed: "Can't disable script.",
-          },
-
-          script_disabled: "{{v}} Script disabled. Script is turned off in store.",
-        },
-
-        enable: {
-          help: <<~HELP,
-          Turn on script in store.
-            Usage: {{command:%s enable}}
-            Options:
-              {{command:--config-props='name1:value1, name2:value2'}} Optional. Define the configuration of your script by passing individual name and value pairs. If used with --config_file, then matching values in --config-props will override those set in the file.
-              {{command:--config_file=<path/to/YAMLFilename>}} Optional. Define the configuration of your script using a YAML formatted file. --config-props values override properties in this file.
-          HELP
-
-          info: "{{*}} A script always remains enabled until you disable it - even after pushing "\
-                "script changes with the same extension point to an app. To disable a script, use "\
-                "the 'disable' command.",
-
-          error: {
-            operation_failed: "Can't enable script.",
-          },
-
-          script_enabled: "{{v}} Script enabled. %{type} script %{title} in app (API key: %{api_key}) "\
-                          "is turned on in store {{green:%{shop_domain}}}",
-        },
-
         project_deps: {
           none_required: "{{v}} None required",
           checking_with_npm: "Checking dependencies with npm",
@@ -217,7 +171,6 @@ module Script
             select_extension_point: "Which extension point do you want to use?",
             select_language: "Which language do you want to use?",
             script_name: "Script Name",
-            description: "Description",
           },
         },
 

data/lib/project_types/script/ui/error_handler.rb

@@ -39,7 +39,7 @@ module Script
             cause_of_error: ShopifyCli::Context.message("script.error.oauth_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.oauth_help"),
           }
-        when Errors::InvalidContextError
+        when Layers::Infrastructure::Errors::InvalidContextError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.invalid_context_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.invalid_context_help"),
@@ -53,7 +53,7 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message("script.error.invalid_config", e.config_file),
           }
-        when Errors::InvalidLanguageError
+        when Layers::Infrastructure::Errors::InvalidLanguageError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.invalid_language_cause", e.language),
             help_suggestion: ShopifyCli::Context.message(
@@ -84,12 +84,12 @@ module Script
               organization_id: e.organization_id
             ),
           }
-        when Errors::ScriptProjectAlreadyExistsError
+        when Layers::Infrastructure::Errors::ScriptProjectAlreadyExistsError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.project_exists_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.project_exists_help"),
           }
-        when Errors::DeprecatedEPError
+        when Layers::Infrastructure::Errors::DeprecatedEPError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.deprecated_ep", e.ep),
             help_suggestion: ShopifyCli::Context.message("script.error.deprecated_ep_cause"),
@@ -141,11 +141,6 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message("script.error.app_not_installed_cause"),
           }
-        when Layers::Infrastructure::Errors::AppScriptNotPushedError,
-          Layers::Infrastructure::Errors::AppScriptUndefinedError
-          {
-            cause_of_error: ShopifyCli::Context.message("script.error.app_script_not_pushed_help"),
-          }
         when Layers::Infrastructure::Errors::BuildError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.build_error_cause"),
@@ -193,7 +188,9 @@ module Script
           }
         when Layers::Infrastructure::Errors::GraphqlError
           {
-            cause_of_error: ShopifyCli::Context.message("script.error.graphql_error_cause", e.errors.join(", ")),
+            cause_of_error: ShopifyCli::Context.message(
+              "script.error.graphql_error_cause", JSON.pretty_generate(e.errors)
+            ),
             help_suggestion: ShopifyCli::Context.message("script.error.graphql_error_help"),
           }
         when Layers::Infrastructure::Errors::ScriptRepushError
@@ -201,25 +198,11 @@ module Script
             cause_of_error: ShopifyCli::Context.message("script.error.script_repush_cause", e.api_key),
             help_suggestion: ShopifyCli::Context.message("script.error.script_repush_help"),
           }
-        when Layers::Infrastructure::Errors::ScriptServiceUserError
-          {
-            cause_of_error: ShopifyCli::Context.message("script.error.user_error_cause"),
-            help_suggestion: ShopifyCli::Context.message("script.error.user_error_help"),
-          }
         when Layers::Infrastructure::Errors::ShopAuthenticationError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.shop_auth_cause"),
             help_suggestion: ShopifyCli::Context.message("script.error.shop_auth_help"),
           }
-        when Layers::Infrastructure::Errors::ShopScriptConflictError
-          {
-            cause_of_error: ShopifyCli::Context.message("script.error.shop_script_conflict_cause"),
-            help_suggestion: ShopifyCli::Context.message("script.error.shop_script_conflict_help"),
-          }
-        when Layers::Infrastructure::Errors::ShopScriptUndefinedError
-          {
-            cause_of_error: ShopifyCli::Context.message("script.error.shop_script_undefined_cause"),
-          }
         when Layers::Infrastructure::Errors::BuildScriptNotFoundError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.build_script_not_found"),

data/lib/shopify-cli/context.rb

@@ -144,6 +144,34 @@ module ShopifyCli
       File.write(ctx_path(fname), content)
     end
 
+    # will read a binary file relative to the context root unless the file path is absolute.
+    #
+    # #### Parameters
+    # * `fname` - filename of the file that you are reading, relative to root unless it is absolute.
+    #
+    # #### Example
+    #
+    #   @ctx.read('binary.out')
+    #
+    def binread(fname)
+      File.binread(ctx_path(fname))
+    end
+
+    # will write/overwrite a binary file with the provided contents, relative to the context root
+    # unless the file path is absolute.
+    #
+    # #### Parameters
+    # * `fname` - filename of the file that you are writing, relative to root unless it is absolute.
+    # * `content` - the body contents of the file that you are writing
+    #
+    # #### Example
+    #
+    #   @ctx.binwrite('binary.out', 'ASCII-8BIT encoded binary')
+    #
+    def binwrite(fname, content)
+      File.binwrite(ctx_path(fname), content)
+    end
+
     # will change directories and update the root, the filepath is relative to the command root unless absolute
     #
     # #### Parameters

data/lib/shopify-cli/version.rb

@@ -1,3 +1,3 @@
 module ShopifyCli
-  VERSION = "1.8.0"
+  VERSION = "1.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-cli
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,6 +144,8 @@ files:
 - lib/project_types/extension/features/argo.rb
 - lib/project_types/extension/features/argo_config.rb
 - lib/project_types/extension/features/argo_dependencies.rb
+- lib/project_types/extension/features/argo_renderer_package.rb
+- lib/project_types/extension/features/argo_serve.rb
 - 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
@@ -208,20 +210,14 @@ files:
 - lib/project_types/rails/ruby.rb
 - lib/project_types/script/cli.rb
 - lib/project_types/script/commands/create.rb
-- lib/project_types/script/commands/disable.rb
-- lib/project_types/script/commands/enable.rb
 - lib/project_types/script/commands/push.rb
 - lib/project_types/script/config/extension_points.yml
 - lib/project_types/script/errors.rb
 - lib/project_types/script/forms/create.rb
 - lib/project_types/script/graphql/app_script_update_or_create.graphql
 - lib/project_types/script/graphql/script_service_proxy.graphql
-- lib/project_types/script/graphql/shop_script_delete.graphql
-- lib/project_types/script/graphql/shop_script_update_or_create.graphql
 - lib/project_types/script/layers/application/build_script.rb
 - lib/project_types/script/layers/application/create_script.rb
-- lib/project_types/script/layers/application/disable_script.rb
-- lib/project_types/script/layers/application/enable_script.rb
 - lib/project_types/script/layers/application/extension_points.rb
 - lib/project_types/script/layers/application/project_dependencies.rb
 - lib/project_types/script/layers/application/push_script.rb
@@ -230,19 +226,19 @@ files:
 - lib/project_types/script/layers/domain/extension_point.rb
 - lib/project_types/script/layers/domain/metadata.rb
 - lib/project_types/script/layers/domain/push_package.rb
+- lib/project_types/script/layers/domain/script_project.rb
 - lib/project_types/script/layers/infrastructure/assemblyscript_project_creator.rb
 - lib/project_types/script/layers/infrastructure/assemblyscript_task_runner.rb
-- lib/project_types/script/layers/infrastructure/config_ui_repository.rb
 - lib/project_types/script/layers/infrastructure/errors.rb
 - lib/project_types/script/layers/infrastructure/extension_point_repository.rb
 - lib/project_types/script/layers/infrastructure/project_creator.rb
 - lib/project_types/script/layers/infrastructure/push_package_repository.rb
 - lib/project_types/script/layers/infrastructure/rust_project_creator.rb
 - lib/project_types/script/layers/infrastructure/rust_task_runner.rb
+- lib/project_types/script/layers/infrastructure/script_project_repository.rb
 - lib/project_types/script/layers/infrastructure/script_service.rb
 - lib/project_types/script/layers/infrastructure/task_runner.rb
 - lib/project_types/script/messages/messages.rb
-- lib/project_types/script/script_project.rb
 - lib/project_types/script/ui/error_handler.rb
 - lib/project_types/script/ui/printing_spinner.rb
 - lib/project_types/script/ui/strict_spinner.rb

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Script
-  module Commands
-    class Disable < ShopifyCli::Command
-      def call(_args, _name)
-        ShopifyCli::Tasks::EnsureEnv.call(@ctx, required: [:api_key, :secret, :shop])
-        project = ScriptProject.current
-        Layers::Application::DisableScript.call(
-          ctx: @ctx,
-          api_key: project.env[:api_key],
-          shop_domain: project.env[:shop],
-          extension_point_type: project.extension_point_type
-        )
-        @ctx.puts(@ctx.message("script.disable.script_disabled"))
-      rescue StandardError => e
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message("script.disable.error.operation_failed"))
-      end
-
-      def self.help
-        ShopifyCli::Context.message("script.disable.help", ShopifyCli::TOOL_NAME)
-      end
-    end
-  end
-end

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

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module Script
-  module Commands
-    class Enable < ShopifyCli::Command
-      options do |parser, flags|
-        parser.on("--config_props=KEYVALUEPAIRS", Array) { |t| flags[:config_props] = t }
-        parser.on("--config-props=KEYVALUEPAIRS", Array) { |t| flags[:config_props] = t }
-        parser.on("--config_file=CONFIGFILEPATH") { |t| flags[:config_file] = t }
-        parser.on("--config-file=CONFIGFILEPATH") { |t| flags[:config_file] = t }
-      end
-
-      def call(_args, _name)
-        ShopifyCli::Tasks::EnsureEnv.call(@ctx, required: [:api_key, :secret, :shop])
-        project = ScriptProject.current
-        api_key = project.env[:api_key]
-        shop_domain = project.env[:shop]
-
-        Layers::Application::EnableScript.call(
-          ctx: @ctx,
-          api_key: api_key,
-          shop_domain: shop_domain,
-          configuration: acquire_configuration(**slice(options.flags, :config_file, :config_props)),
-          extension_point_type: project.extension_point_type,
-          title: project.script_name
-        )
-        @ctx.puts(@ctx.message(
-          "script.enable.script_enabled",
-          api_key: api_key,
-          shop_domain: shop_domain,
-          type: project.extension_point_type.capitalize,
-          title: project.script_name
-        ))
-        @ctx.puts(@ctx.message("script.enable.info"))
-      rescue Errors::InvalidConfigYAMLError => e
-        UI::ErrorHandler.pretty_print_and_raise(e)
-      rescue StandardError => e
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message("script.enable.error.operation_failed"))
-      end
-
-      def self.help
-        ShopifyCli::Context.message("script.enable.help", ShopifyCli::TOOL_NAME)
-      end
-
-      private
-
-      def acquire_configuration(config_file: nil, config_props: nil)
-        properties = {}
-        properties = YAML.load(File.read(config_file)) unless config_file.nil?
-        properties = properties.merge(parse_config_props(config_props)) unless config_props.nil?
-
-        configuration = { entries: [] }
-        properties.each do |key, value|
-          configuration[:entries].push({
-            key: key,
-            value: value,
-          })
-        end
-        configuration
-      rescue Errno::ENOENT, Psych::SyntaxError
-        raise Errors::InvalidConfigYAMLError, options.flags[:config_file]
-      end
-
-      def parse_config_props(config_props)
-        Hash[
-          config_props.map do |s|
-            args = s.split(":").map(&:strip)
-            raise Errors::InvalidConfigProps unless args.size == 2
-            args
-          end
-        ]
-      end
-
-      # No slice pre Ruby 2.5 so roll our own
-      def slice(hash, *keys)
-        Hash[hash.to_a - hash.select { |key, _value| !keys.include?(key) }.to_a]
-      end
-    end
-  end
-end