fix: Change tests to use new filter and use gax warn for warning just once #1185
Conversation
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
In the legacy version of filter we trim the operator. We should do this here too.
Always pass entity filters into the filter function in tests to reflect new behavior.
A string is needed as an input parameter because we might trim it to get an operator.
Revert changes on the .filter method
The new property filter should be used and this should be reflected in the doc comments.
In entity.ts, use the new property filter constructor.
The changes cause compiler errors. Do not trim the operator for now.
Add change to issue warning just once. Use google-gax so that the warning is issued just once.
product-auto-label bot added size: m This reverts commit c290481.
product-auto-label bot added size: s 
kolea2 approved these changes Oct 23, 2023
feywind approved these changes Oct 23, 2023
| }); | ||
| | ||
| describe('filter', () => { | ||
| it('should issue a warning when a Filter instance is not provided', done => { |
There was a problem hiding this comment.
It might be nice to make this validate that the warning only happens once, but since gax probably also tests that, it's probably not a big issue.
danieljbruce added the owlbot:run 
gcf-owl-bot bot removed the owlbot:run A test to make sure the warning is emitted just once might provide proper coverage.
danieljbruce added the owlbot:run gcf-owl-bot bot removed the owlbot:run 
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
Summary:
To partially address #1109 we use a warning function internally that will emit a warning only when the legacy
.filterfunction is used the first time. Right now, a warning is emitted every time the legacy filter function is used.Changes:
In src/query.ts:
Changes are made inside the src/query.ts file to use the function that will limit warnings to 1.
In tests outside of test/query.ts:
.filter is called the new way by providing PropertyFilter and CompositeFilter objects, this ensures that when the test/query.ts file is run, a warning about using .filter the legacy way hasn't been emitted yet
In test/query.ts:
A test is moved up so that it is the first test that uses the legacy filter function. This test expects a warning so this change is necessary to make this test pass.