shopify-cli 2.6.3 → 2.7.0

data/lib/shopify_cli/migrator/migrations/1633691650_merge_reporting_configuration.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ShopifyCLI
+  module Migrator
+    module Migrations
+      # Before this migration, users configured automatic usage and error
+      # reporting independenty. We changed it to be a single configuration
+      # in the environment's configuration and therefore we need a migration
+      # to merge the configurations.
+      class MergeReportingConfiguration
+        def self.run
+          analytics_enabled = ShopifyCLI::Config.get_bool(
+            Constants::Config::Sections::Analytics::NAME,
+            Constants::Config::Sections::Analytics::Fields::ENABLED,
+            default: false
+          )
+          error_reporting_enabled = ShopifyCLI::Config.get_bool(
+            "error-tracking",
+            "automatic-reporting",
+            default: false
+          )
+          # Because we are merging configuration options, both need
+          # to be true to for the new flag to be true. Otherwise,
+          # we delete them and let the CLI prompt the user again.
+          should_merge_be_true = analytics_enabled && error_reporting_enabled
+
+          unless should_merge_be_true
+            ShopifyCLI::Config.unset(
+              Constants::Config::Sections::Analytics::NAME,
+              Constants::Config::Sections::Analytics::Fields::ENABLED
+            )
+            ShopifyCLI::Config.unset(
+              "error-tracking",
+              "automatic-reporting"
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_cli/migrator.rb

@@ -9,23 +9,21 @@ module ShopifyCLI
       migrations_directory: File.expand_path("migrator/migrations", __dir__)
     )
       baseline_date = last_migration_date
-      unless baseline_date.nil?        
-        migrations = migrations(migrations_directory: migrations_directory)
-          .select { |m| 
-            m.date > baseline_date.to_i 
-          }
-          .each { |m| m.run }
+      unless baseline_date.nil?
+        migrations(migrations_directory: migrations_directory)
+          .select do |m|
+            m.date > baseline_date.to_i
+          end
+          .each(&:run)
       end
 
       store_last_migration_date
     end
 
-    private
-
     def self.store_last_migration_date
       ShopifyCLI::DB.set(ShopifyCLI::Constants::StoreKeys::LAST_MIGRATION_DATE => Time.now.to_i)
     end
-    
+
     def self.last_migration_date
       ShopifyCLI::DB.get(ShopifyCLI::Constants::StoreKeys::LAST_MIGRATION_DATE)
     end
@@ -35,7 +33,7 @@ module ShopifyCLI
         file_name = File.basename(file_path).gsub(".rb", "")
         file_name_components = file_name.split("_")
         date_timestamp = file_name_components[0].to_i
-        migration_name = file_name_components[1...].join("_")
+        migration_name = file_name_components.drop(1).join("_")
 
         Migrator::Migration.new(
           name: migration_name,
@@ -45,4 +43,4 @@ module ShopifyCLI
       end
     end
   end
-end
+end

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/reporting_configuration_controller.rb

@@ -0,0 +1,64 @@
+module ShopifyCLI
+  module ReportingConfigurationController
+    def self.enable_reporting(enabled)
+      ShopifyCLI::Config.set(
+        Constants::Config::Sections::Analytics::NAME,
+        Constants::Config::Sections::Analytics::Fields::ENABLED,
+        enabled
+      )
+    end
+
+    def self.reporting_prompted?
+      ShopifyCLI::Config.get_section(Constants::Config::Sections::Analytics::NAME).key?(
+        Constants::Config::Sections::Analytics::Fields::ENABLED
+      )
+    end
+
+    def self.reporting_enabled?
+      ShopifyCLI::Config.get_bool(
+        Constants::Config::Sections::Analytics::NAME,
+        Constants::Config::Sections::Analytics::Fields::ENABLED,
+        default: false
+      )
+    end
+
+    def self.check_or_prompt_report_automatically(source: :usage, prompt: true, context: ShopifyCLI::Context.new)
+      return false if ShopifyCLI::Environment.development? || ShopifyCLI::Environment.test?
+
+      # If the terminal is not interactive we can't prompt the user.
+      return false unless ShopifyCLI::Environment.interactive?
+
+      if reporting_prompted?
+        reporting_enabled?
+      elsif prompt
+        prompt_user(context: context, source: source)
+      else
+        false
+      end
+    end
+
+    def self.prompt_user(context:, source:)
+      enable_automatic_tracking = CLI::UI::Prompt.ask(
+        context.message("core.analytics.enable_prompt.#{source}.question")
+      ) do |handler|
+        handler.option(context.message("core.analytics.enable_prompt.#{source}.yes")) { |_| true }
+        handler.option(context.message("core.analytics.enable_prompt.#{source}.no")) { |_| false }
+      end
+
+      ShopifyCLI::Config.set(
+        Constants::Config::Sections::Analytics::NAME,
+        Constants::Config::Sections::Analytics::Fields::ENABLED,
+        enable_automatic_tracking
+      )
+
+      message = if enable_automatic_tracking
+        context.message("core.reporting.turned_on_message")
+      else
+        context.message("core.reporting.turned_off_message", ShopifyCLI::TOOL_NAME)
+      end
+      context.puts(message)
+
+      enable_automatic_tracking
+    end
+  end
+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