Skip to content

A platform for community discussion. Free, open, simple.

DEV: Use plugin name instead of directory name for module paths (#38418)

Jarek Radoszda840b5c260c
diff --git a/lib/discourse.rb b/lib/discourse.rb
index 129453d1c1b..ddec22da8cc 100644
--- a/lib/discourse.rb
+++ b/lib/discourse.rb
@@ -468,7 +468,7 @@ module Discourse
imports: Plugin::JsManager.import_paths_for(plugin.directory_name, "main"),
plugin: plugin,
type_module: true,
- importmap_name: "discourse/plugins/#{plugin.directory_name}",
+ importmap_name: "discourse/plugins/#{plugin.name}",
}
end
else
@@ -522,7 +522,7 @@ module Discourse
asset[:plugin_attributes] = {
"data-official": !!asset[:plugin].metadata&.official?,
"data-preinstalled": asset[:plugin].preinstalled?,
- "data-plugin-name": asset[:plugin].directory_name,
+ "data-plugin-name": asset[:plugin].name,
}
end
diff --git a/lib/plugin/js_manager.rb b/lib/plugin/js_manager.rb
index 7226d2a4ae1..529ef09f312 100644
--- a/lib/plugin/js_manager.rb
+++ b/lib/plugin/js_manager.rb
@@ -4,40 +4,40 @@ module Plugin
class JsManager
@cache = {}
- def self.js_asset_exists?(plugin_name)
- maybe_cache("js_asset_exists_#{plugin_name}") do
- has_source_files_in_dir(plugin_name, "assets/javascripts")
+ def self.js_asset_exists?(plugin_directory_name)
+ maybe_cache("js_asset_exists_#{plugin_directory_name}") do
+ has_source_files_in_dir(plugin_directory_name, "assets/javascripts")
end
end
- def self.admin_js_asset_exists?(plugin_name)
- maybe_cache("admin_js_asset_exists_#{plugin_name}") do
- has_source_files_in_dir(plugin_name, "admin/assets/javascripts")
+ def self.admin_js_asset_exists?(plugin_directory_name)
+ maybe_cache("admin_js_asset_exists_#{plugin_directory_name}") do
+ has_source_files_in_dir(plugin_directory_name, "admin/assets/javascripts")
end
end
- def self.test_js_asset_exists?(plugin_name)
- maybe_cache("test_js_asset_exists_#{plugin_name}") do
- has_source_files_in_dir(plugin_name, "test/javascripts")
+ def self.test_js_asset_exists?(plugin_directory_name)
+ maybe_cache("test_js_asset_exists_#{plugin_directory_name}") do
+ has_source_files_in_dir(plugin_directory_name, "test/javascripts")
end
end
- def self.read_manifest(plugin_name)
- maybe_cache("manifest_#{plugin_name}") do
- manifest_path = "#{Rails.root}/app/assets/generated/#{plugin_name}/manifest.json"
+ def self.read_manifest(plugin_directory_name)
+ maybe_cache("manifest_#{plugin_directory_name}") do
+ manifest_path = "#{Rails.root}/app/assets/generated/#{plugin_directory_name}/manifest.json"
JSON.parse(File.read(manifest_path))
rescue Errno::ENOENT
{}
end
end
- def self.digested_logical_path_for(plugin_name, entrypoint_name)
- manifest_entry = read_manifest(plugin_name)[entrypoint_name]
+ def self.digested_logical_path_for(plugin_directory_name, entrypoint_name)
+ manifest_entry = read_manifest(plugin_directory_name)[entrypoint_name]
"js/plugins/#{manifest_entry["fileName"].delete_suffix(".js")}" if manifest_entry
end
- def self.import_paths_for(plugin_name, entrypoint_name)
- read_manifest(plugin_name)[entrypoint_name]["imports"].map do
+ def self.import_paths_for(plugin_directory_name, entrypoint_name)
+ read_manifest(plugin_directory_name)[entrypoint_name]["imports"].map do
"js/plugins/#{it.delete_suffix(".js")}"
end
end
@@ -104,6 +104,7 @@ module Plugin
AssetProcessor::BASE_COMPILER_VERSION,
AssetProcessor.ember_version,
minify?.to_s,
+ plugin.name,
].join,
)
base36_digest = hex_digest.to_i(16).to_s(36).first(8)
@@ -121,7 +122,7 @@ module Plugin
if !cache? || !files_exist
compiler =
Plugin::JsCompiler.new(
- plugin.directory_name,
+ plugin.name,
minify: minify?,
tree: tree,
entrypoints: entrypoints_config,
@@ -215,8 +216,9 @@ module Plugin
end
end
- private_class_method def self.has_source_files_in_dir(plugin_name, dir)
- Dir.glob("plugins/#{plugin_name}/#{dir}/**/*.{js,hbs,gjs,es6}") { break true } || false
+ private_class_method def self.has_source_files_in_dir(plugin_directory_name, dir)
+ Dir.glob("plugins/#{plugin_directory_name}/#{dir}/**/*.{js,hbs,gjs,es6}") { break true } ||
+ false
end
end
end
diff --git a/spec/lib/discourse_spec.rb b/spec/lib/discourse_spec.rb
index 69b424dc50b..f54f5313813 100644
--- a/spec/lib/discourse_spec.rb
+++ b/spec/lib/discourse_spec.rb
@@ -165,12 +165,14 @@ RSpec.describe Discourse do
plugin_class.new.tap do |p|
p.enabled = true
p.path = "my-plugin-1"
+ p.metadata = Plugin::Metadata.parse("# name: plugin1")
end
end
let(:plugin2) do
plugin_class.new.tap do |p|
p.enabled = false
- p.path = "my-plugin-1"
+ p.path = "my-plugin-2"
+ p.metadata = Plugin::Metadata.parse("# name: plugin2")
end
end