Skip to content

Handle null PATH environment variable in UserAgent #763

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.

Sign up for GitHub

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

Open
renaudhartert-db wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Handle null PATH environment variable in UserAgent #763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
296862c
Handle null PATH environment variable in UserAgent
renaudhartert-db Apr 16, 2026
2710949
Add changelog entry for null PATH fix
renaudhartert-db Apr 16, 2026
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
1 change: 1 addition & 0 deletions NEXT_CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* Fixed non-JSON error responses (e.g. plain-text "Invalid Token" with HTTP 403) producing `Unknown` instead of the correct typed exception (`PermissionDenied`, `Unauthenticated`, etc.). The error message no longer contains Jackson deserialization internals.
* Added `X-Databricks-Org-Id` header to deprecated workspace SCIM APIs (Groups, ServicePrincipals, Users) for SPOG host compatibility.
* Fixed Databricks CLI authentication to detect when the cached token's scopes don't match the SDK's configured scopes. Previously, a scope mismatch was silently ignored, causing requests to use wrong permissions. The SDK now raises an error with instructions to re-authenticate.
* Fixed `NullPointerException` in `UserAgent.env()` when the `PATH` environment variable is not set ([#550](https://github.com/databricks/databricks-sdk-java/issues/550)).

### Security Vulnerabilities

Expand Down
8 changes: 3 additions & 5 deletions databricks-sdk-java/src/main/java/com/databricks/sdk/core/UserAgent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,11 +299,9 @@ private static String agentProvider() {

private static Environment env() {
if (env == null) {
env =
new Environment(
System.getenv(),
System.getenv("PATH").split(File.pathSeparator),
System.getProperty("os.name"));
String pathEnv = System.getenv("PATH");
String[] pathEntries = pathEnv != null ? pathEnv.split(File.pathSeparator) : new String[0];
env = new Environment(System.getenv(), pathEntries, System.getProperty("os.name"));
}
return env;
}
Expand Down
10 changes: 10 additions & 0 deletions databricks-sdk-java/src/test/java/com/databricks/sdk/core/UserAgentTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,16 @@ public void testAgentProviderEmptyValue() {
Assertions.assertFalse(UserAgent.asString().contains("agent/"));
}

@Test
public void testEnvWithNullPath() {
UserAgent.env =
new Environment(new HashMap<>(), new ArrayList<>(), System.getProperty("os.name"));
UserAgent.cicdProvider = null;
UserAgent.agentProvider = null;
String userAgent = UserAgent.asString();
Assertions.assertTrue(userAgent.contains("databricks-sdk-java/"));
}

@Test
public void testAgentProviderCached() {
// Set up with cursor agent
Expand Down
Loading