shopify-cli 1.9.1 → 1.13.1

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Script
+  module Layers
+    module Infrastructure
+      module Languages
+        class TaskRunner
+          TASK_RUNNERS = {
+            "assemblyscript" => AssemblyScriptTaskRunner,
+            "rust" => RustTaskRunner,
+          }
+
+          def self.for(ctx, language, script_name)
+            raise Errors::TaskRunnerNotFoundError unless TASK_RUNNERS[language]
+            TASK_RUNNERS[language].new(ctx, script_name)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module Script
         property! :ctx, accepts: ShopifyCli::Context
 
         def create_push_package(script_project:, script_content:, compiled_type:, metadata:)
-          build_file_path = file_path(script_project.id, script_project.script_name, compiled_type)
+          build_file_path = file_path(script_project.id, compiled_type)
           write_to_path(build_file_path, script_content)
 
           Domain::PushPackage.new(
@@ -24,11 +24,10 @@ module Script
         end
 
         def get_push_package(script_project:, compiled_type:, metadata:)
-          build_file_path = file_path(script_project.id, script_project.script_name, compiled_type)
+          build_file_path = file_path(script_project.id, compiled_type)
           raise Domain::PushPackageNotFoundError unless ctx.file_exist?(build_file_path)
 
           script_content = ctx.binread(build_file_path)
-
           Domain::PushPackage.new(
             id: build_file_path,
             uuid: script_project.uuid,
@@ -48,8 +47,8 @@ module Script
           ctx.binwrite(path, content)
         end
 
-        def file_path(path_to_script, script_name, compiled_type)
-          "#{path_to_script}/build/#{script_name}.#{compiled_type}"
+        def file_path(path_to_script, compiled_type)
+          "#{path_to_script}/build/script.#{compiled_type}"
         end
       end
     end

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

@@ -13,15 +13,9 @@ module Script
         def create(script_name:, extension_point_type:, language:, no_config_ui:)
           validate_metadata!(extension_point_type, language)
 
-          optional_identifiers = {}
           config_ui_file = nil
-
-          unless no_config_ui
-            optional_identifiers.merge!(config_ui_file: DEFAULT_CONFIG_UI_FILENAME)
-            config_ui_file = ConfigUiRepository
-              .new(ctx: ctx)
-              .create(DEFAULT_CONFIG_UI_FILENAME, default_config_ui_content(script_name))
-          end
+          optional_identifiers = {}
+          optional_identifiers.merge!(config_ui_file: DEFAULT_CONFIG_UI_FILENAME) unless no_config_ui
 
           ShopifyCli::Project.write(
             ctx,
@@ -76,6 +70,25 @@ module Script
           )
         end
 
+        def create_env(api_key:, secret:, uuid:)
+          ShopifyCli::Resources::EnvFile.new(
+            api_key: api_key,
+            secret: secret,
+            extra: {
+              Domain::ScriptProject::UUID_ENV_KEY => uuid,
+            }
+          ).write(ctx)
+
+          Domain::ScriptProject.new(
+            id: ctx.root,
+            env: project.env,
+            script_name: script_name,
+            extension_point_type: extension_point_type,
+            language: language,
+            config_ui: ConfigUiRepository.new(ctx: ctx).get(config_ui_file),
+          )
+        end
+
         private
 
         def capture_io(&block)
@@ -109,18 +122,7 @@ module Script
         end
 
         def project
-          ShopifyCli::Project.current
-        end
-
-        def default_config_ui_content(title)
-          require "yaml" # takes 20ms, so deferred as late as possible.
-          YAML.dump({
-            "version" => 1,
-            "inputMode" => "single",
-            "title" => title,
-            "description" => "",
-            "fields" => [],
-          })
+          @project ||= ShopifyCli::Project.current(force_reload: true)
         end
 
         def default_language
@@ -139,15 +141,6 @@ module Script
           include SmartProperties
           property! :ctx, accepts: ShopifyCli::Context
 
-          def create(filename, content)
-            File.write(filename, content)
-
-            Domain::ConfigUi.new(
-              filename: filename,
-              content: content,
-            )
-          end
-
           def get(filename)
             return nil unless filename
 

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

@@ -40,7 +40,7 @@ module Script
           return resp_hash["data"]["appScriptUpdateOrCreate"]["appScript"]["uuid"] if user_errors.empty?
 
           if user_errors.any? { |e| e["tag"] == "already_exists_error" }
-            raise Errors::ScriptRepushError, api_key
+            raise Errors::ScriptRepushError, uuid
           elsif (e = user_errors.any? { |err| err["tag"] == "config_ui_syntax_error" })
             raise Errors::ConfigUiSyntaxError, config_ui&.filename
           elsif (e = user_errors.find { |err| err["tag"] == "config_ui_missing_keys_error" })
@@ -58,6 +58,12 @@ module Script
           end
         end
 
+        def get_app_scripts(api_key:, extension_point_type:)
+          query_name = "get_app_scripts"
+          variables = { appKey: api_key, extensionPointName: extension_point_type.upcase }
+          script_service_request(query_name: query_name, api_key: api_key, variables: variables)["data"]["appScripts"]
+        end
+
         private
 
         class ScriptServiceAPI < ShopifyCli::API

data/lib/project_types/script/messages/messages.rb

@@ -78,8 +78,8 @@ module Script
 
           script_not_found_cause: "Couldn't find script %s for extension point %s",
 
-          service_failure_cause: "Internal service error.",
-          service_failure_help: "Ensure the 'shopify/scripts-toolchain-as' package is up to date.",
+          system_call_failure_cause: "An error was returned while running {{command:%{cmd}}}.",
+          system_call_failure_help: "Review the following error and try again.\n{{red:%{out}}}",
 
           metadata_validation_cause: "Invalid script extension metadata.",
           metadata_validation_help: "Ensure the 'shopify/scripts-toolchain-as' package is up to date.",
@@ -113,7 +113,7 @@ module Script
           graphql_error_cause: "An error was returned: %s.",
           graphql_error_help: "\nReview the error and try again.",
 
-          script_repush_cause: "A script with the same extension point already exists on app (API key: %s).",
+          script_repush_cause: "A script with this UUID already exists (UUID: %s).",
           script_repush_help: "Use {{cyan:--force}} to replace the existing script.",
 
           shop_auth_cause: "Unable to authenticate with the store.",
@@ -161,7 +161,8 @@ module Script
           HELP
 
           error: {
-            operation_failed: "Couldn't push script to app (API key: %{api_key}).",
+            operation_failed_with_api_key: "Couldn't push script to app (API key: %{api_key}).",
+            operation_failed_no_api_key: "Couldn't push script to app.",
           },
 
           script_pushed: "{{v}} Script pushed to app (API key: %{api_key}).",
@@ -192,6 +193,15 @@ module Script
           disabled: "Disabled",
           enabling: "Enabling",
           enabled: "Enabled",
+          ensure_env: {
+            organization: "Partner organization {{green:%s (%s)}}.",
+            organization_select: "Which partner organization do you want to use?",
+            app: "Script will be pushed to app {{green:%s}}.",
+            app_select: "Which app do you want to push this script to?",
+            ask_connect_to_existing_script: "The selected app has some scripts. Do you want to replace any of the "\
+              "existing scripts with the current script?",
+            ask_which_script_to_connect_to: "Which script do you want to replace?",
+          },
         },
       },
     }.freeze

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

@@ -0,0 +1,104 @@
+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
+        return stubbed_org if partner_proxy_bypass
+
+        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 stubbed_org
+        {
+          "apps" => [
+            {
+              "appType" => "custom",
+              "apiKey" => "stubbed-api-key",
+              "apiSecretKeys" => [{ "secret" => "stubbed-api-secret" }],
+              "title" => "Fake App (Not connected to Partners)",
+            },
+          ],
+        }
+      end
+
+      def partner_proxy_bypass
+        !ENV["BYPASS_PARTNERS_PROXY"].nil?
+      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"),
@@ -211,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/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",
@@ -97,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
         },
@@ -131,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",
@@ -154,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.",
@@ -175,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",
@@ -196,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
           },
         },
@@ -226,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
 
@@ -240,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}}",
@@ -268,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?",
@@ -306,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.",
@@ -327,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",
@@ -341,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
         },