From 9c88693783447bd3ad877c8921f4da8e0c61fb06 Mon Sep 17 00:00:00 2001 From: Tihomir Surdilovic Date: Sun, 25 Feb 2024 21:44:38 -0500 Subject: [PATCH 1/3] SpringBoot - add workflow and activity metadata to RegisteredInfo Signed-off-by: Tihomir Surdilovic --- .../template/WorkersTemplate.java | 55 ++++++++++++++++--- 1 file changed, 46 insertions(+), 9 deletions(-) diff --git a/temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/WorkersTemplate.java b/temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/WorkersTemplate.java index e4d542aaf..7cc2e4832 100644 --- a/temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/WorkersTemplate.java +++ b/temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/WorkersTemplate.java @@ -24,6 +24,7 @@ import io.opentracing.Tracer; import io.temporal.client.WorkflowClient; import io.temporal.common.Experimental; +import io.temporal.common.metadata.POJOActivityImplMetadata; import io.temporal.common.metadata.POJOWorkflowImplMetadata; import io.temporal.common.metadata.POJOWorkflowMethodMetadata; import io.temporal.spring.boot.ActivityImpl; @@ -314,7 +315,10 @@ private void createWorkerFromAnExplicitConfig( AopUtils.getTargetClass(bean), taskQueue); worker.registerActivitiesImplementations(bean); - addRegisteredActivityImpl(worker, beanName, bean.getClass().getName()); + POJOActivityImplMetadata activityImplMetadata = + POJOActivityImplMetadata.newInstance(AopUtils.getTargetClass(bean)); + addRegisteredActivityImpl( + worker, beanName, bean.getClass().getName(), activityImplMetadata); }); } } @@ -328,7 +332,9 @@ private void configureActivityImplementationAutoDiscovery( Workers workers) { try { worker.registerActivitiesImplementations(bean); - addRegisteredActivityImpl(worker, beanName, bean.getClass().getName()); + POJOActivityImplMetadata activityImplMetadata = + POJOActivityImplMetadata.newInstance(AopUtils.getTargetClass(bean)); + addRegisteredActivityImpl(worker, beanName, bean.getClass().getName(), activityImplMetadata); if (log.isInfoEnabled()) { log.info( "Registering auto-discovered activity bean '{}' of class {} on a worker {}with a task queue '{}'", @@ -396,7 +402,8 @@ private void configureWorkflowImplementation(Worker worker, Class clazz) (Class) workflowMethod.getWorkflowInterface(), () -> (T) beanFactory.createBean(clazz), workflowImplementationOptions); - addRegisteredWorkflowImpl(worker, workflowMethod.getWorkflowInterface().getName()); + addRegisteredWorkflowImpl( + worker, workflowMethod.getWorkflowInterface().getName(), workflowMetadata); } } @@ -429,32 +436,42 @@ private Worker createNewWorker( return worker; } - private void addRegisteredWorkflowImpl(Worker worker, String workflowClass) { + private void addRegisteredWorkflowImpl( + Worker worker, String workflowClass, POJOWorkflowImplMetadata metadata) { if (!registeredInfo.containsKey(worker.getTaskQueue())) { registeredInfo.put( worker.getTaskQueue(), new RegisteredInfo() - .addWorkflowInfo(new RegisteredWorkflowInfo().addClassName(workflowClass))); + .addWorkflowInfo( + new RegisteredWorkflowInfo().addClassName(workflowClass).addMetadata(metadata))); } else { registeredInfo .get(worker.getTaskQueue()) .getRegisteredWorkflowInfo() - .add(new RegisteredWorkflowInfo().addClassName(workflowClass)); + .add(new RegisteredWorkflowInfo().addClassName(workflowClass).addMetadata(metadata)); } } - private void addRegisteredActivityImpl(Worker worker, String beanName, String beanClass) { + private void addRegisteredActivityImpl( + Worker worker, String beanName, String beanClass, POJOActivityImplMetadata metadata) { if (!registeredInfo.containsKey(worker.getTaskQueue())) { registeredInfo.put( worker.getTaskQueue(), new RegisteredInfo() .addActivityInfo( - new RegisteredActivityInfo().addBeanName(beanName).addClassName(beanClass))); + new RegisteredActivityInfo() + .addBeanName(beanName) + .addClassName(beanClass) + .addMetadata(metadata))); } else { registeredInfo .get(worker.getTaskQueue()) .getRegisteredActivityInfo() - .add(new RegisteredActivityInfo().addBeanName(beanName).addClassName(beanClass)); + .add( + new RegisteredActivityInfo() + .addBeanName(beanName) + .addClassName(beanClass) + .addMetadata(metadata)); } } @@ -484,6 +501,7 @@ public List getRegisteredWorkflowInfo() { public static class RegisteredActivityInfo { private String beanName; private String className; + private POJOActivityImplMetadata metadata; public RegisteredActivityInfo addClassName(String className) { this.className = className; @@ -495,6 +513,11 @@ public RegisteredActivityInfo addBeanName(String beanName) { return this; } + public RegisteredActivityInfo addMetadata(POJOActivityImplMetadata metadata) { + this.metadata = metadata; + return this; + } + public String getClassName() { return className; } @@ -502,19 +525,33 @@ public String getClassName() { public String getBeanName() { return beanName; } + + public POJOActivityImplMetadata getMetadata() { + return metadata; + } } public static class RegisteredWorkflowInfo { private String className; + private POJOWorkflowImplMetadata metadata; public RegisteredWorkflowInfo addClassName(String className) { this.className = className; return this; } + public RegisteredWorkflowInfo addMetadata(POJOWorkflowImplMetadata metadata) { + this.metadata = metadata; + return this; + } + public String getClassName() { return className; } + + public POJOWorkflowImplMetadata getMetadata() { + return metadata; + } } private static class Workers { From e55bf19825a0b5f5f605bf50a8660fa956e8a1ea Mon Sep 17 00:00:00 2001 From: Tihomir Surdilovic Date: Sun, 10 Mar 2024 23:25:29 -0400 Subject: [PATCH 2/3] marked register classes as experimental Signed-off-by: Tihomir Surdilovic --- .../spring/boot/autoconfigure/template/WorkersTemplate.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/WorkersTemplate.java b/temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/WorkersTemplate.java index 7cc2e4832..b693d995c 100644 --- a/temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/WorkersTemplate.java +++ b/temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/WorkersTemplate.java @@ -498,6 +498,7 @@ public List getRegisteredWorkflowInfo() { } } + @Experimental public static class RegisteredActivityInfo { private String beanName; private String className; @@ -531,6 +532,7 @@ public POJOActivityImplMetadata getMetadata() { } } + @Experimental public static class RegisteredWorkflowInfo { private String className; private POJOWorkflowImplMetadata metadata; From d8ea60d09cc258dbf1bf62d948cb634eb4c4255b Mon Sep 17 00:00:00 2001 From: Tihomir Surdilovic Date: Fri, 22 Mar 2024 14:08:44 -0400 Subject: [PATCH 3/3] adding test Signed-off-by: Tihomir Surdilovic --- .../autoconfigure/RegisteredInfoTest.java | 107 ++++++++++++++++++ 1 file changed, 107 insertions(+) create mode 100644 temporal-spring-boot-autoconfigure-alpha/src/test/java/io/temporal/spring/boot/autoconfigure/RegisteredInfoTest.java diff --git a/temporal-spring-boot-autoconfigure-alpha/src/test/java/io/temporal/spring/boot/autoconfigure/RegisteredInfoTest.java b/temporal-spring-boot-autoconfigure-alpha/src/test/java/io/temporal/spring/boot/autoconfigure/RegisteredInfoTest.java new file mode 100644 index 000000000..e1a666ff5 --- /dev/null +++ b/temporal-spring-boot-autoconfigure-alpha/src/test/java/io/temporal/spring/boot/autoconfigure/RegisteredInfoTest.java @@ -0,0 +1,107 @@ +/* + * Copyright (C) 2022 Temporal Technologies, Inc. All Rights Reserved. + * + * Copyright (C) 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Modifications copyright (C) 2017 Uber Technologies, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this material except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.temporal.spring.boot.autoconfigure; + +import static org.junit.jupiter.api.Assertions.*; + +import io.temporal.common.metadata.POJOActivityImplMetadata; +import io.temporal.common.metadata.POJOWorkflowImplMetadata; +import io.temporal.spring.boot.autoconfigure.template.WorkersTemplate; +import java.util.Map; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestInstance; +import org.junit.jupiter.api.Timeout; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.FilterType; +import org.springframework.test.context.ActiveProfiles; + +@SpringBootTest(classes = RegisteredInfoTest.Configuration.class) +@ActiveProfiles(profiles = "auto-discovery-by-worker-name") +@TestInstance(TestInstance.Lifecycle.PER_CLASS) +public class RegisteredInfoTest { + + @Autowired ConfigurableApplicationContext applicationContext; + + @Autowired private WorkersTemplate workersTemplate; + + @BeforeEach + void setUp() { + applicationContext.start(); + } + + @Test + @Timeout(value = 10) + public void testRegisteredInfo() { + assertNotNull(workersTemplate); + assertNotNull(workersTemplate.getRegisteredInfo()); + Map registeredInfoMap = + workersTemplate.getRegisteredInfo(); + + assertEquals(1, registeredInfoMap.size()); + registeredInfoMap.forEach( + (taskQueue, info) -> { + assertEquals("UnitTest", taskQueue); + info.getRegisteredWorkflowInfo() + .forEach( + (workflowInfo) -> { + assertNotNull(workflowInfo); + assertEquals( + "io.temporal.spring.boot.autoconfigure.byworkername.TestWorkflow", + workflowInfo.getClassName()); + POJOWorkflowImplMetadata metadata = workflowInfo.getMetadata(); + assertNotNull(metadata); + assertEquals(1, metadata.getWorkflowMethods().size()); + assertEquals(1, metadata.getWorkflowInterfaces().size()); + assertEquals(0, metadata.getSignalMethods().size()); + }); + + info.getRegisteredActivityInfo() + .forEach( + (activityInfo) -> { + assertEquals( + "io.temporal.spring.boot.autoconfigure.bytaskqueue.TestActivityImpl", + activityInfo.getClassName()); + assertEquals("TestActivityImpl", activityInfo.getBeanName()); + POJOActivityImplMetadata metadata = activityInfo.getMetadata(); + assertEquals(1, metadata.getActivityInterfaces().size()); + assertEquals(1, metadata.getActivityMethods().size()); + assertEquals( + "io.temporal.common.metadata.POJOActivityMethodMetadata", + metadata.getActivityMethods().get(0).getClass().getName()); + assertEquals( + "Execute", metadata.getActivityMethods().get(0).getActivityTypeName()); + assertEquals( + "execute", metadata.getActivityMethods().get(0).getMethod().getName()); + }); + }); + } + + @ComponentScan( + excludeFilters = + @ComponentScan.Filter( + pattern = "io\\.temporal\\.spring\\.boot\\.autoconfigure\\.byworkername\\..*", + type = FilterType.REGEX)) + public static class Configuration {} +}