shopify-cli 2.3.0 → 2.4.0

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

@@ -3,6 +3,10 @@
 module Extension
   class Command
     class Create < ShopifyCli::SubCommand
+      DEVELOPMENT_SERVER_SUPPORTED_TYPES = [
+        "checkout_ui_extension",
+      ]
+
       prerequisite_task :ensure_authenticated
 
       options do |parser, flags|
@@ -18,6 +22,8 @@ module Extension
             @ctx.abort(message_for_extension["create.errors.directory_exists", form.directory_name])
           end
 
+          return use_new_create_flow(form, message_for_extension) if supports_development_server?(form.type)
+
           if form.type.create(form.directory_name, @ctx, getting_started: options.flags[:getting_started])
             ExtensionProject.write_cli_file(context: @ctx, type: form.type.identifier)
             ExtensionProject.write_env_file(
@@ -47,6 +53,25 @@ module Extension
 
         yield form, form.type.method(:message_for_extension)
       end
+
+      def supports_development_server?(type)
+        Models::DevelopmentServerRequirements.supported?(type.identifier)
+      end
+
+      def use_new_create_flow(form, msg)
+        Tasks::RunExtensionCommand.new(
+          root_dir: form.directory_name,
+          template: form.template,
+          type: form.type.identifier.downcase,
+          command: "create"
+        ).call
+
+        @ctx.puts(msg["create.ready_to_start", form.directory_name, form.name])
+        @ctx.puts(msg["create.learn_more", form.type.name])
+      rescue => error
+        @ctx.debug(error)
+        @ctx.puts(msg["create.try_again"])
+      end
     end
   end
 end

data/lib/project_types/extension/forms/create.rb

@@ -3,7 +3,7 @@
 module Extension
   module Forms
     class Create < ShopifyCli::Form
-      flag_arguments :name, :type, :api_key
+      flag_arguments :name, :type, :api_key, :template
 
       attr_reader :app
 
@@ -13,6 +13,7 @@ module Extension
         property :app, accepts: Models::App
         property :name, accepts: String
         property :type, accepts: Models::SpecificationHandlers::Default
+        property :template, accepts: String
 
         def complete?
           !!(app && name && type)
@@ -23,6 +24,7 @@ module Extension
         ShopifyCli::Result.wrap(ExtensionProjectDetails.new)
           .then(&Questions::AskApp.new(ctx: ctx, api_key: api_key))
           .then(&Questions::AskType.new(ctx: ctx, type: type))
+          .then(&Questions::AskTemplate.new(ctx: ctx))
           .then(&Questions::AskName.new(ctx: ctx, name: name))
           .unwrap { |e| raise e }
           .tap do |project_details|
@@ -30,6 +32,7 @@ module Extension
 
             self.app = project_details.app
             self.type = project_details.type
+            self.template = project_details.template
             self.name = project_details.name
           end
       end

data/lib/project_types/extension/forms/questions/ask_template.rb

@@ -0,0 +1,44 @@
+module Extension
+  module Forms
+    module Questions
+      class AskTemplate
+        include ShopifyCli::MethodObject
+
+        TEMPLATE_REQUIRED_TYPES = [
+          "checkout_ui_extension",
+        ]
+
+        property! :ctx
+        property :prompt,
+          accepts: ->(prompt) { prompt.respond_to?(:call) },
+          default: -> { CLI::UI::Prompt.method(:ask) }
+
+        def call(project_details)
+          return project_details unless template_required?(project_details)
+          project_details.template = choose_interactively
+          project_details
+        end
+
+        private
+
+        def template_required?(project_details)
+          return false unless extension_server_beta?
+          type = project_details&.type&.identifier
+          TEMPLATE_REQUIRED_TYPES.include?(type.downcase)
+        end
+
+        def extension_server_beta?
+          ShopifyCli::Shopifolk.check && ShopifyCli::Feature.enabled?(:extension_server_beta)
+        end
+
+        def choose_interactively
+          prompt.call(ctx.message("create.ask_template")) do |handler|
+            Models::ServerConfig::Development::VALID_TEMPLATES.each do |template|
+              handler.option(template) { template }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -45,6 +45,7 @@ module Extension
           "or try creating a new app using {{command:shopify [node|rails] create}}.",
         loading_apps: "Loading your apps…",
         no_available_extensions: "{{x}} There are no available extensions for this app.",
+        ask_template: "Select a template to use for your extension",
       },
       connect: {
         connected: "Project now connected to {{green:%s: %s}}",
@@ -67,6 +68,8 @@ module Extension
         HELP
         frame_title: "Building extension with: %s…",
         build_failure_message: "Failed to build extension code.",
+        build_success_message: "Build was successful!",
+        directory_not_found: "Build directory not found.",
       },
       register: {
         help: <<~HELP,

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    class DevelopmentServer
+      class DevelopmentServerError < StandardError; end
+
+      include SmartProperties
+
+      EXECUTABLE_PATH = "../../../../../ext/shopify-cli/shopify-extensions/shopify-extensions"
+
+      property! :executable, converts: :to_s, default: File.expand_path(EXECUTABLE_PATH, __FILE__)
+
+      def create(server_config)
+        CLI::Kit::System.capture3(executable, "create", "-", stdin_data: server_config.to_yaml)
+      rescue StandardError => error
+        raise error
+      end
+
+      def build(server_config)
+        _, error, pid = CLI::Kit::System.capture3(executable, "build", "-", stdin_data: server_config.to_yaml)
+        return if pid.success?
+        raise DevelopmentServerError, error
+      end
+
+      def serve
+        raise NotImplementedError
+      end
+
+      def version
+        raise NotImplementedError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Models
+    class DevelopmentServerRequirements
+      SUPPORTED_EXTENSION_TYPES = [
+        "checkout_ui_extension",
+      ]
+
+      def self.supported?(type)
+        return false unless SUPPORTED_EXTENSION_TYPES.include?(type.downcase)
+        ShopifyCli::Shopifolk.check && ShopifyCli::Feature.enabled?(:extension_server_beta)
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/server_config/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module ServerConfig
+      class Base
+        def to_h
+          to_hash
+        end
+
+        def to_hash
+          is_hashable = ->(obj) { obj.respond_to?(:to_hash) }
+          is_collection_of_hashables = ->(obj) { obj.is_a?(Enumerable) && obj.all?(&is_hashable) }
+
+          self.class.properties.each.reduce({}) do |data, (_, property)|
+            data.merge(property.name.to_s => send(property.reader).yield_self do |value|
+              case value
+              when is_collection_of_hashables
+                value.map { |element| element.to_hash.transform_keys(&:to_s) }
+              when is_hashable
+                value.to_hash.transform_keys(&:to_s)
+              else
+                value
+              end
+            end)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/server_config/development.rb

@@ -0,0 +1,23 @@
+module Extension
+  module Models
+    module ServerConfig
+      class Development < Base
+        include SmartProperties
+        VALID_TEMPLATES = [
+          "javascript",
+          "javascript-react",
+          "typescript",
+          "typescript-react",
+        ]
+
+        CURRENT_DIRECTORY = "."
+
+        property :root_dir, accepts: String, default: CURRENT_DIRECTORY
+        property! :build_dir, accepts: String, default: "build"
+        property :template, accepts: VALID_TEMPLATES
+        property :renderer, accepts: ServerConfig::DevelopmentRenderer
+        property :entries, accepts: ServerConfig::DevelopmentEntries
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/server_config/development_entries.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module ServerConfig
+      class DevelopmentEntries < Base
+        include SmartProperties
+
+        JAVASCRIPT = "javascript"
+        JAVASCRIPT_REACT = "javascript-react"
+        TYPESCRIPT = "typescript"
+        TYPESCRIPT_REACT = "typescript-react"
+
+        VALID_ENTRY_POINTS = [
+          "src/index.js",
+          "src/index.jsx",
+          "src/index.ts",
+          "src/index.tsx",
+        ]
+
+        property! :main, accepts: VALID_ENTRY_POINTS
+
+        def self.find(template)
+          case template
+          when JAVASCRIPT
+            new(main: "src/index.js")
+          when JAVASCRIPT_REACT
+            new(main: "src/index.jsx")
+          when TYPESCRIPT
+            new(main: "src/index.ts")
+          when TYPESCRIPT_REACT
+            new(main: "src/index.tsx")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/server_config/development_renderer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module ServerConfig
+      class DevelopmentRenderer < Base
+        include SmartProperties
+
+        VALID_RENDERERS = [
+          "@shopify/admin-ui-extensions",
+          "@shopify/post-purchase-ui-extensions",
+          "@shopify/checkout-ui-extensions",
+        ]
+
+        property! :name, accepts: VALID_RENDERERS
+
+        def self.find(type)
+          case type.downcase
+          when "admin_ui_extension"
+            new(name: "@shopify/admin-ui-extensions")
+          when "checkout_ui_extension"
+            new(name: "@shopify/checkout-ui-extensions")
+          when "checkout_post_purchase"
+            new(name: "@shopify/post-purchase-ui-extensions")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require "securerandom"
+
+module Extension
+  module Models
+    module ServerConfig
+      class Extension < Base
+        include SmartProperties
+        property! :uuid, accepts: String
+        property! :type, accepts: String
+        property! :user, accepts: ServerConfig::User
+        property! :development, accepts: ServerConfig::Development
+
+        def self.build(uuid: "", template:, type:, root_dir:)
+          renderer = ServerConfig::DevelopmentRenderer.find(type)
+          entry = ServerConfig::DevelopmentEntries.find(template)
+          new(
+            uuid: uuid.empty? ? generate_dev_uuid : uuid,
+            type: type.downcase,
+            user: ServerConfig::User.new,
+            development: ServerConfig::Development.new(
+              root_dir: root_dir,
+              template: template,
+              renderer: renderer,
+              entries: entry
+            )
+          )
+        end
+
+        def self.generate_dev_uuid
+          "dev-#{SecureRandom.uuid}"
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/server_config/root.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Extension
+  module Models
+    module ServerConfig
+      class Root < Base
+        include SmartProperties
+
+        property! :port, accepts: Integer, default: 39351
+        property! :extensions, accepts: Array, default: -> { [] }
+
+        def to_yaml
+          to_h.to_yaml.gsub("---\n", "")
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/models/server_config/user.rb

@@ -0,0 +1,10 @@
+module Extension
+  module Models
+    module ServerConfig
+      class User < Base
+        include SmartProperties
+        property! :metafields, accepts: Array, default: -> { [] }
+      end
+    end
+  end
+end

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

@@ -9,7 +9,7 @@ module Extension
 
       property! :from
       property! :to, default: -> { from + 10 }
-      property! :host, default: "localhost"
+      property! :host, default: "127.0.0.1"
 
       def call
         available_port = port_range(from: from, to: to).find { |p| available?(host, p) }

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

@@ -0,0 +1,58 @@
+
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    class RunExtensionCommand < ShopifyCli::Task
+      include SmartProperties
+
+      SUPPORTED_EXTENSION_TYPES = [
+        "checkout_ui_extension",
+      ]
+
+      SUPPORTED_COMMANDS = [
+        "create",
+        "build",
+      ]
+
+      property :root_dir, accepts: String
+      property :template, accepts: Models::ServerConfig::Development::VALID_TEMPLATES
+      property! :type, accepts: SUPPORTED_EXTENSION_TYPES
+      property! :command, accepts: SUPPORTED_COMMANDS
+
+      def call
+        ShopifyCli::Result
+          .call(&method(:build_extension))
+          .then(&method(:build_server_config))
+          .then(&method(:run_command))
+          .unwrap do |error|
+            raise error unless error.nil?
+          end
+      end
+
+      private
+
+      def build_extension
+        Models::ServerConfig::Extension.build(
+          template: template,
+          type: type,
+          root_dir: root_dir,
+        )
+      end
+
+      def build_server_config(extension)
+        Models::ServerConfig::Root.new(extensions: [extension])
+      end
+
+      def run_command(server_config)
+        case command
+        when "create"
+          Models::DevelopmentServer.new.create(server_config)
+        when "build"
+          Models::DevelopmentServer.new.build(server_config)
+        end
+      end
+    end
+  end
+end

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

@@ -46,7 +46,7 @@ module Node
           scopes: "write_products,write_customers,write_draft_orders",
         ).write(@ctx)
 
-        partners_url = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client["id"], local_debug?)
+        partners_url = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client["id"])
 
         @ctx.puts(@ctx.message("apps.create.info.created", form.title, partners_url))
         @ctx.puts(@ctx.message("apps.create.info.serve", form.name, ShopifyCli::TOOL_NAME, "node"))
@@ -120,10 +120,6 @@ module Node
           @ctx.debug(e)
         end
       end
-
-      def local_debug?
-        @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
-      end
     end
   end
 end

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

@@ -63,7 +63,7 @@ module Rails
           scopes: "write_products,write_customers,write_draft_orders",
         ).write(@ctx)
 
-        partners_url = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client["id"], local_debug?)
+        partners_url = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client["id"])
 
         @ctx.puts(@ctx.message("apps.create.info.created", form.title, partners_url))
         @ctx.puts(@ctx.message("apps.create.info.serve", form.name, ShopifyCli::TOOL_NAME, "rails"))
@@ -178,10 +178,6 @@ module Rails
       def install_gem(name, version = nil)
         Gem.install(@ctx, name, version)
       end
-
-      def local_debug?
-        @ctx.getenv(ShopifyCli::PartnersAPI::LOCAL_DEBUG)
-      end
     end
   end
 end

data/lib/project_types/script/cli.rb

@@ -45,12 +45,14 @@ module Script
     end
 
     module Infrastructure
+      autoload :ApiClients, Project.project_filepath("layers/infrastructure/api_clients")
       autoload :Errors, Project.project_filepath("layers/infrastructure/errors")
       autoload :CommandRunner, Project.project_filepath("layers/infrastructure/command_runner")
       autoload :PushPackageRepository, Project.project_filepath("layers/infrastructure/push_package_repository")
       autoload :ExtensionPointRepository, Project.project_filepath("layers/infrastructure/extension_point_repository")
       autoload :ScriptProjectRepository, Project.project_filepath("layers/infrastructure/script_project_repository")
       autoload :ScriptService, Project.project_filepath("layers/infrastructure/script_service")
+      autoload :ScriptUploader, Project.project_filepath("layers/infrastructure/script_uploader")
 
       module Languages
         autoload :AssemblyScriptProjectCreator,

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

@@ -20,7 +20,16 @@ module Script
                 compiled_type: task_runner.compiled_type,
                 metadata: task_runner.metadata,
               )
-              uuid = package.push(Infrastructure::ScriptService.new(ctx: p_ctx), script_project.api_key, force)
+              script_service = Infrastructure::ScriptService.new(ctx: p_ctx, api_key: script_project.api_key)
+              module_upload_url = Infrastructure::ScriptUploader.new(script_service).upload(package.script_content)
+              uuid = script_service.set_app_script(
+                uuid: package.uuid,
+                extension_point_type: package.extension_point_type,
+                force: force,
+                metadata: package.metadata,
+                script_json: package.script_json,
+                module_upload_url: module_upload_url,
+              )
               script_project_repo.update_env(uuid: uuid)
               spinner.update_title(p_ctx.message("script.application.pushed"))
             end

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

@@ -29,18 +29,6 @@ module Script
           @metadata = metadata
           @script_json = script_json
         end
-
-        def push(script_service, api_key, force)
-          script_service.push(
-            uuid: @uuid,
-            extension_point_type: @extension_point_type,
-            script_content: @script_content,
-            api_key: api_key,
-            force: force,
-            metadata: @metadata,
-            script_json: @script_json,
-          )
-        end
       end
     end
   end

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

@@ -0,0 +1,89 @@
+module Script
+  module Layers
+    module Infrastructure
+      class ApiClients
+        def self.default_client(ctx, api_key)
+          if ENV["BYPASS_PARTNERS_PROXY"]
+            ScriptServiceApiClient.new(ctx, api_key)
+          else
+            PartnersProxyApiClient.new(ctx, api_key)
+          end
+        end
+
+        class ScriptServiceApiClient
+          LOCAL_INSTANCE_URL = "https://script-service.myshopify.io"
+
+          def initialize(ctx, api_key)
+            instance_url = script_service_url
+            @api = ShopifyCli::API.new(
+              ctx: ctx,
+              url: "#{instance_url}/graphql",
+              token: { "APP_KEY" => api_key }.compact.to_json,
+              auth_header: "X-Shopify-Authenticated-Tokens"
+            )
+          end
+
+          def query(query_name, variables: {})
+            @api.query(query_name, variables: variables)
+          end
+
+          private
+
+          def script_service_url
+            if ::ShopifyCli::Environment.use_spin_partners_instance?
+              "https://script-service.#{::ShopifyCli::Environment.spin_url}"
+            else
+              LOCAL_INSTANCE_URL
+            end
+          end
+        end
+        private_constant(:ScriptServiceApiClient)
+
+        class PartnersProxyApiClient
+          def initialize(ctx, api_key)
+            @ctx = ctx
+            @api_key = api_key
+          end
+
+          def query(query_name, variables: {})
+            response = ShimAPI.query(@ctx, query_name, api_key: @api_key, variables: variables.to_json)
+            raise_if_graphql_failed(response)
+            JSON.parse(response["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
+
+          class ShimAPI < ShopifyCli::PartnersAPI
+            def query(query_name, variables: {})
+              variables[:query] = load_query(query_name)
+              super("script_service_proxy", variables: variables)
+            end
+          end
+          private_constant(:ShimAPI)
+        end
+        private_constant(:PartnersProxyApiClient)
+      end
+    end
+  end
+end

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

@@ -40,7 +40,7 @@ module Script
           def extension_point_version
             return extension_point.sdks.assemblyscript.version if extension_point.sdks.assemblyscript.versioned?
 
-            out = command_runner.call("npm show #{extension_point.sdks.assemblyscript.package} version --json")
+            out = command_runner.call("npm -s show #{extension_point.sdks.assemblyscript.package} version --json")
             "^#{JSON.parse(out)}"
           end