shopify-cli 0.9.3 → 1.0.4

data/lib/project_types/script/templates/ts/as-pect.config.js

@@ -17,5 +17,11 @@ module.exports = {
         reportMax: false,
         reportMin: false,
     },
+    wasi: {
+      args: [],
+      env: process.env,
+      preopens: {},
+      returnOnExit: false,
+    },
     outputBinary: false,
 };

data/lib/project_types/script/ui/error_handler.rb

@@ -92,6 +92,10 @@ module Script
           {
             cause_of_error: ShopifyCli::Context.message('script.error.app_not_installed_cause'),
           }
+        when Layers::Infrastructure::Errors::AppScriptNotPushedError
+          {
+            cause_of_error: ShopifyCli::Context.message('script.error.app_script_not_pushed_help'),
+          }
         when Layers::Infrastructure::Errors::AppScriptUndefinedError
           {
             help_suggestion: ShopifyCli::Context.message('script.error.app_script_undefined_help'),

data/lib/project_types/script/ui/printing_spinner.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require 'shopify_cli'
+
+module Script
+  module UI
+    module PrintingSpinner
+      ##
+      # Creates a single spinner that runs the provided block.
+      # The block can take in a ctx argument that formats printed output to support
+      # printing from within the spin block.
+      #
+      # ==== Attributes
+      #
+      # * +ctx+   - The current context.
+      # * +title+ - Title of the spinner to use
+      #
+      # ==== Options
+      #
+      # * +:auto_debrief+ - Automatically debrief exceptions? Default to true
+      #
+      # ==== Block
+      #
+      # * +ctx+     - Instance of the PrintingSpinnerContext built from the ctx attribute.
+      #             - +ctx.puts(...)+ formats output to enable support for printing within spinners
+      # * +spinner+ - Instance of the spinner. Can call +update_title+ to update the user of changes
+      #
+      def self.spin(ctx, title, auto_debrief: false)
+        StrictSpinner.spin(title, auto_debrief: auto_debrief) do |spinner, *args|
+          Thread.current[:cliui_output_hook] = nil
+          yield(PrintingSpinnerContext.from(ctx, spinner), spinner, *args)
+        end
+      end
+
+      ##
+      # Printing within spinners requires the manipulation of ANSI escape
+      # sequences in order to make sure the CLI::UI::Spinner does not overwrite
+      # previously printed content.
+      class PrintingSpinnerContext < ShopifyCli::Context
+        include SmartProperties
+        property :spinner, required: true
+
+        def self.from(ctx, spinner)
+          new_ctx = new(spinner: spinner)
+          ctx.instance_variables.each do |var|
+            new_ctx.instance_variable_set(var, ctx.instance_variable_get(var))
+          end
+          new_ctx
+        end
+
+        def puts(*input)
+          super(encoded_lines(*input) + "\n" + spinner_text)
+        end
+
+        private
+
+        def encoded_lines(*lines)
+          lines
+            .join("\n")
+            .split("\n")
+            .map { |line| encode_ansi(line) unless line.nil? }
+            .join(CLI::UI::ANSI.next_line + "\n")
+        end
+
+        def encode_ansi(line)
+          CLI::UI::ANSI.previous_line + line + CLI::UI::ANSI.clear_to_end_of_line
+        end
+
+        def spinner_text
+          spinner.render(0, true)
+        end
+      end
+      private_constant(:PrintingSpinnerContext)
+    end
+  end
+end

data/lib/shopify-cli/admin_api.rb

@@ -37,8 +37,7 @@ module ShopifyCli
       #
       #   ShopifyCli::AdminAPI.query(@ctx, 'all_organizations')
       #
-      def query(ctx, query_name, api_version: nil, shop: nil, **variables)
-        shop ||= Project.current.env.shop
+      def query(ctx, query_name, shop:, api_version: nil, **variables)
         authenticated_req(ctx, shop) do
           api_client(ctx, api_version, shop).query(query_name, variables: variables)
         end

data/lib/shopify-cli/admin_api/populate_resource_command.rb

@@ -41,6 +41,8 @@ module ShopifyCli
           return @ctx.puts(output)
         end
 
+        @shop ||= Project.current.env.shop || get_shop(@ctx)
+
         if @silent
           spin_group = CLI::UI::SpinGroup.new
           spin_group.add(@ctx.message('core.populate.populating', @count, camel_case_resource_type)) do |spinner|
@@ -114,7 +116,7 @@ module ShopifyCli
 
       def run_mutation(data)
         kwargs = { input: data }
-        kwargs[:shop] = @shop if @shop
+        kwargs[:shop] = @shop
         resp = AdminAPI.query(
           @ctx, "create_#{snake_case_resource_type}", kwargs
         )
@@ -145,6 +147,13 @@ module ShopifyCli
 
       private
 
+      def get_shop(ctx)
+        res = ShopifyCli::Tasks::SelectOrgAndShop.call(ctx)
+        domain = res[:shop_domain]
+        Project.current.env.update(ctx, :shop, domain)
+        domain
+      end
+
       def camel_case_resource_type
         @camel_case_resource_type ||= self.class.to_s.split('::').last
       end

data/lib/shopify-cli/admin_api/schema.rb

@@ -3,15 +3,27 @@ require 'shopify_cli'
 module ShopifyCli
   class AdminAPI
     class Schema < Hash
-      def self.get(ctx)
-        unless ShopifyCli::DB.exists?(:shopify_admin_schema)
-          schema = AdminAPI.query(ctx, 'admin_introspection')
-          ShopifyCli::DB.set(shopify_admin_schema: JSON.dump(schema))
+      class << self
+        def get(ctx)
+          unless ShopifyCli::DB.exists?(:shopify_admin_schema)
+            shop = Project.current.env.shop || get_shop(ctx)
+            schema = AdminAPI.query(ctx, 'admin_introspection', shop: shop)
+            ShopifyCli::DB.set(shopify_admin_schema: JSON.dump(schema))
+          end
+          # This is ruby magic for making a new hash with another hash.
+          # It wraps the JSON in our Schema Class to have the helper methods
+          # available
+          self[JSON.parse(ShopifyCli::DB.get(:shopify_admin_schema))]
+        end
+
+        private
+
+        def get_shop(ctx)
+          res = ShopifyCli::Tasks::SelectOrgAndShop.call(ctx)
+          domain = res[:shop_domain]
+          Project.current.env.update(ctx, :shop, domain)
+          domain
         end
-        # This is ruby magic for making a new hash with another hash.
-        # It wraps the JSON in our Schema Class to have the helper methods
-        # available
-        self[JSON.parse(ShopifyCli::DB.get(:shopify_admin_schema))]
       end
 
       def type(name)

data/lib/shopify-cli/command.rb

@@ -3,12 +3,13 @@ require 'shopify_cli'
 
 module ShopifyCli
   class Command < CLI::Kit::BaseCommand
+    extend Feature::Set
+
     attr_writer :ctx
     attr_accessor :options
 
     class << self
       attr_writer :ctx
-      attr_reader :hidden
 
       def call(args, command_name)
         subcommand, resolved_name = subcommand_registry.lookup_command(args.first)
@@ -23,10 +24,6 @@ module ShopifyCli
         end
       end
 
-      def hidden_command
-        @hidden = true
-      end
-
       def options(&block)
         @_options = block
       end

data/lib/shopify-cli/commands.rb

@@ -18,6 +18,7 @@ module ShopifyCli
       @core_commands.include?(cmd)
     end
 
+    register :Config, 'config', 'shopify-cli/commands/config', true
     register :Connect, 'connect', 'shopify-cli/commands/connect', true
     register :Create, 'create', 'shopify-cli/commands/create', true
     register :Help, 'help', 'shopify-cli/commands/help', true

data/lib/shopify-cli/commands/config.rb

@@ -0,0 +1,44 @@
+require 'shopify_cli'
+
+module ShopifyCli
+  module Commands
+    class Config < ShopifyCli::Command
+      hidden_feature(feature_set: :debug)
+
+      subcommand :Feature, 'feature'
+
+      def call(*)
+        @ctx.puts(self.class.help)
+      end
+
+      def self.help
+        ShopifyCli::Context.message('core.config.help', ShopifyCli::TOOL_NAME)
+      end
+
+      class Feature < ShopifyCli::SubCommand
+        options do |parser, flags|
+          parser.on('--enable') { flags[:action] = 'enable' }
+          parser.on('--disable') { flags[:action] = 'disable' }
+          parser.on('--status') { flags[:action] = 'status' }
+        end
+
+        def call(args, _name)
+          feature_name = args.shift
+          return @ctx.puts(@ctx.message('core.config.help', ShopifyCli::TOOL_NAME)) if feature_name.nil?
+          is_enabled = ShopifyCli::Feature.enabled?(feature_name)
+          if options.flags[:action] == 'disable' && is_enabled
+            ShopifyCli::Feature.disable(feature_name)
+            @ctx.puts(@ctx.message('core.config.feature.disabled', is_enabled))
+          elsif options.flags[:action] == 'enable' && !is_enabled
+            ShopifyCli::Feature.enable(feature_name)
+            @ctx.puts(@ctx.message('core.config.feature.enabled', feature_name))
+          elsif is_enabled
+            @ctx.puts(@ctx.message('core.config.feature.is_enabled', feature_name))
+          else
+            @ctx.puts(@ctx.message('core.config.feature.is_disabled', feature_name))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify-cli/commands/connect.rb

@@ -6,7 +6,7 @@ module ShopifyCli
       def call(*)
         project_type = ask_project_type unless Project.has_current?
 
-        if Project.has_current? && Project.current
+        if Project.has_current? && Project.current && Project.current.env
           @ctx.puts @ctx.message('core.connect.already_connected_warning')
           prod_warning = @ctx.message('core.connect.production_warning')
           @ctx.puts prod_warning if [:rails, :node].include?(Project.current_project_type)
@@ -20,13 +20,13 @@ module ShopifyCli
 
         org = fetch_org
         id = org['id']
-        app = get_app(org['apps'])
+        app = get_app(id, org['apps'])
         shop = get_shop(org['stores'], id)
 
         write_env(app, shop, env_data[:scopes], env_data[:extra])
         write_cli_yml(project_type, id) unless Project.has_current?
 
-        @ctx.puts(@ctx.message('core.connect.connected', app.first['title']))
+        @ctx.puts(@ctx.message('core.connect.connected', app['title']))
       end
 
       def ask_project_type
@@ -45,7 +45,7 @@ module ShopifyCli
           CLI::UI::Prompt.ask(@ctx.message('core.connect.organization_select')) do |handler|
             orgs.each do |org|
               handler.option(
-                ctx.message('core.partners_api.org_name_and_id', org['businessName'], org['id'])
+                @ctx.message('core.partners_api.org_name_and_id', org['businessName'], org['id'])
               ) { org["id"] }
             end
           end
@@ -54,15 +54,22 @@ module ShopifyCli
         org
       end
 
-      def get_app(apps)
-        app_id = if apps.count == 1
-          apps.first["id"]
+      def get_app(org_id, apps)
+        if apps.count == 1
+          apps.first
+        elsif apps.count == 0
+          @ctx.puts(@ctx.message('core.connect.no_apps'))
+          title = CLI::UI::Prompt.ask(@ctx.message('core.connect.app_name'))
+          type = CLI::UI::Prompt.ask(@ctx.message('core.connect.app_type.select')) do |handler|
+            handler.option(@ctx.message('core.connect.app_type.select_public')) { 'public' }
+            handler.option(@ctx.message('core.connect.app_type.select_custom')) { 'custom' }
+          end
+          ShopifyCli::Tasks::CreateApiClient.call(@ctx, org_id: org_id, title: title, type: type)
         else
           CLI::UI::Prompt.ask(@ctx.message('core.connect.app_select')) do |handler|
-            apps.each { |app| handler.option(app["title"]) { app["id"] } }
+            apps.each { |app| handler.option(app["title"]) { app } }
           end
         end
-        apps.select { |app| app["id"] == app_id }
       end
 
       def get_shop(shops, id)
@@ -83,8 +90,8 @@ module ShopifyCli
         extra = {} if extra.nil?
 
         Resources::EnvFile.new(
-          api_key: app.first["apiKey"],
-          secret: app.first["apiSecretKeys"].first["secret"],
+          api_key: app["apiKey"],
+          secret: app["apiSecretKeys"].first["secret"],
           shop: shop,
           scopes: scopes,
           extra: extra,

data/lib/shopify-cli/commands/create.rb

@@ -28,7 +28,7 @@ module ShopifyCli
       def self.all_visible_type
         ProjectType
           .load_all
-          .select { |type| !type.hidden }
+          .select { |type| !type.hidden? }
       end
 
       def self.help

data/lib/shopify-cli/commands/help.rb

@@ -47,7 +47,7 @@ module ShopifyCli
 
       def core_commands
         resolved_commands
-          .select { |_name, c| !c.hidden }
+          .select { |_name, c| !c.hidden? }
           .select { |name, _c| Commands.core_command?(name) }
       end
 

data/lib/shopify-cli/commands/system.rb

@@ -4,7 +4,7 @@ require 'rbconfig'
 module ShopifyCli
   module Commands
     class System < ShopifyCli::Command
-      hidden_command
+      hidden_feature(feature_set: :debug)
 
       def call(args, _name)
         show_all_details = false

data/lib/shopify-cli/context.rb

@@ -146,10 +146,19 @@ module ShopifyCli
     # #### Parameters
     # * `path` - the file path to a directory, relative to the context root to remove from the FS
     #
-    def exist?(path)
+    def dir_exist?(path)
       Dir.exist?(ctx_path(path))
     end
 
+    # checks if a file exists, the filepath is relative to the command root unless absolute
+    #
+    # #### Parameters
+    # * `path` - the file path to a file, relative to the context root to remove from the FS
+    #
+    def file_exist?(path)
+      File.exist?(ctx_path(path))
+    end
+
     # will recursively copy a directory from the FS, the filepath is relative to the command
     # root unless absolute
     #

data/lib/shopify-cli/core.rb

@@ -4,6 +4,5 @@ module ShopifyCli
     autoload :Executor, 'shopify-cli/core/executor'
     autoload :HelpResolver, 'shopify-cli/core/help_resolver'
     autoload :Monorail, 'shopify-cli/core/monorail'
-    autoload :Update, 'shopify-cli/core/update'
   end
 end

data/lib/shopify-cli/core/entry_point.rb

@@ -11,6 +11,12 @@ module ShopifyCli
             IO.open(9) { is_shell_shim = true }
           rescue Errno::EBADF
             # This is expected if the descriptor doesn't exist
+          rescue ArgumentError => e
+            # This can happen on RVM, because it can use fd 9 itself and block access to it. That only happens if the fd
+            # did not exist beforehand, so that means there was no fd 9 before Ruby started.
+            unless e.message == 'The given fd is not accessible because RubyVM reserves it'
+              raise e
+            end
           end
 
           if !ctx.testing? && is_shell_shim

data/lib/shopify-cli/core/finalize.rb

@@ -0,0 +1,13 @@
+module ShopifyCli
+  module Core
+    # This class is just a dummy to make sure that we don't trigger warnings on the first time the updated code runs.
+    # The old code would try to call the Finalizer after it is done updating, which would then trigger an autoload of
+    # this class and fail.
+    module Finalize
+      class << self
+        def deliver!
+        end
+      end
+    end
+  end
+end

data/lib/shopify-cli/feature.rb

@@ -0,0 +1,97 @@
+module ShopifyCli
+  ##
+  # ShopifyCli::Feature contains the logic to hide and show features across the CLI
+  # These features can be either commands or project types currently.
+  #
+  # Feature flags will persist between runs so if the flag is enabled or disabled,
+  # it will still be in that same state on the next cli invocation.
+  class Feature
+    SECTION = 'features'
+
+    ##
+    # ShopifyCli::Feature::Set is included on commands and projects to allow you to hide
+    # and enable projects and commands based on feature flags.
+    module Set
+      ##
+      # will hide a feature, either a project_type or a command
+      #
+      # #### Parameters
+      #
+      # * `feature_set` - either a single, or array of symbols that represent feature sets
+      #
+      # #### Example
+      #
+      #    module ShopifyCli
+      #      module Commands
+      #        class Config < ShopifyCli::Command
+      #          hidden_feature(feature_set: :basic)
+      #          ....
+      #
+      def hidden_feature(feature_set: [])
+        @feature_hidden = true
+        @hidden_feature_set = Array(feature_set).compact
+      end
+
+      ##
+      # will return if the feature has been hidden or not
+      #
+      # #### Returns
+      #
+      # * `is_hidden` - returns true if the feature has been hidden and false otherwise
+      #
+      # #### Example
+      #
+      #     ShopifyCli::Commands::Config.hidden?
+      #
+      def hidden?
+        enabled = (@hidden_feature_set || []).any? do |feature|
+          Feature.enabled?(feature)
+        end
+        @feature_hidden && !enabled
+      end
+    end
+
+    class << self
+      ##
+      # will enable a feature in the CLI.
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing the flag to be enabled
+      def enable(feature)
+        set(feature, true)
+      end
+
+      ##
+      # will disable a feature in the CLI.
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing the flag to be disabled
+      def disable(feature)
+        set(feature, false)
+      end
+
+      ##
+      # will check if the feature has been enabled
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing a flag that the status should be requested
+      #
+      # #### Returns
+      #
+      # * `is_enabled` - will be true if the feature has been enabled.
+      def enabled?(feature)
+        return false if feature.nil?
+        ShopifyCli::Config.get_bool(SECTION, feature.to_s)
+      end
+
+      private
+
+      def set(feature, value)
+        ShopifyCli::Config.set(SECTION, feature.to_s, value)
+      end
+    end
+  end
+end