shopify-cli 1.9.0 → 1.13.0

data/lib/project_types/script/tasks/ensure_env.rb

@@ -0,0 +1,85 @@
+require "shopify_cli"
+
+module Script
+  module Tasks
+    class EnsureEnv < ShopifyCli::Task
+      attr_accessor :ctx
+
+      def call(ctx)
+        self.ctx = ctx
+
+        script_project_repo = Layers::Infrastructure::ScriptProjectRepository.new(ctx: ctx)
+        script_project = script_project_repo.get
+
+        return if script_project.api_key && script_project.api_secret && script_project.uuid_defined?
+
+        org = ask_org
+        app = ask_app(org["apps"])
+        uuid = ask_script_uuid(app, script_project.extension_point_type)
+
+        script_project_repo.create_env(
+          api_key: app["apiKey"],
+          secret: app["apiSecretKeys"].first["secret"],
+          uuid: uuid
+        )
+      end
+
+      private
+
+      def ask_org
+        if ShopifyCli::Shopifolk.check && wants_to_run_against_shopify_org?
+          ShopifyCli::Shopifolk.act_as_shopify_organization
+        end
+
+        orgs = ShopifyCli::PartnersAPI::Organizations.fetch_with_app(ctx)
+        if orgs.count == 1
+          default = orgs.first
+          ctx.puts(ctx.message("script.application.ensure_env.organization", default["businessName"], default["id"]))
+          default
+        elsif orgs.count > 0
+          CLI::UI::Prompt.ask(ctx.message("script.application.ensure_env.organization_select")) do |handler|
+            orgs.each do |org|
+              handler.option("#{org["businessName"]} (#{org["id"]})") { org }
+            end
+          end
+        else
+          raise Errors::NoExistingOrganizationsError
+        end
+      end
+
+      def ask_app(apps)
+        unless ShopifyCli::Shopifolk.acting_as_shopify_organization?
+          apps = apps.select { |app| app["appType"] == "custom" }
+        end
+
+        if apps.count == 1
+          default = apps.first
+          ctx.puts(ctx.message("script.application.ensure_env.app", default["title"]))
+          default
+        elsif apps.count > 0
+          CLI::UI::Prompt.ask(ctx.message("script.application.ensure_env.app_select")) do |handler|
+            apps.each do |app|
+              handler.option(app["title"]) { app }
+            end
+          end
+        else
+          raise Errors::NoExistingAppsError
+        end
+      end
+
+      def ask_script_uuid(app, extension_point_type)
+        script_service = Layers::Infrastructure::ScriptService.new(ctx: ctx)
+        scripts = script_service.get_app_scripts(api_key: app["apiKey"], extension_point_type: extension_point_type)
+
+        return nil unless scripts.count > 0 &&
+          CLI::UI::Prompt.confirm(ctx.message("script.application.ensure_env.ask_connect_to_existing_script"))
+
+        CLI::UI::Prompt.ask(ctx.message("script.application.ensure_env.ask_which_script_to_connect_to")) do |handler|
+          scripts.each do |script|
+            handler.option("#{script["title"]} (#{script["uuid"]})") { script["uuid"] }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -110,11 +110,6 @@ module Script
               e.extension_point_type
             ),
           }
-        when Layers::Domain::Errors::ServiceFailureError
-          {
-            cause_of_error: ShopifyCli::Context.message("script.error.service_failure_cause"),
-            help_suggestion: ShopifyCli::Context.message("script.error.service_failure_help"),
-          }
         when Layers::Domain::Errors::MetadataValidationError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.metadata_validation_cause"),
@@ -163,6 +158,15 @@ module Script
             ),
             help_suggestion: ShopifyCli::Context.message("script.error.config_ui_missing_keys_error_help"),
           }
+        when Layers::Infrastructure::Errors::ConfigUiInvalidInputModeError
+          {
+            cause_of_error: ShopifyCli::Context.message(
+              "script.error.config_ui_invalid_input_mode_error_cause",
+              filename: e.filename,
+              valid_input_modes: e.valid_input_modes
+            ),
+            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_invalid_input_mode_error_help"),
+          }
         when Layers::Infrastructure::Errors::ConfigUiFieldsMissingKeysError
           {
             cause_of_error: ShopifyCli::Context.message(
@@ -172,6 +176,15 @@ module Script
             ),
             help_suggestion: ShopifyCli::Context.message("script.error.config_ui_fields_missing_keys_error_help"),
           }
+        when Layers::Infrastructure::Errors::ConfigUiFieldsInvalidTypeError
+          {
+            cause_of_error: ShopifyCli::Context.message(
+              "script.error.config_ui_fields_invalid_type_error_cause",
+              filename: e.filename,
+              valid_types: e.valid_types
+            ),
+            help_suggestion: ShopifyCli::Context.message("script.error.config_ui_fields_invalid_type_error_help"),
+          }
         when Layers::Infrastructure::Errors::DependencyInstallError
           {
             cause_of_error: ShopifyCli::Context.message("script.error.dependency_install_cause"),
@@ -193,9 +206,15 @@ module Script
             ),
             help_suggestion: ShopifyCli::Context.message("script.error.graphql_error_help"),
           }
+        when Layers::Infrastructure::Errors::SystemCallFailureError
+          {
+            cause_of_error: ShopifyCli::Context
+              .message("script.error.system_call_failure_cause", cmd: e.cmd),
+            help_suggestion: ShopifyCli::Context.message("script.error.system_call_failure_help", out: e.out),
+          }
         when Layers::Infrastructure::Errors::ScriptRepushError
           {
-            cause_of_error: ShopifyCli::Context.message("script.error.script_repush_cause", e.api_key),
+            cause_of_error: ShopifyCli::Context.message("script.error.script_repush_cause", e.uuid),
             help_suggestion: ShopifyCli::Context.message("script.error.script_repush_help"),
           }
         when Layers::Infrastructure::Errors::ShopAuthenticationError

data/lib/shopify-cli/admin_api.rb

@@ -85,11 +85,14 @@ module ShopifyCli
 
       private
 
-      def authenticated_req(ctx, shop)
-        yield
+      def authenticated_req(ctx, shop, &block)
+        CLI::Kit::Util
+          .begin(&block)
+          .retry_after(API::APIRequestUnauthorizedError, retries: 1) do
+            authenticate(ctx, shop)
+          end
       rescue API::APIRequestUnauthorizedError
-        authenticate(ctx, shop)
-        retry
+        ctx.abort(ctx.message("core.api.error.failed_auth"))
       end
 
       def authenticate(ctx, shop)

data/lib/shopify-cli/js_system.rb

@@ -37,8 +37,8 @@ module ShopifyCli
       #
       #   ShopifyCli::JsSystem.call(ctx, yarn: ['install', '--silent'], npm: ['install', '--no-audit'])
       #
-      def call(ctx, yarn:, npm:)
-        JsSystem.new(ctx: ctx).call(yarn: yarn, npm: npm)
+      def call(ctx, yarn:, npm:, capture_response: false)
+        JsSystem.new(ctx: ctx).call(yarn: yarn, npm: npm, capture_response: capture_response)
       end
     end
 

data/lib/shopify-cli/messages/messages.rb

@@ -16,8 +16,8 @@ module ShopifyCli
       core: {
         connect: {
           help: <<~HELP,
-          Connect (or re-connect) an existing project to a Shopify partner organization and/or a store. Creates or updates the {{green:.env}} file, and creates the {{green:.shopify-cli.yml}} file.
-            Usage: {{command:%s connect}}
+            Connect (or re-connect) an existing project to a Shopify partner organization and/or a store. Creates or updates the {{green:.env}} file, and creates the {{green:.shopify-cli.yml}} file.
+              Usage: {{command:%s connect}}
           HELP
 
           already_connected_warning: "{{yellow:! This app appears to be already connected}}",
@@ -27,15 +27,15 @@ module ShopifyCli
 
         context: {
           open_url: <<~OPEN,
-          Please open this URL in your browser:
-          {{green:%s}}
+            Please open this URL in your browser:
+            {{green:%s}}
           OPEN
         },
 
         create: {
           help: <<~HELP,
-          Create a new project.
-            Usage: {{command:%s create [ %s ]}}
+            Create a new project.
+              Usage: {{command:%s create [ %s ]}}
           HELP
 
           error: {
@@ -53,13 +53,13 @@ module ShopifyCli
 
         config: {
           help: <<~HELP,
-          Change configuration of how the CLI operates
-            Usage: {{command:%s config [ feature | analytics ] }}
+            Change configuration of how the CLI operates
+              Usage: {{command:%s config [ feature | analytics ] }}
           HELP
           feature: {
             help: <<~HELP,
-            Change configuration of various features
-              Usage: {{command:%s config [ feature ] [ feature_name ] }}
+              Change configuration of various features
+                Usage: {{command:%s config [ feature ] [ feature_name ] }}
             HELP
             enabled: "{{v}} feature {{green:%s}} has been enabled",
             disabled: "{{v}} feature {{green:%s}} has been disabled",
@@ -68,8 +68,8 @@ module ShopifyCli
           },
           analytics: {
             help: <<~HELP,
-            Opt in/out of anonymous usage reporting
-              Usage: {{command:%s config [ analytics ] }}
+              Opt in/out of anonymous usage reporting
+                Usage: {{command:%s config [ analytics ] }}
             HELP
             enabled: "{{v}} analytics have been enabled",
             disabled: "{{v}} analytics have been disabled",
@@ -82,7 +82,8 @@ module ShopifyCli
           error: {
             directory_exists: "Project directory already exists. Please create a project with a new name.",
             no_branches_found: "Could not find any git branches",
-            repo_not_initiated: "Git repo is not initiated. Please run `git init` and make at least one commit.",
+            repo_not_initiated:
+              "Git repo is not initiated. Please run {{command:git init}} and make at least one commit.",
             no_commits_made: "No git commits have been made. Please make at least one commit.",
           },
 
@@ -96,9 +97,9 @@ module ShopifyCli
           },
 
           preamble: <<~MESSAGE,
-          Use {{command:%s help <command>}} to display detailed information about a specific command.
+            Use {{command:%s help <command>}} to display detailed information about a specific command.
 
-          {{bold:Available core commands:}}
+            {{bold:Available core commands:}}
 
           MESSAGE
         },
@@ -110,7 +111,7 @@ module ShopifyCli
             deploy: "Could not deploy to Heroku",
             download: "Heroku CLI could not be downloaded",
             install: "Could not install Heroku CLI",
-            could_not_select_app: "Heroku app `%s` could not be selected",
+            could_not_select_app: "Heroku app {{green:%s}} could not be selected",
           },
         },
 
@@ -130,8 +131,8 @@ module ShopifyCli
 
         logout: {
           help: <<~HELP,
-          Log out of a currently authenticated partner organization and store, or clear invalid credentials
-            Usage: {{command:%s logout}}
+            Log out of a currently authenticated partner organization and store, or clear invalid credentials
+              Usage: {{command:%s logout}}
           HELP
 
           success: "Logged out of partner organization and store",
@@ -153,6 +154,7 @@ module ShopifyCli
           location: {
             admin: "development store",
             partner: "Shopify Partners account",
+            shopifolk: "{{green:Shopify Employee account}}",
           },
           authentication_required:
             "{{i}} Authentication required. Login to the URL below with your %s credentials to continue.",
@@ -174,14 +176,15 @@ module ShopifyCli
           org_name_and_id: "%s (%s)",
           error: {
             account_not_found: <<~MESSAGE,
-            {{x}} error: Your account was not found. Please sign up at https://partners.shopify.com/signup
-            For authentication issues, run {{command:%s logout}} to clear invalid credentials
+              {{x}} error: Your account was not found. Please sign up at https://partners.shopify.com/signup
+              For authentication issues, run {{command:%s logout}} to clear invalid credentials
             MESSAGE
           },
         },
 
         api: {
           error: {
+            failed_auth: "Failed to authenticate with Shopify. Please try again later.",
             internal_server_error: "{{red:{{x}} An unexpected error occurred on Shopify.}}",
             internal_server_error_debug: "\n{{red:Response details:}}\n%s\n\n",
             invalid_url: "Invalid URL: %s",
@@ -195,16 +198,16 @@ module ShopifyCli
           },
           populating: "Populating %d %ss...",
           completion_message: <<~COMPLETION_MESSAGE,
-          Successfully added %d %s to {{green:%s}}
-          {{*}} View all %ss at {{underline:%s%ss}}
+            Successfully added %d %s to {{green:%s}}
+            {{*}} View all %ss at {{underline:%s%ss}}
           COMPLETION_MESSAGE
         },
 
         project: {
           error: {
             not_in_project: <<~MESSAGE,
-            {{x}} You are not in a Shopify app project
-            {{yellow:{{*}}}}{{reset: Run}}{{cyan: shopify create}}{{reset: to create your app}}
+              {{x}} You are not in a Shopify app project
+              {{yellow:{{*}}}}{{reset: Run}}{{cyan: shopify create}}{{reset: to create your app}}
             MESSAGE
           },
         },
@@ -225,10 +228,10 @@ module ShopifyCli
 
         system: {
           help: <<~HELP,
-          Print details about the development system.
-            Usage: {{command:%s system [all]}}
+            Print details about the development system.
+              Usage: {{command:%s system [all]}}
 
-          {{cyan:all}}: displays more details about development system and environment
+            {{cyan:all}}: displays more details about development system and environment
 
           HELP
 
@@ -239,8 +242,8 @@ module ShopifyCli
           header: "{{bold:Shopify App CLI}}",
           const: "%17s = %s",
           ruby_header: <<~RUBY_MESSAGE,
-          {{bold:Ruby (via RbConfig)}}
-            %s
+            {{bold:Ruby (via RbConfig)}}
+              %s
           RUBY_MESSAGE
           rb_config: "%-25s - RbConfig[\"%s\"]",
           command_header: "{{bold:Commands}}",
@@ -267,8 +270,8 @@ module ShopifyCli
           ensure_env: {
             organization_select: "To which partner organization does this project belong?",
             no_development_stores: <<~MESSAGE,
-            No development stores available.
-            Visit {{underline:https://partners.shopify.com/%d/stores}} to create one
+              No development stores available.
+              Visit {{underline:https://partners.shopify.com/%d/stores}} to create one
             MESSAGE
             development_store_select: "Which development store would you like to use?",
             app_select: "To which app does this project belong?",
@@ -305,7 +308,10 @@ module ShopifyCli
               no_development_stores: "{{x}} No Development Stores available.",
               no_organizations: "No partner organizations available.",
               organization_not_found: "Cannot find a partner organization with that ID",
-              partners_notice: "Please visit https://partners.shopify.com/ to create a partners account",
+              shopifolk_notice: <<~MESSAGE,
+                {{i}} As a {{green:Shopify}} employee, the authentication should take you to the Shopify Okta login,
+                NOT the Partner account login. Please run {{command:%s logout}} and try again.
+              MESSAGE
             },
             first_party: "Are you working on a 1P (1st Party) app?",
             identified_as_shopify: "We've identified you as a {{green:Shopify}} employee.",
@@ -326,9 +332,9 @@ module ShopifyCli
 
           not_running: "{{green:x}} ngrok tunnel not running",
           signup_suggestion: <<~MESSAGE,
-          {{*}} To avoid tunnels that timeout, it is recommended to signup for a free ngrok
-          account at {{underline:https://ngrok.com/signup}}. After you signup, install your
-          personalized authorization token using {{command:%s tunnel auth <token>}}.
+            {{*}} To avoid tunnels that timeout, it is recommended to signup for a free ngrok
+            account at {{underline:https://ngrok.com/signup}}. After you signup, install your
+            personalized authorization token using {{command:%s tunnel auth <token>}}.
           MESSAGE
           start: "{{v}} ngrok tunnel running at {{underline:%s}}",
           start_with_account: "{{v}} ngrok tunnel running at {{underline:%s}}, with account %s",
@@ -340,31 +346,31 @@ module ShopifyCli
 
         version: {
           help: <<~HELP,
-          Prints version number.
-            Usage: {{command:%s version}}
+            Prints version number.
+              Usage: {{command:%s version}}
           HELP
         },
 
         warning: {
           development_version: <<~DEVELOPMENT,
-          {{*}} {{yellow:You are running a development version of the CLI at:}}
-            {{yellow:%s}}
+            {{*}} {{yellow:You are running a development version of the CLI at:}}
+              {{yellow:%s}}
 
           DEVELOPMENT
 
           shell_shim: <<~MESSAGE,
-          {{x}} This version of Shopify App CLI is no longer supported. You’ll need to migrate to the new CLI version to continue.
+            {{x}} This version of Shopify App CLI is no longer supported. You’ll need to migrate to the new CLI version to continue.
 
-            Please visit this page for complete instructions:
-            {{underline:https://shopify.dev/tools/cli/troubleshooting#migrate-from-a-legacy-version}}
+              Please visit this page for complete instructions:
+              {{underline:https://shopify.dev/tools/cli/troubleshooting#migrate-from-a-legacy-version}}
 
           MESSAGE
 
           new_version: <<~MESSAGE,
-          {{*}} {{yellow:A new version of Shopify App CLI is available! You have version %s and the latest version is %s.
+            {{*}} {{yellow:A new version of Shopify App CLI is available! You have version %s and the latest version is %s.
 
-            To upgrade, follow the instructions for the package manager you’re using:
-            {{underline:https://shopify.dev/tools/cli/troubleshooting#upgrade-shopify-app-cli}}}}
+              To upgrade, follow the instructions for the package manager you’re using:
+              {{underline:https://shopify.dev/tools/cli/troubleshooting#upgrade-shopify-app-cli}}}}
 
           MESSAGE
         },

data/lib/shopify-cli/method_object.rb

@@ -52,8 +52,8 @@ module ShopifyCli
       # invokes the original `call` implementation and wraps its return value
       # into a result object.
       #
-      def call(*args, **kwargs)
-        Result.wrap { super(*args, **kwargs) }.call
+      def call(*args, **kwargs, &block)
+        Result.wrap { kwargs.any? ? super(*args, **kwargs, &block) : super(*args, &block) }.call
       end
     end
 
@@ -64,10 +64,10 @@ module ShopifyCli
       # initializer or to `call`. If the keyword argument matches the name of
       # property, it is forwarded to the initializer, otherwise to call.
       #
-      def call(*args, **kwargs)
+      def call(*args, **kwargs, &block)
         properties.keys.yield_self do |properties|
           new(**kwargs.slice(*properties))
-            .call(*args, **kwargs.slice(*(kwargs.keys - properties)))
+            .call(*args, **kwargs.slice(*(kwargs.keys - properties)), &block)
         end
       end
 

data/lib/shopify-cli/oauth.rb

@@ -24,10 +24,10 @@ module ShopifyCli
     property! :service, accepts: String
     property! :client_id, accepts: String
     property! :scopes
-    property :store, default: ShopifyCli::DB.new
+    property :store, default: -> { ShopifyCli::DB.new }
     property :secret, accepts: String
     property :request_exchange, accepts: String
-    property :options, default: {}, accepts: Hash
+    property :options, default: -> { {} }, accepts: Hash
     property :auth_path, default: "/authorize", accepts: ->(path) { path.is_a?(String) && path.start_with?("/") }
     property :token_path, default: "/token", accepts: ->(path) { path.is_a?(String) && path.start_with?("/") }
     property :state_token, accepts: String, default: SecureRandom.hex(30)
@@ -80,7 +80,13 @@ module ShopifyCli
     end
 
     def output_authentication_info(uri)
-      login_location = ctx.message(service == "admin" ? "core.oauth.location.admin" : "core.oauth.location.partner")
+      login_location = if service == "admin"
+        ctx.message("core.oauth.location.admin")
+      elsif Shopifolk.acting_as_shopify_organization?
+        ctx.message("core.oauth.location.shopifolk")
+      else
+        ctx.message("core.oauth.location.partner")
+      end
       ctx.puts(ctx.message("core.oauth.authentication_required", login_location))
       ctx.open_url!(uri)
     end