Add support for environment config #2660

Quinn-With-Two-Ns · 2025-09-15T06:14:25Z

Add support for environment config to the Java SDK

https://docs.temporal.io/develop/environment-configuration

Quinn-With-Two-Ns · 2025-09-15T06:15:21Z

temporal-envconfig/build.gradle

@@ -0,0 +1,13 @@
+description = '''Temporal Java SDK Environment Config Module'''


In terms of naming it would probably more consistent internally in the Java SDK to call this module temporal-enviorment-configuration, but that isn't consistent with the Go SDK

👍 The envconfig shortened term for the modules/packages/namespaces myself is kinda nice

Quinn-With-Two-Ns · 2025-09-15T06:17:09Z

temporal-envconfig/src/main/java/io/temporal/envconfig/ClientConfig.java

+    }
+  }
+
+  public ClientConfig(Map<String, ClientConfigProfile> profiles) {


May want to use a builder here for consistency

cretz · 2025-09-15T19:11:39Z

temporal-envconfig/src/main/java/io/temporal/envconfig/ClientConfig.java

+
+/** ClientConfig represents a client config file. */
+@Experimental
+public class ClientConfig {


Hrmm, ideally we could have one static call on client config in the SDKs that gives you what you need to connect a client. With Java this is admittedly harder because 1) stubs are separate from client, and 2) Java doesn't support a native tuple to return two things at once.

I wonder if there is any creative approach we can think of here.

The only thing I could think of was have a method that gives you a full client that takes a few options customizers to set additional options on the service stub options and client options.

I think what you have here is good enough

cretz · 2025-09-15T19:13:25Z

temporal-envconfig/src/main/java/io/temporal/envconfig/ClientConfig.java

+
+/** ClientConfig represents a client config file. */
+@Experimental
+public class ClientConfig {


I know it sounds pedantic, but can we also expose static calls for getting the default profile stuff to connect. Specifically, can we have:

public static WorkflowServiceStubsOptions loadWorkflowServiceStubsOptions()

and

public static WorkflowClientOptions loadWorkflowClientOptions()

on this class? Or maybe named loadDefaultWorkflowServiceStubsOptions or something? With the other SDKs, we are putting a static call on the highest level class/place we can to be able to load what is needed from the default profile to make client connections. I would guess these would be the calls used by every SDK sample.

So we wan't a short cut to call ClientConfigProfile.load().toWorkflowServiceStubsOptions()?

Yeah, we have been adding this to other SDKs. But it's not a big deal if we don't do it.

cretz · 2025-09-15T19:14:52Z

temporal-envconfig/src/main/java/io/temporal/envconfig/ClientConfigToml.java

One feature we were adding to other SDKs is the ability to be able to read/write TOML. For languages that didn't want a dependency, we would just give an object that could serialize as such, but Java already has the dependency.

So the Go SDK does not have the feature, does any SDK support the ability to read/write the TOML file? Is any user asking for this?

So the Go SDK does not have the featur

ClientConfig does have FromTOML and ToTOML

does any SDK support the ability to read/write the TOML file? Is any user asking for this?

Every SDK supports at least the raw TOML structure (even if it's maps/dictionary structures of generic objects). We don't necessarily do the reading/writing of TOML to an actual file for the users, but the ability for users to parse/write our config format in SDKs was something we had originally stated was a goal. Doesn't have to be TOML or even typesafe structures, just any way a user can parse/write it.

Okay so we want Okay I added a fromToml and toToml equivalent

cretz · 2025-09-15T19:15:52Z

temporal-envconfig/src/main/java/io/temporal/envconfig/ClientConfigTLS.java

+    return new Builder(config);
+  }
+
+  private final boolean disabled;


IMO we should match the TOML representation exactly, which IMO I think means this is a Boolean because it can be unset and unset has different behavior than just false (default is TLS disabled by default unless API key is present). This is mostly thinking about the ability to convert it back to TOML, but maybe that's not a concern.

does this also apply to disableHostVerification as well?

Hrmm, up to you since it's only ever true/false (absent is always false). My concern was mostly about disabled's absence having a special meaning, granted in Go we don't use a nullable bool either, hrmm. No strong opinion here. Core-based SDKs do not have a disable-host-verification option.

cretz · 2025-09-15T19:24:38Z

temporal-envconfig/build.gradle

@@ -0,0 +1,13 @@
+description = '''Temporal Java SDK Environment Config Module'''


👍 The envconfig shortened term for the modules/packages/namespaces myself is kinda nice

cretz

LGTM (especially since it's experimental atm). Added small suggestion concerning Jackson version.

temporal-envconfig/build.gradle

Quinn-With-Two-Ns requested a review from a team as a code owner September 15, 2025 06:14

Quinn-With-Two-Ns commented Sep 15, 2025

View reviewed changes

This comment was marked as outdated.

Sign in to view

cretz reviewed Sep 15, 2025

View reviewed changes

This comment was marked as outdated.

Sign in to view

Quinn-With-Two-Ns force-pushed the SDK-3958 branch from c130d9f to 471a1ae Compare September 18, 2025 00:19

cretz approved these changes Sep 18, 2025

View reviewed changes

temporal-envconfig/build.gradle Outdated Show resolved Hide resolved

Quinn-With-Two-Ns added 11 commits September 18, 2025 09:41

Add environment config

1187ce5

Add more docs and tests

8a83e3a

clean up

89bd5fe

fix recursion

caf6191

More tests

e71764f

Added parsing and writing

682433b

Fix ClientConfigFromTomlOptions

60f9605

Fix isDisabled

a36af6c

Pin Ubuntu version

26c6a79

revert

274493e

Fix TLS disabled

9d28fe9

Quinn-With-Two-Ns force-pushed the SDK-3958 branch from 471a1ae to 9d28fe9 Compare September 18, 2025 16:58

Quinn-With-Two-Ns added 2 commits September 21, 2025 23:44

Use GrpcSslContexts to make the SslContextBuilder

96e853b

Fix type

b0eb6da

		@@ -0,0 +1,13 @@
		description = '''Temporal Java SDK Environment Config Module'''

Add support for environment config #2660

Are you sure you want to change the base?

Add support for environment config #2660

Conversation

Quinn-With-Two-Ns commented Sep 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cretz Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

cretz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cretz Sep 16, 2025 •

edited

Loading