Extract bootstrap/framework code from dev #5

burke · 2018-01-22T21:19:04Z

This PR extracts a bunch of the really generic bootstrap-level code from dev. Much of it is directly moved and renamespaced. I'm adding comments to draw attention to what got a more serious facelift.

burke · 2018-01-22T21:19:42Z

lib/cli/kit/base_command.rb

+        true
+      end
+
+      def self.statsd_increment(metric, **kwargs)


I'll probably migrate Statsd over here too, but for now, these two are interface methods.

burke · 2018-01-22T21:20:14Z

lib/cli/kit/base_command.rb

+
+module CLI
+  module Kit
+    class BaseCommand


This is Dev::Command, more or less. I was able to extract a reasonable amount of it to here and subclass this over there.

burke · 2018-01-22T21:21:19Z

lib/cli/kit/command_registry.rb

+
+module CLI
+  module Kit
+    module CommandRegistry


Some modest gymnastics here to manage variables on this command vs. access the module it's extended in.

burke · 2018-01-22T21:22:48Z

lib/cli/kit/command_registry.rb

+        attr_accessor :registry_target
+      end
+
+      def resolve_contextual_command


The concept of "Project-local" and "Type" commands was generalized a bit into "Contextual" commands. The interface to add contextual commands to a command registry is:

resolve_contextual_command

contextual_aliases

contextual_command_class

This is a pretty niche concern and I don't really expect to build too many tools other than dev that use this feature.

So this is only included for stuff from a dev.yml?

Well it's "included" everywhere depending on what you mean, but, well: https://github.com/Shopify/dev/blob/4eea78118cc0f6fe4180f37aef97ab676101915c/lib/dev/commands.rb#L7-L19

burke · 2018-01-22T21:23:55Z

lib/cli/kit/config.rb

+      # if ENV['XDG_CONFIG_HOME'] is not set, we default to ~/.config, e.g.:
+      #   ~/.config/tool/config
+      #
+      def file


This is different. I've overridden it back to the current behaviour in dev, but this is what we probably should have done initially. It's a bit tricky to migrate now, but I might shave that yak eventually.

burke · 2018-01-22T21:24:56Z

lib/cli/kit/entry_point.rb

+module CLI
+  module Kit
+    class EntryPoint
+      # Interface methods: You may want to implement these:


The abstraction feels a little rough here but four miscellaneous subclass/interface methods seems tolerable.

burke · 2018-01-22T21:26:37Z

lib/cli/kit/report_errors.rb

+
+      # error_reporter should support the interface:
+      #  .call(notify_with, logs = nil, stage = nil, api_key = nil, custom_metadata = {})
+      def self.setup(logfile_path, error_reporter)


Going back and forth on whether to actually bring in bugsnag or leave it at this kind of awkward integration level.

What would an app need to implement to use ReportErrors?

I made the comment more useful.

jules2689 · 2018-01-22T21:29:12Z

lib/cli/kit/command_registry.rb

+        attr_accessor :registry_target
+      end
+
+      def resolve_contextual_command


So this is only included for stuff from a dev.yml?

jules2689 · 2018-01-22T21:29:37Z

lib/cli/kit/command_registry.rb

+      end
+
+      def self.extended(base)
+        raise "multiple registries unsupported" if registry_target


if self.registry_target to be consistent with the next line?

self is only needed on the next line because it's a setter, and otherwise it would create a variable called registry_target and set it to base. self. convinces ruby that it's a method call.

jules2689 · 2018-01-22T21:30:03Z

lib/cli/kit/config.rb

+        @toolname = toolname
+      end
+
+      # Fixes a bug where setting a key,val would result in the key growing with whitespace


We can remove this method and what calls it

jules2689 · 2018-01-22T21:30:45Z

lib/cli/kit/config.rb

+
+module CLI
+  module Kit
+    class Config


Quick follow up here is to make CLI::Kit::Config subclass our IniParser (or use it)

Yup. I have bad timing but there wasn't much transformation here so it's an easy follow-up

jules2689 · 2018-01-22T21:31:04Z

lib/cli/kit/config.rb

+        end
+      end
+
+      # Returns a mapping of all srcpath variables in the ~/.devconfig file


This is not needed outside of dev

jules2689 · 2018-01-22T21:31:23Z

lib/cli/kit/config.rb

+        path_config
+      end
+
+      # Returns a path from config in expanded form


Not needed outside of dev

I disagree. I think it's generically useful.

jules2689 · 2018-01-22T21:33:36Z

lib/cli/kit/entry_point.rb

+                STDERR.puts(CLI::UI.fmt("{{command:#{EntryPoint.tool_name} #{@command_name}}} was not found"))
+              end
+
+              # TODO: this can be removed when we drop Sierra support


Let's just remove this?

We should move OS support to before_initialize

Oh yeah, that was only necessary in the first place when we were trying to get Levenshtein from the stdlib.

jules2689 · 2018-01-22T21:35:04Z

lib/cli/kit/report_errors.rb

+
+      # error_reporter should support the interface:
+      #  .call(notify_with, logs = nil, stage = nil, api_key = nil, custom_metadata = {})
+      def self.setup(logfile_path, error_reporter)


What would an app need to implement to use ReportErrors?

lugray · 2018-01-23T18:47:40Z

lib/cli/kit/config.rb

+        @ini.to_s
+      end
+
+      def un_ini


This shouldn't be ported. This was my escape hatch that I left in in case of problems.

lugray · 2018-01-23T18:49:04Z

lib/cli/kit/config.rb

+        File.expand_path(File.join(toolname, 'config'), config_home)
+      end
+
+      def reset


This probably only makes sense for dev which doesn't have an instance, or acts like it doesn't.

lugray · 2018-01-23T18:50:29Z

lib/cli/kit/config.rb

+        return @ini.ini if @ini
+        @ini = Dev::Helpers::Ini.new(file, default_section: "[global]", convert_types: false)
+        @ini.parse
+        if @ini.ini.keys == ["[global]"]


This if block and convert_package_cloud below are specific to the dev config migration.

lugray · 2018-01-23T19:56:48Z

lib/cli/kit/config.rb

+        return @ini if @ini
+        @ini = CLI::Kit::Ini
+          .new(file, default_section: "[global]", convert_types: false)
+          .tap(&:parse)


😍 .tap(&:parse). Now @ini ||= , killing the early return.

burke · 2018-01-23T21:18:02Z

Ok, I have tests passing on dev. Going to merge this for now and get it shipped over there.

burke commented Jan 22, 2018

View reviewed changes

burke requested review from jules2689 and lugray January 22, 2018 21:27

jules2689 reviewed Jan 22, 2018

View reviewed changes

burke force-pushed the extract-from-dev branch from 081f9e7 to ee270e6 Compare January 23, 2018 18:46

lugray reviewed Jan 23, 2018

View reviewed changes

burke force-pushed the extract-from-dev branch from ee270e6 to 788c46f Compare January 23, 2018 18:48

lugray reviewed Jan 23, 2018

View reviewed changes

burke force-pushed the extract-from-dev branch from 788c46f to f32f9dd Compare January 23, 2018 18:50

lugray reviewed Jan 23, 2018

View reviewed changes

Extract various components from dev

748b5ad

burke force-pushed the extract-from-dev branch from e4e3f1e to 748b5ad Compare January 23, 2018 21:05

burke merged commit 142f1fb into master Jan 23, 2018

burke deleted the extract-from-dev branch January 23, 2018 21:18

technicalpickles mentioned this pull request Dec 14, 2021

CLI::Kit documentation mentions reporting Bug to bugsnag, but does not seem to be implemented #166

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extract bootstrap/framework code from dev #5

Extract bootstrap/framework code from dev #5

burke commented Jan 22, 2018

burke Jan 22, 2018

burke Jan 22, 2018

burke Jan 22, 2018

burke Jan 22, 2018

jules2689 Jan 22, 2018

burke Jan 22, 2018

burke Jan 22, 2018

burke Jan 22, 2018

burke Jan 22, 2018

jules2689 Jan 22, 2018

burke Jan 22, 2018

jules2689 Jan 22, 2018

jules2689 Jan 22, 2018

lugray Jan 23, 2018 •

edited

Loading

jules2689 Jan 22, 2018

jules2689 Jan 22, 2018

burke Jan 22, 2018

jules2689 Jan 22, 2018

jules2689 Jan 22, 2018

lugray Jan 23, 2018

jules2689 Jan 22, 2018

jules2689 Jan 22, 2018

burke Jan 22, 2018

jules2689 Jan 22, 2018

lugray Jan 23, 2018

lugray Jan 23, 2018

lugray Jan 23, 2018

lugray Jan 23, 2018

burke commented Jan 23, 2018

Extract bootstrap/framework code from dev #5

Extract bootstrap/framework code from dev #5

Conversation

burke commented Jan 22, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lugray Jan 23, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

burke commented Jan 23, 2018

lugray Jan 23, 2018 •

edited

Loading