Skip to content

[events] Support Prototype Scope #840

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,14 @@ Set<UType> allGenericTypes() {
if (utype.isGeneric()) {
allUTypes.add(utype);
}
method.params().stream()
.filter(p -> !p.observeEvent())
.map(MethodParam::getFullUType)
.forEach(u -> {
if (u.isGeneric()) {
allUTypes.add(u);
}
});
}

if (constructor != null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Supplier;

import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
Expand Down Expand Up @@ -419,6 +420,11 @@ void addImports(ImportTypeMap importTypes) {
if (optionalType) {
importTypes.add(Constants.OPTIONAL);
}

if (observeParameter != null && params.size() > 1) {
importTypes.add(Supplier.class.getCanonicalName());
importTypes.add(Constants.BEANSCOPE);
}
conditions.addImports(importTypes);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,7 @@ private void writeExtraInjection() {
private void writeObserveMethods() {
final var bean = "bean";
final var builder = "builder";
final var scope = "beanScope";

final var indent = " ";
for (MethodReader methodReader : beanReader.observerMethods()) {
Expand All @@ -264,9 +265,18 @@ private void writeObserveMethods() {
final var shortWithoutAnnotations = observeUtype.shortWithoutAnnotations();
var injectParams = methodReader.params().stream().skip(1).collect(toList());

if (!injectParams.isEmpty()) {
writer.indent(indent).append("var %s = %s.get(BeanScope.class);", scope, builder).eol();
}

for (MethodParam param : injectParams) {
writer.indent(indent).append("var %s = ", methodReader.name() + "$" + param.simpleName());
param.builderGetDependency(writer, builder);
if (Constants.BEANSCOPE.equals(param.getFullUType().fullWithoutAnnotations())) {
continue;
}
writer.indent(indent).append("Supplier<%s> %s = () -> ",
param.getFullUType().shortType(),
methodReader.name() + "$" + param.simpleName());
param.builderGetDependency(writer, scope);
writer.append(";").eol();
}

Expand All @@ -281,7 +291,10 @@ private void writeObserveMethods() {
writer.append("%s::%s;", bean, methodReader.name());
} else {
var injectParamNames = injectParams.stream()
.map(p -> methodReader.name() + "$" + p.simpleName())
.map(p ->
Constants.BEANSCOPE.equals(p.getFullUType().fullWithoutAnnotations())
? scope
: methodReader.name() + "$" + p.simpleName() + ".get()")
.collect(joining(", "));
writer.append("e -> bean.%s(e, %s);", methodReader.name(), injectParamNames);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
package io.avaje.inject.generator.models.valid.observes;

import io.avaje.inject.BeanScope;
import io.avaje.inject.events.ObservesAsync;
import jakarta.inject.Singleton;

@Singleton
public class TestObserverInjection {

void observe(@ObservesAsync String e, TestObserver observer) {}
void observe(@ObservesAsync String e, TestObserver observer, BeanScope scope) {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package org.example.observes;

import java.util.ArrayDeque;

import org.example.coffee.prototype.MyProto;

import io.avaje.inject.events.Observes;
import jakarta.inject.Singleton;

@Singleton
public class MyObserverInjectPrototype {

boolean invoked = false;
CustomEvent event;
ArrayDeque<MyProto> beansList = new ArrayDeque<>();

void observe(@Observes CustomEvent e, MyProto proto) {
invoked = true;
event = e;
beansList.add(proto);
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package org.example.observes;

import io.avaje.inject.events.Event;
import io.avaje.inject.events.Observes;
import jakarta.inject.Singleton;

Expand All @@ -9,7 +10,10 @@ public class MyObserverInjected {
boolean invoked = false;
CustomEvent event;

void observe(@Observes CustomEvent e, MyObserver observer) {
void observe(
@Observes CustomEvent e,
MyObserver observer,
@StrQualifier(value = "foo") Event<CustomEvent> publisher) {
invoked = true;
event = e;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ class TestEventMessaging {
@Inject MyObserver observer;
@Inject MyQualifiedObserver qualifiedObserver;
@Inject MyObserverInjected observerInjected;
@Inject MyObserverInjectPrototype observerPrototype;
@Inject MyStrQualifiedObserver strQualifiedObserver;
@Inject Event<CustomEvent> event;
@Inject EventSender2 sender2;
Expand All @@ -30,6 +31,9 @@ void before() {
qualifiedObserver.event = null;
observerInjected.invoked= false;
observerInjected.event = null;
observerPrototype.invoked = false;
observerPrototype.event = null;
observerPrototype.beansList.clear();
}

@Test
Expand All @@ -45,6 +49,21 @@ void test() {
assertThat(observerInjected.event).isSameAs(message);
}

@Test
void testProtoType() {
var message = new CustomEvent("hi");

event.fire(message);

assertThat(observerPrototype.invoked).isTrue();
assertThat(observerPrototype.event).isSameAs(message);
event.fire(message);

assertThat(observerPrototype.invoked).isTrue();
assertThat(observerPrototype.event).isSameAs(message);
assertThat(observerPrototype.beansList.poll()).isNotSameAs(observerPrototype.beansList.poll());
}

@Test
void testWithQualified() {
var message = new CustomEvent("hi");
Expand Down