Skip to content

Inline logic to set a value in dyn.SetByPath - #1261

Merged
pietern merged 3 commits into
mainfrom
dyn-visit-set-inner-function
Mar 7, 2024
Merged

Inline logic to set a value in dyn.SetByPath#1261
pietern merged 3 commits into
mainfrom
dyn-visit-set-inner-function

Conversation

@pietern

Copy link
Copy Markdown
Contributor

Changes

This removes the need for the allowMissingKeyInMap option to the private visit function and ensures that the body of the visit function doesn't add or remove values of the configuration it traverses.

This in turn prepares for visiting a path pattern that yields more than one callback, which doesn't match well with the now-removed option.

Tests

Unit tests pass and fully cover the inlined code.

This change means the callback supplied to `dyn.Foreach` can introspect the
path of the value it is being called for. It also prepares for allowing
visiting path patterns where the exact path is not known upfront.
This removes the need for the `allowMissingKeyInMap` option to the private
`visit` function and ensures that the body of the visit function doesn't add or
remove values of the configuration it traverses.
This in turn prepares for visiting a path pattern that yields more than one
callback, which doesn't match well with the now removed option.
@codecov-commenter

codecov-commenter commented Mar 7, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 95.45455% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 52.07%. Comparing base (c05c0cd) to head (67e55ac).

FilesPatch %Lines
libs/dyn/visit_set.go95.34%2 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #1261 +/- ##
==========================================
+ Coverage 52.00% 52.07% +0.07% 
==========================================
Files 314 314 Lines 17839 17877 +38 ==========================================
+ Hits 9277 9310 +33 - Misses 7873 7877 +4 - Partials 689 690 +1 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Base automatically changed from dyn-visit-include-path-in-callback to mainMarch 7, 2024 14:04
@pietern
pietern enabled auto-merge March 7, 2024 14:08
Comment threadlibs/dyn/visit_set.go

// Lookup current value in the sequence.
if component.index < 0 || component.index >= len(s) {
return InvalidValue, indexOutOfBoundsError{prefix}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would be the idiomatic way to append to a sequence using dyn?

@pieternpieternMar 7, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For an existing sequence, this would be to call dyn.Map on its path and the modify the sequence yourself.

@pietern
pietern added this pull request to the merge queueMar 7, 2024
Merged via the queue into main with commit 16a4c71Mar 7, 2024
@pietern
pietern deleted the dyn-visit-set-inner-function branch March 7, 2024 14:19
pietern added a commit that referenced this pull request Mar 25, 2024
CLI:
* Propagate correct `User-Agent` for CLI during OAuth flow ([#1264](#1264)).
* Add usage string when command fails with incorrect arguments ([#1276](#1276)).
Bundles:
* Include `dyn.Path` as argument to the visit callback function ([#1260](#1260)).
* Inline logic to set a value in `dyn.SetByPath` ([#1261](#1261)).
* Add assertions for the `dyn.Path` argument to the visit callback ([#1265](#1265)).
* Add `dyn.MapByPattern` to map a function to values with matching paths ([#1266](#1266)).
* Filter current user from resource permissions ([#1262](#1262)).
* Retain location annotation when expanding globs for pipeline libraries ([#1274](#1274)).
* Added deployment state for bundles ([#1267](#1267)).
* Do CheckRunningResource only after terraform.Write ([#1292](#1292)).
* Rewrite relative paths using `dyn.Location` of the underlying value ([#1273](#1273)).
* Push deployment state right after files upload ([#1293](#1293)).
* Make `Append` function to `dyn.Path` return independent slice ([#1295](#1295)).
* Move bundle tests into bundle/tests ([#1299](#1299)).
* Upgrade Terraform provider to 1.38.0 ([#1308](#1308)).
Internal:
* Add integration test for mlops-stacks initialization ([#1155](#1155)).
* Update actions/setup-python to v5 ([#1290](#1290)).
* Update codecov/codecov-action to v4 ([#1291](#1291)).
API Changes:
* Changed `databricks catalogs list` command.
* Changed `databricks online-tables create` command.
* Changed `databricks lakeview publish` command.
* Added `databricks lakeview create` command.
* Added `databricks lakeview get` command.
* Added `databricks lakeview get-published` command.
* Added `databricks lakeview trash` command.
* Added `databricks lakeview update` command.
* Moved settings related commands to `databricks settings` and `databricks account settings`.
OpenAPI commit 93763b0d7ae908520c229c786fff28b8fd623261 (2024-03-20)
Dependency updates:
* Bump golang.org/x/oauth2 from 0.17.0 to 0.18.0 ([#1270](#1270)).
* Bump golang.org/x/mod from 0.15.0 to 0.16.0 ([#1271](#1271)).
* Update Go SDK to v0.35.0 ([#1300](#1300)).
* Update Go SDK to v0.36.0 ([#1304](#1304)).
@pieternpietern mentioned this pull request Mar 25, 2024
github-merge-queueBot pushed a commit that referenced this pull request Mar 25, 2024
CLI:
* Propagate correct `User-Agent` for CLI during OAuth flow
([#1264](#1264)).
* Add usage string when command fails with incorrect arguments
([#1276](#1276)).
Bundles:
* Include `dyn.Path` as argument to the visit callback function
([#1260](#1260)).
* Inline logic to set a value in `dyn.SetByPath`
([#1261](#1261)).
* Add assertions for the `dyn.Path` argument to the visit callback
([#1265](#1265)).
* Add `dyn.MapByPattern` to map a function to values with matching paths
([#1266](#1266)).
* Filter current user from resource permissions
([#1262](#1262)).
* Retain location annotation when expanding globs for pipeline libraries
([#1274](#1274)).
* Added deployment state for bundles
([#1267](#1267)).
* Do CheckRunningResource only after terraform.Write
([#1292](#1292)).
* Rewrite relative paths using `dyn.Location` of the underlying value
([#1273](#1273)).
* Push deployment state right after files upload
([#1293](#1293)).
* Make `Append` function to `dyn.Path` return independent slice
([#1295](#1295)).
* Move bundle tests into bundle/tests
([#1299](#1299)).
* Upgrade Terraform provider to 1.38.0
([#1308](#1308)).
Internal:
* Add integration test for mlops-stacks initialization
([#1155](#1155)).
* Update actions/setup-python to v5
([#1290](#1290)).
* Update codecov/codecov-action to v4
([#1291](#1291)).
API Changes:
* Changed `databricks catalogs list` command.
* Changed `databricks online-tables create` command.
* Changed `databricks lakeview publish` command.
* Added `databricks lakeview create` command.
* Added `databricks lakeview get` command.
* Added `databricks lakeview get-published` command.
* Added `databricks lakeview trash` command.
* Added `databricks lakeview update` command.
* Moved settings related commands to `databricks settings` and
`databricks account settings`.
OpenAPI commit 93763b0d7ae908520c229c786fff28b8fd623261 (2024-03-20)
Dependency updates:
* Bump golang.org/x/oauth2 from 0.17.0 to 0.18.0
([#1270](#1270)).
* Bump golang.org/x/mod from 0.15.0 to 0.16.0
([#1271](#1271)).
* Update Go SDK to v0.35.0
([#1300](#1300)).
* Update Go SDK to v0.36.0
([#1304](#1304)).
denik pushed a commit that referenced this pull request May 20, 2026
## Changes
This removes the need for the `allowMissingKeyInMap` option to the
private `visit` function and ensures that the body of the visit function
doesn't add or remove values of the configuration it traverses.
This in turn prepares for visiting a path pattern that yields more than
one callback, which doesn't match well with the now-removed option.
## Tests
Unit tests pass and fully cover the inlined code.
denik pushed a commit that referenced this pull request May 20, 2026
CLI:
* Propagate correct `User-Agent` for CLI during OAuth flow
([#1264](#1264)).
* Add usage string when command fails with incorrect arguments
([#1276](#1276)).
Bundles:
* Include `dyn.Path` as argument to the visit callback function
([#1260](#1260)).
* Inline logic to set a value in `dyn.SetByPath`
([#1261](#1261)).
* Add assertions for the `dyn.Path` argument to the visit callback
([#1265](#1265)).
* Add `dyn.MapByPattern` to map a function to values with matching paths
([#1266](#1266)).
* Filter current user from resource permissions
([#1262](#1262)).
* Retain location annotation when expanding globs for pipeline libraries
([#1274](#1274)).
* Added deployment state for bundles
([#1267](#1267)).
* Do CheckRunningResource only after terraform.Write
([#1292](#1292)).
* Rewrite relative paths using `dyn.Location` of the underlying value
([#1273](#1273)).
* Push deployment state right after files upload
([#1293](#1293)).
* Make `Append` function to `dyn.Path` return independent slice
([#1295](#1295)).
* Move bundle tests into bundle/tests
([#1299](#1299)).
* Upgrade Terraform provider to 1.38.0
([#1308](#1308)).
Internal:
* Add integration test for mlops-stacks initialization
([#1155](#1155)).
* Update actions/setup-python to v5
([#1290](#1290)).
* Update codecov/codecov-action to v4
([#1291](#1291)).
API Changes:
* Changed `databricks catalogs list` command.
* Changed `databricks online-tables create` command.
* Changed `databricks lakeview publish` command.
* Added `databricks lakeview create` command.
* Added `databricks lakeview get` command.
* Added `databricks lakeview get-published` command.
* Added `databricks lakeview trash` command.
* Added `databricks lakeview update` command.
* Moved settings related commands to `databricks settings` and
`databricks account settings`.
OpenAPI commit 93763b0d7ae908520c229c786fff28b8fd623261 (2024-03-20)
Dependency updates:
* Bump golang.org/x/oauth2 from 0.17.0 to 0.18.0
([#1270](#1270)).
* Bump golang.org/x/mod from 0.15.0 to 0.16.0
([#1271](#1271)).
* Update Go SDK to v0.35.0
([#1300](#1300)).
* Update Go SDK to v0.36.0
([#1304](#1304)).
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@pietern@codecov-commenter@andrewnester@shreyas-goenka