shopify-cli 2.6.6 → 2.7.0

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.}}",
           },
@@ -328,7 +572,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
           },
         },

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

data/lib/shopify_cli/services/app/create/node_service.rb

@@ -0,0 +1,153 @@
+require "semantic/semantic"
+
+module ShopifyCLI
+  module Services
+    module App
+      module Create
+        class NodeService < BaseService
+          attr_reader :context, :name, :organization_id, :store_domain, :type, :verbose
+
+          def initialize(name:, organization_id:, store_domain:, type:, verbose:, context:)
+            @name = name
+            @organization_id = organization_id
+            @store_domain = store_domain
+            @type = type
+            @verbose = verbose
+            @context = context
+            super()
+          end
+
+          def call
+            form = form_data({
+              name: name,
+              organization_id: organization_id,
+              shop_domain: store_domain,
+              type: type,
+              verbose: verbose,
+            })
+
+            check_node
+            check_npm
+            build(form.name)
+
+            ShopifyCLI::Project.write(
+              context,
+              project_type: "node",
+              organization_id: form.organization_id,
+            )
+
+            api_client = if ShopifyCLI::Environment.acceptance_test?
+              {
+                "apiKey" => "public_api_key",
+                "apiSecretKeys" => [
+                  {
+                    "secret" => "api_secret_key",
+                  },
+                ],
+              }
+            else
+              ShopifyCLI::Tasks::CreateApiClient.call(
+                context,
+                org_id: form.organization_id,
+                title: form.name,
+                type: form.type,
+              )
+            end
+
+            ShopifyCLI::Resources::EnvFile.new(
+              api_key: api_client["apiKey"],
+              secret: api_client["apiSecretKeys"].first["secret"],
+              shop: form.shop_domain,
+              scopes: "write_products,write_customers,write_draft_orders",
+            ).write(context)
+
+            partners_url = ShopifyCLI::PartnersAPI.partners_url_for(form.organization_id, api_client["id"])
+
+            context.puts(context.message("apps.create.info.created", form.name, partners_url))
+            context.puts(context.message("apps.create.info.serve", form.name, ShopifyCLI::TOOL_NAME))
+            unless ShopifyCLI::Shopifolk.acting_as_shopify_organization?
+              context.puts(context.message("apps.create.info.install", partners_url, form.name))
+            end
+          end
+
+          private
+
+          def form_data(form_options)
+            if ShopifyCLI::Environment.acceptance_test?
+              Struct.new(:name, :organization_id, :type, :shop_domain, keyword_init: true).new(
+                name: form_options[:name],
+                organization_id: form_options[:organization_id] || "123",
+                shop_domain: form_options[:shop_domain] || "test.shopify.io",
+                type: form_options[:type] || "public",
+              )
+            else
+              Node::Forms::Create.ask(context, [], form_options)
+            end
+          end
+
+          def check_node
+            cmd_path = context.which("node")
+            context.abort(context.message("core.app.create.node.error.node_required")) if cmd_path.nil?
+
+            version, stat = context.capture2e("node", "-v")
+            unless stat.success?
+              context.abort(context.message("core.app.create.node.error.node_version_failure"))
+            end
+
+            context.done(context.message("core.app.create.node.node_version", version))
+          end
+
+          def check_npm
+            cmd_path = context.which("npm")
+            context.abort(context.message("core.app.create.node.error.npm_required")) if cmd_path.nil?
+
+            version, stat = context.capture2e("npm", "-v")
+            context.abort(context.message("core.app.create.node.error.npm_version_failure")) unless stat.success?
+
+            context.done(context.message("core.app.create.node.npm_version", version))
+          end
+
+          def set_npm_config
+            # check available npmrc (either user or system) for production registry
+            registry, _ = context.capture2("npm config get @shopify:registry")
+            return if registry.include?("https://registry.yarnpkg.com")
+
+            # available npmrc doesn't have production registry =>
+            # set a project-based .npmrc
+            context.system(
+              "npm",
+              "--userconfig",
+              "./.npmrc",
+              "config",
+              "set",
+              "@shopify:registry",
+              "https://registry.yarnpkg.com",
+              chdir: context.root
+            )
+          end
+
+          def build(name)
+            ShopifyCLI::Git.clone("https://github.com/Shopify/shopify-app-node.git", name)
+
+            context.root = File.join(context.root, name)
+
+            set_npm_config
+            ShopifyCLI::JsDeps.install(context, verbose)
+
+            begin
+              context.rm_r(".git")
+              context.rm_r(".github")
+              context.rm(File.join("server", "handlers", "client.js"))
+              context.rename(
+                File.join("server", "handlers", "client.cli.js"),
+                File.join("server", "handlers", "client.js")
+              )
+            rescue Errno::ENOENT => e
+              context.debug(e)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/services/app/create/php_service.rb

@@ -0,0 +1,152 @@
+require "semantic/semantic"
+
+module ShopifyCLI
+  module Services
+    module App
+      module Create
+        class PHPService < BaseService
+          attr_reader :name, :organization_id, :store_domain, :type, :verbose, :context
+
+          def initialize(name:, organization_id:, store_domain:, type:, verbose:, context:)
+            @name = name
+            @organization_id = organization_id
+            @store_domain = store_domain
+            @type = type
+            @verbose = verbose
+            @context = context
+            super()
+          end
+
+          def call
+            form = PHP::Forms::Create.ask(context, [], {
+              name: name,
+              organization_id: organization_id,
+              shop_domain: store_domain,
+              type: type,
+              verbose: verbose,
+            })
+            return context.puts(self.class.help) if form.nil?
+
+            check_php
+            check_composer
+            check_npm
+            app_id = build(form)
+
+            ShopifyCLI::Project.write(
+              context,
+              project_type: "php",
+              organization_id: form.organization_id,
+            )
+
+            partners_url = ShopifyCLI::PartnersAPI.partners_url_for(form.organization_id, app_id)
+
+            context.puts(context.message("apps.create.info.created", form.name, partners_url))
+            context.puts(context.message("apps.create.info.serve", form.name, ShopifyCLI::TOOL_NAME))
+            unless ShopifyCLI::Shopifolk.acting_as_shopify_organization?
+              context.puts(context.message("apps.create.info.install", partners_url, form.name))
+            end
+          end
+
+          private
+
+          def check_php
+            cmd_path = context.which("php")
+            context.abort(context.message("core.app.create.php.error.php_required")) if cmd_path.nil?
+
+            version, stat = context.capture2e("php", "-r", "echo phpversion();")
+            context.abort(context.message("core.app.create.php.error.php_version_failure")) unless stat.success?
+
+            if ::Semantic::Version.new(version) < ::Semantic::Version.new("7.3.0")
+              context.abort(context.message("core.app.create.php.error.php_version_too_low", "7.3"))
+            end
+
+            context.done(context.message("core.app.create.php.php_version", version))
+          end
+
+          def check_composer
+            cmd_path = context.which("composer")
+            context.abort(context.message("core.app.create.php.error.composer_required")) if cmd_path.nil?
+          end
+
+          def check_npm
+            cmd_path = context.which("npm")
+            context.abort(context.message("core.app.create.php.error.npm_required")) if cmd_path.nil?
+
+            version, stat = context.capture2e("npm", "-v")
+            context.abort(context.message("core.app.create.php.error.npm_version_failure")) unless stat.success?
+
+            context.done(context.message("core.app.create.php.npm_version", version))
+          end
+
+          def build(form)
+            ShopifyCLI::Git.clone("https://github.com/Shopify/shopify-app-php.git", form.name)
+
+            context.root = File.join(context.root, form.name)
+            context.chdir(context.root)
+
+            api_client = ShopifyCLI::Tasks::CreateApiClient.call(
+              context,
+              org_id: form.organization_id,
+              title: form.name,
+              type: form.type,
+            )
+
+            # Override the example settings with our own
+            context.cp(".env.example", ".env")
+
+            env_file = ShopifyCLI::Resources::EnvFile.read
+            env_file.api_key = api_client["apiKey"]
+            env_file.secret = api_client["apiSecretKeys"].first["secret"]
+            env_file.shop = form.shop_domain
+            env_file.host = "localhost"
+            env_file.scopes = "write_products,write_draft_orders,write_customers"
+            env_file.extra["DB_DATABASE"] = File.join(context.root, env_file.extra["DB_DATABASE"])
+            env_file.write(context)
+
+            ShopifyCLI::PHPDeps.install(context, verbose)
+
+            set_npm_config
+            ShopifyCLI::JsDeps.install(context, verbose)
+
+            title = context.message("core.app.create.php.app_setting_up")
+            success = context.message("core.app.create.php.app_set_up")
+            failure = context.message("core.app.create.php.error.app_setup")
+            CLI::UI::Frame.open(title, success_text: success, failure_text: failure) do
+              FileUtils.touch(env_file.extra["DB_DATABASE"])
+              context.system("php", "artisan", "key:generate")
+              context.system("php", "artisan", "migrate")
+            end
+
+            begin
+              context.rm_r(".git")
+              context.rm_r(".github")
+            rescue Errno::ENOENT => e
+              context.debug(e)
+            end
+
+            api_client["id"]
+          end
+
+          def set_npm_config
+            # check available npmrc (either user or system) for production registry
+            registry, _ = context.capture2("npm config get @shopify:registry")
+            return if registry.include?("https://registry.yarnpkg.com")
+
+            # available npmrc doesn't have production registry =>
+            # set a project-based .npmrc
+            context.system(
+              "npm",
+              "--userconfig",
+              "./.npmrc",
+              "config",
+              "set",
+              "@shopify:registry",
+              "https://registry.yarnpkg.com",
+              chdir: context.root
+            )
+          end
+        end
+      end
+    end
+  end
+end