Add the bundle_uuid helper function for templates
#1947
Conversation
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
shreyas-goenka
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
|
Test Details: go/deco-tests/12109518697 |
| // | ||
| // It's automatically logged in our telemetry logs when `databricks bundle init` | ||
| // is run and can be used to attribute DBU revenue to bundle templates. | ||
| var bundleUuid = uuid.New().String() |
There was a problem hiding this comment.
To confirm, this line will only run once per bundle initialization? Is that when this class is instantiated?
There was a problem hiding this comment.
this line will only run once per bundle initialization?
Yeah. This PR also adds a unit test to confirm this behaviour when materializing the template.
Is that when this class is instantiated?
There's no class associated with this variable. According to the Go specification the global variables are initialized before the main thread of the go program executes. Specifically it's during the package initialization.
There was a problem hiding this comment.
Can you make this not a global? Looks like it can be scoped to loadHelpers.
There was a problem hiding this comment.
Can you make this not a global? Looks like it can be scoped to loadHelpers.
We need it to be accessible outside loadHelpers helpers as well once we populate it in the telemetry payload.
Also, while loadHelpers would work in practice today, if in the future we make multiple loadHelpers function calls to materialize a template we could end up changing the value of the UUID being serialized accidentally
I can switch over to the cachedBundleUuid *string pattern like we do for API calls if that's something you'd prefer.
| // | ||
| // It's automatically logged in our telemetry logs when `databricks bundle init` | ||
| // is run and can be used to attribute DBU revenue to bundle templates. | ||
| var bundleUuid = uuid.New().String() |
There was a problem hiding this comment.
Can you make this not a global? Looks like it can be scoped to loadHelpers.
## Changes Addresses feedback from this thread #1947 (comment)
**New features for Databricks Asset Bundles:** This release adds support for managing Unity Catalog volumes as part of your bundle configuration. Bundles: * Add DABs support for Unity Catalog volumes ([#1762](#1762)). * Support lookup by name of notification destinations ([#1922](#1922)). * Extend "notebook not found" error to warn about missing extension ([#1920](#1920)). * Skip sync warning if no sync paths are defined ([#1926](#1926)). * Add validation for single node clusters ([#1909](#1909)). * Fix segfault in bundle summary command ([#1937](#1937)). * Add the `bundle_uuid` helper function for templates ([#1947](#1947)). * Add default value for `volume_type` for DABs ([#1952](#1952)). * Properly read Git metadata when running inside workspace ([#1945](#1945)). * Upgrade TF provider to 1.59.0 ([#1960](#1960)). Internal: * Breakout variable lookup into separate files and tests ([#1921](#1921)). * Add golangci-lint v1.62.2 ([#1953](#1953)). Dependency updates: * Bump golang.org/x/term from 0.25.0 to 0.26.0 ([#1907](#1907)). * Bump github.com/Masterminds/semver/v3 from 3.3.0 to 3.3.1 ([#1930](#1930)). * Bump github.com/stretchr/testify from 1.9.0 to 1.10.0 ([#1932](#1932)). * Bump github.com/databricks/databricks-sdk-go from 0.51.0 to 0.52.0 ([#1931](#1931)).
**New features for Databricks Asset Bundles:** This release adds support for managing Unity Catalog volumes as part of your bundle configuration. Bundles: * Add DABs support for Unity Catalog volumes ([#1762](#1762)). * Support lookup by name of notification destinations ([#1922](#1922)). * Extend "notebook not found" error to warn about missing extension ([#1920](#1920)). * Skip sync warning if no sync paths are defined ([#1926](#1926)). * Add validation for single node clusters ([#1909](#1909)). * Fix segfault in bundle summary command ([#1937](#1937)). * Add the `bundle_uuid` helper function for templates ([#1947](#1947)). * Add default value for `volume_type` for DABs ([#1952](#1952)). * Properly read Git metadata when running inside workspace ([#1945](#1945)). * Upgrade TF provider to 1.59.0 ([#1960](#1960)). Internal: * Breakout variable lookup into separate files and tests ([#1921](#1921)). * Add golangci-lint v1.62.2 ([#1953](#1953)). Dependency updates: * Bump golang.org/x/term from 0.25.0 to 0.26.0 ([#1907](#1907)). * Bump github.com/Masterminds/semver/v3 from 3.3.0 to 3.3.1 ([#1930](#1930)). * Bump github.com/stretchr/testify from 1.9.0 to 1.10.0 ([#1932](#1932)). * Bump github.com/databricks/databricks-sdk-go from 0.51.0 to 0.52.0 ([#1931](#1931)).
Changes
This PR adds the
bundle_uuidhelper function that'll return a stable identifier for the bundle for the duration of thebundle initcommand.This is also the UUID that'll be set in the telemetry event sent during
databricks bundle initand would be used to correlate revenue from bundle init with resource deployments.Template authors should add the uuid field to their
databricks.ymlfile they generate:Tests
Unit test