@shopify/cli-kit 3.39.0 → 3.40.1

package/assets/cli-ruby/lib/shopify_cli/commands/system.rb

@@ -0,0 +1,165 @@
+require "shopify_cli"
+require "rbconfig"
+
+module ShopifyCLI
+  module Commands
+    class System < ShopifyCLI::Command
+      hidden_feature(feature_set: :debug)
+
+      def call(args, _name)
+        show_all_details = false
+        flag = args.shift
+        if flag && flag != "all"
+          @ctx.puts(@ctx.message("core.system.error.unknown_option", flag))
+          @ctx.puts("\n" + self.class.help)
+          return
+        end
+
+        show_all_details = true if flag == "all"
+
+        display_environment if show_all_details
+
+        display_cli_constants(show_all_details)
+        display_shopify_store(show_all_details)
+        display_cli_ruby(show_all_details)
+        display_utility_commands(show_all_details)
+        display_project_commands(show_all_details)
+        display_shopify_staff_identity if show_all_details
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("core.system.help", ShopifyCLI::TOOL_NAME)
+      end
+
+      private
+
+      def display_cli_constants(show_all_details)
+        cli_constants = %w(ROOT)
+        cli_constants_extra = %w(
+          PROJECT_TYPES_DIR
+          TEMP_DIR
+        )
+        cli_path_methods = [
+          :cache_dir,
+          :tool_config_path,
+          :log_file,
+          :debug_log_file,
+        ]
+
+        cli_constants += cli_constants_extra if show_all_details
+
+        @ctx.puts(@ctx.message("core.system.header"))
+        cli_constants.each do |s|
+          @ctx.puts("  " + @ctx.message("core.system.const", s, ShopifyCLI.const_get(s.to_sym)) + "\n")
+        end
+
+        if show_all_details
+          cli_path_methods.each do |m|
+            @ctx.puts("  " + @ctx.message("core.system.const", m.upcase, ShopifyCLI.send(m)) + "\n")
+          end
+        end
+      end
+
+      def display_shopify_store(_show_all_details)
+        shop = if ShopifyCLI::DB.exists?(:shop)
+          ShopifyCLI::AdminAPI.get_shop_or_abort(@ctx)
+        else
+          @ctx.message("core.populate.error.no_shop", ShopifyCLI::TOOL_NAME)
+        end
+
+        @ctx.puts("\n" + @ctx.message("core.system.shop_header"))
+        @ctx.puts("  " + shop)
+      end
+
+      def display_cli_ruby(_show_all_details)
+        rbconfig_constants = %w(host RUBY_VERSION_NAME)
+
+        @ctx.puts("\n" + @ctx.message("core.system.ruby_header", RbConfig.ruby))
+        rbconfig_constants.each do |s|
+          @ctx.puts("  " + @ctx.message("core.system.rb_config", RbConfig::CONFIG[s], s))
+        end
+      end
+
+      def display_utility_commands(_show_all_details)
+        commands = %w(git curl tar)
+
+        @ctx.puts("\n" + @ctx.message("core.system.command_header"))
+        commands.each do |s|
+          cmd_path = @ctx.which(s)
+
+          if !cmd_path.nil?
+            @ctx.puts("  " + @ctx.message("core.system.command_with_path", s, cmd_path))
+          else
+            @ctx.puts("  " + @ctx.message("core.system.command_not_found", s))
+          end
+        end
+      end
+
+      def display_ngrok
+        ngrok_location = File.join(ShopifyCLI.cache_dir, "ngrok#{@ctx.executable_file_extension}")
+        if File.exist?(ngrok_location)
+          @ctx.puts("  " + @ctx.message("core.system.ngrok_available", ngrok_location))
+        else
+          @ctx.puts("  " + @ctx.message("core.system.ngrok_not_available"))
+        end
+      end
+
+      def display_project_commands(_show_all_details)
+        case Project.current_project_type
+        when :node
+          display_project("Node.js", %w(npm node yarn))
+        when :rails
+          display_project("Rails", %w(gem rails rake ruby))
+        end
+      end
+
+      def display_project(project_type, commands)
+        @ctx.puts("\n" + @ctx.message("core.system.project.header", project_type))
+        commands.each do |s|
+          cmd_path = @ctx.which(s)
+          if !cmd_path.nil?
+            version_output, _ = @ctx.capture2e(s, "--version")
+            version = version_output.match(/(\d+\.[^\s]+)/)[0]
+            @ctx.puts("  " + @ctx.message("core.system.project.command_with_path", s, cmd_path.strip, version.strip))
+          else
+            @ctx.puts("  " + @ctx.message("core.system.project.command_not_found", s))
+          end
+        end
+        display_ngrok
+        display_project_environment
+      end
+
+      def display_project_environment
+        @ctx.puts("\n  " + @ctx.message("core.system.project.env_header"))
+        if File.exist?("./.env")
+          Project.current.env.to_h.each do |k, v|
+            display_value = if v.nil? || v.strip == ""
+              @ctx.message("core.system.project.env_not_set")
+            else
+              k.match(/^SHOPIFY_API/) ? "********" : v
+            end
+            @ctx.puts("  " + @ctx.message("core.system.project.env", k, display_value))
+          end
+        else
+          @ctx.puts("  " + @ctx.message("core.system.project.no_env"))
+        end
+      end
+
+      def display_environment
+        @ctx.puts(@ctx.message("core.system.environment_header"))
+        %w(TERM SHELL PATH USING_SHOPIFY_CLI LANG).each do |k|
+          @ctx.puts("  " + @ctx.message("core.system.env", k, ENV[k])) unless ENV[k].nil?
+        end
+        @ctx.puts("")
+      end
+
+      def display_shopify_staff_identity
+        is_shopifolk = ShopifyCLI::Shopifolk.check
+        if is_shopifolk
+          @ctx.puts("\n" + @ctx.message("core.system.identity_header"))
+          @ctx.puts("  " + @ctx.message("core.system.identity_is_shopifolk"))
+        end
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/shopify_cli/commands/version.rb

@@ -0,0 +1,15 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module Commands
+    class Version < ShopifyCLI::Command
+      def self.help
+        ShopifyCLI::Context.message("core.version.help", ShopifyCLI::TOOL_NAME)
+      end
+
+      def call(_args, _name)
+        @ctx.puts(ShopifyCLI::VERSION.to_s)
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/shopify_cli/commands/whoami.rb

@@ -0,0 +1,28 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module Commands
+    class Whoami < ShopifyCLI::Command
+      def call(_args, _name)
+        shop = ShopifyCLI::DB.get(:shop)
+        org_id = ShopifyCLI::DB.get(:organization_id)
+        org = ShopifyCLI::PartnersAPI::Organizations.fetch(@ctx, id: org_id) unless org_id.nil?
+
+        output = if shop.nil? && org.nil?
+          @ctx.message("core.whoami.not_logged_in", ShopifyCLI::TOOL_NAME)
+        elsif !shop.nil? && org.nil?
+          @ctx.message("core.whoami.logged_in_shop_only", shop)
+        elsif shop.nil? && !org.nil?
+          @ctx.message("core.whoami.logged_in_partner_only", org["businessName"])
+        else
+          @ctx.message("core.whoami.logged_in_partner_and_shop", shop, org["businessName"])
+        end
+        @ctx.puts(output)
+      end
+
+      def self.help
+        ShopifyCLI::Context.message("core.whoami.help", ShopifyCLI::TOOL_NAME)
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/shopify_cli/commands.rb

@@ -0,0 +1,36 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  module Commands
+    Registry = CLI::Kit::CommandRegistry.new(
+      default: "help",
+      contextual_resolver: nil,
+    )
+    @core_commands = []
+
+    def self.register(const, cmd, path = nil, is_core = false)
+      autoload(const, path) if path
+      Registry.add(->() { const_get(const) }, cmd)
+      @core_commands.push(cmd) if is_core
+    end
+
+    def self.core_command?(cmd)
+      @core_commands.include?(cmd)
+    end
+
+    register :Config, "config", "shopify_cli/commands/config", true
+    register :Help, "help", "shopify_cli/commands/help", true
+    register :Login, "login", "shopify_cli/commands/login", true
+    register :Logout, "logout", "shopify_cli/commands/logout", true
+    register :Populate, "populate", "shopify_cli/commands/populate", true
+    register :Reporting, "reporting", "shopify_cli/commands/reporting", true
+    register :Store, "store", "shopify_cli/commands/store", true
+    register :Switch, "switch", "shopify_cli/commands/switch", true
+    register :System, "system", "shopify_cli/commands/system", true
+    register :Version, "version", "shopify_cli/commands/version", true
+    register :Whoami, "whoami", "shopify_cli/commands/whoami", true
+    register :App, "app", "shopify_cli/commands/app", true
+
+    autoload :Connect, "shopify_cli/commands/connect"
+  end
+end

package/assets/cli-ruby/lib/shopify_cli/connect.rb

@@ -0,0 +1,32 @@
+require "shopify_cli"
+
+module ShopifyCLI
+  class Connect
+    def initialize(ctx)
+      @ctx = ctx
+    end
+
+    def default_connect(project_type)
+      if Project.current&.env
+        @ctx.puts(@ctx.message("core.connect.already_connected_warning"))
+      end
+      org = ShopifyCLI::Tasks::EnsureEnv.call(@ctx, regenerate: true)
+      write_cli_yml(project_type, org["id"]) unless Project.has_current?
+      api_key = Project.current(force_reload: true).env["api_key"]
+      get_app(org["apps"], api_key).first["title"]
+    end
+
+    def write_cli_yml(project_type, org_id)
+      ShopifyCLI::Project.write(
+        @ctx,
+        project_type: project_type,
+        organization_id: org_id,
+      )
+      @ctx.done(@ctx.message("core.connect.cli_yml_saved"))
+    end
+
+    def get_app(apps, api_key)
+      apps.select { |app| app["apiKey"] == api_key }
+    end
+  end
+end

package/assets/cli-ruby/lib/shopify_cli/constants.rb

@@ -0,0 +1,91 @@
+module ShopifyCLI
+  module Constants
+    module Paths
+      ROOT = File.expand_path("../..", __dir__)
+    end
+
+    module Files
+      SHOPIFY_CLI_YML = ".shopify-cli.yml"
+    end
+
+    module StoreKeys
+      LAST_MIGRATION_DATE = :last_migration_date
+      ANALYTICS_ENABLED = :analytics_enabled
+    end
+
+    module Bugsnag
+      API_KEY = "773b0c801eb40c20d8928be5b7c739bd"
+    end
+
+    module Config
+      module Sections
+        module Analytics
+          NAME = "analytics"
+          module Fields
+            ENABLED = "enabled"
+          end
+        end
+      end
+    end
+
+    module EnvironmentVariables
+      STACKTRACE = "SHOPIFY_CLI_STACKTRACE"
+      TTY = "SHOPIFY_CLI_TTY"
+      RUN_AS_SUBPROCESS = "SHOPIFY_CLI_RUN_AS_SUBPROCESS"
+
+      # When true the CLI points to a local instance of
+      # the partners dashboard and identity.
+      LOCAL_PARTNERS = "SHOPIFY_APP_CLI_LOCAL_PARTNERS"
+
+      # When true the CLI points to spin instances of services
+      SPIN = "SPIN"
+      SPIN_INSTANCE = "SPIN_INSTANCE"
+      SPIN_WORKSPACE = "SPIN_WORKSPACE"
+      SPIN_NAMESPACE = "SPIN_NAMESPACE"
+      SPIN_HOST = "SPIN_HOST"
+
+      # Deprecated, equivalent to using SPIN=1
+      SPIN_PARTNERS = "SHOPIFY_APP_CLI_SPIN_PARTNERS"
+
+      # Environments
+      TEST = "SHOPIFY_CLI_TEST"
+      ACCEPTANCE_TEST = "SHOPIFY_CLI_ACCEPTANCE_TEST"
+      DEVELOPMENT = "SHOPIFY_CLI_DEVELOPMENT"
+
+      # Authentication
+      AUTH_TOKEN = "SHOPIFY_CLI_AUTH_TOKEN"
+      ADMIN_AUTH_TOKEN = "SHOPIFY_CLI_ADMIN_AUTH_TOKEN"
+      STOREFRONT_RENDERER_AUTH_TOKEN = "SHOPIFY_CLI_STOREFRONT_RENDERER_AUTH_TOKEN"
+
+      # Monorail
+      MONORAIL_REAL_EVENTS = "MONORAIL_REAL_EVENTS"
+
+      STORE = "SHOPIFY_SHOP"
+    end
+
+    module SupportedVersions
+      module Ruby
+        FROM = "2.7.5"
+        TO = "3.2.0"
+      end
+
+      module Node
+        FROM = "14.5.0"
+        TO = "18.0.0"
+      end
+    end
+
+    module Identity
+      CLIENT_ID_DEV = "e5380e02-312a-7408-5718-e07017e9cf52"
+      CLIENT_ID = "fbdb2649-e327-4907-8f67-908d24cfd7e3"
+    end
+
+    module Links
+      NEW_ISSUE = "https://github.com/Shopify/shopify-cli/issues/new"
+    end
+
+    module Extension
+      DEFAULT_PORT = 39351
+    end
+  end
+end