Module metadata: Fix stale module detection and add per-type metadata index

[bcoles]

Description

Fixes two bugs in the metadata cache and adds a per-type index to eliminate an O(n) scan that runs on every module_metadata(type) call.

Bug fixes in cache.rb

1. Stale module detection was a no-op

In refresh_metadata_instance_internal, the delete_if block compared module_metadata.type != module_metadata.type (same object, both sides), which is always false. This meant modules that changed type (e.g. Auxiliary reclassified as Exploit) would leave stale entries in the cache. Fixed to compare against metadata_obj.type.

2. delete_if block relied on implicit return of &&

The delete_if block returned the result of path.eql?(…) && type != type. When both conditions are true, && returns the right-hand operand — in this case a truthy string comparison result, which happened to work, but was fragile and unclear. Replaced with an explicit is_stale boolean variable.

Performance: per-type metadata index

module_metadata(type) previously ran filter_map over all ~6,600 entries on every call (~14ms each). This is called once per module type during startup and tab-completion. Replaced with a pre-built @module_metadata_by_type hash:

• Built once after store initialization and after bulk refresh_metadata operations
• Incrementally updated on single-module changes (common case)
• Full rebuild only when a type mismatch deletion occurs (rare)

Measured improvement: ~14ms → ~0.001ms per call.

Minor cleanup in cache.rb

Replaced allowed_paths.select{|x| path.index(x) == 0}.empty? with allowed_paths.any? { |x| path.start_with?(x) } to avoid allocating a temporary array on every loop iteration.

Simplified get_cache_key

Replaced multi-line string concatenation with string interpolation.

[Copilot]

Pull request overview

This PR fixes stale module detection in Msf::Modules::Metadata::Cache and introduces a per-type metadata index to avoid repeated full-cache scans when retrieving metadata by module type, plus a small load-path filtering optimization in the module manager cache.

Changes:

• Fix stale module detection when a module’s type changes but its path stays the same.
• Add @module_metadata_by_type index and rebuild/update logic to speed up module_metadata(type) lookups.
• Optimize allowed path checks by switching from select(...).empty? to any? + start_with?.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
lib/msf/core/modules/metadata/cache.rb	Fixes stale-type deletion bug and adds per-type metadata index used by module_metadata(type).
lib/msf/core/module_manager/cache.rb	Avoids temporary array allocation when filtering metadata entries by allowed paths.

[Copilot]

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

[Copilot]

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.