shopify-cli 1.0.1 → 1.1.0

data/lib/shopify-cli/heroku.rb

@@ -3,7 +3,7 @@ module ShopifyCli
     DOWNLOAD_URLS = {
       linux: 'https://cli-assets.heroku.com/heroku-linux-x64.tar.gz',
       mac: 'https://cli-assets.heroku.com/heroku-darwin-x64.tar.gz',
-      windows: 'https://cli-assets.heroku.com/heroku-win32-x64.tar.gz',
+      windows: 'https://cli-assets.heroku.com/heroku-x64.exe',
     }
 
     def initialize(ctx)
@@ -36,7 +36,7 @@ module ShopifyCli
     def download
       return if installed?
 
-      result = @ctx.system('curl', '-o', download_path, DOWNLOAD_URLS[@ctx.os], chdir: ShopifyCli::CACHE_DIR)
+      result = @ctx.system('curl', '-o', download_path, DOWNLOAD_URLS[@ctx.os], chdir: ShopifyCli.cache_dir)
       @ctx.abort(@ctx.message('core.heroku.error.download')) unless result.success?
       @ctx.abort(@ctx.message('core.heroku.error.download')) unless File.exist?(download_path)
     end
@@ -44,7 +44,11 @@ module ShopifyCli
     def install
       return if installed?
 
-      result = @ctx.system('tar', '-xf', download_path, chdir: ShopifyCli::CACHE_DIR)
+      result = if @ctx.windows?
+        @ctx.system(download_path)
+      else
+        @ctx.system('tar', '-xf', download_path, chdir: ShopifyCli.cache_dir)
+      end
       @ctx.abort(@ctx.message('core.heroku.error.install')) unless result.success?
 
       @ctx.rm(download_path)
@@ -70,7 +74,7 @@ module ShopifyCli
     end
 
     def download_path
-      File.join(ShopifyCli::CACHE_DIR, download_filename)
+      File.join(ShopifyCli.cache_dir, download_filename)
     end
 
     def git_remote
@@ -79,9 +83,21 @@ module ShopifyCli
     end
 
     def heroku_command
-      local_path = File.join(ShopifyCli::CACHE_DIR, 'heroku', 'bin', 'heroku').to_s
+      local_path = File.join(ShopifyCli.cache_dir, 'heroku', 'bin', 'heroku').to_s
       if File.exist?(local_path)
         local_path
+      elsif @ctx.windows?
+        # Check if Heroku exists in the Windows registry and run it from there
+        require 'win32/registry'
+        begin
+          windows_path = Win32::Registry::HKEY_CURRENT_USER.open('SOFTWARE\heroku') do |reg|
+            reg[''] # This reads the 'Default' registry key
+          end
+
+          File.join(windows_path, 'bin', 'heroku').to_s
+        rescue
+          'heroku'
+        end
       else
         'heroku'
       end

data/lib/shopify-cli/js_deps.rb

@@ -69,7 +69,7 @@ module ShopifyCli
       deps = parse_dependencies
       errors = nil
 
-      spinner_title = ctx.message('core.js_deps.installing_deps', deps.size)
+      spinner_title = ctx.message('core.js_deps.installing', @system.package_manager)
       success = CLI::UI::Spinner.spin(spinner_title, auto_debrief: false) do |spinner|
         _, errors, status = CLI::Kit::System.capture3(*cmd, env: @ctx.env, chdir: ctx.root)
         update_spinner_title_and_status(spinner, status, deps)
@@ -81,7 +81,7 @@ module ShopifyCli
 
     def update_spinner_title_and_status(spinner, status, deps)
       if status.success?
-        spinner.update_title(ctx.message('core.js_deps.installed_deps', deps.size))
+        spinner.update_title(ctx.message('core.js_deps.installed', deps.size))
       else
         spinner.update_title(ctx.message('core.js_deps.error.install_spinner_error', deps.size))
         CLI::UI::Spinner::TASK_FAILED

data/lib/shopify-cli/js_system.rb

@@ -64,8 +64,8 @@ module ShopifyCli
     #
     def yarn?
       @has_yarn ||= begin
-        _, status = CLI::Kit::System.capture2('which', 'yarn')
-        File.exist?(File.join(ctx.root, 'yarn.lock')) && status.success?
+        cmd_path = @ctx.which('yarn')
+        File.exist?(File.join(ctx.root, 'yarn.lock')) && !cmd_path.nil?
       end
     end
 

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

@@ -16,13 +16,6 @@ module ShopifyCli
           already_connected_warning: "{{yellow:! This app appears to be already connected}}",
           connected: "{{v}} Project now connected to {{green:%s}}",
           project_type_select: "What type of project would you like to connect?",
-          organization_select: "To which partner organization does this project belong?",
-          app_select: "To which app does this project belong?",
-          no_development_stores: <<~MESSAGE,
-          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?",
           cli_yml_saved: ".shopify-cli.yml saved to project root",
         },
 
@@ -52,6 +45,19 @@ module ShopifyCli
           saved: "%s saved to project root",
         },
 
+        config: {
+          help: <<~HELP,
+          Change configuration of how the CLI operates
+            Usage: {{command:%s config [ feature ] [ feature_name ] }}
+          HELP
+          feature: {
+            enabled: "{{v}} feature {{green:%s}} was enabled",
+            disabled: "{{v}} feature {{green:%s}} was disabled",
+            is_enabled: "{{v}} feature {{green:%s}} is enabled",
+            is_disabled: "{{v}} feature {{green:%s}} is disabled",
+          },
+        },
+
         git: {
           error: {
             directory_exists: "Project directory already exists. Please create a project with a new name.",
@@ -232,9 +238,21 @@ module ShopifyCli
 
         tasks: {
           ensure_env: {
-            api_key_question: "What is your Shopify API key?",
-            api_secret_key_question: "What is your Shopify API secret key?",
-            development_store_question: "What is your development store URL? (Example: my-dev-store.myshopify.com)",
+            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
+            MESSAGE
+            development_store_select: "Which development store would you like to use?",
+            app_select: "To which app does this project belong?",
+            no_apps: 'You have no apps to connect to, creating a new app.',
+            app_name: "App name",
+            app_type: {
+              select: "What type of app are you building?",
+              select_public: "Public: An app built for a wide merchant audience.",
+              select_custom: "Custom: An app custom built for a single client.",
+              selected: "App type {{green:%s}}",
+            },
           },
           ensure_dev_store: {
             could_not_verify_store: "Couldn't verify your store %s",
@@ -273,10 +291,17 @@ module ShopifyCli
             url_fetch_failure: "Unable to fetch external url",
           },
 
-          stopped: "{{green:x}} ngrok tunnel stopped",
           not_running: "{{green:x}} ngrok tunnel not running",
-          start_with_account: "{{v}} ngrok tunnel running at {{underline:%s}}, with account %s",
+          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>}}.
+          MESSAGE
           start: "{{v}} ngrok tunnel running at {{underline:%s}}",
+          start_with_account: "{{v}} ngrok tunnel running at {{underline:%s}}, with account %s",
+          stopped: "{{green:x}} ngrok tunnel stopped",
+          timed_out: "{{x}} ngrok tunnel has timed out, restarting ...",
+          will_timeout: "{{*}} This tunnel will timeout in {{red:%s}}",
         },
 
         version: {

data/lib/shopify-cli/partners_api/organizations.rb

@@ -4,25 +4,25 @@ module ShopifyCli
       class << self
         def fetch_all(ctx)
           resp = PartnersAPI.query(ctx, 'all_organizations')
-          resp['data']['organizations']['nodes'].map do |org|
-            org['stores'] = org['stores']['nodes']
+          (resp.dig('data', 'organizations', 'nodes') || []).map do |org|
+            org['stores'] = (org.dig('stores', 'nodes') || [])
             org
           end
         end
 
         def fetch(ctx, id:)
           resp = PartnersAPI.query(ctx, 'find_organization', id: id)
-          org = resp['data']['organizations']['nodes'].first
+          org = resp.dig('data', 'organizations', 'nodes').first
           return nil if org.nil?
-          org['stores'] = org['stores']['nodes']
+          org['stores'] = (org.dig('stores', 'nodes') || [])
           org
         end
 
         def fetch_with_app(ctx)
           resp = PartnersAPI.query(ctx, 'all_orgs_with_apps')
-          resp['data']['organizations']['nodes'].map do |org|
-            org['stores'] = org['stores']['nodes']
-            org['apps'] = org['apps']['nodes']
+          (resp.dig('data', 'organizations', 'nodes') || []).map do |org|
+            org['stores'] = (org.dig('stores', 'nodes') || [])
+            org['apps'] = (org.dig('apps', 'nodes') || [])
             org
           end
         end

data/lib/shopify-cli/process_supervision.rb

@@ -5,13 +5,10 @@ module ShopifyCli
   # ProcessSupervision wraps a running process spawned by `exec` and keeps track
   # if its `pid` and keeps a log file for it as well
   class ProcessSupervision
-    # is the directory where the pid and logfile are kept
-    RUN_DIR = File.join(ShopifyCli::CACHE_DIR, 'sv')
-
     # a string or a symbol to identify this process by
     attr_reader :identifier
     # process ID for the running process
-    attr_reader :pid
+    attr_accessor :pid
     # starttime of the process
     attr_reader :time
     # filepath to the pidfile for this process
@@ -20,6 +17,11 @@ module ShopifyCli
     attr_reader :log_path
 
     class << self
+      def run_dir
+        # is the directory where the pid and logfile are kept
+        File.join(ShopifyCli.cache_dir, 'sv')
+      end
+
       ##
       # Will find and create a new instance of ProcessSupervision for a running process
       # if it is currently running. It will return nil if the process is not running.
@@ -34,7 +36,7 @@ module ShopifyCli
       #   will be nil if the process is not running.
       #
       def for_ident(identifier)
-        pid, time = File.read(File.join(RUN_DIR, "#{identifier}.pid")).split(':')
+        pid, time = File.read(File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.pid")).split(':')
         new(identifier, pid: Integer(pid), time: time)
       rescue Errno::ENOENT
         nil
@@ -56,15 +58,37 @@ module ShopifyCli
       #
       def start(identifier, args)
         return for_ident(identifier) if running?(identifier)
-        fork do
-          pid_file = new(identifier, pid: Process.pid)
+
+        # Windows doesn't support forking process without extra gems, so we resort to spawning a new child process -
+        # that means that it dies along with the original process if it is interrupted. On UNIX, we fork the process so
+        # that it doesn't have to be restarted on every run.
+        if Context.new.windows?
+          pid_file = new(identifier)
+
+          # Make sure the file exists and is empty, otherwise Windows fails
+          File.open(pid_file.log_path, 'w') {}
+          pid = Process.spawn(
+            *args,
+            out: pid_file.log_path,
+            err: pid_file.log_path,
+            in: Context.new.windows? ? "nul" : "/dev/null",
+          )
+          pid_file.pid = pid
           pid_file.write
-          STDOUT.reopen(pid_file.log_path, "w")
-          STDERR.reopen(pid_file.log_path, "w")
-          STDIN.reopen("/dev/null", "r")
-          Process.setsid
-          exec(*args)
+
+          Process.detach(pid)
+        else
+          fork do
+            pid_file = new(identifier, pid: Process.pid)
+            pid_file.write
+            STDOUT.reopen(pid_file.log_path, "w")
+            STDERR.reopen(pid_file.log_path, "w")
+            STDIN.reopen("/dev/null", "r")
+            Process.setsid
+            exec(*args)
+          end
         end
+
         sleep(0.1)
         for_ident(identifier)
       end
@@ -104,24 +128,29 @@ module ShopifyCli
       end
     end
 
-    def initialize(identifier, pid:, time: Time.now.strftime('%s')) # :nodoc:
+    def initialize(identifier, pid: nil, time: Time.now.strftime('%s')) # :nodoc:
       @identifier = identifier
       @pid = pid
       @time = time
-      @pid_path = File.join(RUN_DIR, "#{identifier}.pid")
-      @log_path = File.join(RUN_DIR, "#{identifier}.log")
+      FileUtils.mkdir_p(ShopifyCli::ProcessSupervision.run_dir)
+      @pid_path = File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.pid")
+      @log_path = File.join(ShopifyCli::ProcessSupervision.run_dir, "#{identifier}.log")
     end
 
     ##
     # will attempt to shutdown a running process
     #
+    # #### Parameters
+    #
+    # * `ctx` - the context of this command
+    #
     # #### Returns
     #
     # * `stopped` - [true, false]
     #
     def stop
-      unlink
       kill_proc
+      unlink
       true
     rescue
       false
@@ -157,7 +186,11 @@ module ShopifyCli
     end
 
     def kill_proc
-      kill(-pid) # process group
+      if Context.new.windows?
+        kill(pid)
+      else
+        kill(-pid) # process group
+      end
     rescue Errno::ESRCH
       begin
         kill(pid)
@@ -167,12 +200,18 @@ module ShopifyCli
     end
 
     def kill(id)
-      Process.kill('TERM', id)
-      50.times do
-        sleep 0.1
-        break unless stat(id)
+      ctx = Context.new
+
+      # Windows does not handle SIGTERM, go straight to SIGKILL
+      unless ctx.windows?
+        Process.kill('TERM', id)
+        50.times do
+          sleep 0.1
+          break unless stat(id)
+        end
       end
       Process.kill('KILL', id) if stat(id)
+      sleep(0.1) if ctx.windows? # Give Windows a second to actually close the process
     end
 
     def stat(id)

data/lib/shopify-cli/project.rb

@@ -15,6 +15,10 @@ module ShopifyCli
       # will get an instance of the project that the user is currently operating
       # on. This is used for access to project resources.
       #
+      # #### Parameters
+      #
+      # * `force_reload` - whether to force a reload of the project files
+      #
       # #### Returns
       #
       # * `project` - a Project instance if the user is currently in the project.
@@ -29,8 +33,8 @@ module ShopifyCli
       #
       #   project = ShopifyCli::Project.current
       #
-      def current
-        at(Dir.pwd)
+      def current(force_reload: false)
+        at(Dir.pwd, force_reload: force_reload)
       end
 
       ##
@@ -93,13 +97,17 @@ module ShopifyCli
 
       private
 
-      def directory(dir)
+      def directory(dir, force_reload: false)
+        @dir = nil if force_reload
+
         @dir ||= Hash.new { |h, k| h[k] = __directory(k) }
         @dir[dir]
       end
 
-      def at(dir)
-        proj_dir = directory(dir)
+      def at(dir, force_reload: false)
+        @at = nil if force_reload
+
+        proj_dir = directory(dir, force_reload: force_reload)
         unless proj_dir
           raise(ShopifyCli::Abort, Context.message('core.project.error.not_in_project'))
         end
@@ -109,7 +117,7 @@ module ShopifyCli
 
       def __directory(curr)
         loop do
-          return nil if curr == '/'
+          return nil if curr == '/' || /^[A-Z]:\/$/.match?(curr)
           file = File.join(curr, '.shopify-cli.yml')
           return curr if File.exist?(file)
           curr = File.dirname(curr)

data/lib/shopify-cli/project_type.rb

@@ -1,11 +1,12 @@
 module ShopifyCli
   class ProjectType
+    extend Feature::Set
+
     class << self
       attr_accessor :project_type,
         :project_name,
         :project_creator_command_class,
         :project_load_shallow
-      attr_reader :hidden
 
       def repository
         @repository ||= []
@@ -13,6 +14,7 @@ module ShopifyCli
       alias_method :all_loaded, :repository
 
       def inherited(klass)
+        super
         repository << klass
         klass.project_type = @current_type
         klass.project_load_shallow = @shallow_load
@@ -31,7 +33,7 @@ module ShopifyCli
 
       def load_all
         Dir.glob(File.join(ShopifyCli::ROOT, 'lib', 'project_types', '*', 'cli.rb')).map do |filepath|
-          load_type(filepath.split(File::Separator)[-2], true)
+          load_type(filepath.split(File::Separator)[-2].to_sym, true)
         end
       end
 
@@ -53,10 +55,6 @@ module ShopifyCli
         const_get(@project_creator_command_class)
       end
 
-      def hidden_project_type
-        @hidden = true
-      end
-
       def register_command(const, cmd)
         return if project_load_shallow
         Context.new.abort(
@@ -67,7 +65,7 @@ module ShopifyCli
 
       def register_task(task, name)
         return if project_load_shallow
-        Task::Registry.add(const_get(task), name)
+        ShopifyCli::Task.register(task, name)
       end
 
       def register_messages(messages)