GitNexus/gitnexus/test/unit/spring-message-producers.test.ts

import { describe, expect, it } from 'vitest';
import type { SpringMessageProducerFact } from '../../src/core/ingestion/frameworks/spring/message-producers.js';
import { collectJavaCaptureSideChannel } from '../../src/core/ingestion/languages/java/capture-side-channel.js';
import { emitJavaScopeCaptures } from '../../src/core/ingestion/languages/java/captures.js';
import { collectKotlinCaptureSideChannel } from '../../src/core/ingestion/languages/kotlin/capture-side-channel.js';
import { emitKotlinScopeCaptures } from '../../src/core/ingestion/languages/kotlin/captures.js';

const JAVA_FILE = 'src/OrderPublishers.java';
const KOTLIN_FILE = 'src/OrderPublishers.kt';

function javaProducers(code: string): readonly SpringMessageProducerFact[] {
  emitJavaScopeCaptures(code, JAVA_FILE);
  return collectJavaCaptureSideChannel(JAVA_FILE)?.springMessageProducerFacts ?? [];
}

function kotlinProducers(code: string): readonly SpringMessageProducerFact[] {
  emitKotlinScopeCaptures(code, KOTLIN_FILE);
  return collectKotlinCaptureSideChannel(KOTLIN_FILE)?.springMessageProducerFacts ?? [];
}

const signature = (fact: SpringMessageProducerFact) =>
  `${fact.template} ${fact.receiverName}.${fact.methodName}`;

const destination = (fact: SpringMessageProducerFact) => fact.args?.[0]?.text;

describe('Java Spring messaging producers', () => {
  const facts = javaProducers(`
    package com.example.messaging;

    import com.example.messaging.support.Destinations;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.core.env.Environment;
    import org.springframework.kafka.core.KafkaTemplate;

    public class OrderPublishers {
        private final KafkaTemplate<String, String> kafkaTemplate;

        @Value("\${app.messaging.orders-topic}")
        private String ordersTopic;

        public void literalDestination(String payload) {
            kafkaTemplate.send("orders", payload);
        }

        public void constantDestination(String payload) {
            this.kafkaTemplate.send(Destinations.ORDERS, payload);
        }

        public void configuredDestination(String payload) {
            kafkaTemplate.send(ordersTopic, payload);
        }

        public void configuredDestinationInline(String payload, Environment environment) {
            kafkaTemplate.send(environment.getProperty("app.messaging.orders-topic"), payload);
        }

        public void rabbitDestination(String exchange, String routingKey, String payload) {
            rabbitTemplate.convertAndSend(exchange, routingKey, payload);
        }

        public void jmsDestination(String payload) {
            jmsTemplate.convertAndSend("queue.orders", payload);
        }

        public void streamBridgeDestination(String payload) {
            streamBridge.send(Destinations.SHIPMENTS_BINDING, payload);
        }
    }
  `);

  it('recognizes every supported template and method pair', () => {
    expect(facts.map(signature)).toEqual([
      'kafka kafkaTemplate.send',
      'kafka this.kafkaTemplate.send',
      'kafka kafkaTemplate.send',
      'kafka kafkaTemplate.send',
      'rabbit rabbitTemplate.convertAndSend',
      'jms jmsTemplate.convertAndSend',
      'stream-bridge streamBridge.send',
    ]);
  });

  it('produces a fact for a literal, a constant, and a configuration key alike', () => {
    expect(facts.slice(0, 4).map(destination)).toEqual([
      '"orders"',
      'Destinations.ORDERS',
      'ordersTopic',
      'environment.getProperty("app.messaging.orders-topic")',
    ]);
  });

  it('captures every call argument positionally, since Java has no named ones', () => {
    expect(facts[4]?.args).toEqual([
      { text: 'exchange' },
      { text: 'routingKey' },
      { text: 'payload' },
    ]);
    expect(facts.flatMap((fact) => fact.args ?? []).every((arg) => !('name' in arg))).toBe(true);
  });
});

describe('Java Spring messaging producer receivers', () => {
  const facts = javaProducers(`
    package com.example.messaging;

    public class ReceiverShapes {
        public void prefixedReceiver(String payload) {
            orderKafkaTemplate.send("orders", payload);
        }

        public void deepReceiver(String payload) {
            outer.inner.kafkaTemplate.send("orders", payload);
        }

        public void untypedReceiver(String payload) {
            template.send("orders", payload);
        }

        public void mapReceiver(String payload) {
            templates.get("orders").send("orders", payload);
        }

        public void factoryReceiver(String payload) {
            getTemplate().send("orders", payload);
        }

        public void wrongMethodForKafka(String payload) {
            kafkaTemplate.convertAndSend("orders", payload);
        }

        public void wrongMethodForRabbit(String payload) {
            rabbitTemplate.send("orders", payload);
        }
    }
  `);

  it('matches a receiver whose simple name contains the template type name', () => {
    expect(facts.map((fact) => fact.receiverName)).toEqual([
      'orderKafkaTemplate',
      'outer.inner.kafkaTemplate',
    ]);
  });

  it('does not guess a broker for an untyped, indexed, or returned receiver', () => {
    const receivers = facts.map((fact) => fact.receiverName);
    expect(receivers).not.toContain('template');
    expect(receivers.some((name) => name.includes('templates.get'))).toBe(false);
    expect(receivers.some((name) => name.includes('getTemplate'))).toBe(false);
  });

  it('requires the method that belongs to the template, not any send-like name', () => {
    expect(facts.map((fact) => fact.methodName)).toEqual(['send', 'send']);
  });
});

describe('Java Spring messaging producer owners', () => {
  it('attributes a publish to its nearest enclosing callable exactly once', () => {
    const facts = javaProducers(`
      package com.example.messaging;

      import java.util.List;

      public class Owners {
          public Owners(String payload) {
              kafkaTemplate.send("constructor-orders", payload);
          }

          public void insideLambda(List<String> payloads) {
              payloads.forEach(payload -> kafkaTemplate.send("lambda-orders", payload));
          }

          public void insideAnonymousClass() {
              Runnable task = new Runnable() {
                  @Override
                  public void run() {
                      kafkaTemplate.send("anonymous-orders", "payload");
                  }
              };
              task.run();
          }

          static class Nested {
              void nestedPublish(String payload) {
                  kafkaTemplate.send("nested-orders", payload);
              }
          }
      }
    `);
    expect(facts.map(destination)).toEqual([
      '"constructor-orders"',
      '"lambda-orders"',
      '"anonymous-orders"',
      '"nested-orders"',
    ]);
    expect(new Set(facts.map((fact) => fact.ownerScopeId)).size).toBe(4);
    // A lambda body belongs to the method that declares it, while an anonymous
    // class body belongs to its own `run` method (line 17 starts at @Override).
    expect(facts[1]?.ownerRange.startLine).toBe(11);
    expect(facts[2]?.ownerRange.startLine).toBe(17);
  });

  it('drops a publish that has no callable owner', () => {
    const facts = javaProducers(`
      package com.example.messaging;

      public class NoCallableOwner {
          private static final Object WARMUP = kafkaTemplate.send("field-orders", "payload");

          static {
              kafkaTemplate.send("static-initializer-orders", "payload");
          }
      }
    `);
    expect(facts).toEqual([]);
  });
});

// Named arguments are illegal when the callee is a Java method — parameter
// names are not guaranteed in bytecode — so every named-argument example here
// publishes through a template DECLARED IN KOTLIN. `KotlinKafkaTemplate` is
// matched by the same receiver-name rule as the Spring class and keeps the
// examples compilable Kotlin rather than a shape no source could take.
describe('Kotlin Spring messaging producers', () => {
  const facts = kotlinProducers(`
    package com.example.messaging

    import com.example.messaging.support.Destinations
    import org.springframework.kafka.core.KafkaTemplate

    class KotlinKafkaTemplate {
        fun send(topic: String, data: String) {}
    }

    class OrderPublishers(private val kafkaTemplate: KafkaTemplate<String, String>) {
        private val kotlinKafkaTemplate = KotlinKafkaTemplate()
        private lateinit var ordersTopic: String

        fun literalDestination(payload: String) {
            kafkaTemplate.send("orders", payload)
        }

        fun constantDestination(payload: String) {
            this.kafkaTemplate.send(Destinations.ORDERS, payload)
        }

        fun configuredDestination(payload: String) {
            kafkaTemplate.send(ordersTopic, payload)
        }

        fun namedArguments(payload: String) {
            kotlinKafkaTemplate.send(topic = Destinations.ORDERS, data = payload)
        }

        fun safeCallReceiver(payload: String) {
            kafkaTemplate?.send("orders", payload)
        }

        fun rabbitDestination(exchange: String, routingKey: String, payload: String) {
            rabbitTemplate.convertAndSend(exchange, routingKey, payload)
        }

        fun jmsDestination(payload: String) {
            jmsTemplate.convertAndSend("queue.orders", payload)
        }

        fun spreadArgument(args: Array<String>) {
            streamBridge.send(*args)
        }
    }
  `);

  it('recognizes every supported template and method pair', () => {
    expect(facts.map(signature)).toEqual([
      'kafka kafkaTemplate.send',
      'kafka this.kafkaTemplate.send',
      'kafka kafkaTemplate.send',
      'kafka kotlinKafkaTemplate.send',
      'kafka kafkaTemplate.send',
      'rabbit rabbitTemplate.convertAndSend',
      'jms jmsTemplate.convertAndSend',
      'stream-bridge streamBridge.send',
    ]);
  });

  it('produces a fact for a literal, a constant, and a configuration-backed name alike', () => {
    expect(facts.slice(0, 3).map(destination)).toEqual([
      '"orders"',
      'Destinations.ORDERS',
      'ordersTopic',
    ]);
  });

  it('keeps Kotlin named call arguments and spreads as written', () => {
    expect(facts[3]?.args).toEqual([
      { name: 'topic', text: 'Destinations.ORDERS' },
      { name: 'data', text: 'payload' },
    ]);
    expect(facts[7]?.args).toEqual([{ text: '*args' }]);
  });

  it('reads the receiver structurally, so a safe call is still a publish', () => {
    expect(facts[4]?.receiverName).toBe('kafkaTemplate');
    expect(destination(facts[4]!)).toBe('"orders"');
  });
});

describe('Kotlin Spring messaging producer argument lists', () => {
  const facts = kotlinProducers(`
    package com.example.messaging

    class ArgumentLists {
        fun trailingLambdaOnly() {
            kafkaTemplate.send { }
        }

        fun emptyArgumentList() {
            kafkaTemplate.send()
        }
    }
  `);

  it('distinguishes a missing argument list from an empty one', () => {
    expect(facts).toHaveLength(2);
    expect('args' in facts[0]!).toBe(false);
    expect(facts[1]?.args).toEqual([]);
  });
});

describe('Kotlin Spring messaging producer owners', () => {
  it('attributes publishes in companions, objects, lambdas, and top-level functions', () => {
    const facts = kotlinProducers(`
      package com.example.messaging

      class Owners {
          private val warmup = kafkaTemplate.send("property-orders", "payload")

          init {
              kafkaTemplate.send("init-orders", "payload")
          }

          fun insideLambda(payloads: List<String>) {
              payloads.forEach { payload -> kafkaTemplate.send("lambda-orders", payload) }
          }

          companion object {
              fun companionPublish(payload: String) {
                  kafkaTemplate.send("companion-orders", payload)
              }
          }
      }

      object Singleton {
          fun objectPublish(payload: String) {
              kafkaTemplate.send("object-orders", payload)
          }
      }

      fun topLevelPublish(payload: String) {
          kafkaTemplate.send("top-level-orders", payload)
      }
    `);
    // The property initializer and the init block have no callable of their own.
    expect(facts.map(destination)).toEqual([
      '"lambda-orders"',
      '"companion-orders"',
      '"object-orders"',
      '"top-level-orders"',
    ]);
    expect(new Set(facts.map((fact) => fact.ownerScopeId)).size).toBe(4);
  });
});

describe('Spring messaging producer capture regressions', () => {
  it('leaves the side channel untouched for a file that publishes nothing', () => {
    const sideChannel = (() => {
      emitJavaScopeCaptures(
        `
          package com.example.messaging;

          public class Quiet {
              public void run() {
                  logger.send("orders", "payload");
              }
          }
        `,
        JAVA_FILE,
      );
      return collectJavaCaptureSideChannel(JAVA_FILE);
    })();
    expect(sideChannel === undefined || !('springMessageProducerFacts' in sideChannel)).toBe(true);
  });

  it('still captures programmatic bean lookups from the same member-call visit', () => {
    emitJavaScopeCaptures(
      `
        package com.example.messaging;

        public class Lookups {
            public void run() {
                kafkaTemplate.send("orders", "payload");
                OrderService service = SpringContextUtil.getBean(OrderService.class);
                service.handle();
            }
        }
      `,
      JAVA_FILE,
    );
    const sideChannel = collectJavaCaptureSideChannel(JAVA_FILE);
    expect(sideChannel?.springMessageProducerFacts).toHaveLength(1);
    expect(sideChannel?.springDynamicLookupFacts?.map((fact) => fact.targetTypeName)).toEqual([
      'OrderService',
    ]);
  });
});

describe('Spring messaging producer receiver spellings', () => {
  it('captures the inner call of the synchronous send idiom', () => {
    const facts = javaProducers(`
      package com.example.messaging;

      public class Chained {
          public void awaited(String payload) throws Exception {
              kafkaTemplate.send("orders", payload).get();
          }

          public void withCallback(String payload) {
              kafkaTemplate.send("orders", payload).addCallback(ok -> {}, error -> {});
          }
      }
    `);
    expect(facts.map(destination)).toEqual(['"orders"', '"orders"']);
  });

  it('joins a receiver chain that the source wrapped across lines', () => {
    const java = javaProducers(`
      package com.example.messaging;

      public class Wrapped {
          public void publish(String payload) {
              outer
                  .inner
                  .kafkaTemplate.send("orders", payload);
          }
      }
    `);
    const kotlin = kotlinProducers(`
      package com.example.messaging

      class Wrapped {
          fun publish(payload: String) {
              outer
                  .inner
                  .kafkaTemplate.send("orders", payload)
          }
      }
    `);
    expect(java.map((fact) => fact.receiverName)).toEqual(['outer.inner.kafkaTemplate']);
    expect(kotlin.map((fact) => fact.receiverName)).toEqual(['outer.inner.kafkaTemplate']);
  });

  it('leaves single-line spacing and nested literals in the receiver as written', () => {
    // Joining a wrapped chain must not reach inside a string literal that the
    // receiver expression happens to contain.
    const facts = javaProducers(`
      package com.example.messaging;

      public class Literals {
          public void publish(String payload) {
              registry.lookup("a . b").kafkaTemplate.send("orders . v1", payload);
          }
      }
    `);
    expect(facts.map((fact) => fact.receiverName)).toEqual([
      'registry.lookup("a . b").kafkaTemplate',
    ]);
    expect(facts.map(destination)).toEqual(['"orders . v1"']);
  });

  it('does not attribute a call that names no receiver', () => {
    const java = javaProducers(`
      package com.example.messaging;

      public class Bare {
          public void publish(String payload) {
              send("orders", payload);
          }
      }
    `);
    const kotlin = kotlinProducers(`
      package com.example.messaging

      class Bare {
          fun publish(payload: String) {
              send("orders", payload)
          }

          fun scoped(payload: String) {
              with(kafkaTemplate) {
                  send("orders", payload)
              }
          }
      }
    `);
    expect(java).toEqual([]);
    expect(kotlin).toEqual([]);
  });

  it('does not attribute a cast or parenthesized receiver', () => {
    const facts = javaProducers(`
      package com.example.messaging;

      public class Casts {
          public void publish(Object raw, String payload) {
              ((org.springframework.kafka.core.KafkaTemplate<String, String>) raw)
                  .send("orders", payload);
          }
      }
    `);
    expect(facts).toEqual([]);
  });
});

describe('Kotlin Spring messaging producer null assertions', () => {
  const facts = kotlinProducers(`
    package com.example.messaging

    class Assertions {
        fun asserted(payload: String) {
            kafkaTemplate!!.send("asserted", payload)
        }

        fun doubleAsserted(payload: String) {
            kafkaTemplate!!!!.send("double-asserted", payload)
        }

        fun assertedInChain(payload: String) {
            holder.kafkaTemplate!!.send("chain-tail", payload)
        }

        fun assertionInsideChain(payload: String) {
            holder!!.kafkaTemplate.send("chain-middle", payload)
        }

        fun assertedThenSafeCall(payload: String) {
            kafkaTemplate!!?.send("asserted-safe", payload)
        }
    }
  `);

  it('reads through the null assertion to the receiver it asserts', () => {
    // `?.` hides its marker in the navigation suffix, but `!!` wraps the
    // receiver itself; without unwrapping, every asserted publish is lost.
    expect(facts.map((fact) => `${fact.receiverName} ${destination(fact)}`)).toEqual([
      'kafkaTemplate "asserted"',
      'kafkaTemplate "double-asserted"',
      'holder.kafkaTemplate "chain-tail"',
      'holder!!.kafkaTemplate "chain-middle"',
      'kafkaTemplate "asserted-safe"',
    ]);
  });

  it('does not unwrap a postfix operator that is not a null assertion', () => {
    const other = kotlinProducers(`
      package com.example.messaging

      class NotAssertions {
          fun incremented(payload: String) {
              counter++.send("orders", payload)
          }

          fun assertedUntyped(payload: String) {
              template!!.send("orders", payload)
          }

          fun assertedFactory(payload: String) {
              getTemplate()!!.send("orders", payload)
          }

          fun parenthesized(payload: String) {
              (kafkaTemplate!!).send("orders", payload)
          }
      }
    `);
    expect(other).toEqual([]);
  });
});

describe('Kotlin Spring messaging producer call shapes', () => {
  const facts = kotlinProducers(`
    package com.example.messaging

    class KotlinKafkaTemplate {
        fun send(topic: String, data: String) {}
    }

    class CallShapes {
        private val kotlinKafkaTemplate = KotlinKafkaTemplate()

        fun argumentsAndTrailingLambda(payload: String) {
            kafkaTemplate.send("orders", payload) { result -> println(result) }
        }

        fun namedArgumentHoldingComparison(payload: String, flag: Boolean) {
            kotlinKafkaTemplate.send(topic = if (flag == true) "a" else "b", data = payload)
        }

        fun trailingComma(payload: String) {
            kafkaTemplate.send(
                "orders",
                payload,
            )
        }
    }
  `);

  it('keeps the argument list of a call that also passes a trailing lambda', () => {
    expect(facts[0]?.args).toEqual([{ text: '"orders"' }, { text: 'payload' }]);
  });

  it('does not mistake a comparison inside a named argument for a second argument', () => {
    expect(facts[1]?.args).toEqual([
      { name: 'topic', text: 'if (flag == true) "a" else "b"' },
      { name: 'data', text: 'payload' },
    ]);
  });

  it('ignores a trailing comma in the argument list', () => {
    expect(facts[2]?.args).toEqual([{ text: '"orders"' }, { text: 'payload' }]);
  });
});

describe('Spring messaging producer side-channel transport', () => {
  it('leaves the Kotlin side channel free of producer facts for a quiet file', () => {
    emitKotlinScopeCaptures(
      `
        package com.example.messaging

        class Quiet {
            fun run() {
                logger.send("orders", "payload")
            }
        }
      `,
      KOTLIN_FILE,
    );
    const sideChannel = collectKotlinCaptureSideChannel(KOTLIN_FILE);
    expect(sideChannel === undefined || !('springMessageProducerFacts' in sideChannel)).toBe(true);
  });

  it('carries producer facts and handler arguments through a JSON round trip', () => {
    // The worker ships the side channel to the main thread as JSON; a fact
    // shape that does not survive that trip is invisible to every later phase.
    emitJavaScopeCaptures(
      `
        package com.example.messaging;

        import org.springframework.kafka.annotation.KafkaListener;

        public class RoundTrip {
            @KafkaListener(topics = "orders")
            public void consume(String payload) {}

            public void publish(String payload) {
                kafkaTemplate.send("orders", payload);
            }
        }
      `,
      JAVA_FILE,
    );
    const collected = collectJavaCaptureSideChannel(JAVA_FILE);
    const restored = JSON.parse(JSON.stringify(collected)) as typeof collected;
    expect(restored?.springMessageProducerFacts).toEqual(collected?.springMessageProducerFacts);
    expect(restored?.springMessageProducerFacts?.[0]?.args).toEqual([
      { text: '"orders"' },
      { text: 'payload' },
    ]);
    expect(restored?.springNonHttpHandlerFacts?.[0]?.annotations[0]?.args).toEqual([
      { name: 'topics', text: '"orders"' },
    ]);
  });
});

/**
 * Kafka is the template whose destination shapes are covered above. The other
 * three carry the same burden: a destination is written as a literal, as a
 * constant that lives in another file, or as a name bound from configuration,
 * and capture must produce a fact for all three without preferring any.
 */
describe('Spring messaging producer destination kinds per template', () => {
  const JAVA_SOURCE = `
    package com.example.messaging;

    import com.example.messaging.support.Destinations;
    import org.springframework.amqp.rabbit.core.RabbitTemplate;
    import org.springframework.cloud.stream.function.StreamBridge;
    import org.springframework.jms.core.JmsTemplate;

    public class OrderPublishers {
        private final RabbitTemplate rabbitTemplate;
        private final JmsTemplate jmsTemplate;
        private final StreamBridge streamBridge;

        @Value("\${app.messaging.orders-exchange}")
        private String ordersExchange;

        public void rabbitLiteral(String payload) {
            rabbitTemplate.convertAndSend("orders.exchange", "orders.key", payload);
        }

        public void rabbitConstant(String payload) {
            rabbitTemplate.convertAndSend(Destinations.EXCHANGE, Destinations.ROUTING_KEY, payload);
        }

        public void rabbitConfigured(String payload) {
            rabbitTemplate.convertAndSend(ordersExchange, "orders.key", payload);
        }

        public void jmsLiteral(String payload) {
            jmsTemplate.convertAndSend("queue.orders", payload);
        }

        public void jmsConstant(String payload) {
            jmsTemplate.convertAndSend(Destinations.QUEUE, payload);
        }

        public void jmsConfigured(String payload) {
            jmsTemplate.convertAndSend(ordersQueue, payload);
        }

        public void bridgeLiteral(String payload) {
            streamBridge.send("orders-out-0", payload);
        }

        public void bridgeConstant(String payload) {
            streamBridge.send(Destinations.ORDERS_BINDING, payload);
        }

        public void bridgeConfigured(String payload) {
            streamBridge.send(ordersBinding, payload);
        }

        public void notAPublish(String payload) {
            rabbitTemplate.send("orders.exchange", payload);
            jmsTemplate.send("queue.orders", payload);
        }
    }
  `;

  const KOTLIN_SOURCE = `
    package com.example.messaging

    import com.example.messaging.support.Destinations
    import org.springframework.amqp.rabbit.core.RabbitTemplate
    import org.springframework.cloud.stream.function.StreamBridge
    import org.springframework.jms.core.JmsTemplate

    class OrderPublishers(
        private val rabbitTemplate: RabbitTemplate,
        private val jmsTemplate: JmsTemplate,
        private val streamBridge: StreamBridge,
        @Value("\\\${app.messaging.orders-exchange}") private val ordersExchange: String,
    ) {
        fun rabbitLiteral(payload: String) {
            rabbitTemplate.convertAndSend("orders.exchange", "orders.key", payload)
        }

        fun rabbitConstant(payload: String) {
            rabbitTemplate.convertAndSend(Destinations.EXCHANGE, Destinations.ROUTING_KEY, payload)
        }

        fun rabbitConfigured(payload: String) {
            rabbitTemplate.convertAndSend(ordersExchange, "orders.key", payload)
        }

        fun jmsLiteral(payload: String) {
            jmsTemplate.convertAndSend("queue.orders", payload)
        }

        fun jmsConstant(payload: String) {
            jmsTemplate.convertAndSend(Destinations.QUEUE, payload)
        }

        fun jmsConfigured(payload: String) {
            jmsTemplate.convertAndSend(ordersQueue, payload)
        }

        fun bridgeLiteral(payload: String) {
            streamBridge.send("orders-out-0", payload)
        }

        fun bridgeConstant(payload: String) {
            streamBridge.send(Destinations.ORDERS_BINDING, payload)
        }

        fun bridgeConfigured(payload: String) {
            streamBridge.send(ordersBinding, payload)
        }

        fun notAPublish(payload: String) {
            rabbitTemplate.send("orders.exchange", payload)
            jmsTemplate.send("queue.orders", payload)
        }
    }
  `;

  const EXPECTED_SIGNATURES = [
    'rabbit rabbitTemplate.convertAndSend',
    'rabbit rabbitTemplate.convertAndSend',
    'rabbit rabbitTemplate.convertAndSend',
    'jms jmsTemplate.convertAndSend',
    'jms jmsTemplate.convertAndSend',
    'jms jmsTemplate.convertAndSend',
    'stream-bridge streamBridge.send',
    'stream-bridge streamBridge.send',
    'stream-bridge streamBridge.send',
  ];

  const EXPECTED_DESTINATIONS = [
    '"orders.exchange"',
    'Destinations.EXCHANGE',
    'ordersExchange',
    '"queue.orders"',
    'Destinations.QUEUE',
    'ordersQueue',
    '"orders-out-0"',
    'Destinations.ORDERS_BINDING',
    'ordersBinding',
  ];

  it('gives Java rabbit, jms, and stream-bridge a fact for all three shapes', () => {
    const facts = javaProducers(JAVA_SOURCE);
    expect(facts.map(signature)).toEqual(EXPECTED_SIGNATURES);
    expect(facts.map(destination)).toEqual(EXPECTED_DESTINATIONS);
  });

  it('gives Kotlin rabbit, jms, and stream-bridge a fact for all three shapes', () => {
    const facts = kotlinProducers(KOTLIN_SOURCE);
    expect(facts.map(signature)).toEqual(EXPECTED_SIGNATURES);
    expect(facts.map(destination)).toEqual(EXPECTED_DESTINATIONS);
  });

  it('leaves a send that does not belong to its template unrecognized', () => {
    // `notAPublish` is the last method in both fixtures; the signature lists
    // above end at the stream bridge, so `RabbitTemplate.send` and
    // `JmsTemplate.send` produced nothing.
    const receivers = [...javaProducers(JAVA_SOURCE), ...kotlinProducers(KOTLIN_SOURCE)].map(
      (fact) => `${fact.receiverName}.${fact.methodName}`,
    );
    expect(receivers).not.toContain('rabbitTemplate.send');
    expect(receivers).not.toContain('jmsTemplate.send');
  });

  it('resolves no destination while capturing it', () => {
    const texts = [...javaProducers(JAVA_SOURCE), ...kotlinProducers(KOTLIN_SOURCE)].flatMap(
      (fact) => fact.args ?? [],
    );
    // A resolver would have turned the constants and the injected name into
    // addresses; capture must still be looking at the source spelling.
    expect(texts.some((argument) => argument.text === 'Destinations.QUEUE')).toBe(true);
    expect(texts.some((argument) => argument.text === 'ordersExchange')).toBe(true);
    expect(texts.some((argument) => argument.text.includes('${app.messaging'))).toBe(false);
  });
});

describe('Spring messaging producer receiver decorations', () => {
  // Template beans are declared under every naming convention a Java or Kotlin
  // codebase uses: a qualifying prefix, a qualifying suffix, a version or index
  // tail, and the constant spelling that `static final` fields take. A rule that
  // only accepted a decorating PREFIX silently dropped the rest, which are the
  // publishes this capture exists to find.
  const facts = javaProducers(`
    package com.example.messaging;

    public class DecoratedTemplates {
        public void suffixed(String payload) { kafkaTemplateDlq.send("a", payload); }
        public void constantCase(String payload) { KAFKA_TEMPLATE.send("b", payload); }
        public void snakeCase(String payload) { kafka_template.send("c", payload); }
        public void versioned(String payload) { kafkaTemplateV2.send("d", payload); }
        public void indexed(String payload) { kafkaTemplate2.send("e", payload); }
        public void constantBridge(String payload) { STREAM_BRIDGE.send("f", payload); }
        public void indexedBridge(String payload) { streamBridge2.send("g", payload); }
        public void indexedRabbit(String key, String payload) {
            rabbitTemplate1.convertAndSend(key, payload);
        }
        public void prefixed(String payload) { orderKafkaTemplate.send("h", payload); }
        public void plain(String payload) { kafkaTemplate.send("i", payload); }
    }
  `);

  it('recognizes a template decorated by prefix, suffix, index, or constant case', () => {
    expect(facts.map(signature)).toEqual([
      'kafka kafkaTemplateDlq.send',
      'kafka KAFKA_TEMPLATE.send',
      'kafka kafka_template.send',
      'kafka kafkaTemplateV2.send',
      'kafka kafkaTemplate2.send',
      'stream-bridge STREAM_BRIDGE.send',
      'stream-bridge streamBridge2.send',
      'rabbit rabbitTemplate1.convertAndSend',
      'kafka orderKafkaTemplate.send',
      'kafka kafkaTemplate.send',
    ]);
  });

  it('recognizes the same decorations in Kotlin', () => {
    const kotlin = kotlinProducers(`
      package com.example.messaging

      class DecoratedTemplates {
          fun suffixed(payload: String) { kafkaTemplateDlq.send("a", payload) }
          fun constantCase(payload: String) { KAFKA_TEMPLATE.send("b", payload) }
          fun indexedBridge(payload: String) { streamBridge2.send("c", payload) }
      }
    `);
    expect(kotlin.map(signature)).toEqual([
      'kafka kafkaTemplateDlq.send',
      'kafka KAFKA_TEMPLATE.send',
      'stream-bridge streamBridge2.send',
    ]);
  });

  it('still refuses a receiver that only a type could make a template', () => {
    // Widening the name match must not reach any of these: an undecorated
    // `template` would attribute every `send` in the repository to Kafka, and
    // the rest are not names at all. `config.get("a.kafkaTemplate")` is the
    // sharp one — splitting on the last dot lands inside the string literal.
    expect(
      javaProducers(`
        package com.example.messaging;

        public class NotTemplates {
            public void bare(String payload) { template.send("t", payload); }
            public void lookup(String payload) { templates.get("k").send("t", payload); }
            public void factory(String payload) { getTemplate().send("t", payload); }
            public void indexed(String payload) { templates["k"].send("t", payload); }
            public void configured(String payload) {
                config.get("a.kafkaTemplate").send("t", payload);
            }
            public void unrelated(String payload) { mailer.send("t", payload); }
        }
      `),
    ).toEqual([]);
  });

  it('names no broker for a receiver that matches two templates at once', () => {
    // Two signatures share `send` and two share `convertAndSend`, so a
    // substring match lets one receiver name satisfy both. The receiver's type
    // is never resolved, so nothing ranks one match over the other, and the
    // first-listed signature would be published as a definite attribution.
    expect(
      javaProducers(`
        package com.example.messaging;

        public class AmbiguousTemplates {
            public void bothSend(String payload) {
                streamBridgeKafkaTemplate.send("a", payload);
            }
            public void bothSendReversed(String payload) {
                kafkaTemplateStreamBridge.send("b", payload);
            }
            public void bothConvertAndSend(String key, String payload) {
                rabbitTemplateJmsTemplate.convertAndSend(key, payload);
            }
        }
      `),
    ).toEqual([]);
  });

  it('names the broker when only one template matches the receiver', () => {
    // The counterpart of the rule above: withholding applies to a genuinely
    // ambiguous name, not to a decorated one that happens to be long. Neither
    // receiver here contains a second template type name.
    expect(
      javaProducers(`
        package com.example.messaging;

        public class UnambiguousTemplates {
            public void bridged(String payload) { orderStreamBridge.send("a", payload); }
            public void kafka(String payload) { streamingKafkaTemplate.send("b", payload); }
        }
      `).map(signature),
    ).toEqual(['stream-bridge orderStreamBridge.send', 'kafka streamingKafkaTemplate.send']);
  });

  it('refuses a receiver whose last segment is not a bare identifier', () => {
    // The identifier gate, not the name match, is what rejects this: strip it
    // and `/*c*/kafkaTemplate` matches the type name and the publish is
    // attributed to a receiver spelling that includes a comment.
    expect(
      javaProducers(`
        package com.example.messaging;

        public class Commented {
            public void commented(String payload) {
                this./*which*/kafkaTemplate.send("orders", payload);
            }
        }
      `),
    ).toEqual([]);
  });
});

describe('Spring messaging producer error recovery', () => {
  it('produces no Java fact when the argument list did not parse', () => {
    // Recovery keeps the tree well formed while inventing what it contains: the
    // unterminated call below absorbs the next method's source and offers it as
    // an argument. A fact whose whole purpose is to name a destination must not
    // report one that was never written.
    expect(
      javaProducers(`
        package com.example.messaging;

        public class Unfinished {
            public void publish(String payload) {
                kafkaTemplate.send(ORDERS_TOPIC,
            }

            public void other(String value) {
                System.out.println(value);
            }
        }
      `),
    ).toEqual([]);
  });

  it('produces no Kotlin fact when the argument list did not parse', () => {
    expect(
      kotlinProducers(`
        package com.example.messaging

        class Unfinished {
            fun publish(payload: String) {
                kafkaTemplate.send(ORDERS_TOPIC,
            }

            fun other(value: String) { println(value) }
        }
      `),
    ).toEqual([]);
  });

  it('still captures a well-formed publish in a file that fails to parse elsewhere', () => {
    // Failing closed is scoped to the broken call, not to the file: a watcher
    // reparse mid-edit must not blank out the publishes that are still intact.
    const facts = javaProducers(`
      package com.example.messaging;

      public class PartlyBroken {
          public void good(String payload) {
              kafkaTemplate.send("orders", payload);
          }

          public void broken(String payload) {
              kafkaTemplate.send(ORDERS_TOPIC,
          }
      }
    `);
    expect(facts.map(destination)).toEqual(['"orders"']);
  });
});

describe('Spring messaging producer argument spellings', () => {
  it('gives one Java argument one spelling however the source wrapped it', () => {
    // The receiver already normalized its wraps; leaving the argument raw made
    // the same constant compare unequal to itself, because the text carries the
    // ENCLOSING block's indentation and so changes with nesting depth.
    const facts = javaProducers(`
      package com.example.messaging;

      public class WrappedArguments {
          public void single(String payload) {
              kafkaTemplate.send(Destinations.ORDERS, payload);
          }

          public void wrapped(String payload) {
              kafkaTemplate.send(Destinations
                  .ORDERS, payload);
          }

          public void wrappedDeeper(String payload) {
              if (payload != null) {
                  kafkaTemplate.send(Destinations
                          .ORDERS, payload);
              }
          }
      }
    `);
    expect(facts.map(destination)).toEqual([
      'Destinations.ORDERS',
      'Destinations.ORDERS',
      'Destinations.ORDERS',
    ]);
  });

  it('gives one Kotlin argument one spelling however the source wrapped it', () => {
    const facts = kotlinProducers(`
      package com.example.messaging

      class KotlinKafkaTemplate {
          fun send(topic: String, data: String) {}
      }

      class WrappedArguments {
          private val kotlinKafkaTemplate = KotlinKafkaTemplate()

          fun single(payload: String) {
              kafkaTemplate.send(Destinations.ORDERS, payload)
          }

          fun wrapped(payload: String) {
              kotlinKafkaTemplate.send(topic = Destinations
                  .ORDERS, data = payload)
          }
      }
    `);
    expect(facts.map(destination)).toEqual(['Destinations.ORDERS', 'Destinations.ORDERS']);
  });

  it('keeps the newlines inside a multi-line string literal argument', () => {
    // The wrap rule may not reach inside a literal: a Java text block or Kotlin
    // raw string whose newline sits next to a dot is a different VALUE once the
    // newline is removed.
    const java = javaProducers(`
      package com.example.messaging;

      public class LiteralArguments {
          public void publish(String payload) {
              kafkaTemplate.send("""
line-a
.line-b""", payload);
          }
      }
    `);
    expect(java.map(destination)).toEqual(['"""\nline-a\n.line-b"""']);
  });

  it('keeps the newlines inside a multi-line literal nested in the receiver', () => {
    // The single-line form of this is already pinned above; the doc comment on
    // the normalizer promised the same for nested literals, and only the
    // single-line case delivered it.
    const java = javaProducers(`
      package com.example.messaging;

      public class LiteralReceiver {
          public void publish(String payload) {
              registry.get("""
line-a
.line-b""").kafkaTemplate.send("orders", payload);
          }
      }
    `);
    expect(java.map((fact) => fact.receiverName)).toEqual([
      'registry.get("""\nline-a\n.line-b""").kafkaTemplate',
    ]);
  });

  it('drops a comment between Java arguments without shifting their positions', () => {
    // Comments are named children of a Java argument list, so an unfiltered
    // read reports three arguments for a two-argument call and moves the
    // payload into the destination slot for anything reading by position.
    const facts = javaProducers(`
      package com.example.messaging;

      public class CommentedArguments {
          public void publish(String payload) {
              kafkaTemplate.send(/* why */ "orders", payload);
          }
      }
    `);
    expect(facts.map((fact) => fact.args)).toEqual([[{ text: '"orders"' }, { text: 'payload' }]]);
  });

  it('reads a Kotlin named argument through a comment between name and value', () => {
    const facts = kotlinProducers(`
      package com.example.messaging

      class KotlinKafkaTemplate {
          fun send(topic: String) {}
      }

      class CommentedArguments {
          private val kotlinKafkaTemplate = KotlinKafkaTemplate()

          fun publish(payload: String) {
              kotlinKafkaTemplate.send(topic /* which */ = "orders")
          }
      }
    `);
    expect(facts.map((fact) => fact.args)).toEqual([[{ name: 'topic', text: '"orders"' }]]);
  });

  it('does not read an annotated Kotlin positional argument as a named one', () => {
    // `@Suppress("x") "orders"` has the same two-child shape as `name = value`.
    // Only the `=` token tells them apart, and inventing a name here would
    // hand a consumer an argument key that does not exist.
    const facts = kotlinProducers(`
      package com.example.messaging

      class AnnotatedArguments {
          fun publish(payload: String) {
              kafkaTemplate.send(@Suppress("UNCHECKED_CAST") "orders", payload)
          }
      }
    `);
    expect(facts.map((fact) => fact.args)).toEqual([
      [{ text: '@Suppress("UNCHECKED_CAST") "orders"' }, { text: 'payload' }],
    ]);
  });
});

describe('Spring messaging producer owner boundaries', () => {
  it('does not attribute a Java publish across a nested type body', () => {
    // A publish in the field initializer of a class declared inside a method is
    // run when that class is instantiated, which the method may never do. The
    // same construct at the top level of a class already yields no fact, and
    // the rule has to read the same at both depths.
    expect(
      javaProducers(`
        package com.example.messaging;

        public class Nested {
            public void outer(String payload) {
                class Local {
                    private final Object sent = kafkaTemplate.send("local-field", payload);
                }
            }

            public void anonymous(String payload) {
                Runnable task = new Runnable() {
                    private final Object sent = kafkaTemplate.send("anon-field", payload);
                    public void run() {}
                };
            }
        }
      `),
    ).toEqual([]);
  });

  it('still attributes a Java publish to a method of a nested type', () => {
    const facts = javaProducers(`
      package com.example.messaging;

      public class Nested {
          public void anonymous(String payload) {
              Runnable task = new Runnable() {
                  public void run() { kafkaTemplate.send("anon-method", payload); }
              };
          }

          class Inner {
              void publish(String payload) { kafkaTemplate.send("inner-method", payload); }
          }
      }
    `);
    expect(facts.map(destination)).toEqual(['"anon-method"', '"inner-method"']);
  });

  it('does not attribute a Kotlin publish across a nested class body', () => {
    expect(
      kotlinProducers(`
        package com.example.messaging

        class Nested {
            fun outer(payload: String) {
                class Local {
                    val sent = kafkaTemplate.send("local-property", payload)
                }

                val task = object : Runnable {
                    val sent = kafkaTemplate.send("object-property", payload)
                    override fun run() {}
                }
            }
        }
      `),
    ).toEqual([]);
  });

  it('still attributes a Kotlin publish to a function of a nested class body', () => {
    const facts = kotlinProducers(`
      package com.example.messaging

      class Nested {
          fun outer(payload: String) {
              val task = object : Runnable {
                  override fun run() { kafkaTemplate.send("object-method", payload) }
              }
          }
      }
    `);
    expect(facts.map(destination)).toEqual(['"object-method"']);
  });

  it('does not unwrap a Kotlin postfix operator that only looks like an assertion', () => {
    // The existing coverage used `counter++`, which the name match rejects on
    // its own. Only a receiver that WOULD match makes the unwrap guard the
    // reason for the rejection.
    expect(
      kotlinProducers(`
        package com.example.messaging

        class Incremented {
            fun publish(payload: String) {
                kafkaTemplate++.send("orders", payload)
            }
        }
      `),
    ).toEqual([]);
  });
});