shopify-cli 0.9.0

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Script
+  module Layers
+    module Infrastructure
+      class TestSuiteRepository
+        ASPECT_DTS_FILENAME = "as-pect.d.ts"
+        ASPECT_DTS_FILE_CONTENTS = "/// <reference types=\"@as-pect/assembly/types/as-pect\" />"
+        BOOTSTRAP_TEST = "npx --no-install shopify-scripts-bootstrap test %{test_base}"
+
+        def create_test_suite(script)
+          # Remove this once we have a test suite for js
+          return unless script.language == "ts"
+
+          FileUtils.mkdir_p(test_base)
+          FileUtils.copy(aspect_config_template(script.language), "#{test_base}/as-pect.config.js")
+          out, status = CLI::Kit::System.capture2e(format(BOOTSTRAP_TEST, test_base: test_base))
+          raise Domain::Errors::ServiceFailureError, out unless status.success?
+
+          write_tsconfig_file
+          write_aspect_type_definitions_file
+        end
+
+        private
+
+        def test_dir
+          "test"
+        end
+
+        def test_base
+          "#{ScriptProject.current.directory}/#{test_dir}"
+        end
+
+        def aspect_config_template(language)
+          Project.project_filepath("templates/#{language}/as-pect.config.js")
+        end
+
+        def write_tsconfig_file
+          AssemblyScriptTsConfig
+            .new(dir_to_write_in: test_dir)
+            .with_extends_assemblyscript_config(relative_path_to_node_modules: ".")
+            .with_module_resolution_paths(paths: { "*": ["#{relative_path_to_source_dir}/*.ts"] })
+            .write
+        end
+
+        def relative_path_to_source_dir
+          src_path_from_root = ScriptRepository.new.relative_path_to_src
+          Pathname.new(src_path_from_root).relative_path_from(test_dir)
+        end
+
+        def write_aspect_type_definitions_file
+          File.write("#{test_base}/#{ASPECT_DTS_FILENAME}", ASPECT_DTS_FILE_CONTENTS)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+module Script
+  module Messages
+    MESSAGES = {
+      script: {
+        error: {
+          generic: "{{red:{{x}} Error}}",
+          eacces_cause: "You don't have permission to write to this directory.",
+          eacces_help: "Change your directory permissions and try again.",
+
+          enospc_cause: "You don't have enough disk space to perform this action.",
+          enospc_help: "Free up some space and try again.",
+
+          oauth_cause: "Something went wrong while authenticating your account with the Partner Dashboard.",
+          oauth_help: "Try again.",
+
+          invalid_context_cause: "Your .shopify-cli.yml file is not correct.",
+          invalid_context_help: "See https://help.shopify.com",
+
+          no_existing_apps_cause: "You don't have any apps.",
+          no_existing_apps_help: "Please create an app with {{command:shopify create}} or"\
+                                 "visit https://partners.shopify.com/.",
+
+          no_existing_orgs_cause: "You don't have any partner organizations.",
+          no_existing_orgs_help: "Please visit https://partners.shopify.com/ to create a partners account.",
+
+          no_existing_stores_cause: "You don't have any development stores.",
+          no_existing_stores_help: "Visit https://partners.shopify.com/%{organization_id}/stores/ to create one.",
+
+          project_exists_cause: "Directory with the same name as the script already exists.",
+          project_exists_help: "Use different script name and try again.",
+
+          invalid_extension_cause: "Invalid extension point %s",
+          invalid_extension_help: "Allowed values: %s.",
+
+          script_not_found_cause: "Couldn't find script %s for extension point %s",
+
+          app_not_installed_cause: "App not installed on development store.",
+
+          app_script_undefined_help: "Push script to app.",
+
+          build_error_cause: "Something went wrong while building the script.",
+          build_error_help: "Correct the errors and try again.",
+
+          dependency_install_cause: "Something went wrong while installing the dependencies that are needed.",
+          dependency_install_help: "Correct the errors and try again.",
+
+          forbidden_error_cause: "You do not have permission to do this action.",
+
+          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_help: "Use {{cyan:--force}} to replace the existing script.",
+
+          shop_auth_cause: "Unable to authenticate with the store.",
+          shop_auth_help: "Try again.",
+
+          shop_script_conflict_cause: "Another app in this store has already enabled a script "\
+                                      "on this extension point.",
+          shop_script_conflict_help: "Disable that script or uninstall that app and try again.",
+
+          shop_script_undefined_cause: "Script is already turned off in development store.",
+        },
+
+        create: {
+          help: <<~HELP,
+          {{command:%1$s create script}}: Creates a script project.
+            Usage: {{command:%1$s create script}}
+          HELP
+          extended_help: <<~HELP,
+            \s\sOptions:
+              \s\s{{command:--name=NAME}} Script project name. Use any string.
+              \s\s{{command:--extension_point=TYPE}} Extension point name. Allowed values: %2$s.
+          HELP
+
+          error: {
+            operation_failed: "Script not created.",
+          },
+
+          script_path: "{{v}} Project directory: {{green:%{folder}}}",
+          script_created: "{{v}} Script created: {{green:%{script_id}}}",
+          creating: "Creating script",
+          created: "Created script",
+        },
+
+        push: {
+          help: <<~HELP,
+          Build the script and put it into production. If you've already pushed a script with the same extension point, use --force to replace the current script with the newest one.
+            Usage: {{command:%s push}}
+          HELP
+          extended_help: <<~HELP,
+            \s\sOptions:
+              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
+              \s\s{{command:[--force]}} Forces the script to be overwritten if an instance of it already exists.
+          HELP
+
+          error: {
+            operation_failed: "Script not pushed.",
+          },
+
+          script_pushed: "{{v}} Script pushed to app (API key: %{api_key}).",
+        },
+
+        disable: {
+          help: <<~HELP,
+          Turn off script in development store.
+            Usage: {{command:%s disable}}
+          HELP
+          extended_help: <<~HELP,
+            \s\sOptions:
+              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
+              \s\s{{command:--shop_domain=<my_store.myshopify.com>}} Test store URL. Must be an existing test store.
+          HELP
+
+          error: {
+            operation_failed: "Can't disable script.",
+          },
+
+          script_disabled: "{{v}} Script disabled. Script is turned off in development store.",
+        },
+
+        enable: {
+          help: <<~HELP,
+          Turn on script in development store.
+            Usage: {{command:%s enable}}
+          HELP
+          extended_help: <<~HELP,
+            \s\sOptions:
+              \s\s{{command:--API_key=<API_key>}} API key. Must be a valid API key, otherwise store access fails.
+              \s\s{{command:--shop_domain=<my_store.myshopify.com>}} Test store URL. Must be an existing test store.
+          HELP
+
+          info: "{{*}} A script always remains enabled until you disable it - even after pushing "\
+                "script changes with the same extension point to an app. To disable a script, use "\
+                "the 'disable' command.",
+
+          error: {
+            operation_failed: "Can't enable script.",
+          },
+
+          script_enabled: "{{v}} Script enabled. %{type} script %{title} in app (API key: %{api_key}) "\
+                          "is turned on in development store {{green:%{shop_domain}}}",
+        },
+
+        project_deps: {
+          none_required: "{{v}} None required",
+          checking_with_npm: "Checking dependencies with npm",
+          installing: "Dependencies installing",
+          installed: "Missing dependencies installed",
+        },
+
+        test: {
+          help: <<~HELP,
+          Runs unit tests on your script.
+            Usage: {{command:%s test}}
+          HELP
+
+          error: {
+            operation_failed: "Tests didn't run or they ran with failures.",
+          },
+
+          running: "Running tests",
+          success: "{{v}} Tests finished.",
+        },
+
+        forms: {
+          create: {
+            select_extension_point: "Which extension point do you want to use?",
+            script_name: "Script Name",
+
+            error: {
+              invalid_name: "Invalid script name: replace or remove unsupported characters. Valid "\
+                            "characters are numbers, letters, spaces, hyphens, or underscores.",
+            },
+          },
+          script_form: {
+            ask_app_api_key_default: "Which app do you want this script to belong to?",
+            ask_shop_domain_default: "Select a development store",
+            fetching_organizations: "{{i}} Fetching partner organizations",
+            select_organization: "Select partner organization.",
+            using_app: "Using app {{green:%{title} (%{api_key})}}.",
+            using_development_store: "Using development store {{green:%{domain}}}",
+            using_organization: "Partner organization {{green:%s}}.",
+          },
+          enable: {
+            ask_app_api_key: "Which app is the script pushed to?",
+            ask_shop_domain: "Which development store is the app installed on?",
+          },
+        },
+
+        application: {
+          building: "Building",
+          building_script: "Building script",
+          built: "Built",
+          pushed: "{{v}} Pushed",
+          disabled: "{{v}} Disabled",
+          enabled: "{{v}} Enabled",
+        },
+      },
+    }.freeze
+  end
+end

data/lib/project_types/script/script_project.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Script
+  class ScriptProject < ShopifyCli::Project
+    SUPPORTED_LANGUAGES = %w(ts)
+
+    attr_reader :extension_point_type, :script_name, :language
+
+    def initialize(dir)
+      super(dir)
+      @extension_point_type = lookup_config('extension_point_type')
+      @script_name = lookup_config('script_name')
+      @language = 'ts'
+    end
+
+    private
+
+    def lookup_config(key)
+      raise Errors::InvalidContextError, key unless config.key?(key)
+      config[key]
+    end
+
+    class << self
+      def create(dir)
+        raise Errors::ScriptProjectAlreadyExistsError, dir if Dir.exist?(dir)
+
+        FileUtils.mkdir_p(dir)
+        Dir.chdir(dir)
+      end
+
+      def cleanup(ctx:, script_name:, root_dir:)
+        Dir.chdir(root_dir)
+        ctx.rm_r("#{root_dir}/#{script_name}") if Dir.exist?("#{root_dir}/#{script_name}")
+      end
+    end
+  end
+end

data/lib/project_types/script/templates/ts/as-pect.config.js

@@ -0,0 +1,21 @@
+module.exports = {
+    include: ["**/*.spec.ts"],
+    add: ["**/*.include.ts"],
+    flags: {
+        "--runtime": ["stub"],
+        "--lib": ["node_modules","src"]
+    },
+    disclude: [/node_modules/],
+    imports: {},
+    performance: {
+        enabled: false,
+        maxSamples: 10000,
+        maxTestRunTime: 5000,
+        reportMedian: true,
+        reportAverage: true,
+        reportStandardDeviation: false,
+        reportMax: false,
+        reportMin: false,
+    },
+    outputBinary: false,
+};

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

@@ -0,0 +1,136 @@
+require 'cli/ui'
+
+module Script
+  module UI
+    module ErrorHandler
+      def self.display(failed_op:, cause_of_error:, help_suggestion:)
+        $stderr.puts(CLI::UI.fmt(ShopifyCli::Context.message('script.error.generic')))
+        full_msg = failed_op ? failed_op.dup : ""
+        full_msg << " #{cause_of_error}" if cause_of_error
+        full_msg << " #{help_suggestion}" if help_suggestion
+        $stderr.puts(CLI::UI.fmt(full_msg.strip))
+      end
+
+      def self.display_and_raise(failed_op: nil, cause_of_error: nil, help_suggestion: nil)
+        display(failed_op: failed_op, cause_of_error: cause_of_error, help_suggestion: help_suggestion)
+        raise(ShopifyCli::AbortSilent)
+      end
+
+      def self.pretty_print_and_raise(e, failed_op: nil)
+        messages = error_messages(e)
+        raise e if messages.nil?
+        display_and_raise(failed_op: failed_op, **messages)
+      end
+
+      def self.error_messages(e)
+        case e
+        when Errno::EACCES
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.eacces_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.eacces_help'),
+          }
+        when Errno::ENOSPC
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.enospc_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.enospc_help'),
+          }
+        when ShopifyCli::OAuth::Error
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.oauth_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.oauth_help'),
+          }
+        when Errors::InvalidContextError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.invalid_context_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.invalid_context_help'),
+          }
+        when Errors::NoExistingAppsError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.no_existing_apps_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.no_existing_apps_help'),
+          }
+        when Errors::NoExistingOrganizationsError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.no_existing_orgs_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.no_existing_orgs_help'),
+          }
+        when Errors::NoExistingStoresError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.no_existing_stores_cause'),
+            help_suggestion: ShopifyCli::Context.message(
+              'script.error.no_existing_stores_help',
+              organization_id: e.organization_id
+            ),
+          }
+        when Errors::ScriptProjectAlreadyExistsError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.project_exists_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.project_exists_help'),
+          }
+        when Layers::Domain::Errors::InvalidExtensionPointError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.invalid_extension_cause', e.type),
+            help_suggestion: ShopifyCli::Context.message(
+              'script.error.invalid_extension_help',
+             Script::Layers::Application::ExtensionPoints.types.join(', ')
+            ),
+          }
+        when Layers::Domain::Errors::ScriptNotFoundError
+          {
+            cause_of_error: ShopifyCli::Context.message(
+              'script.error.script_not_found_cause',
+              e.script_name,
+              e.extension_point_type
+            ),
+          }
+        when Layers::Infrastructure::Errors::AppNotInstalledError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.app_not_installed_cause'),
+          }
+        when Layers::Infrastructure::Errors::AppScriptUndefinedError
+          {
+            help_suggestion: ShopifyCli::Context.message('script.error.app_script_undefined_help'),
+          }
+        when Layers::Infrastructure::Errors::BuildError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.build_error_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.build_error_help'),
+          }
+        when Layers::Infrastructure::Errors::DependencyInstallError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.dependency_install_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.dependency_install_help'),
+          }
+        when Layers::Infrastructure::Errors::ForbiddenError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.forbidden_error_cause'),
+          }
+        when Layers::Infrastructure::Errors::GraphqlError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.graphql_error_cause', e.errors.join(', ')),
+            help_suggestion: ShopifyCli::Context.message('script.error.graphql_error_help'),
+          }
+        when Layers::Infrastructure::Errors::ScriptRepushError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.script_repush_cause', e.api_key),
+            help_suggestion: ShopifyCli::Context.message('script.error.script_repush_help'),
+          }
+        when Layers::Infrastructure::Errors::ShopAuthenticationError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.shop_auth_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.shop_auth_help'),
+          }
+        when Layers::Infrastructure::Errors::ShopScriptConflictError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.shop_script_conflict_cause'),
+            help_suggestion: ShopifyCli::Context.message('script.error.shop_script_conflict_help'),
+          }
+        when Layers::Infrastructure::Errors::ShopScriptUndefinedError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.shop_script_undefined_cause'),
+          }
+        end
+      end
+    end
+  end
+end