shopify-cli 1.0.0 → 1.0.5

data/lib/project_types/script/layers/application/disable_script.rb

@@ -5,13 +5,15 @@ module Script
     module Application
       class DisableScript
         def self.call(ctx:, api_key:, shop_domain:, extension_point_type:)
-          script_service = Infrastructure::ScriptService.new(ctx: ctx)
-          script_service.disable(
-            api_key: api_key,
-            shop_domain: shop_domain,
-            extension_point_type: extension_point_type,
-          )
-          ctx.puts(ctx.message('script.application.disabled'))
+          UI::PrintingSpinner.spin(ctx, ctx.message('script.application.disabling')) do |p_ctx, spinner|
+            script_service = Infrastructure::ScriptService.new(ctx: p_ctx)
+            script_service.disable(
+              api_key: api_key,
+              shop_domain: shop_domain,
+              extension_point_type: extension_point_type,
+            )
+            spinner.update_title(p_ctx.message('script.application.disabled'))
+          end
         end
       end
     end

data/lib/project_types/script/layers/application/enable_script.rb

@@ -5,15 +5,17 @@ module Script
     module Application
       class EnableScript
         def self.call(ctx:, api_key:, shop_domain:, configuration:, extension_point_type:, title:)
-          script_service = Infrastructure::ScriptService.new(ctx: ctx)
-          script_service.enable(
-            api_key: api_key,
-            shop_domain: shop_domain,
-            configuration: configuration,
-            extension_point_type: extension_point_type,
-            title: title
-          )
-          ctx.puts(ctx.message('script.application.enabled'))
+          UI::PrintingSpinner.spin(ctx, ctx.message('script.application.enabling')) do |p_ctx, spinner|
+            script_service = Infrastructure::ScriptService.new(ctx: p_ctx)
+            script_service.enable(
+              api_key: api_key,
+              shop_domain: shop_domain,
+              configuration: configuration,
+              extension_point_type: extension_point_type,
+              title: title
+            )
+            spinner.update_title(p_ctx.message('script.application.enabled'))
+          end
         end
       end
     end

data/lib/project_types/script/layers/application/push_script.rb

@@ -20,10 +20,12 @@ module Script
           private
 
           def push_script(ctx, task_runner, script, api_key, force)
-            Infrastructure::PushPackageRepository.new(ctx: ctx)
-              .get_push_package(script, task_runner.compiled_type)
-              .push(Infrastructure::ScriptService.new(ctx: ctx), api_key, force)
-            ctx.puts(ctx.message('script.application.pushed'))
+            UI::PrintingSpinner.spin(ctx, ctx.message('script.application.pushing')) do |p_ctx, spinner|
+              Infrastructure::PushPackageRepository.new(ctx: p_ctx)
+                .get_push_package(script, task_runner.compiled_type)
+                .push(Infrastructure::ScriptService.new(ctx: p_ctx), api_key, force)
+              spinner.update_title(p_ctx.message('script.application.pushed'))
+            end
           end
         end
       end

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

@@ -8,12 +8,14 @@ module Script
         class InvalidExtensionPointError < ScriptProjectError
           attr_reader :type
           def initialize(type)
+            super()
             @type = type
           end
         end
         class ScriptNotFoundError < ScriptProjectError
           attr_reader :script_name, :extension_point_type
           def initialize(extension_point_type, script_name)
+            super()
             @script_name = script_name
             @extension_point_type = extension_point_type
           end

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

@@ -86,14 +86,14 @@ module Script
                 "@shopify/scripts-toolchain-as": "#{extension_point.sdks[:ts].toolchain_version}",
                 "#{extension_point.sdks[:ts].package}": "#{extension_point.sdks[:ts].version}",
                 "@as-pect/cli": "4.0.0",
-                "as-wasi": "^0.0.1",
+                "as-wasi": "^0.2.0",
                 "assemblyscript": "^0.12.0"
               },
               "scripts": {
                 "test": "asp --config test/as-pect.config.js --summary --verbose"
               },
               "engines": {
-                "node": ">=12.16"
+                "node": ">=14.5"
               }
             }
           HERE

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

@@ -6,7 +6,7 @@ module Script
       class AssemblyScriptTaskRunner
         BYTECODE_FILE = "%{name}.wasm"
         SCRIPT_SDK_BUILD = "npx --no-install shopify-scripts-build --src=../%{source} --binary=#{BYTECODE_FILE} "\
-                           "-- --lib=../node_modules --validate --optimize"
+                           "-- --lib=../node_modules --optimize --use Date="
 
         attr_reader :ctx, :script_name, :script_source_file
 
@@ -34,7 +34,7 @@ module Script
 
         def dependencies_installed?
           # Assuming if node_modules folder exist at root of script folder, all deps are installed
-          ctx.exist?("node_modules")
+          ctx.dir_exist?("node_modules")
         end
 
         private

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

@@ -5,6 +5,7 @@ module Script
     module Infrastructure
       module Errors
         class AppNotInstalledError < ScriptProjectError; end
+        class AppScriptNotPushedError < ScriptProjectError; end
         class AppScriptUndefinedError < ScriptProjectError; end
         class BuildError < ScriptProjectError; end
         class DependencyInstallError < ScriptProjectError; end
@@ -20,6 +21,7 @@ module Script
         class ScriptRepushError < ScriptProjectError
           attr_reader :api_key
           def initialize(api_key)
+            super()
             @api_key = api_key
           end
         end

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

@@ -22,7 +22,7 @@ module Script
         def get_push_package(script, compiled_type)
           build_file_path = file_path(script.name, compiled_type)
 
-          raise Domain::PushPackageNotFoundError unless File.exist?(build_file_path)
+          raise Domain::PushPackageNotFoundError unless ctx.file_exist?(build_file_path)
 
           script_content = File.read(build_file_path)
 

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

@@ -9,7 +9,7 @@ module Script
 
         def get_script(language, extension_point_type, script_name)
           source_file_path = src_code_file(language)
-          unless File.exist?(source_file_path)
+          unless ctx.file_exist?(source_file_path)
             raise Domain::Errors::ScriptNotFoundError.new(extension_point_type, source_file_path)
           end
 

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

@@ -60,6 +60,8 @@ module Script
             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

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

@@ -38,10 +38,15 @@ module Script
           invalid_extension_cause: "Invalid extension point %s",
           invalid_extension_help: "Allowed values: %s.",
 
+          invalid_config: "Can't change the configuration values because %1$s is missing or "\
+                          "it is not formatted properly.",
+
           script_not_found_cause: "Couldn't find script %s for extension point %s",
 
           app_not_installed_cause: "App not installed on development store.",
 
+          app_script_not_pushed_help: "Push the script and then try this command again.",
+
           app_script_undefined_help: "Push script to app.",
 
           build_error_cause: "Something went wrong while building the script.",
@@ -72,32 +77,26 @@ module Script
           help: <<~HELP,
           {{command:%1$s create script}}: Creates a script project.
             Usage: {{command:%1$s create script}}
-          HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:--name=NAME}} Script project name. Use any string.
-              \s\s{{command:--extension_point=TYPE}} Extension point name. Allowed values: %2$s.
+            Options:
+              {{command:--name=NAME}} Script project name. Use any string.
+              {{command:--extension_point=TYPE}} Extension point name. Allowed values: %2$s.
           HELP
 
           error: {
             operation_failed: "Script not created.",
           },
 
-          script_path: "{{v}} Project directory: {{green:%{folder}}}",
-          script_created: "{{v}} Script created: {{green:%{script_id}}}",
+          change_directory_notice: "{{*}} Change directories to {{green:%s}} to run script commands",
           creating: "Creating script",
-          created: "Created script",
+          created: "Created script: {{green:%s}}",
         },
 
         push: {
           help: <<~HELP,
           Build the script and put it into production. If you've already pushed a script with the same extension point, use --force to replace the current script with the newest one.
             Usage: {{command:%s push}}
-          HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
-              \s\s{{command:[--force]}} Forces the script to be overwritten if an instance of it already exists.
+            Options:
+              {{command:[--force]}} Forces the script to be overwritten if an instance of it already exists.
           HELP
 
           error: {
@@ -112,14 +111,10 @@ module Script
           Turn off script in development store.
             Usage: {{command:%s disable}}
           HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
-              \s\s{{command:--shop_domain=<my_store.myshopify.com>}} Test store URL. Must be an existing test store.
-          HELP
 
           error: {
             operation_failed: "Can't disable script.",
+            not_pushed_to_app: "Can't disable the script because it hasn't been pushed to the app.",
           },
 
           script_disabled: "{{v}} Script disabled. Script is turned off in development store.",
@@ -129,11 +124,9 @@ module Script
           help: <<~HELP,
           Turn on script in development store.
             Usage: {{command:%s enable}}
-          HELP
-          extended_help: <<~HELP,
-            \s\sOptions:
-              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
-              \s\s{{command:--shop_domain=<my_store.myshopify.com>}} Test store URL. Must be an existing test store.
+            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 "\
@@ -142,6 +135,7 @@ module Script
 
           error: {
             operation_failed: "Can't enable script.",
+            not_pushed_to_app: "Can't enable the script because it hasn't been pushed to the app.",
           },
 
           script_enabled: "{{v}} Script enabled. %{type} script %{title} in app (API key: %{api_key}) "\
@@ -177,25 +171,25 @@ module Script
           script_form: {
             ask_app_api_key_default: "Which app do you want this script to belong to?",
             ask_shop_domain_default: "Select a development store",
-            fetching_organizations: "{{i}} Fetching partner organizations",
+            fetching_organizations: "Fetching partner organizations",
+            fetched_organizations: "Fetched partner organizations",
             select_organization: "Select partner organization.",
             using_app: "Using app {{green:%{title} (%{api_key})}}.",
             using_development_store: "Using development store {{green:%{domain}}}",
             using_organization: "Partner organization {{green:%s}}.",
           },
-          enable: {
-            ask_app_api_key: "Which app is the script pushed to?",
-            ask_shop_domain: "Which development store is the app installed on?",
-          },
         },
 
         application: {
           building: "Building",
           building_script: "Building script",
           built: "Built",
-          pushed: "{{v}} Pushed",
-          disabled: "{{v}} Disabled",
-          enabled: "{{v}} Enabled",
+          pushing: "Pushing",
+          pushed: "Pushed",
+          disabling: "Disabling",
+          disabled: "Disabled",
+          enabling: "Enabling",
+          enabled: "Enabled",
         },
       },
     }.freeze

data/lib/project_types/script/script_project.rb

@@ -19,12 +19,16 @@ module Script
       }
     end
 
+    def file_name
+      "script.#{language}"
+    end
+
     def source_file
       "#{SOURCE_DIR}/#{file_name}"
     end
 
-    def file_name
-      "script.#{language}"
+    def source_path
+      "#{script_name}/#{source_file}"
     end
 
     private
@@ -36,14 +40,14 @@ module Script
 
     class << self
       def create(ctx, dir)
-        raise Errors::ScriptProjectAlreadyExistsError, dir if ctx.exist?(dir)
+        raise Errors::ScriptProjectAlreadyExistsError, dir if ctx.dir_exist?(dir)
         ctx.mkdir_p(dir)
         ctx.chdir(dir)
       end
 
       def cleanup(ctx:, script_name:, root_dir:)
         ctx.chdir(root_dir)
-        ctx.rm_r("#{root_dir}/#{script_name}") if ctx.exist?("#{root_dir}/#{script_name}")
+        ctx.rm_r("#{root_dir}/#{script_name}") if ctx.dir_exist?("#{root_dir}/#{script_name}")
       end
     end
   end

data/lib/project_types/script/templates/ts/as-pect.config.js

@@ -17,5 +17,11 @@ module.exports = {
         reportMax: false,
         reportMin: false,
     },
+    wasi: {
+      args: [],
+      env: process.env,
+      preopens: {},
+      returnOnExit: false,
+    },
     outputBinary: false,
 };

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

@@ -44,6 +44,10 @@ module Script
             cause_of_error: ShopifyCli::Context.message('script.error.invalid_context_cause'),
             help_suggestion: ShopifyCli::Context.message('script.error.invalid_context_help'),
           }
+        when Errors::InvalidConfigYAMLError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.invalid_config', e.config_file),
+          }
         when Errors::InvalidScriptNameError
           {
             cause_of_error: ShopifyCli::Context.message('script.error.invalid_script_name_cause'),
@@ -92,6 +96,10 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message('script.error.app_not_installed_cause'),
           }
+        when Layers::Infrastructure::Errors::AppScriptNotPushedError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.app_script_not_pushed_help'),
+          }
         when Layers::Infrastructure::Errors::AppScriptUndefinedError
           {
             help_suggestion: ShopifyCli::Context.message('script.error.app_script_undefined_help'),

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require 'shopify_cli'
+
+module Script
+  module UI
+    module PrintingSpinner
+      ##
+      # Creates a single spinner that runs the provided block.
+      # The block can take in a ctx argument that formats printed output to support
+      # printing from within the spin block.
+      #
+      # ==== Attributes
+      #
+      # * +ctx+   - The current context.
+      # * +title+ - Title of the spinner to use
+      #
+      # ==== Options
+      #
+      # * +:auto_debrief+ - Automatically debrief exceptions? Default to true
+      #
+      # ==== Block
+      #
+      # * +ctx+     - Instance of the PrintingSpinnerContext built from the ctx attribute.
+      #             - +ctx.puts(...)+ formats output to enable support for printing within spinners
+      # * +spinner+ - Instance of the spinner. Can call +update_title+ to update the user of changes
+      #
+      def self.spin(ctx, title, auto_debrief: false)
+        StrictSpinner.spin(title, auto_debrief: auto_debrief) do |spinner, *args|
+          Thread.current[:cliui_output_hook] = nil
+          yield(PrintingSpinnerContext.from(ctx, spinner), spinner, *args)
+        end
+      end
+
+      ##
+      # Printing within spinners requires the manipulation of ANSI escape
+      # sequences in order to make sure the CLI::UI::Spinner does not overwrite
+      # previously printed content.
+      class PrintingSpinnerContext < ShopifyCli::Context
+        include SmartProperties
+        property :spinner, required: true
+
+        def self.from(ctx, spinner)
+          new_ctx = new(spinner: spinner)
+          ctx.instance_variables.each do |var|
+            new_ctx.instance_variable_set(var, ctx.instance_variable_get(var))
+          end
+          new_ctx
+        end
+
+        def puts(*input)
+          super(encoded_lines(*input) + "\n" + spinner_text)
+        end
+
+        private
+
+        def encoded_lines(*lines)
+          lines
+            .join("\n")
+            .split("\n")
+            .map { |line| encode_ansi(line) unless line.nil? }
+            .join(CLI::UI::ANSI.next_line + "\n")
+        end
+
+        def encode_ansi(line)
+          CLI::UI::ANSI.previous_line + line + CLI::UI::ANSI.clear_to_end_of_line
+        end
+
+        def spinner_text
+          spinner.render(0, true)
+        end
+      end
+      private_constant(:PrintingSpinnerContext)
+    end
+  end
+end

data/lib/shopify-cli/admin_api.rb

@@ -37,8 +37,7 @@ module ShopifyCli
       #
       #   ShopifyCli::AdminAPI.query(@ctx, 'all_organizations')
       #
-      def query(ctx, query_name, api_version: nil, shop: nil, **variables)
-        shop ||= Project.current.env.shop
+      def query(ctx, query_name, shop:, api_version: nil, **variables)
         authenticated_req(ctx, shop) do
           api_client(ctx, api_version, shop).query(query_name, variables: variables)
         end