shopify-cli 1.0.5 → 1.3.0

data/lib/project_types/rails/gem.rb

@@ -15,30 +15,65 @@ module Rails
         version = args.shift
         gem = new(ctx: ctx, name: name, version: version)
         ctx.debug(ctx.message('rails.gem.installed_debug', name, gem.installed?))
-        gem.install! unless gem.installed?
+        gem.installed? ? true : gem.install!
       end
 
       def binary_path_for(ctx, binary)
-        File.join(gem_home(ctx), 'bin', binary)
+        path_to_binary = File.join(gem_home(ctx), 'bin', binary)
+        File.exist?(path_to_binary) ? path_to_binary : binary
       end
 
       def gem_home(ctx)
         ctx.getenv('GEM_HOME') || apply_gem_home(ctx)
       end
 
+      def gem_path(ctx)
+        ctx.getenv('GEM_PATH') || apply_gem_path(ctx)
+      end
+
       private
 
       def apply_gem_home(ctx)
-        path = File.join(ctx.getenv('HOME'), '.gem', 'ruby', RUBY_VERSION)
+        path = ''
+        # extract GEM_HOME from `gem environment home` command
+        out, stat = ctx.capture2e('gem', 'environment', 'home')
+        path = out&.empty? ? '' : out.strip if stat.success?
+        # fallback if return from `gem environment home` is empty (somewhat unlikely)
+        path = fallback_gem_home_path(ctx) if path.empty?
+        # fallback if path isn't writable (if using a system installed ruby)
+        path = fallback_gem_home_path(ctx) unless File.writable?(path)
         ctx.mkdir_p(path) unless Dir.exist?(path)
+        ctx.debug(ctx.message('rails.gem.setting_gem_home', path))
         ctx.setenv('GEM_HOME', path)
       end
+
+      def apply_gem_path(ctx)
+        path = ''
+        out, stat = ctx.capture2e('gem', 'environment', 'path')
+        path = out&.empty? ? '' : out.strip if stat.success?
+        # usually GEM_PATH already contains GEM_HOME
+        # if gem_home() falls back to our fallback path, we need to add it
+        path = gem_home(ctx) + File::PATH_SEPARATOR + path unless path.include?(gem_home(ctx))
+        ctx.debug(ctx.message('rails.gem.setting_gem_path', path))
+        ctx.setenv('GEM_PATH', path)
+      end
+
+      def fallback_gem_home_path(ctx)
+        File.join(ctx.getenv('HOME'), '.gem', 'ruby', RUBY_VERSION)
+      end
     end
 
     def installed?
-      !!Dir.glob("#{self.class.gem_home(ctx)}/gems/#{name}-*").detect do |f|
-        f =~ %r{/#{Regexp.quote(name)}-\d}
+      found = false
+      paths = self.class.gem_path(ctx).split(File::PATH_SEPARATOR)
+      paths.each do |path|
+        ctx.debug(ctx.message('rails.gem.checking_installation_path', "#{path}/gems/", name))
+        found = !!Dir.glob("#{path}/gems/#{name}-*").detect do |f|
+          gem_satisfies_version?(f)
+        end
+        break if found
       end
+      found
     end
 
     def install!
@@ -46,11 +81,31 @@ module Rails
       spin.add(ctx.message('rails.gem.installing', name)) do |spinner|
         args = %w(gem install)
         args.push(name)
-        args.push('-v', version) unless version.nil?
+        unless version.nil?
+          if ctx.windows? && version.include?('~')
+            args.push('-v', "\"#{version}\"")
+          else
+            args.push('-v', version)
+          end
+        end
         ctx.system(*args)
         spinner.update_title(ctx.message('rails.gem.installed', name))
       end
       spin.wait
     end
+
+    def gem_satisfies_version?(path)
+      if version
+        # there was a specific version given during new(), so
+        # check version of gem found to determine match
+        require 'semantic/semantic'
+        found_version, _ = path.match(%r{/#{Regexp.quote(name)}-([\d\.]+)})&.captures
+        found_version.nil? ? false : Semantic::Version.new(found_version).satisfies?(version)
+      else
+        # otherwise ignore the actual version number,
+        # just check there's an initial digit
+        %r{/#{Regexp.quote(name)}-\d}.match?(path)
+      end
+    end
   end
 end

data/lib/project_types/rails/messages/messages.rb

@@ -9,9 +9,12 @@ module Rails
         },
 
         gem: {
+          checking_installation_path: "Checking path %s for gem %s",
+          installed: "Installed %s gem",
           installed_debug: "%s installed: %s",
           installing: "Installing %s gem...",
-          installed: "Installed %s gem",
+          setting_gem_home: "GEM_HOME being set to %s",
+          setting_gem_path: "GEM_PATH being set to %s",
         },
 
         create: {
@@ -33,6 +36,15 @@ module Rails
             See {{underline:https://github.com/Shopify/shopify-app-cli/blob/master/docs/installing-ruby.md}}
             for our recommended method of installing ruby.
             MSG
+            dir_exists: "Project directory %s already exists. Please use a different name.",
+            install_failure: "Error installing %s gem",
+            node_required: "node is required to create a rails project. Download at https://nodejs.org/en/download.",
+            node_version_failure: "Failed to get the current node version. Please make sure it is installed as " \
+              "per the instructions at https://nodejs.org/en.",
+            yarn_required: "yarn is required to create a rails project. Download at " \
+              "https://classic.yarnpkg.com/en/docs/install.",
+            yarn_version_failure: "Failed to get the current yarn version. Please make sure it is installed as per " \
+              "the instructions at https://classic.yarnpkg.com/en/docs/install.",
           },
 
           info: {
@@ -40,13 +52,18 @@ module Rails
             serve: "{{*}} Change directories to your new project folder {{green:%s}} and run {{command:%s serve}} " \
               "to start a local server",
             install: "{{*}} Then, visit {{underline:%s/test}} to install {{green:%s}} on your Dev Store",
+            open_new_shell: "{{*}} {{yellow:After installing %s, please open a new Command Prompt or PowerShell " \
+              "window to continue.}}",
           },
-          installing_bundler: "Installing bundler…",
+          installing_bundler: "Installing bundler...",
           generating_app: "Generating new rails app project in %s...",
-          adding_shopify_gem: "{{v}} Adding shopify_app gem…",
+          adding_shopify_gem: "{{v}} Adding shopify_app gem...",
+          node_version: "node %s",
+          yarn_version: "yarn %s",
           running_bundle_install: "Running bundle install...",
           running_generator: "Running shopify_app generator...",
-          running_migrations: "Running migrations…",
+          running_migrations: "Running migrations...",
+          running_webpacker_install: "Running webpacker:install...",
         },
 
         deploy: {
@@ -65,14 +82,14 @@ module Rails
             Deploy the current Rails project to Heroku
             Usage: {{command:%s deploy heroku}}
             HELP
-            downloading: "Downloading Heroku CLI…",
+            downloading: "Downloading Heroku CLI...",
             downloaded: "Downloaded Heroku CLI",
-            installing: "Installing Heroku CLI…",
+            installing: "Installing Heroku CLI...",
             installed: "Installed Heroku CLI",
             authenticated_with_account: "{{v}} Authenticated with Heroku as `%s`",
-            authenticating: "Authenticating with Heroku…",
+            authenticating: "Authenticating with Heroku...",
             authenticated: "{{v}} Authenticated with Heroku",
-            deploying: "Deploying to Heroku…",
+            deploying: "Deploying to Heroku...",
             deployed: "{{v}} Deployed to Heroku",
             db_check: {
               validating: "Validating application...",
@@ -86,7 +103,7 @@ module Rails
               SQLITE
             },
             git: {
-              checking: "Checking git repo…",
+              checking: "Checking git repo...",
               initialized: "Git repo initialized",
               what_branch: "What branch would you like to deploy?",
               branch_selected: "{{v}} Git branch `%s` selected for deploy",
@@ -95,10 +112,10 @@ module Rails
               no_apps_found: "No existing Heroku app found. What would you like to do?",
               name: "What is your Heroku app’s name?",
               select: "Specify an existing Heroku app",
-              selecting: "Selecting Heroku app `%s`…",
+              selecting: "Selecting Heroku app `%s`...",
               selected: "{{v}} Heroku app `%s` selected",
               create: "Create a new Heroku app",
-              creating: "Creating new Heroku app…",
+              creating: "Creating new Heroku app...",
               created: "{{v}} New Heroku app created",
             },
           },
@@ -203,7 +220,10 @@ module Rails
             host_must_be_https: "{{red:HOST must be a HTTPS url.}}",
           },
 
-          open_info: "{{*}} Press {{yellow: Control-T}} to open this project in {{green:%s}} ",
+          open_info: <<~MESSAGE,
+            {{*}} To install and start using your app, open this URL in your browser:
+            {{green:%s}}
+          MESSAGE
           running_server: "Running server...",
         },
 

data/lib/project_types/script/config/extension_points.yml

@@ -1,24 +1,24 @@
 discount:
   assemblyscript:
     package: "@shopify/extension-point-as-discount"
-    version: "^0.2.4"
+    version: "^0.2.10"
     sdk-version: "^6.0.0"
     toolchain-version: "^1.1.0"
 unit_limit_per_order:
   assemblyscript:
     package: "@shopify/extension-point-as-unit-limit-per-order"
-    version: "^0.1.8"
+    version: "^0.1.12"
     sdk-version: "^6.0.0"
     toolchain-version: "^1.1.0"
 payment_filter:
   assemblyscript:
     package: "@shopify/extension-point-as-payment-filter"
-    version: "^0.2.3"
+    version: "^0.2.8"
     sdk-version: "^6.0.0"
     toolchain-version: "^1.1.0"
 shipping_filter:
   assemblyscript:
     package: "@shopify/extension-point-as-shipping-filter"
-    version: "^0.2.4"
+    version: "^0.2.10"
     sdk-version: "^6.0.0"
     toolchain-version: "^1.1.0"

data/lib/project_types/script/forms/create.rb

@@ -2,7 +2,7 @@
 
 module Script
   module Forms
-    class Create < ScriptForm
+    class Create < ShopifyCli::Form
       flag_arguments :extension_point, :name
 
       def ask

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

@@ -34,7 +34,9 @@ module Script
 
         def dependencies_installed?
           # Assuming if node_modules folder exist at root of script folder, all deps are installed
-          ctx.dir_exist?("node_modules")
+          return false unless ctx.dir_exist?("node_modules")
+          check_if_ep_dependencies_up_to_date!
+          true
         end
 
         private
@@ -58,6 +60,39 @@ module Script
         def bytecode
           File.read(format(BYTECODE_FILE, name: script_name))
         end
+
+        def check_if_ep_dependencies_up_to_date!
+          return true if ENV['SHOPIFY_CLI_SCRIPTS_IGNORE_OUTDATED']
+
+          # ignore exit code since it will not be 0 unless every package is up to date which they probably won't be
+          out, _ = ctx.capture2e("npm", "outdated", "--json", "--depth", "0")
+          parsed_outdated_check = JSON.parse(out)
+          outdated_ep_packages = parsed_outdated_check
+            .select { |package_name, _| package_name.start_with?('@shopify/extension-point-as-') }
+            .select { |_, version_info| !package_is_up_to_date?(version_info) }
+            .keys
+          raise Errors::PackagesOutdatedError.new(outdated_ep_packages),
+            "NPM packages out of date: #{outdated_ep_packages.join(', ')}" unless outdated_ep_packages.empty?
+        end
+
+        def package_is_up_to_date?(version_info)
+          require 'semantic/semantic'
+          current_version = version_info['current']
+          latest_version = version_info['latest']
+
+          # making an assumption that the script developer knows what they're doing if they're not referencing a
+          # semver version
+          begin
+            current_version = ::Semantic::Version.new(current_version)
+            latest_version = ::Semantic::Version.new(latest_version)
+          rescue ArgumentError
+            return true
+          end
+
+          return false if current_version.major < latest_version.major
+          return false if latest_version.major == 0 && current_version.minor < latest_version.minor
+          true
+        end
       end
     end
   end

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

@@ -34,6 +34,13 @@ module Script
         class ShopScriptConflictError < ScriptProjectError; end
         class ShopScriptUndefinedError < ScriptProjectError; end
         class TaskRunnerNotFoundError < ScriptProjectError; end
+        class PackagesOutdatedError < ScriptProjectError
+          attr_reader :outdated_packages
+          def initialize(outdated_packages)
+            super("EP packages are outdated and need to be updated: #{outdated_packages.join(', ')}")
+            @outdated_packages = outdated_packages
+          end
+        end
       end
     end
   end

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

@@ -49,7 +49,7 @@ module Script
           resp_hash = script_service_request(
             query_name: query_name,
             api_key: api_key,
-            shop_domain: shop_domain,
+            shop_domain: format_shop_domain(shop_domain),
             variables: variables,
           )
           user_errors = resp_hash["data"]["shopScriptUpdateOrCreate"]["userErrors"]
@@ -76,7 +76,7 @@ module Script
           resp_hash = script_service_request(
             query_name: query_name,
             api_key: api_key,
-            shop_domain: shop_domain,
+            shop_domain: format_shop_domain(shop_domain),
             variables: variables,
           )
           user_errors = resp_hash["data"]["shopScriptDelete"]["userErrors"]
@@ -91,6 +91,10 @@ module Script
 
         private
 
+        def format_shop_domain(shop_domain)
+          shop_domain.delete_suffix("/")
+        end
+
         class ScriptServiceAPI < ShopifyCli::API
           property(:api_key, accepts: String)
           property(:shop_id, accepts: Integer)

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

@@ -29,7 +29,7 @@ module Script
           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_cause: "You don't have any 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.",
@@ -43,11 +43,9 @@ module Script
 
           script_not_found_cause: "Couldn't find script %s for extension point %s",
 
-          app_not_installed_cause: "App not installed on development store.",
+          app_not_installed_cause: "App not installed on store.",
 
-          app_script_not_pushed_help: "Push the script and then try this command again.",
-
-          app_script_undefined_help: "Push script to app.",
+          app_script_not_pushed_help: "Script isn't on the app. Run {{command:shopify push}}, and then try again.",
 
           build_error_cause: "Something went wrong while building the script.",
           build_error_help: "Correct the errors and try again.",
@@ -70,7 +68,10 @@ module 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.",
+          shop_script_undefined_cause: "Script is already turned off in store.",
+
+          packages_outdated_cause: "The following npm packages are out of date: %s.",
+          packages_outdated_help: "Update them by running {{cyan:npm install --save-dev %s}}.",
         },
 
         create: {
@@ -100,7 +101,7 @@ module Script
           HELP
 
           error: {
-            operation_failed: "Script not pushed.",
+            operation_failed: "Couldn't push script to app.",
           },
 
           script_pushed: "{{v}} Script pushed to app (API key: %{api_key}).",
@@ -108,21 +109,20 @@ module Script
 
         disable: {
           help: <<~HELP,
-          Turn off script in development store.
+          Turn off script in store.
             Usage: {{command:%s disable}}
           HELP
 
           error: {
             operation_failed: "Can't disable script.",
-            not_pushed_to_app: "Can't disable the script because it hasn't been pushed to the app.",
           },
 
-          script_disabled: "{{v}} Script disabled. Script is turned off in development store.",
+          script_disabled: "{{v}} Script disabled. Script is turned off in store.",
         },
 
         enable: {
           help: <<~HELP,
-          Turn on script in development store.
+          Turn on script in store.
             Usage: {{command:%s enable}}
             Options:
               {{command:--config_props='name1:value1, name2:value2'}} Optional. Define the configuration of your script by passing individual name and value pairs. If used with --config_file, then matching values in --config_props will override those set in the file.
@@ -135,11 +135,10 @@ module Script
 
           error: {
             operation_failed: "Can't enable script.",
-            not_pushed_to_app: "Can't enable the script because it hasn't been pushed to the app.",
           },
 
           script_enabled: "{{v}} Script enabled. %{type} script %{title} in app (API key: %{api_key}) "\
-                          "is turned on in development store {{green:%{shop_domain}}}",
+                          "is turned on in store {{green:%{shop_domain}}}",
         },
 
         project_deps: {
@@ -149,35 +148,11 @@ module Script
           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",
           },
-          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: "Fetching partner organizations",
-            fetched_organizations: "Fetched 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}}.",
-          },
         },
 
         application: {