Uh oh!
There was an error while loading. Please reload this page.
SK-2963: warn at startup when a beta/dev build targets a Production vault - #406
Open
Devesh-Skyflow wants to merge 2 commits into
Open
SK-2963: warn at startup when a beta/dev build targets a Production vault#406Devesh-Skyflow wants to merge 2 commits into
Devesh-Skyflow wants to merge 2 commits into
Conversation
…ault Adds a WARN-level log, emitted once at Skyflow.builder().build(), when the SDK's own version is non-GA (any -beta.N or -dev.<sha> suffix) and at least one configured vault resolves to Env.PROD. Mirrors the pattern in both the flowvault and skyvault modules. - BaseUtils.isNonGaVersion(): pure regex check, reused by both modules via Utils, so it's testable without touching the real Constants.SDK_VERSION. - SkyflowClientBuilder.anyVaultIsProd(): package-private, same reason. - New WarningLogs.BETA_BUILD_WARNING message. This is the reference implementation for the cross-SDK design in SK-2963; the other 8 SDKs (node, python, go, js, react-js, react-native, android, iOS) follow in separate PRs against their own repos. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
✅ Gitleaks Findings: No secrets detected. Safe to proceed! |
Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging. |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@## main #406 +/- ##
============================================
+ Coverage 91.30% 91.43% +0.13% - Complexity 0 461 +461
============================================
Files 157 157 Lines 6392 6413 +21 Branches 850 858 +8 ============================================
+ Hits 5836 5864 +28 + Misses 364 355 -9 - Partials 192 194 +2
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
build() previously could only be exercised end-to-end against whatever GA Constants.SDK_VERSION this checkout ships, so the actual && wiring between isNonGaVersion and anyVaultIsProd was never driven down its true branch by any test. Extract shouldWarnBetaBuildInProd(version, vaultConfigs) in both flowvault and skyvault so it's directly testable with an injected version string, and add true/false-path tests for it. Also add a test proving the %s1 placeholder in BETA_BUILD_WARNING is fully substituted (not left literal), and a test documenting the current 0.x-is-GA behavior (0.9.0 matches the plain major.minor.patch pattern) so a future change to that is a deliberate decision rather than a silent regression. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
✅ Gitleaks Findings: No secrets detected. Safe to proceed! |
Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging. |
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
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Why
Beta/dev builds of the SDK are meant for acceptance testing only, but nothing today stops a customer from picking one up and pointing it at a Production vault. We want an explicit, unmissable signal the moment that happens so it gets caught early instead of surfacing as a support ticket.
Goal
Skyflow.builder().build(), emit a WARN-level log once when both are true: the SDK's own version is non-GA (has a-beta.Nand/or-dev.<sha>suffix) and at least one configured vault resolves toEnv.PROD.flowvaultandskyvaultmodules, backed by a shared, pureBaseUtils.isNonGaVersion()check incommonso the regex logic is unit-testable without touching the realConstants.SDK_VERSION.Testing
BaseUtilsTestscases coveringisNonGaVersion: plain semver (GA),-beta.Nsuffix,-dev.<sha>suffix, combined-beta.N-dev.<sha>,null, and non-semver strings.anyVaultIsProdunit tests in bothflowvaultandskyvaultSkyflowTests(empty collection, no PROD vaults, one-of-many PROD, all PROD).build()test in both modules asserting a GA build (the currentConstants.SDK_VERSIONin this checkout) never emits the beta warning even when configured against a PROD vault.mvn/javaon PATH) — relying on CI to runmvn testacross modules.🤖 Generated with Claude Code