Collect plugins which should be processed by webpack

Bernhard_Suttner · October 5, 2021, 9:13am

Currently, the method to collect the plugins which should be processed by webpack is implemented like this:

theforeman/foreman/blob/develop/script/plugin_webpack_directories.rb#L42


      
              plugin_name
            end
          end
          
          config = { entries: {}, paths: [], plugins: {} }
          entry_paths = []
          plugin_name_regexp = /foreman.*|katello.*/
          specs.each do |dep|
            dep = dep.to_spec if gemfile_in
          
            # skip other rails engines that are not plugins
            # TODO: Consider using the plugin registration api?
            unless dep.respond_to?("metadata") && dep.metadata.has_key?("is_foreman_plugin") && dep.metadata["is_foreman_plugin"] == "true"
              next unless dep.name =~ plugin_name_regexp
              next if dep.name =~ /.*[_-]core$/
            end
          
            path = "#{dep.to_spec.full_gem_path}/webpack"
          
            unless Dir.exist?(path)
              log_skip_plugin(dep.name, './webpack directory missing')

Rule 1: the plugin starts with foreman or katello
Rule 2: it does not end with “_core” or “-core”

Plugins not named like this can not use deliver react complements e.g.

Every foreman plugin normally should know, that its a foreman plugin In the ruby gem specification there is a metadata attribute which can be used to specify, that its a foreman plugin.

Keep in mind: Metadata items have the following restrictions:

The metadata must be a Hash object
All keys and values must be Strings
Keys can be a maximum of 128 bytes and values can be a maximum of 1024 bytes
All strings must be UTF-8, no binary data is allowed

I’m currently working on a PR to use the new metadata flag “is_foreman_plugin”:

github.com/theforeman/foreman

Fixes #33626 - use webpack for foreman plugin gems

theforeman:develop ← ATIX-AG:fix_33626

opened 02:21PM - 04 Oct 21 UTC

sbernhard

+6 -3

A plugin can specify by the following line in the gemspec that it is really a f…oreman plugin: s.metadata = { "is_foreman_plugin" => "true" } BTW: Metadata items have the following restrictions: - The metadata must be a Hash object - **All keys and values must be Strings** - Keys can be a maximum of 128 bytes and values can be a maximum of 1024 bytes - All strings must be UTF-8, no binary data is allowed

The suggestion would be, to remove the old implementation completely and only use the “is_foreman_plugin” flag.

CC @ekohl @Ron_Lavi

Ron_Lavi · October 5, 2021, 9:34am

+1 for using only is_foreman_plugin in the plugin gem metadata.

ekohl · October 6, 2021, 8:58am

The plugin template should be updated as well:

Then we should encourage plugin authors to update. Luckily not a huge number of plugins use webpack so it should be fairly easy.

Bernhard_Suttner · October 7, 2021, 6:55am

Sure, I will do this after we have clarified and agreed that this approach is the prefered one.

Bernhard_Suttner · October 7, 2021, 7:36am

See: https://github.com/theforeman/foreman_plugin_template/pull/36

ekohl · October 11, 2021, 11:41am

Given there is no objection and it’s a simple addition without removal, I’d say we can start with implementing this.

A quick grep through foreman-packaging’s rpm/develop branch I think these are Foreman plugins that use webpack. It may not be complete or correct, but it may help you:

foreman-tasks
foreman_acd
foreman_ansible
foreman_discovery
foreman_leapp
foreman_openscap
foreman_puppet
foreman_remote_execution
foreman_rh_cloud
foreman_snapshot_management
foreman_statistics
foreman_templates
foreman_webhooks
katello

ofedoren · October 11, 2021, 3:02pm

There is additional one which is not packaged yet, but is using webpack:

foreman_host_reports