Allow task queue names to use property placeholders (#1760)

Author: FrankShaw

temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/ActivityImpl.java

@@ -42,7 +42,7 @@
   /**
    * @return Worker Task Queues to register this activity bean with. If Worker with the specified
    *     Task Queue is not present in the application config, it will be created with a default
-   *     config.
+   *     config. Can be specified as a property key, e.g.: ${propertyKey}.
    */
   String[] taskQueues() default {};
 }

temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/WorkflowImpl.java

@@ -42,7 +42,7 @@
   /**
    * @return Worker Task Queues to register this workflow implementation with. If Worker with the
    *     specified Task Queue is not defined in the application config, it will be created with a
-   *     default config.
+   *     default config. Can be specified by a property key, e.g.: ${propertyKey}.
    */
   String[] taskQueues() default {};
 }

temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/WorkersTemplate.java

@@ -44,13 +44,15 @@
 import org.springframework.beans.factory.config.BeanDefinition;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.beans.factory.support.BeanDefinitionValidationException;
+import org.springframework.context.EnvironmentAware;
 import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider;
 import org.springframework.core.annotation.AnnotationUtils;
+import org.springframework.core.env.Environment;
 import org.springframework.core.type.filter.AnnotationTypeFilter;
 import org.springframework.util.Assert;
 
 /** Creates a {@link WorkerFactory} and Workers for a given namespace provided by WorkflowClient. */
-public class WorkersTemplate implements BeanFactoryAware {
+public class WorkersTemplate implements BeanFactoryAware, EnvironmentAware {
   private static final Logger log = LoggerFactory.getLogger(WorkersTemplate.class);
 
   private final @Nonnull TemporalProperties properties;
@@ -66,6 +68,7 @@ public class WorkersTemplate implements BeanFactoryAware {
   private final @Nullable TemporalOptionsCustomizer<WorkerOptions.Builder> workerCustomizer;
 
   private ConfigurableListableBeanFactory beanFactory;
+  private Environment environment;
 
   private WorkerFactory workerFactory;
   private Collection<Worker> workers;
@@ -149,6 +152,7 @@ private void configureWorkflowImplementationsByTaskQueue(
     for (Class<?> clazz : autoDiscoveredWorkflowImplementationClasses) {
       WorkflowImpl annotation = clazz.getAnnotation(WorkflowImpl.class);
       for (String taskQueue : annotation.taskQueues()) {
+        taskQueue = environment.resolvePlaceholders(taskQueue);
         Worker worker = workerFactory.tryGetWorker(taskQueue);
         if (worker == null) {
           log.info(
@@ -175,6 +179,7 @@ private void configureActivityBeansByTaskQueue(
           ActivityImpl annotation = AnnotationUtils.findAnnotation(targetClass, ActivityImpl.class);
           if (annotation != null) {
             for (String taskQueue : annotation.taskQueues()) {
+              taskQueue = environment.resolvePlaceholders(taskQueue);
               Worker worker = workerFactory.tryGetWorker(taskQueue);
               if (worker == null) {
                 log.info(
@@ -371,6 +376,11 @@ public void setBeanFactory(@Nonnull BeanFactory beanFactory) throws BeansExcepti
     this.beanFactory = (ConfigurableListableBeanFactory) beanFactory;
   }
 
+  @Override
+  public void setEnvironment(@Nonnull Environment environment) {
+    this.environment = environment;
+  }
+
   private Worker createNewWorker(
       @Nonnull String taskQueue, @Nullable WorkerProperties properties, @Nonnull Workers workers) {
     Preconditions.checkState(

temporal-spring-boot-autoconfigure-alpha/src/test/java/io/temporal/spring/boot/autoconfigure/AutoDiscoveryByTaskQueueResolverTest.java

@@ -0,0 +1,69 @@
+/*
+ * 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 io.temporal.client.WorkflowClient;
+import io.temporal.client.WorkflowOptions;
+import io.temporal.spring.boot.autoconfigure.bytaskqueue.TestWorkflow;
+import io.temporal.worker.WorkerFactory;
+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 = AutoDiscoveryByTaskQueueResolverTest.Configuration.class)
+@ActiveProfiles(profiles = "auto-discovery-by-task-queue-dynamic-suffix")
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+public class AutoDiscoveryByTaskQueueResolverTest {
+  @Autowired ConfigurableApplicationContext applicationContext;
+
+  @Autowired WorkflowClient workflowClient;
+
+  @Autowired WorkerFactory workerFactory;
+
+  @BeforeEach
+  void setUp() {
+    applicationContext.start();
+  }
+
+  @Test
+  @Timeout(value = 10)
+  public void testAutoDiscovery() {
+    TestWorkflow testWorkflow =
+        workflowClient.newWorkflowStub(
+            TestWorkflow.class,
+            WorkflowOptions.newBuilder().setTaskQueue("PropertyResolverTest").build());
+    testWorkflow.execute("input");
+  }
+
+  @ComponentScan(
+      excludeFilters =
+          @ComponentScan.Filter(
+              pattern = "io\\.temporal\\.spring\\.boot\\.autoconfigure\\.byworkername\\..*",
+              type = FilterType.REGEX))
+  public static class Configuration {}
+}

temporal-spring-boot-autoconfigure-alpha/src/test/java/io/temporal/spring/boot/autoconfigure/bytaskqueue/TestActivityImpl.java

@@ -24,7 +24,7 @@
 import org.springframework.stereotype.Component;
 
 @Component("TestActivityImpl")
-@ActivityImpl(taskQueues = "UnitTest")
+@ActivityImpl(taskQueues = "${default-queue.name:UnitTest}")
 public class TestActivityImpl implements TestActivity {
   @Override
   public String execute(String input) {

temporal-spring-boot-autoconfigure-alpha/src/test/java/io/temporal/spring/boot/autoconfigure/bytaskqueue/TestWorkflowImpl.java

@@ -25,7 +25,7 @@
 import io.temporal.workflow.Workflow;
 import java.time.Duration;
 
-@WorkflowImpl(taskQueues = "UnitTest")
+@WorkflowImpl(taskQueues = {"${default-queue.name:UnitTest}"})
 public class TestWorkflowImpl implements TestWorkflow {
   @Override
   public String execute(String input) {

temporal-spring-boot-autoconfigure-alpha/src/test/resources/application.yml

@@ -37,6 +37,18 @@ spring:
       packages:
         - io.temporal.spring.boot.autoconfigure.bytaskqueue
 
+---
+spring:
+  config:
+    activate:
+      on-profile: auto-discovery-by-task-queue-dynamic-suffix
+  temporal:
+    workers-auto-discovery:
+      packages:
+        - io.temporal.spring.boot.autoconfigure.bytaskqueue
+default-queue:
+  name: PropertyResolverTest
+
 ---
 spring:
   config: