Support for parsing custom scopes in config file #581

Tejas-Kochar · 2025-12-18T09:23:44Z

Summary

The Java SDK already had support for custom scopes in all three OAuth flows. It only lacked support for configuring scopes in a config file. This PR covers that gap.

Testing

Tested by loading configurations from a test config file and resolving them.

NO_CHANGELOG=true

github-actions · 2025-12-22T05:16:31Z

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/sdk-java

Inputs:

PR number: 581
Commit SHA: 30e93a3c15c1d3551d3c7b2987a6c5bffa2e2c18

Checks will be approved automatically on success.

Tejas-Kochar · 2025-12-22T12:39:45Z

databricks-sdk-java/src/main/java/com/databricks/sdk/core/DatabricksConfig.java

  @ConfigAttribute(env = "DATABRICKS_CLIENT_SECRET", auth = "oauth", sensitive = true)
  private String clientSecret;

-  @ConfigAttribute(env = "DATABRICKS_SCOPES", auth = "oauth")


It actually wasn't possible to pass scopes through environment variable because Lists weren't parsed correctly, so removing this is not a breaking change.
Removing the environment variable attribute for consistency with the other SDKs where we are not supporting setting scopes via environment variables.

parthban-db · 2025-12-22T11:05:14Z

databricks-sdk-java/src/main/java/com/databricks/sdk/core/DatabricksConfig.java


-  @ConfigAttribute(env = "DATABRICKS_SCOPES", auth = "oauth")
+  @ConfigAttribute(auth = "oauth")
  private List<String> scopes;


This is a backward-incompatible change. What's the rationale for removing this environment variable?

parthban-db · 2025-12-23T23:11:11Z

databricks-sdk-java/src/main/java/com/databricks/sdk/core/ConfigAttributeAccessor.java

+          ParameterizedType paramType = (ParameterizedType) field.getGenericType();
+          if (paramType.getActualTypeArguments().length > 0
+              && paramType.getActualTypeArguments()[0] == String.class) {
+            // Split by commas and/or whitespace and filter out empty strings


Why do we have two delimiters? Shouldn't we only have a single delimiter, preferably a comma?

parthban-db · 2025-12-23T23:13:34Z

databricks-sdk-java/src/main/java/com/databricks/sdk/core/ConfigAttributeAccessor.java


  public String getAsString(Object value) {
+    if (value instanceof List) {
+      return String.join(" ", (List<String>) value);


You check the instanceof with just List, however, you typecast the variable to List , I think it can lead to unexpected behaviors.

parthban-db · 2025-12-23T23:16:20Z

databricks-sdk-java/src/main/java/com/databricks/sdk/core/ConfigAttributeAccessor.java


  public String getAsString(Object value) {
+    if (value instanceof List) {
+      return String.join(" ", (List<String>) value);


Also, why did you choose a space as a delimiter instead of a comma?

parthban-db · 2025-12-23T23:18:07Z

databricks-sdk-java/src/main/java/com/databricks/sdk/core/ConfigAttributeAccessor.java

        field.set(cfg, ProxyConfig.ProxyAuthType.valueOf(value));
+      } else if (List.class.isAssignableFrom(field.getType())) {
+        // Handle List<String> fields (e.g., scopes)
+        // Parse comma and/or whitespace separated values from environment variable or config file


Suggested change

// Parse comma and/or whitespace separated values from environment variable or config file

// Parse comma and/or whitespace separated values from environment variable or config file.

parthban-db · 2025-12-23T23:20:59Z

databricks-sdk-java/src/main/java/com/databricks/sdk/core/DatabricksConfig.java

+  /** Sort scopes in-place for better de-duplication in the refresh token cache. */
+  private void sortScopes() {


This is a private function, so according to Java convention. We shouldn't have the comments in the javadoc format.

Suggested change

/** Sort scopes in-place for better de-duplication in the refresh token cache. */

private void sortScopes() {

// Sort scopes in-place for better de-duplication in the refresh token cache.

private void sortScopes() {

parthban-db · 2025-12-23T23:21:42Z

databricks-sdk-java/src/test/java/com/databricks/sdk/core/DatabricksConfigTest.java

+  // Config File Scope Parsing Tests
+
+  private static Stream<Arguments> provideConfigFileScopesTestCases() {


Suggested change

// Config File Scope Parsing Tests

private static Stream<Arguments> provideConfigFileScopesTestCases() {

// Config File Scope Parsing Tests.

private static Stream<Arguments> provideConfigFileScopesTestCases() {

parthban-db · 2025-12-23T23:24:48Z

databricks-sdk-java/src/test/java/com/databricks/sdk/core/DatabricksConfigTest.java

+    assertEquals(expectedScopes.size(), scopes.size());
+    for (int i = 0; i < expectedScopes.size(); i++) {
+      assertEquals(expectedScopes.get(i), scopes.get(i));
+    }


Can we use a direct comparison, like: assertEquals(expectedScopes, config.getScopes())? Instead of the comparison, you are doing? It seems a bit verbose.

parthban-db · 2025-12-23T23:27:14Z

databricks-sdk-java/src/main/java/com/databricks/sdk/core/ConfigAttributeAccessor.java

        field.set(cfg, seconds > 0 ? Duration.ofSeconds(seconds) : null);
      } else if (field.getType() == ProxyConfig.ProxyAuthType.class) {
        field.set(cfg, ProxyConfig.ProxyAuthType.valueOf(value));
+      } else if (List.class.isAssignableFrom(field.getType())) {
+        // Handle List<String> fields (e.g., scopes)


I have a question about this big if-else block. This block doesn't have a default else, which throws an error when an unexpected type appears in the config. So is the current code simply ignoring those types?

Tejas-Kochar temporarily deployed to test-trigger-is December 18, 2025 09:23 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is December 18, 2025 09:25 — with GitHub Actions Inactive

Tejas-Kochar force-pushed the custom-scopes branch from 54ffcc4 to 782d3c9 Compare December 22, 2025 04:19

Tejas-Kochar temporarily deployed to test-trigger-is December 22, 2025 04:19 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is December 22, 2025 04:21 — with GitHub Actions Inactive

Tejas-Kochar force-pushed the custom-scopes branch from 782d3c9 to f1b8d08 Compare December 22, 2025 04:28

Tejas-Kochar temporarily deployed to test-trigger-is December 22, 2025 04:28 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is December 22, 2025 04:29 — with GitHub Actions Inactive

Add support for parsing scopes from config file

42aef75

Tejas-Kochar force-pushed the custom-scopes branch from f1b8d08 to 42aef75 Compare December 22, 2025 04:30

Tejas-Kochar temporarily deployed to test-trigger-is December 22, 2025 04:30 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is December 22, 2025 04:31 — with GitHub Actions Inactive

Tejas-Kochar requested a review from parthban-db December 22, 2025 04:54

No environment variable support for scopes

30e93a3

Tejas-Kochar temporarily deployed to test-trigger-is December 22, 2025 05:15 — with GitHub Actions Inactive

Tejas-Kochar temporarily deployed to test-trigger-is December 22, 2025 05:16 — with GitHub Actions Inactive

Tejas-Kochar changed the title ~~Custom Scopes Support~~ Support for parsing custom scopes in config file Dec 22, 2025

Tejas-Kochar commented Dec 22, 2025

View reviewed changes

parthban-db reviewed Dec 23, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Support for parsing custom scopes in config file #581

Support for parsing custom scopes in config file #581

Tejas-Kochar commented Dec 18, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Dec 22, 2025

Uh oh!

Tejas-Kochar Dec 22, 2025

Uh oh!

parthban-db Dec 22, 2025

Uh oh!

parthban-db Dec 23, 2025

Uh oh!

parthban-db Dec 23, 2025

Uh oh!

parthban-db Dec 23, 2025

Uh oh!

parthban-db Dec 23, 2025

Uh oh!

parthban-db Dec 23, 2025

Uh oh!

parthban-db Dec 23, 2025

Uh oh!

parthban-db Dec 23, 2025

Uh oh!

parthban-db Dec 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	// Parse comma and/or whitespace separated values from environment variable or config file
	// Parse comma and/or whitespace separated values from environment variable or config file.

		/** Sort scopes in-place for better de-duplication in the refresh token cache. */
		private void sortScopes() {

		// Config File Scope Parsing Tests

		private static Stream<Arguments> provideConfigFileScopesTestCases() {

Support for parsing custom scopes in config file #581

Are you sure you want to change the base?

Support for parsing custom scopes in config file #581

Conversation

Tejas-Kochar commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Uh oh!

github-actions bot commented Dec 22, 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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Tejas-Kochar commented Dec 18, 2025 •

edited

Loading