shopify-cli 1.13.1 → 2.1.0

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

@@ -17,6 +17,7 @@ module Extension
 
         def self.build(feature_set_attributes)
           feature_set_attributes.each_with_object(OpenStruct.new) do |(identifier, feature_attributes), feature_set|
+            next if feature_attributes.nil?
             feature_set[identifier] = ShopifyCli::ResolveConstant
               .call(identifier, namespace: Features)
               .rescue { OpenStruct }

data/lib/project_types/extension/models/specification_handlers/{checkout_argo_extension.rb → checkout_ui_extension.rb}

@@ -3,7 +3,7 @@
 module Extension
   module Models
     module SpecificationHandlers
-      class CheckoutArgoExtension < Default
+      class CheckoutUiExtension < Default
         PERMITTED_CONFIG_KEYS = [:metafields, :extension_points]
 
         def config(context)
@@ -13,6 +13,8 @@ module Extension
           }
         end
       end
+
+      CheckoutArgoExtension = CheckoutUiExtension
     end
   end
 end

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

@@ -30,7 +30,7 @@ module Extension
           argo.config(context)
         end
 
-        def create(directory_name, context)
+        def create(directory_name, context, **_args)
           argo.create(directory_name, identifier, context)
         end
 
@@ -43,11 +43,11 @@ module Extension
         end
 
         def choose_port?(context)
-          argo_runtime(context).accepts_port?
+          argo_runtime(context).supports?(:port)
         end
 
         def establish_tunnel?(context)
-          argo_runtime(context).accepts_tunnel_url?
+          argo_runtime(context).supports?(:public_url)
         end
 
         def serve(context:, port:, tunnel_url:)
@@ -80,6 +80,16 @@ module Extension
             .unwrap { |_e| context.abort(context.message("errors.package_not_found", cli_package_name)) }
         end
 
+        def message_for_extension(key, *params)
+          override_key = "overrides.#{key}"
+          key_parts = override_key.split(".").map(&:to_sym)
+          if (str = messages.dig(*key_parts))
+            str % params
+          else
+            ShopifyCli::Context.message(key, *params)
+          end
+        end
+
         protected
 
         def argo

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+require "base64"
+require "json"
+
+module Extension
+  module Models
+    module SpecificationHandlers
+      class ThemeAppExtension < Default
+        SUPPORTED_BUCKETS = %w(assets blocks snippets)
+        BUNDLE_SIZE_LIMIT = 10 * 1024 * 1024 # 10MB
+        LIQUID_SIZE_LIMIT = 100 * 1024 # 100kb
+        SUPPORTED_ASSET_EXTS = %w(.jpg .js .css .png .svg)
+
+        def create(directory_name, context, getting_started: false)
+          context.root = File.join(context.root, directory_name)
+
+          if getting_started
+            ShopifyCli::Git.clone("https://github.com/Shopify/theme-extension-getting-started", context.root)
+            context.rm_r(".git")
+          else
+            FileUtils.makedirs(SUPPORTED_BUCKETS.map { |b| File.join(context.root, b) })
+          end
+        end
+
+        def config(context)
+          current_size = 0
+          current_liquid_size = 0
+          Dir.chdir(context.root) do
+            Dir["**/*"].select { |filename| File.file?(filename) && validate(filename) }
+              .map do |filename|
+                dirname = File.dirname(filename)
+                if dirname == "assets"
+                  # Assets should be read as binary data, since they could be images
+                  mode = "rb"
+                  encoding = "BINARY"
+                else
+                  # Other assets should be treated as UTF-8 encoded text
+                  mode = "rt"
+                  encoding = "UTF-8"
+                  current_liquid_size += File.size(filename)
+                end
+                current_size += File.size(filename)
+                if current_size > BUNDLE_SIZE_LIMIT
+                  raise Extension::Errors::BundleTooLargeError,
+                    "Total size of all files must be less than #{CLI::Kit::Util.to_filesize(BUNDLE_SIZE_LIMIT)}"
+                end
+                if current_liquid_size > LIQUID_SIZE_LIMIT
+                  raise Extension::Errors::BundleTooLargeError,
+                    "Total size of all liquid must be less than #{CLI::Kit::Util.to_filesize(LIQUID_SIZE_LIMIT)}"
+                end
+                [filename, Base64.encode64(File.read(filename, mode: mode, encoding: encoding))]
+              end
+              .yield_self do |encoded_files_by_name|
+                { "theme_extension" => { "files" => encoded_files_by_name.to_h } }
+              end
+          end
+        end
+
+        def name
+          "Theme App Extension"
+        end
+
+        private
+
+        def validate(filename)
+          dirname = File.dirname(filename)
+          # Skip files in the root of the directory tree
+          return false if dirname == "."
+
+          unless SUPPORTED_BUCKETS.include?(dirname)
+            raise Extension::Errors::InvalidFilenameError, "Invalid directory: #{dirname}"
+          end
+
+          ext = File.extname(filename)
+          if dirname == "assets"
+            unless SUPPORTED_ASSET_EXTS.include?(ext)
+              raise Extension::Errors::InvalidFilenameError,
+                "Invalid filename: #{filename}; #{ext} is not supported"
+            end
+          elsif ext != ".liquid"
+            raise Extension::Errors::InvalidFilenameError,
+              "Invalid filename: #{filename}; Only .liquid allowed in #{dirname}"
+          end
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -44,6 +44,7 @@ module Extension
           .map(&ShopifyCli::TransformDataStructure.new(symbolize_keys: true, underscore_keys: true))
           .then(&method(:select_cli_extensions))
           .then(&Tasks::ConfigureFeatures)
+          .then(&Tasks::ConfigureOptions)
           .then(&method(:ensure_legacy_compatibility))
           .then(&method(:build_specifications))
           .then(&method(:require_handler_implementations))

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

@@ -38,16 +38,15 @@ module Extension
       def surface_area_configurations
         {
           admin: {
-            git_template: "https://github.com/Shopify/argo-admin-template.git",
-            renderer_package_name: "@shopify/argo-admin",
+            git_template: "https://github.com/Shopify/admin-ui-extensions-template",
+            renderer_package_name: "@shopify/admin-ui-extensions",
             required_fields: [:shop, :api_key],
-            required_shop_beta_flags: [:argo_admin_beta],
-            cli_package_name: "@shopify/argo-admin-cli",
+            cli_package_name: "@shopify/admin-ui-extensions-run",
           },
           checkout: {
-            git_template: "https://github.com/Shopify/argo-checkout-template.git",
-            renderer_package_name: "@shopify/argo-checkout",
-            cli_package_name: "@shopify/argo-run",
+            git_template: "https://github.com/Shopify/checkout-ui-extensions-template",
+            renderer_package_name: "@shopify/checkout-ui-extensions",
+            cli_package_name: "@shopify/checkout-ui-extensions-run",
           },
         }
       end

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

@@ -0,0 +1,20 @@
+module Extension
+  module Tasks
+    class ConfigureOptions
+      include ShopifyCli::MethodObject
+
+      def call(specification_attribute_sets)
+        specification_attribute_sets.each do |attributes|
+          attributes[:options] ||= {}
+          configure_skip_build(attributes)
+        end
+      end
+
+      private
+
+      def configure_skip_build(attributes)
+        attributes[:options].merge!(skip_build: attributes[:identifier] == "theme_app_extension")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require "shopify_cli"
+
+module Extension
+  module Tasks
+    class GetExtensions < ShopifyCli::Task
+      def call(context:, type:)
+        organizations = ShopifyCli::PartnersAPI::Organizations.fetch_with_extensions(context, type)
+        extensions_from_organizations(organizations, context: context)
+      end
+
+      private
+
+      def extensions_from_organizations(organizations, context:)
+        organizations.flat_map do |organization|
+          extensions_owned_by_organization(organization, context: context)
+        end
+      end
+
+      def extensions_owned_by_organization(organization, context:)
+        return [] unless organization.key?("apps") && organization["apps"].any?
+
+        organization["apps"].flat_map do |app|
+          app["extensionRegistrations"].map do |registration|
+            [Converters::AppConverter.from_hash(app, organization),
+             Converters::RegistrationConverter.from_hash(context, registration)]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/project_types/node/cli.rb

@@ -1,33 +1,21 @@
 # frozen_string_literal: true
 module Node
   class Project < ShopifyCli::ProjectType
-    title("Node.js App")
-    creator("Node::Commands::Create")
-    connector("Node::Commands::Connect")
-
-    register_command("Node::Commands::Deploy", "deploy")
-    register_command("Node::Commands::Generate", "generate")
-    register_command("Node::Commands::Open", "open")
-    register_command("Node::Commands::Populate", "populate")
-    register_command("Node::Commands::Serve", "serve")
-    register_command("Node::Commands::Tunnel", "tunnel")
-    # register_task('Node::Tasks::NodeTask', 'node_task')
-
     require Project.project_filepath("messages/messages")
     register_messages(Node::Messages::MESSAGES)
   end
 
   # define/autoload project specific Commands
-  module Commands
-    autoload :Connect, Project.project_filepath("commands/connect")
-    autoload :Create, Project.project_filepath("commands/create")
-    autoload :Deploy, Project.project_filepath("commands/deploy")
-    autoload :Generate, Project.project_filepath("commands/generate")
-    autoload :Open, Project.project_filepath("commands/open")
-    autoload :Populate, Project.project_filepath("commands/populate")
-    autoload :Serve, Project.project_filepath("commands/serve")
-    autoload :Tunnel, Project.project_filepath("commands/tunnel")
+  class Command < ShopifyCli::ProjectCommands
+    subcommand :Connect, "connect", Project.project_filepath("commands/connect")
+    subcommand :Create, "create", Project.project_filepath("commands/create")
+    subcommand :Deploy, "deploy", Project.project_filepath("commands/deploy")
+    subcommand :Generate, "generate", Project.project_filepath("commands/generate")
+    subcommand :Open, "open", Project.project_filepath("commands/open")
+    subcommand :Serve, "serve", Project.project_filepath("commands/serve")
+    subcommand :Tunnel, "tunnel", Project.project_filepath("commands/tunnel")
   end
+  ShopifyCli::Commands.register("Node::Command", "node")
 
   # define/autoload project specific Tasks
   module Tasks

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

@@ -1,15 +1,21 @@
 # frozen_string_literal: true
 module Node
-  module Commands
+  class Command
     class Connect < ShopifyCli::SubCommand
+      prerequisite_task ensure_project_type: :node
+
       def call(*)
         if ShopifyCli::Project.has_current? && ShopifyCli::Project.current.env
           @ctx.puts(@ctx.message("node.connect.production_warning"))
         end
 
-        app = ShopifyCli::Commands::Connect.new.default_connect("node")
+        app = ShopifyCli::Connect.new(@ctx).default_connect("node")
         @ctx.done(@ctx.message("node.connect.connected", app))
       end
+
+      def self.help
+        ShopifyCli::Context.message("node.connect.help", ShopifyCli::TOOL_NAME, ShopifyCli::TOOL_NAME)
+      end
     end
   end
 end

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

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 module Node
-  module Commands
+  class Command
     class Create < ShopifyCli::SubCommand
+      prerequisite_task :ensure_authenticated
+
       options do |parser, flags|
         # backwards compatibility allow 'title' for now
         parser.on("--title=TITLE") { |t| flags[:title] = t }
         parser.on("--name=NAME") { |t| flags[:title] = t }
-        parser.on("--organization_id=ID") { |url| flags[:organization_id] = url }
-        parser.on("--organization-id=ID") { |url| flags[:organization_id] = url }
+        parser.on("--organization_id=ID") { |id| flags[:organization_id] = id }
+        parser.on("--organization-id=ID") { |id| flags[:organization_id] = id }
+        parser.on("--store=MYSHOPIFYDOMAIN") { |url| flags[:shop_domain] = url }
+        # backwards compatibility allow 'shop domain' for now
         parser.on("--shop_domain=MYSHOPIFYDOMAIN") { |url| flags[:shop_domain] = url }
         parser.on("--shop-domain=MYSHOPIFYDOMAIN") { |url| flags[:shop_domain] = url }
-        parser.on("--type=APPTYPE") { |url| flags[:type] = url }
+        parser.on("--type=APPTYPE") { |type| flags[:type] = type }
         parser.on("--verbose") { flags[:verbose] = true }
       end
 
@@ -45,7 +49,7 @@ module Node
         partners_url = ShopifyCli::PartnersAPI.partners_url_for(form.organization_id, api_client["id"], local_debug?)
 
         @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))
+        @ctx.puts(@ctx.message("apps.create.info.serve", form.name, ShopifyCli::TOOL_NAME, "node"))
         unless ShopifyCli::Shopifolk.acting_as_shopify_organization?
           @ctx.puts(@ctx.message("apps.create.info.install", partners_url, form.title))
         end

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

@@ -2,12 +2,22 @@
 require "shopify_cli"
 
 module Node
-  module Commands
-    class Deploy < ShopifyCli::Command
-      subcommand :Heroku, "heroku", Project.project_filepath("commands/deploy/heroku")
+  class Command
+    class Deploy < ShopifyCli::SubCommand
+      prerequisite_task ensure_project_type: :node
 
-      def call(*)
-        @ctx.puts(self.class.help)
+      autoload :Heroku, Project.project_filepath("commands/deploy/heroku")
+
+      HEROKU = "heroku"
+
+      def call(args, _name)
+        subcommand = args.shift
+        case subcommand
+        when HEROKU
+          Node::Command::Deploy::Heroku.start(@ctx)
+        else
+          @ctx.puts(self.class.help)
+        end
       end
 
       def self.help

data/lib/project_types/node/commands/deploy/heroku.rb

@@ -2,81 +2,81 @@
 require "shopify_cli"
 
 module Node
-  module Commands
+  class Command
     class Deploy
-      class Heroku < ShopifyCli::SubCommand
+      class Heroku
         def self.help
           ShopifyCli::Context.message("node.deploy.heroku.help", ShopifyCli::TOOL_NAME)
         end
 
-        def call(*)
+        def self.start(ctx)
           spin_group = CLI::UI::SpinGroup.new
-          heroku_service = ShopifyCli::Heroku.new(@ctx)
+          heroku_service = ShopifyCli::Heroku.new(ctx)
 
-          spin_group.add(@ctx.message("node.deploy.heroku.downloading")) do |spinner|
+          spin_group.add(ctx.message("node.deploy.heroku.downloading")) do |spinner|
             heroku_service.download
-            spinner.update_title(@ctx.message("node.deploy.heroku.downloaded"))
+            spinner.update_title(ctx.message("node.deploy.heroku.downloaded"))
           end
           spin_group.wait
 
-          install_message = @ctx.message(
-            @ctx.windows? ? "node.deploy.heroku.installing_windows" : "node.deploy.heroku.installing"
+          install_message = ctx.message(
+            ctx.windows? ? "node.deploy.heroku.installing_windows" : "node.deploy.heroku.installing"
           )
           spin_group.add(install_message) do |spinner|
             heroku_service.install
-            spinner.update_title(@ctx.message("node.deploy.heroku.installed"))
+            spinner.update_title(ctx.message("node.deploy.heroku.installed"))
           end
           spin_group.wait
 
-          spin_group.add(@ctx.message("node.deploy.heroku.git.checking")) do |spinner|
-            ShopifyCli::Git.init(@ctx)
-            spinner.update_title(@ctx.message("node.deploy.heroku.git.initialized"))
+          spin_group.add(ctx.message("node.deploy.heroku.git.checking")) do |spinner|
+            ShopifyCli::Git.init(ctx)
+            spinner.update_title(ctx.message("node.deploy.heroku.git.initialized"))
           end
           spin_group.wait
 
           if (account = heroku_service.whoami)
-            @ctx.puts(@ctx.message("node.deploy.heroku.authenticated_with_account", account))
+            ctx.puts(ctx.message("node.deploy.heroku.authenticated_with_account", account))
           else
             CLI::UI::Frame.open(
-              @ctx.message("node.deploy.heroku.authenticating"),
-              success_text: @ctx.message("node.deploy.heroku.authenticated")
+              ctx.message("node.deploy.heroku.authenticating"),
+              success_text: ctx.message("node.deploy.heroku.authenticated")
             ) do
               heroku_service.authenticate
             end
           end
 
           if (app_name = heroku_service.app)
-            @ctx.puts(@ctx.message("node.deploy.heroku.app.selected", app_name))
+            ctx.puts(ctx.message("node.deploy.heroku.app.selected", app_name))
           else
-            app_type = CLI::UI::Prompt.ask(@ctx.message("node.deploy.heroku.app.no_apps_found")) do |handler|
-              handler.option(@ctx.message("node.deploy.heroku.app.create")) { :new }
-              handler.option(@ctx.message("node.deploy.heroku.app.select")) { :existing }
+            app_type = CLI::UI::Prompt.ask(ctx.message("node.deploy.heroku.app.no_apps_found")) do |handler|
+              handler.option(ctx.message("node.deploy.heroku.app.create")) { :new }
+              handler.option(ctx.message("node.deploy.heroku.app.select")) { :existing }
             end
 
             if app_type == :existing
-              app_name = CLI::UI::Prompt.ask(@ctx.message("node.deploy.heroku.app.name"))
+              app_name = CLI::UI::Prompt.ask(ctx.message("node.deploy.heroku.app.name"))
               CLI::UI::Frame.open(
-                @ctx.message("node.deploy.heroku.app.selecting", app_name),
-                success_text: @ctx.message("node.deploy.heroku.app.selected", app_name)
+                ctx.message("node.deploy.heroku.app.selecting", app_name),
+                success_text: ctx.message("node.deploy.heroku.app.selected", app_name)
               ) do
                 heroku_service.select_existing_app(app_name)
               end
             elsif app_type == :new
               CLI::UI::Frame.open(
-                @ctx.message("node.deploy.heroku.app.creating"),
-                success_text: @ctx.message("node.deploy.heroku.app.created")
+                ctx.message("node.deploy.heroku.app.creating"),
+                success_text: ctx.message("node.deploy.heroku.app.created")
               ) do
                 heroku_service.create_new_app
               end
             end
           end
 
-          branches = ShopifyCli::Git.branches(@ctx)
+          branches = ShopifyCli::Git.branches(ctx)
           if branches.length == 1
             branch_to_deploy = branches[0]
-            @ctx.puts(@ctx.message("node.deploy.heroku.git.branch_selected", branch_to_deploy))
+            ctx.puts(ctx.message("node.deploy.heroku.git.branch_selected", branch_to_deploy))
           else
-            branch_to_deploy = CLI::UI::Prompt.ask(@ctx.message("node.deploy.heroku.git.what_branch")) do |handler|
+            branch_to_deploy = CLI::UI::Prompt.ask(ctx.message("node.deploy.heroku.git.what_branch")) do |handler|
               branches.each do |branch|
                 handler.option(branch) { branch }
               end
@@ -84,8 +84,8 @@ module Node
           end
 
           CLI::UI::Frame.open(
-            @ctx.message("node.deploy.heroku.deploying"),
-            success_text: @ctx.message("node.deploy.heroku.deployed")
+            ctx.message("node.deploy.heroku.deploying"),
+            success_text: ctx.message("node.deploy.heroku.deployed")
           ) do
             heroku_service.deploy(branch_to_deploy)
           end