refactor(linter): simplify unicorn/require-post-message-target-origin (#12110)

We are unable to correctly handle cases like `window.postMessage(message /** comments, */ )` due to the complexity of parsing trailing comments between arguments.

To simplify the logic, we always append `, ...` after the first argument instead of trying to analyze whether a trailing comma or comment exists.

Author: shulaoda

crates/oxc_linter/src/rules/unicorn/require_post_message_target_origin.rs

@@ -6,7 +6,7 @@ use oxc_diagnostics::OxcDiagnostic;
 use oxc_macros::declare_oxc_lint;
 use oxc_span::{GetSpan, Span};
 
-use crate::{AstNode, ast_util::is_method_call, context::LintContext, rule::Rule};
+use crate::{AstNode, context::LintContext, rule::Rule};
 
 fn require_post_message_target_origin_diagnostic(span: Span) -> OxcDiagnostic {
     OxcDiagnostic::warn("Missing the `targetOrigin` argument.").with_label(span)
@@ -45,52 +45,37 @@ declare_oxc_lint!(
 );
 
 impl Rule for RequirePostMessageTargetOrigin {
-    #[expect(clippy::cast_possible_truncation)]
     fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) {
         let AstKind::CallExpression(call_expr) = node.kind() else {
             return;
         };
-        let arguments = &call_expr.arguments;
-        if arguments.len() != 1 || call_expr.optional {
+        // ignore "foo.postMessage?.(...message)" and "foo.postMessage(...message)"
+        if call_expr.arguments.len() != 1
+            || call_expr.optional
+            || matches!(&call_expr.arguments[0], Argument::SpreadElement(_))
+        {
             return;
         }
-        let arg = &call_expr.arguments[0];
-        // ignore "foo.postMessage(...message)"
-        if matches!(arg, Argument::SpreadElement(_)) {
-            return;
-        }
-        if !is_method_call(call_expr, None, Some(&["postMessage"]), Some(1), Some(1)) {
-            return;
-        }
-        // ignore "foo['postMessage'](message)"
-        let Some(member_expr) = call_expr.callee.as_member_expression() else {
-            return;
+        let member_expr = match call_expr.callee.get_member_expr() {
+            // ignore "foo[postMessage](message)" and "foo?.postMessage(message)"
+            Some(expr) if !(expr.is_computed() || expr.optional()) => expr,
+            _ => return,
         };
-        // ignore "foo[postMessage](message)" and "foo?.postMessage(message)"
-        if member_expr.is_computed() || member_expr.optional() {
-            return;
+        if matches!(member_expr.static_property_name(), Some(name) if name == "postMessage") {
+            let span = call_expr.arguments[0].span();
+            ctx.diagnostic_with_suggestion(
+                require_post_message_target_origin_diagnostic(Span::new(span.end, span.end)),
+                |fixer| {
+                    let text = match member_expr.object() {
+                        Expression::Identifier(ident) => {
+                            format!(", {}.location.origin", ident.name.as_str())
+                        }
+                        _ => ", self.location.origin".to_string(),
+                    };
+                    fixer.insert_text_after_range(span, text)
+                },
+            );
         }
-
-        let comma_idx =
-            Span::new(arg.span().end, call_expr.span.end).source_text(ctx.source_text()).find(',');
-        let offset = comma_idx.unwrap_or(0) as u32;
-        let target_span = Span::new(arg.span().end + offset, call_expr.span.end);
-        ctx.diagnostic_with_suggestion(
-            require_post_message_target_origin_diagnostic(target_span),
-            |fixer| {
-                let last_token = Span::new(call_expr.span.end - 1, call_expr.span.end);
-                let text = match member_expr.object() {
-                    Expression::Identifier(ident) => {
-                        format!("{}.location.origin", ident.name.as_str())
-                    }
-                    _ => "self.location.origin".to_string(),
-                };
-
-                let replacement =
-                    if comma_idx.is_some() { format!(" {text},") } else { format!(", {text}") };
-                fixer.insert_text_before(&last_token, replacement)
-            },
-        );
     }
 }
 
@@ -149,15 +134,15 @@ fn test() {
             "globalThis.postMessage(message, globalThis.location.origin)",
             None,
         ),
-        ("foo.postMessage(message )", "foo.postMessage(message , foo.location.origin)", None),
+        ("foo.postMessage(message )", "foo.postMessage(message, foo.location.origin )", None),
         (
             "window.postMessage(message,)",
             "window.postMessage(message, window.location.origin,)",
             None,
         ),
         (
             "window.postMessage(message,                 /** comments */  )",
-            "window.postMessage(message,                 /** comments */   window.location.origin,)",
+            "window.postMessage(message, window.location.origin,                 /** comments */  )",
             None,
         ),
         (

crates/oxc_linter/src/snapshots/unicorn_require_post_message_target_origin.snap

@@ -4,111 +4,111 @@ source: crates/oxc_linter/src/tester.rs
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:27]
  1 │ window.postMessage(message)
-   ·                           ─
+   ·                           ▲
    ╰────
   help: Insert `, window.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:25]
  1 │ self.postMessage(message)
-   ·                         ─
+   ·                         ▲
    ╰────
   help: Insert `, self.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:31]
  1 │ globalThis.postMessage(message)
-   ·                               ─
+   ·                               ▲
    ╰────
   help: Insert `, globalThis.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:24]
  1 │ foo.postMessage(message )
-   ·                        ──
+   ·                        ▲
    ╰────
   help: Insert `, foo.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:29]
  1 │ foo.postMessage( ((message)) )
-   ·                             ──
+   ·                             ▲
    ╰────
   help: Insert `, foo.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:24]
  1 │ foo.postMessage(message,)
-   ·                        ──
+   ·                        ▲
    ╰────
-  help: Insert ` foo.location.origin,`
+  help: Insert `, foo.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
-   ╭─[require_post_message_target_origin.tsx:1:25]
+   ╭─[require_post_message_target_origin.tsx:1:24]
  1 │ foo.postMessage(message , )
-   ·                         ───
+   ·                        ▲
    ╰────
-  help: Insert ` foo.location.origin,`
+  help: Insert `, foo.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:31]
  1 │ foo.window.postMessage(message)
-   ·                               ─
+   ·                               ▲
    ╰────
   help: Insert `, self.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:41]
  1 │ document.defaultView.postMessage(message)
-   ·                                         ─
+   ·                                         ▲
    ╰────
   help: Insert `, self.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:32]
  1 │ getWindow().postMessage(message)
-   ·                                ─
+   ·                                ▲
    ╰────
   help: Insert `, self.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:27]
  1 │ window.postMessage(message,                 /** comments */  )
-   ·                           ────────────────────────────────────
+   ·                           ▲
    ╰────
-  help: Insert ` window.location.origin,`
+  help: Insert `, window.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:29]
  1 │ window.c.postMessage(message)
-   ·                             ─
+   ·                             ▲
    ╰────
   help: Insert `, self.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:30]
  1 │ window?.c.postMessage(message)
-   ·                              ─
+   ·                              ▲
    ╰────
   help: Insert `, self.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:32]
  1 │ window?.a.b.postMessage(message)
-   ·                                ─
+   ·                                ▲
    ╰────
   help: Insert `, self.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:32]
  1 │ window.a?.b.postMessage(message)
-   ·                                ─
+   ·                                ▲
    ╰────
   help: Insert `, self.location.origin`
 
   ⚠ eslint-plugin-unicorn(require-post-message-target-origin): Missing the `targetOrigin` argument.
    ╭─[require_post_message_target_origin.tsx:1:33]
  1 │ window?.a?.b.postMessage(message)
-   ·                                 ─
+   ·                                 ▲
    ╰────
   help: Insert `, self.location.origin`