shopify-cli 2.7.2 → 2.9.0

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

@@ -89,6 +89,9 @@ module Extension
         help: <<~HELP,
           Push the current extension to Shopify.
             Usage: {{command:%s extension push}}
+            Options:
+              {{command:--api-key=API_KEY}} Connect your extension and app by inserting your app's API key (which you can get from your app setup page on shopify.dev).
+              {{command:--extension-id=EXTENSION_ID}} The id of the extension's registration.
         HELP
         frame_title: "Pushing your extension to Shopify",
         waiting_text: "Pushing code to Shopify…",
@@ -173,6 +176,7 @@ module Extension
       errors: {
         unknown_type: "Unknown extension type %s",
         package_not_found: "`%s` package not found.",
+        missing_api_key: "Missing api_key.",
         module_not_found: "Unable to find module %s. Ensure your dependencies are up-to-date and try again.",
       },
       warnings: {

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

@@ -6,7 +6,7 @@ module Extension
       include SmartProperties
 
       property! :api_key, accepts: String
-      property! :secret, accepts: String
+      property :secret, accepts: String
       property :title, accepts: String
       property :business_name, accepts: String
     end

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

@@ -40,7 +40,7 @@ module Extension
 
       def serve(context, server_config)
         CLI::Kit::System.popen3(executable, "serve", "-") do |input, out, err, status|
-          context.puts("Sending configuration data …")
+          context.debug("Sending configuration data to extension development server …")
           input << server_config.to_yaml
           input.close
 
@@ -57,17 +57,15 @@ module Extension
       private
 
       def forward_output_to_user(out, err, ctx)
-        ctx.puts("Starting monitoring threads …")
+        ctx.debug("Starting message processing threads to relay output produced by the extension development server …")
 
         Thread.new do
-          ctx.puts("Ready to process standard output")
           while (line = out.gets)
             ctx.puts(line)
           end
         end
 
         Thread.new do
-          ctx.puts("Ready to process standard error")
           while (error = err.gets)
             ctx.puts(error)
           end

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

@@ -103,6 +103,10 @@ module Extension
           raise NotImplementedError
         end
 
+        def server_config_path(base_dir = Dir.pwd)
+          File.join(base_dir, server_config_file)
+        end
+
         def server_config_file
           "shopifile.yml"
         end

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

@@ -9,11 +9,12 @@ module Extension
       property! :api_key, accepts: String
       property! :context, accepts: ShopifyCLI::Context
       property! :hash, accepts: Hash
+      property  :port, accepts: Integer, default: ShopifyCLI::Constants::Extension::DEFAULT_PORT
       property! :registration_uuid, accepts: String
       property  :resource_url, accepts: String
       property! :store, accepts: String
       property! :title, accepts: String
-      property :tunnel_url, accepts: String
+      property  :tunnel_url, accepts: String
       property! :type, accepts: String
 
       def self.call(*args)
@@ -46,6 +47,7 @@ module Extension
         end
         server_config = Models::ServerConfig::Root.new(
           extensions: [extension],
+          port: port,
           public_url: tunnel_url,
           store: store
         )

data/lib/project_types/extension/tasks/execute_commands/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    module ExecuteCommands
+      class Base
+        include SmartProperties
+        property! :type, accepts: Models::DevelopmentServerRequirements::SUPPORTED_EXTENSION_TYPES
+      end
+    end
+  end
+end

data/lib/project_types/extension/tasks/execute_commands/build.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    module ExecuteCommands
+      class Build < Base
+        property! :context, accepts: ShopifyCLI::Context
+        property! :config_file_path, accepts: String
+
+        def call
+          ShopifyCLI::Result
+            .call(&method(:merge_server_config))
+            .then { |server_config| Models::DevelopmentServer.new.build(server_config) }
+        end
+
+        private
+
+        def merge_server_config
+          Tasks::MergeServerConfig.call(
+            context: context,
+            file_path: config_file_path,
+            type: type
+          )
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/tasks/execute_commands/create.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    module ExecuteCommands
+      class Create < Base
+        property!  :template, accepts: Models::ServerConfig::Development::VALID_TEMPLATES
+        property!  :root_dir, accepts: String
+
+        def call
+          ShopifyCLI::Result.success(generate_config)
+            .then { |server_config| Models::DevelopmentServer.new.create(server_config) }
+            .unwrap do |error|
+              raise error unless error.nil?
+            end
+        end
+
+        private
+
+        def generate_config
+          extension = Models::ServerConfig::Extension.build(
+            template: template,
+            type: type,
+            root_dir: root_dir,
+          )
+
+          Models::ServerConfig::Root.new(extensions: [extension])
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/tasks/execute_commands/serve.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    module ExecuteCommands
+      class Serve < Base
+        property! :context, accepts: ShopifyCLI::Context
+        property! :config_file_path, accepts: String
+        property  :port, accepts: Integer, default: ShopifyCLI::Constants::Extension::DEFAULT_PORT
+        property  :resource_url, accepts: String
+        property! :tunnel_url, accepts: String
+
+        def call
+          ShopifyCLI::Result
+            .call(&method(:merge_server_config))
+            .then { |server_config| Models::DevelopmentServer.new.serve(context, server_config) }
+        end
+
+        private
+
+        def merge_server_config
+          Tasks::MergeServerConfig.call(
+            context: context,
+            file_path: config_file_path,
+            port: port,
+            resource_url: resource_url,
+            tunnel_url: tunnel_url,
+            type: type
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -4,28 +4,39 @@ require "yaml"
 
 module Extension
   module Tasks
-    class MergeServerConfig < ShopifyCLI::Task
-      class << self
-        def call(context:, file_name:, resource_url:, tunnel_url:, type:)
-          config = YAML.load_file(file_name)
-          project = ExtensionProject.current
-          Tasks::ConvertServerConfig.call(
-            api_key: project.env.api_key,
-            context: context,
-            hash: config,
-            registration_uuid: project.registration_uuid,
-            resource_url: resource_url || project.resource_url,
-            store: project.env.shop || "",
-            title: project.title,
-            tunnel_url: tunnel_url,
-            type: type
-          )
-        rescue Psych::SyntaxError => e
-          raise(
-            ShopifyCLI::Abort,
-            ShopifyCLI::Context.message("core.yaml.error.invalid", file_name, e.message)
-          )
-        end
+    class MergeServerConfig
+      include SmartProperties
+
+      property! :context, accepts: ShopifyCLI::Context
+      property! :file_path, accepts: ->(path) { Pathname(path).yield_self { |pn| pn.absolute? && pn.file? } }
+      property  :port, accepts: Integer, default: ShopifyCLI::Constants::Extension::DEFAULT_PORT
+      property  :resource_url, accepts: String
+      property  :tunnel_url, accepts: String
+      property! :type, accepts: Models::DevelopmentServerRequirements::SUPPORTED_EXTENSION_TYPES
+
+      def self.call(*args)
+        new(*args).call
+      end
+
+      def call
+        config = YAML.load_file(file_path)
+        project = ExtensionProject.current
+        Tasks::ConvertServerConfig.call(
+          api_key: project.env.api_key,
+          context: context,
+          hash: config,
+          registration_uuid: project.registration_uuid,
+          resource_url: resource_url || project.resource_url,
+          store: project.env.shop || "",
+          title: project.title,
+          tunnel_url: tunnel_url,
+          type: type
+        )
+      rescue Psych::SyntaxError => e
+        raise(
+          ShopifyCLI::Abort,
+          ShopifyCLI::Context.message("core.yaml.error.invalid", file_name, e.message)
+        )
       end
     end
   end

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

@@ -156,10 +156,10 @@ module Rails
 
         CLI::UI::Frame.open(@ctx.message("rails.create.generating_app", name)) do
           new_command = %w(rails new)
+          new_command << name
           new_command += DEFAULT_RAILS_FLAGS
           new_command << "--database=#{db}"
           new_command += options.flags[:rails_opts].split unless options.flags[:rails_opts].nil?
-          new_command << name
 
           syscall(new_command)
         end

data/lib/project_types/rails/gem.rb

@@ -79,8 +79,7 @@ module Rails
     def install!
       spin = CLI::UI::SpinGroup.new
       spin.add(ctx.message("rails.gem.installing", name)) do |spinner|
-        args = %w(gem install)
-        args.push(name)
+        args = ["#{ENV["RUBY_BINDIR"]}gem", "install", name]
         unless version.nil?
           if ctx.windows? && version.include?("~")
             args.push("-v", "\"#{version}\"")

data/lib/project_types/script/cli.rb

@@ -13,6 +13,7 @@ module Script
     hidden_feature(feature_set: :script_project)
     subcommand :Create, "create", Project.project_filepath("commands/create")
     subcommand :Push, "push", Project.project_filepath("commands/push")
+    subcommand :Connect, "connect", Project.project_filepath("commands/connect")
     subcommand :Javy, "javy", Project.project_filepath("commands/javy")
   end
   ShopifyCLI::Commands.register("Script::Command", "script")
@@ -24,6 +25,7 @@ module Script
     autoload :AskScriptUuid, Project.project_filepath("forms/ask_script_uuid")
     autoload :RunAgainstShopifyOrg, Project.project_filepath("forms/run_against_shopify_org")
     autoload :Create, Project.project_filepath("forms/create")
+    autoload :Connect, Project.project_filepath("forms/connect")
     autoload :ScriptForm, Project.project_filepath("forms/script_form")
   end
 
@@ -46,7 +48,7 @@ module Script
       autoload :PushPackage, Project.project_filepath("layers/domain/push_package")
       autoload :Metadata, Project.project_filepath("layers/domain/metadata")
       autoload :ExtensionPoint, Project.project_filepath("layers/domain/extension_point")
-      autoload :ScriptJson, Project.project_filepath("layers/domain/script_json")
+      autoload :ScriptConfig, Project.project_filepath("layers/domain/script_config")
       autoload :ScriptProject, Project.project_filepath("layers/domain/script_project")
     end
 
@@ -90,5 +92,10 @@ module Script
 
   autoload :Errors, Project.project_filepath("errors")
 
+  module Loaders
+    autoload :Project, Script::Project.project_filepath("loaders/project")
+    autoload :SpecificationHandler, Script::Project.project_filepath("loaders/specification_handler")
+  end
+
   class ScriptProjectError < StandardError; end
 end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Script
+  class Command
+    class Connect < ShopifyCLI::Command::SubCommand
+      prerequisite_task :ensure_authenticated
+      prerequisite_task ensure_project_type: :script
+
+      def call(_args, _)
+        Layers::Application::ConnectApp.call(ctx: @ctx, force: true)
+      rescue StandardError => e
+        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: @ctx.message("script.connect.error.operation_failed"))
+      end
+
+      def self.help
+        ShopifyCLI::Context.new.message("connect.help", ShopifyCLI::TOOL_NAME, ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end

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

@@ -33,8 +33,14 @@ module Script
       end
 
       def self.help
-        allowed_values = Script::Layers::Application::ExtensionPoints.available_types.map { |type| "{{cyan:#{type}}}" }
-        ShopifyCLI::Context.message("script.create.help", ShopifyCLI::TOOL_NAME, allowed_values.join(", "))
+        allowed_apis = Layers::Application::ExtensionPoints.available_types.map { |type| "{{cyan:#{type}}}" }
+        allowed_languages = Layers::Application::ExtensionPoints.all_languages.map { |lang| "{{cyan:#{lang}}}" }
+        ShopifyCLI::Context.message(
+          "script.create.help",
+          ShopifyCLI::TOOL_NAME,
+          allowed_apis.join(", "),
+          allowed_languages.join(", ")
+        )
       end
     end
   end

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

@@ -7,25 +7,48 @@ module Script
 
       options do |parser, flags|
         parser.on("--force") { |t| flags[:force] = t }
+        parser.on("--api-key=API_KEY") { |api_key| flags[:api_key] = api_key.gsub('"', "") }
+        parser.on("--api-secret=API_SECRET") { |api_secret| flags[:api_secret] = api_secret.gsub('"', "") }
+        parser.on("--uuid=UUID") do |uuid|
+          flags[:uuid] = uuid.gsub('""', "")
+        end
       end
 
       def call(_args, _name)
-        fresh_env = Layers::Application::ConnectApp.call(ctx: @ctx)
-
-        force = options.flags.key?(:force) || !!fresh_env
+        connect_to_app
+        project = load_project
+        push(project: project)
+      rescue StandardError => e
+        UI::ErrorHandler.pretty_print_and_raise(e,
+          failed_op: @ctx.message("script.push.error.operation_failed_no_api_key"))
+      end
 
-        api_key = Layers::Infrastructure::ScriptProjectRepository.new(ctx: @ctx).get.api_key
-        return @ctx.puts(self.class.help) unless api_key
+      def push(project:)
+        force = options.flags.key?(:force)
+        api_key = project.env[:api_key]
+        uuid = project.env[:extra]["UUID"]
 
-        Layers::Application::PushScript.call(ctx: @ctx, force: force)
-        @ctx.puts(@ctx.message("script.push.script_pushed", api_key: api_key))
-      rescue StandardError => e
-        msg = if api_key
-          @ctx.message("script.push.error.operation_failed_with_api_key", api_key: api_key)
+        if ShopifyCLI::Environment.interactive? || (uuid && !uuid.empty?)
+          Layers::Application::PushScript.call(ctx: @ctx, force: force, project: project)
+          @ctx.puts(@ctx.message("script.push.script_pushed", api_key: api_key))
         else
-          @ctx.message("script.push.error.operation_failed_no_api_key")
+          raise ShopifyCLI::Abort, @ctx.message("script.push.error.operation_failed_no_uuid")
+        end
+      end
+
+      def load_project
+        Script::Loaders::Project.load(
+          directory: Dir.pwd,
+          api_key: options.flags[:api_key],
+          api_secret: options.flags[:api_secret],
+          uuid: options.flags[:uuid]
+        )
+      end
+
+      def connect_to_app
+        if ShopifyCLI::Environment.interactive?
+          Layers::Application::ConnectApp.call(ctx: @ctx)
         end
-        UI::ErrorHandler.pretty_print_and_raise(e, failed_op: msg)
       end
 
       def self.help

data/lib/project_types/script/config/extension_points.yml

@@ -18,11 +18,19 @@ shipping_methods:
       beta: true
       package: "@shopify/scripts-checkout-apis"
       repo: "https://github.com/Shopify/scripts-apis-examples"
-discount_types:
+merchandise_discount_types:
   beta: true
   domain: 'discounts'
   libraries:
     typescript:
       beta: true
-      package: "@shopify/scripts-discount-apis"
+      package: "@shopify/scripts-discounts-apis"
+      repo: "https://github.com/Shopify/scripts-apis-examples"
+delivery_discount_types:
+  beta: true
+  domain: 'discounts'
+  libraries:
+    typescript:
+      beta: true
+      package: "@shopify/scripts-discounts-apis"
       repo: "https://github.com/Shopify/scripts-apis-examples"

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

@@ -6,7 +6,7 @@ mutation AppScriptSet(
   $force: Boolean,
   $schemaMajorVersion: String,
   $schemaMinorVersion: String,
-  $scriptJsonVersion: String!,
+  $scriptConfigVersion: String!,
   $configurationUi: Boolean!,
   $configurationDefinition: String!,
   $moduleUploadUrl: String!,
@@ -20,7 +20,7 @@ mutation AppScriptSet(
     force: $force
     schemaMajorVersion: $schemaMajorVersion
     schemaMinorVersion: $schemaMinorVersion,
-    scriptJsonVersion: $scriptJsonVersion,
+    scriptConfigVersion: $scriptConfigVersion,
     configurationUi: $configurationUi,
     configurationDefinition: $configurationDefinition,
     moduleUploadUrl: $moduleUploadUrl,

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

@@ -7,10 +7,11 @@ module Script
     module Application
       class ConnectApp
         class << self
-          def call(ctx:)
+          def call(ctx:, force: false)
             script_project_repo = Layers::Infrastructure::ScriptProjectRepository.new(ctx: ctx)
             script_project = script_project_repo.get
-            return false if script_project.env_valid?
+
+            return false if script_project.env_valid? && !force
 
             if ShopifyCLI::Shopifolk.check && Forms::RunAgainstShopifyOrg.ask(ctx, nil, nil).response
               ShopifyCLI::Shopifolk.act_as_shopify_organization
@@ -37,15 +38,26 @@ module Script
             extension_point_type = script_project.extension_point_type
             scripts = script_service.get_app_scripts(extension_point_type: extension_point_type)
 
-            uuid = Forms::AskScriptUuid.ask(ctx, scripts, nil).uuid
+            uuid = Forms::AskScriptUuid.ask(ctx, scripts, nil)&.uuid
 
             script_project_repo.create_env(
               api_key: app["apiKey"],
               secret: app["apiSecretKeys"].first["secret"],
               uuid: uuid
             )
+            ctx.done(ctx.message("script.connect.connected", app["title"]))
 
             true
+          rescue SmartProperties::InitializationError, SmartProperties::InvalidValueError => error
+            handle_error(error, context: ctx)
+          end
+
+          def handle_error(error, context:)
+            properties_hash = { api_key: "SHOPIFY_API_KEY", secret: "SHOPIFY_API_SECRET" }
+            missing_env_variables = error.properties.map { |p| properties_hash[p.name] }.compact.join(", ")
+            raise ShopifyCLI::Abort,
+              context.message("script.connect.error.missing_env_file_variables", missing_env_variables,
+                ShopifyCLI::TOOL_NAME)
           end
 
           private

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

@@ -8,11 +8,14 @@ module Script
       class CreateScript
         class << self
           def call(ctx:, language:, sparse_checkout_branch:, script_name:, extension_point_type:)
-            raise Infrastructure::Errors::ScriptProjectAlreadyExistsError, script_name if ctx.dir_exist?(script_name)
+            script_project_repo = Infrastructure::ScriptProjectRepository.new(
+              ctx: ctx,
+              directory: script_name,
+              initial_directory: ctx.root
+            )
 
-            in_new_directory_context(ctx, script_name) do
+            in_new_directory_context(script_project_repo) do
               extension_point = ExtensionPoints.get(type: extension_point_type)
-              script_project_repo = Infrastructure::ScriptProjectRepository.new(ctx: ctx)
               project = script_project_repo.create(
                 script_name: script_name,
                 extension_point_type: extension_point_type,
@@ -36,7 +39,7 @@ module Script
               )
 
               install_dependencies(ctx, language, script_name, project_creator)
-              script_project_repo.update_or_create_script_json(title: script_name)
+              script_project_repo.update_script_config(title: script_name)
               project
             end
           end
@@ -62,19 +65,16 @@ module Script
             ProjectDependencies.install(ctx: ctx, task_runner: task_runner)
           end
 
-          def in_new_directory_context(ctx, directory)
-            initial_directory = ctx.root
-            begin
-              ctx.mkdir_p(directory)
-              ctx.chdir(directory)
-              yield
-            rescue
-              ctx.chdir(initial_directory)
-              ctx.rm_r(directory)
-              raise
-            ensure
-              ctx.chdir(initial_directory)
-            end
+          def in_new_directory_context(script_project_repo)
+            script_project_repo.create_project_directory
+            yield
+          rescue Infrastructure::Errors::ScriptProjectAlreadyExistsError
+            raise
+          rescue
+            script_project_repo.delete_project_directory
+            raise
+          ensure
+            script_project_repo.change_to_initial_directory
           end
         end
       end

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

@@ -4,37 +4,61 @@ module Script
   module Layers
     module Application
       class ExtensionPoints
-        def self.get(type:)
-          Infrastructure::ExtensionPointRepository.new.get_extension_point(type)
-        end
+        class << self
+          def get(type:)
+            extension_point_repository.get_extension_point(type)
+          end
 
-        def self.types
-          Infrastructure::ExtensionPointRepository.new.extension_point_types
-        end
+          def types
+            extension_point_repository.extension_point_types
+          end
 
-        def self.available_types
-          Infrastructure::ExtensionPointRepository.new.extension_points.select do |ep|
-            next false if ep.deprecated?
-            !ep.beta? || ShopifyCLI::Feature.enabled?(:scripts_beta_extension_points)
-          end.map(&:type)
-        end
+          def available_types
+            available_extension_points.map(&:type)
+          end
 
-        def self.deprecated_types
-          Infrastructure::ExtensionPointRepository.new
-            .extension_points
-            .select(&:deprecated?)
-            .map(&:type)
-        end
+          def deprecated_types
+            extension_point_repository
+              .extension_points
+              .select(&:deprecated?)
+              .map(&:type)
+          end
 
-        def self.languages(type:)
-          get(type: type).libraries.all.map do |library|
-            next nil if library.beta? && !ShopifyCLI::Feature.enabled?(:scripts_beta_languages)
-            library.language
-          end.compact
-        end
+          def all_languages
+            available_extension_points
+              .map { |ep| ep.library_languages(include_betas: include_beta_languages?) }
+              .flatten
+              .uniq
+          end
+
+          def languages(type:)
+            get(type: type).library_languages(include_betas: include_beta_languages?)
+          end
+
+          def supported_language?(type:, language:)
+            languages(type: type).include?(language.downcase)
+          end
+
+          private
+
+          def available_extension_points
+            extension_point_repository.extension_points.select do |ep|
+              next false if ep.deprecated?
+              ep.stable? || include_beta_extension_points?
+            end
+          end
+
+          def extension_point_repository
+            Infrastructure::ExtensionPointRepository.new
+          end
+
+          def include_beta_languages?
+            ShopifyCLI::Feature.enabled?(:scripts_beta_languages)
+          end
 
-        def self.supported_language?(type:, language:)
-          languages(type: type).include?(language.downcase)
+          def include_beta_extension_points?
+            ShopifyCLI::Feature.enabled?(:scripts_beta_extension_points)
+          end
         end
       end
     end