Message not interpolated in "Show details..." dialog

[harbulot]

(This is using version PMD 7.0.0.v20230502-1028-rc2)

The message regarding a specific marker/violation only shows placeholders in the "Show details..." dialog.

The message is rendered properly (with placeholders filled in) when hovering on the marker in the editor and in the "Violation Outline" table, but not in the "Show details..." dialog.

---

I've tried to track the problem as follows:

• The view with the table that works is produced by ViolationOutline
  • The table itself is produced by ViolationOutlinePageBR
• The "Show details..." (contextual menu action) triggers ShowRuleAction
  • This shows a RuleDialog, filled with the selectedRule

The interpolated message seems to be in the actual IMarker, which is why the ViolationOutlinePageBR and the markers in general seem to work.

However, I think the problem is that the dialog uses Rule, instead of using the IMarker. See ShowRuleAction.getSelectedViolationRule():

    @Override
    public void run() {
        Rule selectedRule = getSelectedViolationRule();
        if (selectedRule != null) {
            RuleDialog ruleDialog = new RuleDialog(shell, selectedRule, false);
            ruleDialog.open();
        }
    }

    /**
     * Returns the rule from the first selected violation.
     */
    public Rule getSelectedViolationRule() {
        Rule rule = null;
        try {
            IMarker[] markers = getSelectedViolations();
            if (markers != null) {
                rule = PMDPlugin.getDefault().getPreferencesManager().getRuleSet()
                        .getRuleByName(MarkerUtil.ruleNameFor(markers[0]));
            }
        } catch (RuntimeException e) {
            logErrorByKey(StringKeys.ERROR_RUNTIME_EXCEPTION, e);
        }

        return rule;
    }

The information in the dialog is based uses the general Rule, not the specific IMarker. I get the impressing the RuleDialog was meant for another purpose: the rule editor, and that it's now deprecated anyway.

A workaround to fix this might be to create a fake Rule that has the actual message from the specific marker (similar to what FakeRuleViolation seems to do).