shopify-cli 1.7.1 → 1.11.0

data/lib/shopify-cli/context.rb

@@ -144,6 +144,34 @@ module ShopifyCli
       File.write(ctx_path(fname), content)
     end
 
+    # will read a binary file relative to the context root unless the file path is absolute.
+    #
+    # #### Parameters
+    # * `fname` - filename of the file that you are reading, relative to root unless it is absolute.
+    #
+    # #### Example
+    #
+    #   @ctx.read('binary.out')
+    #
+    def binread(fname)
+      File.binread(ctx_path(fname))
+    end
+
+    # will write/overwrite a binary file with the provided contents, relative to the context root
+    # unless the file path is absolute.
+    #
+    # #### Parameters
+    # * `fname` - filename of the file that you are writing, relative to root unless it is absolute.
+    # * `content` - the body contents of the file that you are writing
+    #
+    # #### Example
+    #
+    #   @ctx.binwrite('binary.out', 'ASCII-8BIT encoded binary')
+    #
+    def binwrite(fname, content)
+      File.binwrite(ctx_path(fname), content)
+    end
+
     # will change directories and update the root, the filepath is relative to the command root unless absolute
     #
     # #### Parameters

data/lib/shopify-cli/js_system.rb

@@ -37,8 +37,8 @@ module ShopifyCli
       #
       #   ShopifyCli::JsSystem.call(ctx, yarn: ['install', '--silent'], npm: ['install', '--no-audit'])
       #
-      def call(ctx, yarn:, npm:)
-        JsSystem.new(ctx: ctx).call(yarn: yarn, npm: npm)
+      def call(ctx, yarn:, npm:, capture_response: false)
+        JsSystem.new(ctx: ctx).call(yarn: yarn, npm: npm, capture_response: capture_response)
       end
     end
 

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",
@@ -82,7 +82,8 @@ module ShopifyCli
           error: {
             directory_exists: "Project directory already exists. Please create a project with a new name.",
             no_branches_found: "Could not find any git branches",
-            repo_not_initiated: "Git repo is not initiated. Please run `git init` and make at least one commit.",
+            repo_not_initiated:
+              "Git repo is not initiated. Please run {{command:git init}} and make at least one commit.",
             no_commits_made: "No git commits have been made. Please make at least one commit.",
           },
 
@@ -96,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
         },
@@ -110,7 +111,7 @@ module ShopifyCli
             deploy: "Could not deploy to Heroku",
             download: "Heroku CLI could not be downloaded",
             install: "Could not install Heroku CLI",
-            could_not_select_app: "Heroku app `%s` could not be selected",
+            could_not_select_app: "Heroku app {{green:%s}} could not be selected",
           },
         },
 
@@ -130,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",
@@ -153,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.",
@@ -174,8 +176,8 @@ 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
           },
         },
@@ -195,16 +197,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
           },
         },
@@ -225,10 +227,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
 
@@ -239,8 +241,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}}",
@@ -267,8 +269,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?",
@@ -305,7 +307,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.",
@@ -326,9 +331,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",
@@ -340,31 +345,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
         },

data/lib/shopify-cli/method_object.rb

@@ -52,8 +52,8 @@ module ShopifyCli
       # invokes the original `call` implementation and wraps its return value
       # into a result object.
       #
-      def call(*args, **kwargs)
-        Result.wrap { super(*args, **kwargs) }.call
+      def call(*args, **kwargs, &block)
+        Result.wrap { kwargs.any? ? super(*args, **kwargs, &block) : super(*args, &block) }.call
       end
     end
 
@@ -64,10 +64,10 @@ module ShopifyCli
       # initializer or to `call`. If the keyword argument matches the name of
       # property, it is forwarded to the initializer, otherwise to call.
       #
-      def call(*args, **kwargs)
+      def call(*args, **kwargs, &block)
         properties.keys.yield_self do |properties|
           new(**kwargs.slice(*properties))
-            .call(*args, **kwargs.slice(*(kwargs.keys - properties)))
+            .call(*args, **kwargs.slice(*(kwargs.keys - properties)), &block)
         end
       end
 

data/lib/shopify-cli/oauth.rb

@@ -24,10 +24,10 @@ module ShopifyCli
     property! :service, accepts: String
     property! :client_id, accepts: String
     property! :scopes
-    property :store, default: ShopifyCli::DB.new
+    property :store, default: -> { ShopifyCli::DB.new }
     property :secret, accepts: String
     property :request_exchange, accepts: String
-    property :options, default: {}, accepts: Hash
+    property :options, default: -> { {} }, accepts: Hash
     property :auth_path, default: "/authorize", accepts: ->(path) { path.is_a?(String) && path.start_with?("/") }
     property :token_path, default: "/token", accepts: ->(path) { path.is_a?(String) && path.start_with?("/") }
     property :state_token, accepts: String, default: SecureRandom.hex(30)
@@ -80,7 +80,13 @@ module ShopifyCli
     end
 
     def output_authentication_info(uri)
-      login_location = ctx.message(service == "admin" ? "core.oauth.location.admin" : "core.oauth.location.partner")
+      login_location = if service == "admin"
+        ctx.message("core.oauth.location.admin")
+      elsif Shopifolk.acting_as_shopify_organization?
+        ctx.message("core.oauth.location.shopifolk")
+      else
+        ctx.message("core.oauth.location.partner")
+      end
       ctx.puts(ctx.message("core.oauth.authentication_required", login_location))
       ctx.open_url!(uri)
     end

data/lib/shopify-cli/packager.rb

@@ -99,7 +99,7 @@ module ShopifyCli
         raise <<~MESSAGE
 
           Could not find program #{program} which is required to build the package.
-          You can install it by running `#{installation_cmd}`.
+          You can install it by running #{installation_cmd}.
 
         MESSAGE
       end

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

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

data/lib/shopify-cli/resolve_constant.rb

@@ -11,7 +11,7 @@
 module ShopifyCli
   class ResolveConstant
     include ShopifyCli::MethodObject
-    property! :namespace, accepts: ->(ns) { ns.respond_to?(:const_get) }, default: Kernel
+    property! :namespace, accepts: ->(ns) { ns.respond_to?(:const_get) }, default: -> { Kernel }
 
     def call(name)
       name

data/lib/shopify-cli/resources/env_file.rb

@@ -57,7 +57,7 @@ module ShopifyCli
       property :shop
       property :scopes
       property :host
-      property :extra, default: {}
+      property :extra, default: -> { {} }
 
       def to_h
         out = {}

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

@@ -5,7 +5,7 @@ module ShopifyCli
     class EnsureDevStore < ShopifyCli::Task
       def call(ctx)
         @ctx = ctx
-        return ctx.puts(ctx.message(
+        return ctx.abort(ctx.message(
           "core.tasks.ensure_dev_store.could_not_verify_store", project.env.shop
         )) if shop.nil?
         return if shop["transferDisabled"] == true

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

@@ -35,14 +35,16 @@ module ShopifyCli
         @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.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.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"))
+          if Shopifolk.acting_as_shopify_organization?
+            ctx.abort(ctx.message("core.tasks.select_org_and_shop.error.shopifolk_notice", ShopifyCli::TOOL_NAME))
+          else
+            ctx.abort(ctx.message("core.tasks.select_org_and_shop.error.no_organizations"))
+          end
         elsif organizations.count == 1
           org = organizations.first
           ctx.puts(ctx.message("core.tasks.select_org_and_shop.organization", org["businessName"], org["id"]))

data/lib/shopify-cli/transform_data_structure.rb

@@ -42,7 +42,7 @@ module ShopifyCli
     property! :symbolize_keys, accepts: [true, false], default: false, reader: :symbolize_keys?
     property! :associative_array_container,
       accepts: ->(c) { c.respond_to?(:new) && c.method_defined?(:[]=) },
-      default: Hash
+      default: -> { Hash }
 
     def call(object)
       case object
@@ -68,7 +68,7 @@ module ShopifyCli
     def underscore_key(key)
       return key unless underscore_keys? && key.respond_to?(:to_str)
 
-      key.to_str.dup.yield_self do |k|
+      key.to_str.dup.tap do |k|
         k.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
         k.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
         k.tr!("-", "_")

data/lib/shopify-cli/tunnel.rb

@@ -2,6 +2,7 @@ require "json"
 require "fileutils"
 require "shopify_cli"
 require "forwardable"
+require "uri"
 
 module ShopifyCli
   ##
@@ -11,7 +12,7 @@ module ShopifyCli
   class Tunnel
     extend SingleForwardable
 
-    def_delegators :new, :start, :stop, :auth, :stats, :urls
+    def_delegators :new, :start, :stop, :auth, :stats, :urls, :running_on?
 
     class FetchUrlError < RuntimeError; end
     class NgrokError < RuntimeError; end
@@ -26,6 +27,7 @@ module ShopifyCli
 
     NGROK_TUNNELS_URI = URI.parse("http://localhost:4040/api/tunnels")
     TUNNELS_FIELD = "tunnels"
+    TUNNEL_ADDRESS_KEY_PATH = ["config", "addr"]
     PUBLIC_URL_FIELD = "public_url"
 
     ##
@@ -120,6 +122,25 @@ module ShopifyCli
       []
     end
 
+    ##
+    # Returns Boolean if a tunnel is running on a given port
+    #
+    # #### Parameters
+    #
+    # * `port` - port to check
+    #
+    # #### Returns
+    #
+    # * true / false
+    #
+    def running_on?(port)
+      extract_port = ->(tunnel) { URI(tunnel.dig(*TUNNEL_ADDRESS_KEY_PATH)).port }
+      matches_port = ->(occupied_port) { occupied_port == port }
+      stats.fetch(TUNNELS_FIELD, []).map(&extract_port).any?(&matches_port)
+    rescue
+      false
+    end
+
     private
 
     def install(ctx)