shopify-cli 0.9.2 → 1.0.3

data/lib/shopify-cli/commands/create.rb

@@ -28,7 +28,7 @@ module ShopifyCli
       def self.all_visible_type
         ProjectType
           .load_all
-          .select { |type| !type.hidden }
+          .select { |type| !type.hidden? }
       end
 
       def self.help

data/lib/shopify-cli/commands/help.rb

@@ -47,7 +47,7 @@ module ShopifyCli
 
       def core_commands
         resolved_commands
-          .select { |_name, c| !c.hidden }
+          .select { |_name, c| !c.hidden? }
           .select { |name, _c| Commands.core_command?(name) }
       end
 

data/lib/shopify-cli/commands/system.rb

@@ -4,7 +4,7 @@ require 'rbconfig'
 module ShopifyCli
   module Commands
     class System < ShopifyCli::Command
-      hidden_command
+      hidden_feature(feature_set: :debug)
 
       def call(args, _name)
         show_all_details = false

data/lib/shopify-cli/context.rb

@@ -146,10 +146,19 @@ module ShopifyCli
     # #### Parameters
     # * `path` - the file path to a directory, relative to the context root to remove from the FS
     #
-    def exist?(path)
+    def dir_exist?(path)
       Dir.exist?(ctx_path(path))
     end
 
+    # checks if a file exists, the filepath is relative to the command root unless absolute
+    #
+    # #### Parameters
+    # * `path` - the file path to a file, relative to the context root to remove from the FS
+    #
+    def file_exist?(path)
+      File.exist?(ctx_path(path))
+    end
+
     # will recursively copy a directory from the FS, the filepath is relative to the command
     # root unless absolute
     #

data/lib/shopify-cli/core.rb

@@ -4,6 +4,5 @@ module ShopifyCli
     autoload :Executor, 'shopify-cli/core/executor'
     autoload :HelpResolver, 'shopify-cli/core/help_resolver'
     autoload :Monorail, 'shopify-cli/core/monorail'
-    autoload :Update, 'shopify-cli/core/update'
   end
 end

data/lib/shopify-cli/core/entry_point.rb

@@ -11,6 +11,12 @@ module ShopifyCli
             IO.open(9) { is_shell_shim = true }
           rescue Errno::EBADF
             # This is expected if the descriptor doesn't exist
+          rescue ArgumentError => e
+            # This can happen on RVM, because it can use fd 9 itself and block access to it. That only happens if the fd
+            # did not exist beforehand, so that means there was no fd 9 before Ruby started.
+            unless e.message == 'The given fd is not accessible because RubyVM reserves it'
+              raise e
+            end
           end
 
           if !ctx.testing? && is_shell_shim

data/lib/shopify-cli/core/finalize.rb

@@ -0,0 +1,13 @@
+module ShopifyCli
+  module Core
+    # This class is just a dummy to make sure that we don't trigger warnings on the first time the updated code runs.
+    # The old code would try to call the Finalizer after it is done updating, which would then trigger an autoload of
+    # this class and fail.
+    module Finalize
+      class << self
+        def deliver!
+        end
+      end
+    end
+  end
+end

data/lib/shopify-cli/feature.rb

@@ -0,0 +1,97 @@
+module ShopifyCli
+  ##
+  # ShopifyCli::Feature contains the logic to hide and show features across the CLI
+  # These features can be either commands or project types currently.
+  #
+  # Feature flags will persist between runs so if the flag is enabled or disabled,
+  # it will still be in that same state on the next cli invocation.
+  class Feature
+    SECTION = 'features'
+
+    ##
+    # ShopifyCli::Feature::Set is included on commands and projects to allow you to hide
+    # and enable projects and commands based on feature flags.
+    module Set
+      ##
+      # will hide a feature, either a project_type or a command
+      #
+      # #### Parameters
+      #
+      # * `feature_set` - either a single, or array of symbols that represent feature sets
+      #
+      # #### Example
+      #
+      #    module ShopifyCli
+      #      module Commands
+      #        class Config < ShopifyCli::Command
+      #          hidden_feature(feature_set: :basic)
+      #          ....
+      #
+      def hidden_feature(feature_set: [])
+        @feature_hidden = true
+        @hidden_feature_set = Array(feature_set).compact
+      end
+
+      ##
+      # will return if the feature has been hidden or not
+      #
+      # #### Returns
+      #
+      # * `is_hidden` - returns true if the feature has been hidden and false otherwise
+      #
+      # #### Example
+      #
+      #     ShopifyCli::Commands::Config.hidden?
+      #
+      def hidden?
+        enabled = (@hidden_feature_set || []).any? do |feature|
+          Feature.enabled?(feature)
+        end
+        @feature_hidden && !enabled
+      end
+    end
+
+    class << self
+      ##
+      # will enable a feature in the CLI.
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing the flag to be enabled
+      def enable(feature)
+        set(feature, true)
+      end
+
+      ##
+      # will disable a feature in the CLI.
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing the flag to be disabled
+      def disable(feature)
+        set(feature, false)
+      end
+
+      ##
+      # will check if the feature has been enabled
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing a flag that the status should be requested
+      #
+      # #### Returns
+      #
+      # * `is_enabled` - will be true if the feature has been enabled.
+      def enabled?(feature)
+        return false if feature.nil?
+        ShopifyCli::Config.get_bool(SECTION, feature.to_s)
+      end
+
+      private
+
+      def set(feature, value)
+        ShopifyCli::Config.set(SECTION, feature.to_s, value)
+      end
+    end
+  end
+end

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

@@ -24,6 +24,15 @@ module ShopifyCli
           MESSAGE
           development_store_select: "Which development store would you like to use?",
           cli_yml_saved: ".shopify-cli.yml saved to project root",
+
+          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}}",
+          },
         },
 
         context: {
@@ -52,6 +61,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.",
@@ -251,6 +273,20 @@ module ShopifyCli
               "{{x}} error: For authentication issues, run {{command:%s logout}} to clear invalid credentials",
             update_prompt: "Do you want to update your application url?",
           },
+          select_org_and_shop: {
+            authentication_issue: "For authentication issues, run {{command:%s logout}} to clear invalid credentials",
+            create_store: "Visit {{underline:https://partners.shopify.com/%s/stores}} to create one",
+            development_store: "Using development store {{green:%s}}",
+            development_store_select: "Select a development store",
+            error: {
+              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",
+            },
+            organization: "Partner organization {{green:%s (%s)}}",
+            organization_select: "Select partner organization",
+          },
         },
 
         tunnel: {
@@ -259,10 +295,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/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 ||= []
@@ -53,10 +54,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(

data/lib/shopify-cli/tasks.rb

@@ -27,6 +27,7 @@ module ShopifyCli
     register :EnsureEnv, :ensure_env, 'shopify-cli/tasks/ensure_env'
     register :EnsureLoopbackURL, :ensure_loopback_url, 'shopify-cli/tasks/ensure_loopback_url'
     register :EnsureDevStore, :ensure_dev_store, 'shopify-cli/tasks/ensure_dev_store'
+    register :SelectOrgAndShop, :select_org_and_shop, 'shopify-cli/tasks/select_org_and_shop'
     register :UpdateDashboardURLS, :update_dashboard_urls, 'shopify-cli/tasks/update_dashboard_urls'
   end
 end

data/lib/shopify-cli/tasks/ensure_env.rb

@@ -14,7 +14,6 @@ module ShopifyCli
         api_key = CLI::UI.ask(@ctx.message('core.tasks.ensure_env.api_key_question'))
         api_secret = CLI::UI.ask(@ctx.message('core.tasks.ensure_env.api_secret_key_question'))
         shop = CLI::UI.ask(@ctx.message('core.tasks.ensure_env.development_store_question'))
-
         shop.gsub!(/https?\:\/\//, '')
 
         env = Resources::EnvFile.new(

data/lib/shopify-cli/tasks/select_org_and_shop.rb

@@ -0,0 +1,77 @@
+require 'shopify_cli'
+
+module ShopifyCli
+  module Tasks
+    class SelectOrgAndShop < ShopifyCli::Task
+      attr_reader :ctx
+
+      def call(ctx, organization_id: nil, shop_domain: nil)
+        @ctx = ctx
+        return response(organization_id.to_i, shop_domain) unless organization_id.nil? || shop_domain.nil?
+        org = get_organization(organization_id)
+        shop_domain ||= get_shop_domain(org)
+        response(org["id"].to_i, shop_domain)
+      end
+
+      private
+
+      def response(organization_id, shop_domain)
+        {
+          organization_id: organization_id,
+          shop_domain: shop_domain,
+        }
+      end
+
+      def organizations
+        @organizations ||= ShopifyCli::PartnersAPI::Organizations.fetch_all(ctx)
+      end
+
+      def get_organization(organization_id)
+        @organization ||= if !organization_id.nil?
+          org = ShopifyCli::PartnersAPI::Organizations.fetch(ctx, id: organization_id)
+          if org.nil?
+            ctx.puts(ctx.message('core.tasks.select_org_and_shop.error.authentication_issue', ShopifyCli::TOOL_NAME))
+            ctx.abort(ctx.message('core.tasks.select_org_and_shop.error.organization_not_found'))
+          end
+          org
+        elsif organizations.count == 0
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.error.partners_notice'))
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.authentication_issue', ShopifyCli::TOOL_NAME))
+          ctx.abort(ctx.message('core.tasks.select_org_and_shop.error.no_organizations'))
+        elsif organizations.count == 1
+          org = organizations.first
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.organization', org['businessName'], org['id']))
+          org
+        else
+          org_id = CLI::UI::Prompt.ask(ctx.message('core.tasks.select_org_and_shop.organization_select')) do |handler|
+            organizations.each do |o|
+              handler.option(ctx.message('core.partners_api.org_name_and_id', o['businessName'], o['id'])) { o['id'] }
+            end
+          end
+          organizations.find { |o| o['id'] == org_id }
+        end
+      end
+
+      def get_shop_domain(organization)
+        valid_stores = organization['stores'].select do |store|
+          store['transferDisabled'] == true || store['convertableToPartnerTest'] == true
+        end
+
+        if valid_stores.count == 0
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.error.no_development_stores'))
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.create_store', organization['id']))
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.authentication_issue', ShopifyCli::TOOL_NAME))
+        elsif valid_stores.count == 1
+          domain = valid_stores.first['shopDomain']
+          ctx.puts(ctx.message('core.tasks.select_org_and_shop.development_store', domain))
+          domain
+        else
+          CLI::UI::Prompt.ask(
+            ctx.message('core.tasks.select_org_and_shop.development_store_select'),
+            options: valid_stores.map { |s| s['shopDomain'] }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/shopify-cli/tasks/update_dashboard_urls.rb

@@ -28,16 +28,17 @@ module ShopifyCli
       end
 
       def construct_redirect_urls(urls, new_url, callback_url)
-        urls.map do |url|
+        new_urls = urls.map do |url|
           if (match = url.match(NGROK_REGEX))
             "#{new_url}#{match[2]}"
           else
             url
           end
         end
-        if urls.grep(/#{new_url}#{callback_url}/).empty?
-          urls.push("#{new_url}#{callback_url}")
+        if new_urls.grep(/#{new_url}#{callback_url}/).empty?
+          new_urls.push("#{new_url}#{callback_url}")
         end
+        new_urls.uniq
       end
     end
   end

data/lib/shopify-cli/tunnel.rb

@@ -11,7 +11,7 @@ module ShopifyCli
   class Tunnel
     extend SingleForwardable
 
-    def_delegators :new, :start, :stop, :auth
+    def_delegators :new, :start, :stop, :auth, :stats, :urls
 
     class FetchUrlError < RuntimeError; end
     class NgrokError < RuntimeError; end
@@ -23,6 +23,10 @@ module ShopifyCli
       linux: 'https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip',
     }
 
+    NGROK_TUNNELS_URI = URI.parse('http://localhost:4040/api/tunnels')
+    TUNNELS_FIELD = 'tunnels'
+    PUBLIC_URL_FIELD = 'public_url'
+
     ##
     # will find and stop a running tunnel process. It will also output if the
     # operation was successful or not
@@ -58,14 +62,19 @@ module ShopifyCli
     #
     def start(ctx, port: PORT)
       install(ctx)
-      process = ShopifyCli::ProcessSupervision.start(:ngrok, ngrok_command(port))
-      log = fetch_url(ctx, process.log_path)
-      if log.account
-        ctx.puts(ctx.message('core.tunnel.start_with_account', log.url, log.account))
+      url, account, seconds_remaining = start_ngrok(ctx, port)
+      if account
+        ctx.puts(ctx.message('core.tunnel.start_with_account', url, account))
       else
-        ctx.puts(ctx.message('core.tunnel.start', log.url))
+        if seconds_remaining <= 0
+          ctx.puts(ctx.message('core.tunnel.timed_out'))
+          url, _account, seconds_remaining = restart_ngrok(ctx, port)
+        end
+        ctx.puts(ctx.message('core.tunnel.start', url))
+        ctx.puts(ctx.message('core.tunnel.will_timeout', seconds_to_hm(seconds_remaining)))
+        ctx.puts(ctx.message('core.tunnel.signup_suggestion', ShopifyCli::TOOL_NAME))
       end
-      log.url
+      url
     end
 
     ##
@@ -82,6 +91,34 @@ module ShopifyCli
       ctx.system(File.join(ShopifyCli::CACHE_DIR, 'ngrok'), 'authtoken', token)
     end
 
+    ##
+    # will return the statistics of the current running tunnels
+    #
+    # #### Returns
+    #
+    # * `stats` - the hash of running statistics returning from the ngrok api
+    #
+    def stats
+      response = Net::HTTP.get_response(NGROK_TUNNELS_URI)
+      JSON.parse(response.body)
+    rescue
+      {}
+    end
+
+    ##
+    # will return the urls of the current running tunnels
+    #
+    # #### Returns
+    #
+    # * `stats` - the array of urls
+    #
+    def urls
+      tunnels = stats.dig(TUNNELS_FIELD)
+      tunnels.map { |tunnel| tunnel.dig(PUBLIC_URL_FIELD) }
+    rescue
+      []
+    end
+
     private
 
     def install(ctx)
@@ -106,13 +143,30 @@ module ShopifyCli
     end
 
     def ngrok_command(port)
-      "exec #{File.join(ShopifyCli::CACHE_DIR, 'ngrok')} http -log=stdout -log-level=debug #{port}"
+      "exec #{File.join(ShopifyCli::CACHE_DIR, 'ngrok')} http -inspect=false -log=stdout -log-level=debug #{port}"
+    end
+
+    def seconds_to_hm(seconds)
+      format("%d hours %d minutes", seconds / 3600, seconds / 60 % 60)
     end
 
+    def start_ngrok(ctx, port)
+      process = ShopifyCli::ProcessSupervision.start(:ngrok, ngrok_command(port))
+      log = fetch_url(ctx, process.log_path)
+      seconds_remaining = (process.time.to_i + log.timeout) - Time.now.to_i
+      [log.url, log.account, seconds_remaining]
+    end
+
+    def restart_ngrok(ctx, port)
+      unless ShopifyCli::ProcessSupervision.stop(:ngrok)
+        ctx.abort(ctx.message('core.tunnel.error.stop'))
+      end
+      start_ngrok(ctx, port)
+    end
     class LogParser # :nodoc:
       TIMEOUT = 10
 
-      attr_reader :url, :account
+      attr_reader :url, :account, :timeout
 
       def initialize(log_path)
         @log_path = log_path
@@ -141,7 +195,9 @@ module ShopifyCli
       end
 
       def parse_account
-        @account, _ = @log.match(/AccountName:([\w\s]+) SessionDuration/)&.captures
+        account, timeout, _ = @log.match(/AccountName:([\w\s]*) SessionDuration:([\d]+) PlanName/)&.captures
+        @account = account&.empty? ? nil : account
+        @timeout = timeout&.empty? ? 0 : timeout.to_i
       end
 
       def error