shopify-cli 2.4.0 → 2.6.2

data/lib/{shopify-cli → shopify_cli}/transform_data_structure.rb

@@ -1,5 +1,5 @@
 
-module ShopifyCli
+module ShopifyCLI
   ##
   # `TransformDataStructure` helps to standardize data structure access. It
   # traverses nested data structures and can convert
@@ -22,13 +22,13 @@ module ShopifyCli
   # Since `TransformDataStructure` is a method object, it can easily be chained:
   #
   #    require 'open-uri'
-  #    ShopifyCli::Result
+  #    ShopifyCLI::Result
   #      .call { open("https://jsonplaceholder.typicode.com/todos/1") }
   #      .map(&TransformDataStructure.new(symbolize_keys: true, underscore_keys: true))
   #      .value # => { id: 1, user_id: 1, ... }
   #
   class TransformDataStructure
-    include ShopifyCli::MethodObject
+    include ShopifyCLI::MethodObject
 
     class << self
       private
@@ -53,7 +53,7 @@ module ShopifyCli
           result[transform_key(key)] = call(value).value
         end
       else
-        ShopifyCli::Result.success(object)
+        ShopifyCLI::Result.success(object)
       end
     end
 

data/lib/{shopify-cli → shopify_cli}/tunnel.rb

@@ -4,7 +4,7 @@ require "shopify_cli"
 require "forwardable"
 require "uri"
 
-module ShopifyCli
+module ShopifyCLI
   ##
   # Wraps around ngrok functionality to allow you to spawn a ngrok proccess in the
   # background and stop the process when you need to. It also allows control over
@@ -39,8 +39,8 @@ module ShopifyCli
     # * `ctx` - running context from your command
     #
     def stop(ctx)
-      if ShopifyCli::ProcessSupervision.running?(:ngrok)
-        if ShopifyCli::ProcessSupervision.stop(:ngrok)
+      if ShopifyCLI::ProcessSupervision.running?(:ngrok)
+        if ShopifyCLI::ProcessSupervision.stop(:ngrok)
           ctx.puts(ctx.message("core.tunnel.stopped"))
         else
           ctx.abort(ctx.message("core.tunnel.error.stop"))
@@ -75,7 +75,7 @@ module ShopifyCli
         end
         ctx.puts(ctx.message("core.tunnel.start", url))
         ctx.puts(ctx.message("core.tunnel.will_timeout", seconds_to_hm(seconds_remaining)))
-        ctx.puts(ctx.message("core.tunnel.signup_suggestion", ShopifyCli::TOOL_NAME))
+        ctx.puts(ctx.message("core.tunnel.signup_suggestion", ShopifyCLI::TOOL_NAME))
       end
       url
     end
@@ -91,7 +91,7 @@ module ShopifyCli
     #
     def auth(ctx, token)
       install(ctx)
-      ctx.system(File.join(ShopifyCli.cache_dir, "ngrok"), "authtoken", token)
+      ctx.system(File.join(ShopifyCLI.cache_dir, "ngrok"), "authtoken", token)
     end
 
     ##
@@ -145,28 +145,28 @@ module ShopifyCli
 
     def install(ctx)
       ngrok = "ngrok#{ctx.executable_file_extension}"
-      return if File.exist?(File.join(ShopifyCli.cache_dir, ngrok))
+      return if File.exist?(File.join(ShopifyCLI.cache_dir, ngrok))
       check_prereq_command(ctx, "curl")
       check_prereq_command(ctx, ctx.linux? ? "unzip" : "tar")
       spinner = CLI::UI::SpinGroup.new
       spinner.add(ctx.message("core.tunnel.installing")) do
-        zip_dest = File.join(ShopifyCli.cache_dir, "ngrok.zip")
+        zip_dest = File.join(ShopifyCLI.cache_dir, "ngrok.zip")
         unless File.exist?(zip_dest)
-          ctx.system("curl", "-o", zip_dest, DOWNLOAD_URLS[ctx.os], chdir: ShopifyCli.cache_dir)
+          ctx.system("curl", "-o", zip_dest, DOWNLOAD_URLS[ctx.os], chdir: ShopifyCLI.cache_dir)
         end
         args = if ctx.linux?
           %W(unzip -u #{zip_dest})
         else
           %W(tar -xf #{zip_dest})
         end
-        ctx.system(*args, chdir: ShopifyCli.cache_dir)
+        ctx.system(*args, chdir: ShopifyCLI.cache_dir)
         ctx.rm(zip_dest)
       end
       spinner.wait
 
       # final check to see if ngrok is accessible
-      unless File.exist?(File.join(ShopifyCli.cache_dir, ngrok))
-        ctx.abort(ctx.message("core.tunnel.error.ngrok", ngrok, ShopifyCli.cache_dir))
+      unless File.exist?(File.join(ShopifyCLI.cache_dir, ngrok))
+        ctx.abort(ctx.message("core.tunnel.error.ngrok", ngrok, ShopifyCLI.cache_dir))
       end
     end
 
@@ -178,7 +178,7 @@ module ShopifyCli
     end
 
     def ngrok_command(port)
-      "\"#{File.join(ShopifyCli.cache_dir, "ngrok")}\" http -inspect=false -log=stdout -log-level=debug #{port}"
+      "\"#{File.join(ShopifyCLI.cache_dir, "ngrok")}\" http -inspect=false -log=stdout -log-level=debug #{port}"
     end
 
     def seconds_to_hm(seconds)
@@ -186,14 +186,14 @@ module ShopifyCli
     end
 
     def start_ngrok(ctx, port)
-      process = ShopifyCli::ProcessSupervision.start(:ngrok, ngrok_command(port))
+      process = ShopifyCLI::ProcessSupervision.start(:ngrok, ngrok_command(port))
       log = fetch_url(ctx, process.log_path)
       seconds_remaining = (process.time.to_i + log.timeout) - Time.now.to_i
       [log.url, log.account, seconds_remaining]
     end
 
     def restart_ngrok(ctx, port)
-      unless ShopifyCli::ProcessSupervision.stop(:ngrok)
+      unless ShopifyCLI::ProcessSupervision.stop(:ngrok)
         ctx.abort(ctx.message("core.tunnel.error.stop"))
       end
       start_ngrok(ctx, port)

data/lib/shopify_cli/version.rb

@@ -0,0 +1,3 @@
+module ShopifyCLI
+  VERSION = "2.6.2"
+end

data/lib/shopify_cli.rb

@@ -24,7 +24,9 @@ end
 require "cli/ui"
 require "cli/kit"
 require "smart_properties"
-require_relative "shopify-cli/version"
+require_relative "shopify_cli/version"
+require_relative "shopify_cli/migrator"
+require_relative "shopify_cli/exception_reporter"
 
 # Enable stdout routing. At this point all calls to STDOUT (and STDERR) will go through this class.
 # See https://github.com/Shopify/cli-ui/blob/main/lib/cli/ui/stdout_router.rb for more info
@@ -36,7 +38,7 @@ CLI::UI::StdoutRouter.enable
 #
 # It is recommended to read through CLI Kit (https://github.com/shopify/cli-kit) and a CLI Kit example
 # (https://github.com/Shopify/cli-kit-example) to fully understand how shopify-cli functions
-module ShopifyCli
+module ShopifyCLI
   extend CLI::Kit::Autocall
 
   TOOL_NAME         = "shopify"
@@ -75,66 +77,67 @@ module ShopifyCli
   # application and CLI kit framework.
   # To understand how this works, read https://github.com/Shopify/cli-kit/blob/main/lib/cli/kit.rb
 
-  # ShopifyCli::Config
+  # ShopifyCLI::Config
   autocall(:Config)   { CLI::Kit::Config.new(tool_name: TOOL_NAME) }
-  # ShopifyCli::Logger
-  autocall(:Logger)   { CLI::Kit::Logger.new(debug_log_file: ShopifyCli.debug_log_file) }
-  # ShopifyCli::Resolver
+  # ShopifyCLI::Logger
+  autocall(:Logger)   { CLI::Kit::Logger.new(debug_log_file: ShopifyCLI.debug_log_file) }
+  # ShopifyCLI::Resolver
   autocall(:Resolver) do
-    ShopifyCli::Core::HelpResolver.new(
+    ShopifyCLI::Core::HelpResolver.new(
       tool_name: TOOL_NAME,
-      command_registry: ShopifyCli::Commands::Registry
+      command_registry: ShopifyCLI::Commands::Registry
     )
   end
-  # ShopifyCli::ErrorHandler
+  # ShopifyCLI::ErrorHandler
   autocall(:ErrorHandler) do
     CLI::Kit::ErrorHandler.new(
-      log_file: ShopifyCli.log_file,
-      exception_reporter: nil,
+      log_file: ShopifyCLI.log_file,
+      exception_reporter: ->() { ShopifyCLI::ExceptionReporter },
     )
   end
 
-  autoload :Constants, "shopify-cli/constants"
-  autoload :Environment, "shopify-cli/environment"
-  autoload :AdminAPI, "shopify-cli/admin_api"
-  autoload :API, "shopify-cli/api"
-  autoload :Command, "shopify-cli/command"
-  autoload :Commands, "shopify-cli/commands"
-  autoload :Connect, "shopify-cli/connect"
-  autoload :Context, "shopify-cli/context"
-  autoload :Core, "shopify-cli/core"
-  autoload :DB, "shopify-cli/db"
-  autoload :Feature, "shopify-cli/feature"
-  autoload :Form, "shopify-cli/form"
-  autoload :Git, "shopify-cli/git"
-  autoload :Helpers, "shopify-cli/helpers"
-  autoload :Heroku, "shopify-cli/heroku"
-  autoload :IdentityAuth, "shopify-cli/identity_auth"
-  autoload :JsDeps, "shopify-cli/js_deps"
-  autoload :JsSystem, "shopify-cli/js_system"
-  autoload :LazyDelegator, "shopify-cli/lazy_delegator"
-  autoload :MethodObject, "shopify-cli/method_object"
-  autoload :Options, "shopify-cli/options"
-  autoload :PartnersAPI, "shopify-cli/partners_api"
-  autoload :ProcessSupervision, "shopify-cli/process_supervision"
-  autoload :Project, "shopify-cli/project"
-  autoload :ProjectCommands, "shopify-cli/project_commands"
-  autoload :ProjectType, "shopify-cli/project_type"
-  autoload :ResolveConstant, "shopify-cli/resolve_constant"
-  autoload :Resources, "shopify-cli/resources"
-  autoload :Result, "shopify-cli/result"
-  autoload :Shopifolk, "shopify-cli/shopifolk"
-  autoload :SubCommand, "shopify-cli/sub_command"
-  autoload :Task, "shopify-cli/task"
-  autoload :Tasks, "shopify-cli/tasks"
-  autoload :TransformDataStructure, "shopify-cli/transform_data_structure"
-  autoload :Tunnel, "shopify-cli/tunnel"
-
-  require "shopify-cli/messages/messages"
-  Context.load_messages(ShopifyCli::Messages::MESSAGES)
+  autoload :Constants, "shopify_cli/constants"
+  autoload :Environment, "shopify_cli/environment"
+  autoload :AdminAPI, "shopify_cli/admin_api"
+  autoload :API, "shopify_cli/api"
+  autoload :Command, "shopify_cli/command"
+  autoload :Commands, "shopify_cli/commands"
+  autoload :Connect, "shopify_cli/connect"
+  autoload :Context, "shopify_cli/context"
+  autoload :Core, "shopify_cli/core"
+  autoload :DB, "shopify_cli/db"
+  autoload :Feature, "shopify_cli/feature"
+  autoload :Form, "shopify_cli/form"
+  autoload :Git, "shopify_cli/git"
+  autoload :Helpers, "shopify_cli/helpers"
+  autoload :Heroku, "shopify_cli/heroku"
+  autoload :IdentityAuth, "shopify_cli/identity_auth"
+  autoload :JsDeps, "shopify_cli/js_deps"
+  autoload :JsSystem, "shopify_cli/js_system"
+  autoload :PHPDeps, "shopify_cli/php_deps"
+  autoload :LazyDelegator, "shopify_cli/lazy_delegator"
+  autoload :MethodObject, "shopify_cli/method_object"
+  autoload :Options, "shopify_cli/options"
+  autoload :PartnersAPI, "shopify_cli/partners_api"
+  autoload :ProcessSupervision, "shopify_cli/process_supervision"
+  autoload :Project, "shopify_cli/project"
+  autoload :ProjectCommands, "shopify_cli/project_commands"
+  autoload :ProjectType, "shopify_cli/project_type"
+  autoload :ResolveConstant, "shopify_cli/resolve_constant"
+  autoload :Resources, "shopify_cli/resources"
+  autoload :Result, "shopify_cli/result"
+  autoload :Shopifolk, "shopify_cli/shopifolk"
+  autoload :SubCommand, "shopify_cli/sub_command"
+  autoload :Task, "shopify_cli/task"
+  autoload :Tasks, "shopify_cli/tasks"
+  autoload :TransformDataStructure, "shopify_cli/transform_data_structure"
+  autoload :Tunnel, "shopify_cli/tunnel"
+
+  require "shopify_cli/messages/messages"
+  Context.load_messages(ShopifyCLI::Messages::MESSAGES)
 
   def self.cache_dir
-    cache_dir = if Environment.running_tests?
+    cache_dir = if Environment.test?
       TEMP_DIR
     elsif ENV["LOCALAPPDATA"].nil?
       File.join(File.expand_path(ENV.fetch("XDG_CACHE_HOME", "~/.cache")), TOOL_NAME)
@@ -149,7 +152,7 @@ module ShopifyCli
   end
 
   def self.tool_config_path
-    if Environment.running_tests?
+    if Environment.test?
       TEMP_DIR
     elsif ENV["APPDATA"].nil?
       File.join(File.expand_path(ENV.fetch("XDG_CONFIG_HOME", "~/.config")), TOOL_NAME)
@@ -168,6 +171,12 @@ module ShopifyCli
 
   def self.sha
     return @sha if defined?(@sha)
-    @sha = Git.sha(dir: ShopifyCli::ROOT)
+    @sha = Git.sha(dir: ShopifyCLI::ROOT)
+  end
+
+  # Migrate runs migrations that migrate the state of the environment
+  # in which the CLI runs.
+  unless ShopifyCLI::Environment.test? || ShopifyCLI::Environment.development?
+    ShopifyCLI::Migrator.migrate
   end
 end

data/shopify-cli.gemspec

@@ -1,8 +1,8 @@
-require_relative "lib/shopify-cli/version"
+require_relative "lib/shopify_cli/version"
 
 Gem::Specification.new do |spec|
   spec.name = "shopify-cli"
-  spec.version = ShopifyCli::VERSION
+  spec.version = ShopifyCLI::VERSION
   spec.authors = ["Shopify"]
   spec.email = ["dev-tools-education@shopify.com"]
   spec.license = "MIT"
@@ -43,6 +43,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency("rake", "~> 12.3", ">= 12.3.3")
   spec.add_development_dependency("minitest", "~> 5.0")
 
+  spec.add_dependency("bugsnag", "~> 6.22")
   spec.add_dependency("listen", "~> 3.7.0")
-  spec.add_dependency("theme-check", "~> 1.4.0")
+
+  # Note: theme-check is _intentionally_ not specifying the third
+  # digit. We _want_ new features to make their way into new installs
+  # of the Shopify CLI. Otherwise updates need to be released twice.
+  #
+  # That is, DO USE ~> 1.X, DO NOT USE ~> 1.X.Y, this would unnecessarily
+  # fix the feature version.
+  spec.add_dependency("theme-check", "~> 1.7")
 end

data/utilities/docker.rb

@@ -0,0 +1,47 @@
+require "open3"
+
+module Utilities
+  module Docker
+    Error = Class.new(StandardError)
+
+    class << self
+      def run_and_rm_container(*args)
+        build_image_if_needed
+        system(
+          "docker", "run",
+          "-t", "--rm",
+          "--volume", "#{Shellwords.escape(root_dir)}:/usr/src/app",
+          image_tag,
+          *args
+        ) || abort
+      end
+
+      private
+
+      def root_dir
+        File.expand_path("..", __dir__)
+      end
+
+      def build_image_if_needed
+        unless image_exists?(image_tag)
+          system("docker", "build", root_dir, "-t", image_tag) || abort
+        end
+      end
+
+      def image_tag
+        gemfile_lock_path = File.expand_path("./Gemfile.lock", root_dir)
+        image_sha = Digest::SHA256.hexdigest(File.read(gemfile_lock_path))
+        "shopify-cli-#{image_sha}"
+      end
+
+      def image_exists?(tag)
+        _, stat = Open3.capture2(
+          "docker", "inspect",
+          "--type=image",
+          tag
+        )
+        stat.success?
+      end
+    end
+  end
+end

data/utilities/utilities.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
+
+module Utilities
+  autoload :Docker, "docker"
+end