-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat(bigquery-jdbc): implement driver environment builder #13723
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.
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
Neenu1995
wants to merge
3
commits into
jdbc-telemetry-feature
Choose a base branch
from
jdbc-telemetry-pr4
base: jdbc-telemetry-feature
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+330
−0
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
190 changes: 190 additions & 0 deletions
190
...c/src/main/java/com/google/cloud/bigquery/jdbc/telemetry/v1/DriverEnvironmentBuilder.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| /* | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://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 com.google.cloud.bigquery.jdbc.telemetry.v1; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
| import java.util.UUID; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| /** Utility builder for constructing {@link DriverEnvironment} telemetry protos. */ | ||
| final class DriverEnvironmentBuilder { | ||
| private static final Logger logger = Logger.getLogger(DriverEnvironmentBuilder.class.getName()); | ||
|
|
||
| static final String DRIVER_NAME = "google-bigquery-jdbc"; | ||
| static final String CLIENT_LANGUAGE = "java"; | ||
| static final String DEFAULT_TELEMETRY_TAG_DIR = ".bigquery-jdbc"; | ||
| static final String DEFAULT_TELEMETRY_TAG_FILE = "telemetry-tag"; | ||
| static final String UNKNOWN = "unknown"; | ||
| static final String RESTRICTED = "restricted"; | ||
| static final String DEFAULT_VERSION = "0.0"; | ||
|
|
||
| private DriverEnvironmentBuilder() {} | ||
|
|
||
| static DriverEnvironment build(String driverVersion) { | ||
| return build(driverVersion, null); | ||
| } | ||
|
|
||
| static DriverEnvironment build(String driverVersion, Path customTelemetryTagPath) { | ||
| return DriverEnvironment.newBuilder() | ||
| .setDriverName(DRIVER_NAME) | ||
| .setDriverVersion(sanitizeVersion(driverVersion)) | ||
| .setClientLanguage(CLIENT_LANGUAGE) | ||
| .setClientLanguageVersion(getMajorJavaVersion()) | ||
| .setOsType(detectOsType()) | ||
| .setOsVersion(getMajorOsVersion()) | ||
| .setTelemetryTag(getOrCreateTelemetryTag(customTelemetryTagPath)) | ||
| .build(); | ||
| } | ||
|
|
||
| static String sanitizeVersion(String version) { | ||
| if (version == null || version.trim().isEmpty()) { | ||
| return DEFAULT_VERSION; | ||
| } | ||
| String trimmed = version.trim(); | ||
| String[] parts = trimmed.split("\\."); | ||
| if (parts.length >= 2) { | ||
| return parts[0] + "." + parts[1]; | ||
| } | ||
| return trimmed; | ||
| } | ||
|
|
||
| static String getMajorJavaVersion() { | ||
| try { | ||
| return getMajorJavaVersion(System.getProperty("java.version")); | ||
| } catch (SecurityException e) { | ||
| return RESTRICTED; | ||
| } | ||
| } | ||
|
|
||
| static String getMajorJavaVersion(String versionProperty) { | ||
| if (versionProperty == null || versionProperty.trim().isEmpty()) { | ||
| return UNKNOWN; | ||
| } | ||
| String version = versionProperty.trim(); | ||
| if (version.startsWith("1.")) { | ||
| // Legacy Java version format (e.g. 1.8.0_292 -> 8) | ||
| String[] parts = version.split("\\."); | ||
| if (parts.length >= 2) { | ||
| return parts[1]; | ||
| } | ||
| } else { | ||
| // Modern Java version format (e.g. 11.0.12 -> 11 or 17.0.1 -> 17) | ||
| int firstDot = version.indexOf('.'); | ||
| if (firstDot > 0) { | ||
| return version.substring(0, firstDot); | ||
| } | ||
| } | ||
| return version; | ||
| } | ||
|
|
||
| static DriverEnvironment.OsType detectOsType() { | ||
| try { | ||
| return detectOsType(System.getProperty("os.name")); | ||
| } catch (SecurityException e) { | ||
| return DriverEnvironment.OsType.OS_TYPE_UNSPECIFIED; | ||
| } | ||
| } | ||
|
|
||
| static DriverEnvironment.OsType detectOsType(String osNameProperty) { | ||
| if (osNameProperty == null || osNameProperty.trim().isEmpty()) { | ||
| return DriverEnvironment.OsType.OS_TYPE_UNKNOWN; | ||
| } | ||
| String osName = osNameProperty.toLowerCase(); | ||
| if (osName.contains("win")) { | ||
| return DriverEnvironment.OsType.OS_TYPE_WINDOWS; | ||
| } else if (osName.contains("mac") || osName.contains("darwin")) { | ||
| return DriverEnvironment.OsType.OS_TYPE_MACOS; | ||
| } else if (osName.contains("nux") || osName.contains("nix")) { | ||
| return DriverEnvironment.OsType.OS_TYPE_LINUX; | ||
| } else if (osName.contains("solaris") || osName.contains("sunos")) { | ||
| return DriverEnvironment.OsType.OS_TYPE_SOLARIS; | ||
| } else if (osName.contains("freebsd")) { | ||
| return DriverEnvironment.OsType.OS_TYPE_FREEBSD; | ||
| } else if (osName.contains("openbsd")) { | ||
| return DriverEnvironment.OsType.OS_TYPE_OPENBSD; | ||
| } else if (osName.contains("netbsd")) { | ||
| return DriverEnvironment.OsType.OS_TYPE_NETBSD; | ||
| } else if (osName.contains("aix")) { | ||
| return DriverEnvironment.OsType.OS_TYPE_AIX; | ||
| } | ||
| return DriverEnvironment.OsType.OS_TYPE_UNKNOWN; | ||
| } | ||
|
|
||
| static String getMajorOsVersion() { | ||
| try { | ||
| return getMajorOsVersion(System.getProperty("os.version")); | ||
| } catch (SecurityException e) { | ||
| return RESTRICTED; | ||
| } | ||
| } | ||
|
|
||
| static String getMajorOsVersion(String osVersionProperty) { | ||
| if (osVersionProperty == null || osVersionProperty.trim().isEmpty()) { | ||
| return UNKNOWN; | ||
| } | ||
| String version = osVersionProperty.trim(); | ||
| int firstDot = version.indexOf('.'); | ||
| if (firstDot > 0) { | ||
| return version.substring(0, firstDot); | ||
| } | ||
| return version; | ||
| } | ||
|
|
||
| static String getOrCreateTelemetryTag(Path customFilePath) { | ||
| try { | ||
| Path idFilePath = customFilePath; | ||
| if (idFilePath == null) { | ||
| String userHome = System.getProperty("user.home"); | ||
| if (userHome == null || userHome.trim().isEmpty()) { | ||
| return UUID.randomUUID().toString(); | ||
| } | ||
| idFilePath = Paths.get(userHome, DEFAULT_TELEMETRY_TAG_DIR, DEFAULT_TELEMETRY_TAG_FILE); | ||
| } | ||
|
|
||
| if (Files.exists(idFilePath)) { | ||
| try { | ||
| String content = | ||
| new String(Files.readAllBytes(idFilePath), StandardCharsets.UTF_8).trim(); | ||
| // Validate existing content is a valid UUID | ||
| UUID.fromString(content); | ||
| return content; | ||
| } catch (Exception e) { | ||
| logger.log( | ||
| Level.WARNING, "Failed to read or parse telemetry tag from file, regenerating", e); | ||
| } | ||
| } | ||
|
Neenu1995 marked this conversation as resolved.
|
||
|
|
||
| String newId = UUID.randomUUID().toString(); | ||
| try { | ||
| if (idFilePath.getParent() != null) { | ||
| Files.createDirectories(idFilePath.getParent()); | ||
| } | ||
| Files.write(idFilePath, newId.getBytes(StandardCharsets.UTF_8)); | ||
| } catch (IOException e) { | ||
| logger.log(Level.WARNING, "Failed to persist telemetry tag to file", e); | ||
| } | ||
| return newId; | ||
| } catch (SecurityException e) { | ||
| return UUID.randomUUID().toString(); | ||
| } | ||
| } | ||
| } | ||
140 changes: 140 additions & 0 deletions
140
...c/test/java/com/google/cloud/bigquery/jdbc/telemetry/v1/DriverEnvironmentBuilderTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /* | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://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 com.google.cloud.bigquery.jdbc.telemetry.v1; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNotEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNotNull; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.util.UUID; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.io.TempDir; | ||
|
|
||
| public class DriverEnvironmentBuilderTest { | ||
|
|
||
| @Test | ||
| public void testBuildDriverEnvironment() { | ||
| DriverEnvironment env = DriverEnvironmentBuilder.build("1.2.0-SNAPSHOT"); | ||
| assertNotNull(env); | ||
| assertEquals("google-bigquery-jdbc", env.getDriverName()); | ||
| assertEquals("1.2", env.getDriverVersion()); | ||
| assertEquals("java", env.getClientLanguage()); | ||
| assertNotNull(env.getClientLanguageVersion()); | ||
| assertNotNull(env.getOsType()); | ||
| assertNotNull(env.getOsVersion()); | ||
| assertNotNull(env.getTelemetryTag()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testSanitizeVersion() { | ||
| assertEquals("1.2", DriverEnvironmentBuilder.sanitizeVersion("1.2.0-SNAPSHOT")); | ||
| assertEquals("2.5", DriverEnvironmentBuilder.sanitizeVersion("2.5")); | ||
| assertEquals("0.0", DriverEnvironmentBuilder.sanitizeVersion(null)); | ||
| assertEquals("0.0", DriverEnvironmentBuilder.sanitizeVersion(" ")); | ||
| assertEquals("single", DriverEnvironmentBuilder.sanitizeVersion("single")); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetMajorJavaVersion() { | ||
| assertEquals("8", DriverEnvironmentBuilder.getMajorJavaVersion("1.8.0_292")); | ||
| assertEquals("11", DriverEnvironmentBuilder.getMajorJavaVersion("11.0.12")); | ||
| assertEquals("17", DriverEnvironmentBuilder.getMajorJavaVersion("17.0.1")); | ||
| assertEquals("21", DriverEnvironmentBuilder.getMajorJavaVersion("21")); | ||
| assertEquals("unknown", DriverEnvironmentBuilder.getMajorJavaVersion(null)); | ||
| assertEquals("unknown", DriverEnvironmentBuilder.getMajorJavaVersion(" ")); | ||
| } | ||
|
|
||
| @Test | ||
| public void testDetectOsType() { | ||
| assertEquals( | ||
| DriverEnvironment.OsType.OS_TYPE_WINDOWS, | ||
| DriverEnvironmentBuilder.detectOsType("Windows 11")); | ||
| assertEquals( | ||
| DriverEnvironment.OsType.OS_TYPE_MACOS, DriverEnvironmentBuilder.detectOsType("Mac OS X")); | ||
| assertEquals( | ||
| DriverEnvironment.OsType.OS_TYPE_MACOS, DriverEnvironmentBuilder.detectOsType("Darwin")); | ||
| assertEquals( | ||
| DriverEnvironment.OsType.OS_TYPE_LINUX, DriverEnvironmentBuilder.detectOsType("Linux")); | ||
| assertEquals( | ||
| DriverEnvironment.OsType.OS_TYPE_SOLARIS, DriverEnvironmentBuilder.detectOsType("Solaris")); | ||
| assertEquals( | ||
| DriverEnvironment.OsType.OS_TYPE_FREEBSD, DriverEnvironmentBuilder.detectOsType("FreeBSD")); | ||
| assertEquals( | ||
| DriverEnvironment.OsType.OS_TYPE_OPENBSD, DriverEnvironmentBuilder.detectOsType("OpenBSD")); | ||
| assertEquals( | ||
| DriverEnvironment.OsType.OS_TYPE_NETBSD, DriverEnvironmentBuilder.detectOsType("NetBSD")); | ||
| assertEquals( | ||
| DriverEnvironment.OsType.OS_TYPE_AIX, DriverEnvironmentBuilder.detectOsType("AIX")); | ||
| assertEquals( | ||
| DriverEnvironment.OsType.OS_TYPE_UNKNOWN, | ||
| DriverEnvironmentBuilder.detectOsType("UnknownOS")); | ||
| assertEquals( | ||
| DriverEnvironment.OsType.OS_TYPE_UNKNOWN, DriverEnvironmentBuilder.detectOsType(null)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetMajorOsVersion() { | ||
| assertEquals("10", DriverEnvironmentBuilder.getMajorOsVersion("10.0")); | ||
| assertEquals("6", DriverEnvironmentBuilder.getMajorOsVersion("6.1.0")); | ||
| assertEquals("5", DriverEnvironmentBuilder.getMajorOsVersion("5")); | ||
| assertEquals("unknown", DriverEnvironmentBuilder.getMajorOsVersion(null)); | ||
| assertEquals("unknown", DriverEnvironmentBuilder.getMajorOsVersion(" ")); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetOrCreateTelemetryTag_CreateNew(@TempDir Path tempDir) { | ||
| Path tagFile = tempDir.resolve("telemetry-tag"); | ||
| String tag = DriverEnvironmentBuilder.getOrCreateTelemetryTag(tagFile); | ||
|
|
||
| assertNotNull(tag); | ||
| assertTrue(Files.exists(tagFile)); | ||
| // Verify it is a valid UUID | ||
| assertEquals(tag, UUID.fromString(tag).toString()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetOrCreateTelemetryTag_ReadExisting(@TempDir Path tempDir) throws IOException { | ||
| Path tagFile = tempDir.resolve("telemetry-tag"); | ||
| String existingUuid = UUID.randomUUID().toString(); | ||
| Files.write(tagFile, existingUuid.getBytes(StandardCharsets.UTF_8)); | ||
|
|
||
| String tag = DriverEnvironmentBuilder.getOrCreateTelemetryTag(tagFile); | ||
| assertEquals(existingUuid, tag); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetOrCreateTelemetryTag_RegenerateOnCorruptedFile(@TempDir Path tempDir) | ||
| throws IOException { | ||
| Path tagFile = tempDir.resolve("telemetry-tag"); | ||
| String corruptedContent = "not-a-valid-uuid"; | ||
| Files.write(tagFile, corruptedContent.getBytes(StandardCharsets.UTF_8)); | ||
|
|
||
| String newTag = DriverEnvironmentBuilder.getOrCreateTelemetryTag(tagFile); | ||
|
|
||
| assertNotNull(newTag); | ||
| assertNotEquals(corruptedContent, newTag); | ||
| assertEquals(newTag, UUID.fromString(newTag).toString()); | ||
| // Verify file on disk was overwritten with new valid UUID | ||
| String fileOnDisk = new String(Files.readAllBytes(tagFile), StandardCharsets.UTF_8).trim(); | ||
| assertEquals(newTag, fileOnDisk); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.