shopify-cli 2.6.6 → 2.7.3

data/lib/shopify_cli/commands.rb

@@ -29,6 +29,7 @@ module ShopifyCLI
     register :System, "system", "shopify_cli/commands/system", true
     register :Version, "version", "shopify_cli/commands/version", true
     register :Whoami, "whoami", "shopify_cli/commands/whoami", true
+    register :App, "app", "shopify_cli/commands/app", true
 
     autoload :Connect, "shopify_cli/commands/connect"
   end

data/lib/shopify_cli/constants.rb

@@ -4,6 +4,10 @@ module ShopifyCLI
       ROOT = File.expand_path("../..", __dir__)
     end
 
+    module Files
+      SHOPIFY_CLI_YML = ".shopify-cli.yml"
+    end
+
     module StoreKeys
       LAST_MIGRATION_DATE = :last_migration_date
       ANALYTICS_ENABLED = :analytics_enabled
@@ -42,6 +46,9 @@ module ShopifyCLI
       ACCEPTANCE_TEST = "SHOPIFY_CLI_ACCEPTANCE_TEST"
       DEVELOPMENT = "SHOPIFY_CLI_DEVELOPMENT"
 
+      # Authentication
+      AUTH_TOKEN = "SHOPIFY_CLI_AUTH_TOKEN"
+
       # Monorail
       MONORAIL_REAL_EVENTS = "MONORAIL_REAL_EVENTS"
     end

data/lib/shopify_cli/context.rb

@@ -61,6 +61,7 @@ module ShopifyCLI
     # will return which operating system that the cli is running on [:mac, :linux]
     def os
       host = uname
+      return :mac_m1 if /arm64-apple-darwin/i.match(host)
       return :mac if /darwin/i.match(host)
       return :windows if /mswin|mingw|cygwin/i.match(host)
       return :linux if /linux|bsd/i.match(host)
@@ -357,6 +358,15 @@ module ShopifyCLI
       Kernel.puts(CLI::UI.fmt(*args))
     end
 
+    # a wrapper around $stderr.puts to allow for easy formatting
+    #
+    # #### Parameters
+    # * `text` - a string message to output
+    #
+    def error(text)
+      $stderr.puts(CLI::UI.fmt(text))
+    end
+
     # a wrapper around Kernel.warn to allow for easy formatting
     #
     # #### Parameters

data/lib/shopify_cli/environment.rb

@@ -86,6 +86,10 @@ module ShopifyCLI
       )
     end
 
+    def self.auth_token(env_variables: ENV)
+      env_variables[Constants::EnvironmentVariables::AUTH_TOKEN]
+    end
+
     def self.env_variable_truthy?(variable_name, env_variables: ENV)
       TRUTHY_ENV_VARIABLE_VALUES.include?(env_variables[variable_name.to_s])
     end

data/lib/shopify_cli/exception_reporter.rb

@@ -2,10 +2,10 @@ module ShopifyCLI
   module ExceptionReporter
     def self.report(error, _logs = nil, _api_key = nil, custom_metadata = {})
       context = ShopifyCLI::Context.new
-
       unless ShopifyCLI::Environment.development?
         context.puts(context.message("core.error_reporting.unhandled_error.message"))
-        context.puts(context.message("core.error_reporting.unhandled_error.issue_message"))
+        context.puts(context.message("core.error_reporting.unhandled_error.issue_message",
+          ShopifyCLI::GitHub::IssueURLGenerator.error_url(error)))
       end
 
       # Stack trace hint
@@ -17,8 +17,8 @@ module ShopifyCLI
       context.puts("\n")
 
       return unless reportable_error?(error)
-      return unless report?(context: context)
 
+      return unless report?(context: context)
       ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"] = "1"
       require "bugsnag"
 
@@ -48,7 +48,6 @@ module ShopifyCLI
       unless ReportingConfigurationController.reporting_prompted?
         ReportingConfigurationController.check_or_prompt_report_automatically(source: :uncaught_error)
       end
-
       report_error
     end
 

data/lib/shopify_cli/git.rb

@@ -4,6 +4,14 @@ module ShopifyCLI
   # git.
   class Git
     class << self
+      # Check if Git is available in the environment
+      def available?(ctx)
+        _output, status = ctx.capture2e("git", "status")
+        status.success?
+      rescue Errno::ENOENT # git is not installed
+        false
+      end
+
       ##
       # will return the current sha of the cli repo
       #
@@ -20,8 +28,13 @@ module ShopifyCLI
       #
       #   ShopifyCLI::Git.sha
       #
+      # Some environments don't have git in PATH and this prevents
+      # the execution from raising an error
+      # https://app.bugsnag.com/shopify/shopify-cli/errors/615dd36365ce57000889d4c5
       def sha(dir: Dir.pwd, ctx: Context.new)
-        rev_parse("HEAD", dir: dir, ctx: ctx)
+        if available?(ctx)
+          rev_parse("HEAD", dir: dir, ctx: ctx)
+        end
       end
 
       ##

data/lib/shopify_cli/github/issue_url_generator.rb

@@ -0,0 +1,19 @@
+module ShopifyCLI
+  module GitHub
+    module IssueURLGenerator
+      def self.error_url(error)
+        title = "#{error.class}: #{error.message}"
+        labels = "type:bug"
+        content = File.read(File.join(ShopifyCLI::ROOT, ".github/ISSUE_TEMPLATE.md"))
+
+        # take at most 5 lines from backtrace
+        stacktrace = error.backtrace.length < 5 ? error.backtrace : error.backtrace[0..4]
+        body = stacktrace.join("\n").to_s
+        output = content.gsub(/<!--Stacktrace(.|\n)*-->/, body)
+        query = URI.encode_www_form({ title: title, body: output, labels: labels })
+        url = "#{ShopifyCLI::Constants::Links::NEW_ISSUE}?#{query}"
+        url
+      end
+    end
+  end
+end

data/lib/shopify_cli/github.rb

@@ -0,0 +1,5 @@
+module ShopifyCLI
+  module GitHub
+    autoload :IssueURLGenerator, "shopify_cli/github/issue_url_generator"
+  end
+end

data/lib/shopify_cli/identity_auth.rb

@@ -68,6 +68,24 @@ module ShopifyCLI
       request_exchange_tokens
     end
 
+    def self.fetch_or_auth_partners_token(ctx:)
+      env_var_auth_token = Environment.auth_token
+      return env_var_auth_token if env_var_auth_token
+
+      ShopifyCLI::DB.get(:partners_exchange_token) do
+        IdentityAuth.new(ctx: ctx).authenticate
+        ShopifyCLI::DB.get(:partners_exchange_token)
+      end
+    end
+
+    def self.environment_auth_token?
+      !!Environment.auth_token
+    end
+
+    def self.authenticated?
+      environment_auth_token? || IDENTITY_ACCESS_TOKENS.all? { |key| ShopifyCLI::DB.exists?(key) }
+    end
+
     def reauthenticate
       return if refresh_exchange_tokens || refresh_access_tokens
       ctx.abort(ctx.message("core.identity_auth.error.reauthenticate", ShopifyCLI::TOOL_NAME))

data/lib/shopify_cli/messages/messages.rb

@@ -8,28 +8,272 @@ module ShopifyCLI
           info: {
             created: "{{v}} {{green:%s}} was created in the organization's Partner Dashboard {{underline:%s}}",
             serve: "{{*}} Change directories to your new project folder {{green:%s}} and run "\
-            "{{command:%s %s serve}} to start a local server",
+            "{{command:%s app serve}} to start a local server",
             install: "{{*}} Then, visit {{underline:%s/test}} to install {{green:%s}} on your Dev Store",
           },
         },
       },
       core: {
         app: {
+          help: <<~HELP,
+          Suite of commands for developing apps. See {{command:%1$s app <command> --help}} for usage of each command.
+            Usage: {{command:%1$s app [ %2$s ]}}
+          HELP
+          error: {
+            type_not_found: <<~MESSAGE,
+            Couldn't detect the app type in directory %s. We currently support Rails, PHP, and NodeJS apps.
+            MESSAGE
+            missing_shopify_cli_yml: <<~MESSAGE,
+            Couldn't find a #{Constants::Files::SHOPIFY_CLI_YML} file in the directory %s to determine the app type.
+            MESSAGE
+            invalid_project_type: <<~MESSAGE,
+            The project type %s doesn't represent an app.
+            MESSAGE
+          },
+          create: {
+            type_required_error: "",
+            invalid_type: "The type %s is not supported. The only supported types are"\
+              " {{command:[ rails | node | php ]}}",
+            help: <<~HELP,
+            {{command:%s app create}}: Creates a ruby on rails app.
+              Usage: {{command:%s app create [ rails | node | php ]}}
+            HELP
+            rails: {
+              help: <<~HELP,
+                {{command:%s app create rails}}: Creates a ruby on rails app.
+                  Usage: {{command:%s app create rails}}
+                  Options:
+                    {{command:--name=NAME}} App name. Any string.
+                    {{command:--organization-id=ID}} Partner organization ID. Must be an existing organization.
+                    {{command:--store-domain=MYSHOPIFYDOMAIN }} Development store URL. Must be an existing development store.
+                    {{command:--db=DB}} Database type. Must be one of: mysql, postgresql, sqlite3, oracle, frontbase, ibm_db, sqlserver, jdbcmysql, jdbcsqlite3, jdbcpostgresql, jdbc.
+                    {{command:--rails-opts=RAILSOPTS}} Additional options. Must be string containing one or more valid Rails options, separated by spaces.
+              HELP
+
+              error: {
+                invalid_ruby_version: "This project requires a Ruby version ~> 2.5 or Ruby 3.0.",
+                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: {
+                open_new_shell: "{{*}} {{yellow:After installing %s, please open a new Command Prompt or PowerShell " \
+                  "window to continue.}}",
+              },
+              installing_bundler: "Installing bundler…",
+              generating_app: "Generating new rails app project in %s…",
+              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_webpacker_install: "Running webpacker:install…",
+            },
+            node: {
+              help: <<~HELP,
+                {{command:%s app create node}}: Creates an embedded nodejs app.
+                  Usage: {{command:%s app create node}}
+                  Options:
+                    {{command:--name=NAME}} App name. Any string.
+                    {{command:--organization-id=ID}} Partner organization ID. Must be an existing organization.
+                    {{command:--store-domain=MYSHOPIFYDOMAIN }} Development store URL. Must be an existing development store.
+              HELP
+              error: {
+                node_required: "node is required to create an app 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.",
+                npm_required: "npm is required to create an app project. Download at https://www.npmjs.com/get-npm.",
+                npm_version_failure: "Failed to get the current npm version. Please make sure it is installed as per " \
+                  "the instructions at https://www.npmjs.com/get-npm.",
+              },
+              node_version: "node %s",
+              npm_version: "npm %s",
+            },
+            php: {
+              help: <<~HELP,
+                {{command:%s app create php}}: Creates an embedded PHP app.
+                  Usage: {{command:%s app create php}}
+                  Options:
+                    {{command:--name=NAME}} App name. Any string.
+                    {{command:--organization-id=ID}} Partner organization ID. Must be an existing organization.
+                    {{command:--store-domain=MYSHOPIFYDOMAIN}} Development store URL. Must be an existing development store.
+                    {{command:--type=APPTYPE}} Whether this app is public or custom.
+                    {{command:--verbose}} Output verbose information when installing dependencies.
+                HELP
+
+              error: {
+                php_required: <<~VERSION,
+                  PHP is required to create an app project. For installation instructions, visit:
+                    {{underline:https://www.php.net/manual/en/install.php}}
+                  VERSION
+                php_version_failure: <<~VERSION,
+                  Failed to get the current PHP version. Please make sure it is installed as per the instructions at:
+                    {{underline:https://www.php.net/manual/en/install.php.}}
+                  VERSION
+                php_version_too_low: "Your PHP version is too low. Please use version %s or higher.",
+                composer_required: <<~COMPOSER,
+                  Composer is required to create an app project. Download at:
+                    {{underline:https://getcomposer.org/download/}}
+                  COMPOSER
+                npm_required: "npm is required to create an app project. Download at https://www.npmjs.com/get-npm.",
+                npm_version_failure: "Failed to get the current npm version. Please make sure it is installed as per " \
+                  "the instructions at https://www.npmjs.com/get-npm.",
+                app_setup: "Failed to set up the app",
+              },
+
+              php_version: "PHP %s",
+              npm_version: "npm %s",
+              app_setting_up: "Setting up app…",
+              app_set_up: "App is now set up",
+            },
+          },
+          deploy: {
+            help: <<~HELP,
+            Deploy the current app to a hosting service. Heroku ({{underline:https://www.heroku.com}}) is currently the only option, but more will be added in the future.
+              Usage: {{command:%s app deploy [ heroku ]}}
+            HELP
+            extended_help: <<~HELP,
+              {{bold:Subcommands:}}
+                {{cyan:heroku}}: Deploys the current app to Heroku.
+                  Usage: {{command:%s app deploy heroku}}
+            HELP
+            error: {
+              missing_platform: <<~MESSAGE,
+              The platform argument is missing.
+                Usage: {{command:%s app deploy [ heroku ]}}
+              MESSAGE
+              invalid_platform: <<~MESSAGE,
+              The platform argument passed {{command:%s}} is not supported.
+                Usage: {{command:%s app deploy [ heroku ]}}
+              MESSAGE
+            },
+            heroku: {
+              downloading: "Downloading Heroku CLI…",
+              downloaded: "Downloaded Heroku CLI",
+              installing: "Installing Heroku CLI…",
+              installing_windows: "Running Heroku CLI install wizard…",
+              installed: "Installed Heroku CLI",
+              authenticated_with_account: "{{v}} Authenticated with Heroku as {{green:%s}}",
+              authenticating: "Authenticating with Heroku…",
+              authenticated: "{{v}} Authenticated with Heroku",
+              deploying: "Deploying to Heroku…",
+              deployed: "{{v}} Deployed to Heroku",
+              php: {
+                post_deploy: <<~DEPLOYED,
+                {{v}} Deployed to Heroku, you can access your app at {{green:%s}}
+
+                  If you're deploying this app for the first time, make sure to set up your database and your app's environment at {{bold:App dashboard -> Settings -> Config Vars}}.
+
+                  When setting your config vars, don't forget to set up your database and the appropriate Laravel values for it, particularly {{bold:DB_CONNECTION and DB_DATABASE}}.
+                DEPLOYED
+                error: {
+                  generate_app_key: "Failed to generate Laravel APP_KEY",
+                },
+              },
+              rails: {
+                db_check: {
+                  validating: "Validating application…",
+                  checking: "Checking database type…",
+                  validated: "Database type \"%s\" validated for platform \"Heroku\"",
+                  problem: "A problem was encountered while checking your database type.",
+                  sqlite: <<~SQLITE,
+                    Heroku does not support deployment using the SQLite database system.
+                    Change the database type using {{command:rails db:system:change --to=[new_db_type]}}. For more info:
+                    {{underline:https://gorails.com/episodes/rails-6-db-system-change-command}}
+                  SQLITE
+                },
+              },
+              git: {
+                checking: "Checking git repo…",
+                initialized: "Git repo initialized",
+                what_branch: "What branch would you like to deploy?",
+                branch_selected: "{{v}} Git branch {{green:%s}} selected for deploy",
+              },
+              app: {
+                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…",
+                selected: "{{v}} Heroku app {{green:%s}} selected",
+                create: "Create a new Heroku app",
+                creating: "Creating new Heroku app…",
+                created: "{{v}} New Heroku app created",
+                setting_configs: "Setting Shopify app configs…",
+                configs_set: "{{v}} Shopify app configs set",
+              },
+            },
+          },
+          connect: {
+            help: <<~HELP,
+            {{command:%s app connect}}: Connects an existing app to Shopify CLI. Creates a config file.
+              Usage: {{command:%s app connect}}
+            HELP
+            connected: "Project now connected to {{green:%s}}",
+            production_warning: <<~MESSAGE,
+              {{yellow:! Warning: if you have connected to an {{bold:app in production}}, running {{command:serve}} may update the app URL and cause an outage.
+            MESSAGE
+          },
+          tunnel: {
+            help: <<~HELP,
+              Start or stop an http tunnel to your local development app using ngrok.
+                Usage: {{command:%s app tunnel [ auth | start | stop ]}}
+            HELP
+            extended_help: <<~HELP,
+              {{bold:Subcommands:}}
+
+                {{cyan:auth}}: Writes an ngrok auth token to ~/.ngrok2/ngrok.yml to connect with an ngrok account. Visit https://dashboard.ngrok.com/signup to sign up.
+                  Usage: {{command:%1$s app tunnel auth <token>}}
+
+                {{cyan:start}}: Starts an ngrok tunnel, will print the URL for an existing tunnel if already running.
+                  Usage: {{command:%1$s app tunnel start}}
+
+                {{cyan:stop}}: Stops the ngrok tunnel.
+                  Usage: {{command:%1$s app tunnel stop}}
+
+            HELP
+            error: {
+              token_argument_missing: "{{x}} {{red:auth requires a token argument}}\n\n",
+            },
+          },
           serve: {
+            help: <<~HELP,
+              Start a local development server for your project, as well as a public ngrok tunnel to your localhost.
+                Usage: {{command:%s app serve}}
+            HELP
+            extended_help: <<~HELP,
+              {{bold:Options:}}
+                {{cyan:--host=HOST}}: Bypass running tunnel and use custom host. HOST must be HTTPS url.
+                {{cyan:--port=PORT}}: Use custom port.
+            HELP
+            open_info: <<~MESSAGE,
+              {{*}} To install and start using your app, open this URL in your browser:
+              {{green:%s}}
+            MESSAGE
+            running_server: "Running server…",
             error: {
-              invalid_port: "%s is not a valid port.",
               host_must_be_https: "HOST must be a HTTPS url.",
+              invalid_port: "%s is not a valid port.",
             },
           },
-          help: <<~HELP,
-          Create and manage embedded apps
-            Usage: {{command:%s app [ rails | node | php ] }}
-          HELP
+          open: {
+            help: <<~HELP,
+              Open your local development app in the default browser.
+                Usage: {{command:%s app open}}
+              HELP
+          },
         },
         error_reporting: {
           unhandled_error: {
             message: "{{x}} {{red:An unexpected error occured.}}",
-            issue_message: "{{red:\tTo \e]8;;#{ShopifyCLI::Constants::Links::NEW_ISSUE}\e\\submit an issue\e]8;;\e\\"\
+            issue_message: "{{red:\tTo \e]8;;%s\e\\submit an issue\e]8;;\e\\"\
               " include the stack trace.}}",
             stacktrace_message: "{{red:\tTo print the stack trace, add the environment variable %s.}}",
           },
@@ -213,6 +457,7 @@ module ShopifyCLI
             not_authenticated: "Failed to authenticate",
           },
           login_prompt: "Please ensure you've logged in with {{command:%s login}} and try again",
+          token_authentication: "%s environment variable. We'll authenticate using its value as a token.",
         },
 
         options: {
@@ -328,7 +573,7 @@ module ShopifyCLI
           error: {
             not_in_project: <<~MESSAGE,
               {{x}} You are not in a Shopify app project
-              {{yellow:{{*}}}}{{reset: Run}}{{cyan: shopify rails create}}{{reset: or}}{{cyan: shopify node create}}{{reset: to create your app}}
+              {{yellow:{{*}}}}{{reset: Run}}{{cyan: shopify app create}}{{reset: to create your app}}
             MESSAGE
           },
         },
@@ -520,7 +765,7 @@ module ShopifyCLI
             Anonymized reports will be sent to Shopify.
           MESSAGE
           turned_off_message: <<~MESSAGE,
-            Turn on automatic reporting later wtih {{command:%s reporting on}}.
+            Turn on automatic reporting later with {{command:%s reporting on}}.
           MESSAGE
         },
         whoami: {

data/lib/shopify_cli/partners_api.rb

@@ -61,18 +61,11 @@ module ShopifyCLI
       def api_client(ctx)
         new(
           ctx: ctx,
-          token: access_token(ctx),
+          token: IdentityAuth.fetch_or_auth_partners_token(ctx: ctx),
           url: "https://#{Environment.partners_domain}/api/cli/graphql",
         )
       end
 
-      def access_token(ctx)
-        ShopifyCLI::DB.get(:partners_exchange_token) do
-          IdentityAuth.new(ctx: ctx).authenticate
-          ShopifyCLI::DB.get(:partners_exchange_token)
-        end
-      end
-
       def auth_failure_info(ctx, error)
         if error.response
           headers = %w(www-authenticate x-request-id)

data/lib/shopify_cli/project.rb

@@ -81,7 +81,11 @@ module ShopifyCLI
       #
       # #### Example
       #
-      #   type = ShopifyCLI::Project.current_project_type
+      #   ShopifyCLI::Project.write(
+      #     @ctx,
+      #     project_type: "node",
+      #     organization_id: form_data.organization_id,
+      #   )
       #
       def write(ctx, project_type:, organization_id:, **identifiers)
         require "yaml" # takes 20ms, so deferred as late as possible.

data/lib/shopify_cli/project_commands.rb

@@ -1,5 +1,5 @@
 module ShopifyCLI
-  class ProjectCommands < Command
+  class ProjectCommand < Command
     def call(*)
       @ctx.puts(self.class.help)
     end

data/lib/shopify_cli/services/app/connect_service.rb

@@ -0,0 +1,25 @@
+module ShopifyCLI
+  module Services
+    module App
+      class ConnectService < BaseService
+        attr_reader :app_type, :project, :context
+
+        def initialize(app_type:, project:, context:)
+          @app_type = app_type
+          @project = project
+          @context = context
+          super()
+        end
+
+        def call
+          unless project&.env.nil?
+            context.puts(context.message("core.app.connect.production_warning"))
+          end
+
+          app = ShopifyCLI::Connect.new(context).default_connect(app_type.to_s)
+          context.done(context.message("core.app.connect.connected", app))
+        end
+      end
+    end
+  end
+end