[Feature] Skip calling Read after Create/Update operations for notebooks #4173
+287
−104
Conversation
This file contains 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
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
mgyucht
reviewed
Oct 30, 2024
alexott
changed the title
get-status for notebooks in Read after Create/Update operations
alexott
changed the title
alexott
force-pushed
the
notebooks-skip-get-status
branch
from
7ecd15c to
2ddb757
Compare
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
changed the title
alexott
added a commit
that referenced
this pull request
Nov 3, 2024
This PR adds the ability for a resource to specify that it may not need to call `Read` after `Create` and `Update` operations so we can avoid performing another API call(s). The resource may implement `CanSkipReadAfterCreateAndUpdate` function that can decide if the `Read` operation should be skipped. I decided to move common part from #4173 to make it easier to review
5 tasks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 4, 2024
## Changes <!-- Summary of your changes that are easy to understand --> This PR adds the ability for a resource to specify that it may not need to call `Read` after `Create` and `Update` operations so we can avoid performing another API call(s). The resource may implement `CanSkipReadAfterCreateAndUpdate` function that can decide if the `Read` operation should be skipped. I decided to move common part from #4173 to make it easier to review ## Tests <!-- How is this tested? Please see the checklist below and also describe any other relevant tests --> - [x] `make test` run locally - [ ] relevant change in `docs/` folder - [ ] covered with integration tests in `internal/acceptance` - [x] relevant acceptance tests are passing - [ ] using Go SDK
It was found that the import API returns `object_id` as a result of its execution, so we don't really need to call get-status to fill all attributes. This should help when we import a large number of notebooks, i.e., when applying exported resources. This also changes `format` and `language` attributes to `optional,computed` to avoid having issues with defaults, and suppress diff.
alexott
force-pushed
the
notebooks-skip-get-status
branch
from
2ddb757 to
e80cda6
Compare
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
changed the title
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
rauchy
approved these changes
Dec 4, 2024
There was a problem hiding this comment.
I think this PR is doing a bit more than what the title suggests, especially now that #4190 lets us skip calling Read, and this PR is using that. I'm missing some specific Notebook context, so it's tough for me to fully judge if the change is correct. My review is mainly focused on the tests and code, and I don't see any issues there. @mgyucht, do you think you should have another look at it as well?
Co-authored-by: Omer Lachish <[email protected]>
alexott
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. |
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
|
Test Details: go/deco-tests/12159341397 |
|
@rauchy I've added more context to the PR description |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
It's based on #4190.
It was found that the
importAPI returnsobject_idas a result of its execution, so we don't really need to call theReadoperation that will callget-statusto fill all attributes (when we create a notebook using theSOURCEformat).The other formats (
DBCandJUPYTER) will still call theReadto fill in the missing parameters, such aslanguage.It also changed the
languagetooptional,computedso we can safely set the value and don't trigger the diff.This should help when we import a large number of notebooks, i.e., when applying exported resources.
Tests
make testrun locallyrelevant change indocs/folderinternal/acceptanceusing Go SDK