Skip to content

feat: Create a view on the instance, not on the table#1476

Merged
danieljbruce merged 5 commits intobigtable-authorized-viewsfrom
bigtable-authorized-views-create-view-change
Sep 30, 2024
Merged

feat: Create a view on the instance, not on the table#1476
danieljbruce merged 5 commits intobigtable-authorized-viewsfrom
bigtable-authorized-views-create-view-change

Conversation

@danieljbruce
Copy link
Contributor

@danieljbruce danieljbruce commented Sep 23, 2024

Summary:

This PR is being added to address a recent minor change suggested in the design document for Bigtable Authorized Views. To support future feature work, the views should be decoupled from tables and therefore created using a Bigtable instance object instead of a table object.

Background:

This PR is part of a series of PRs for introducing the Bigtable Authorized Views feature. So far this PR and this PR have been merged.

Changes

  1. Add the view method to Instance.
  2. Remove the view method from Table.
  3. Modify the authorized view constructor not to require the whole table

Next Steps

(Verbatim from the previous PR)

  1. Write some tests that use the new increment, createRules and filter methods now available on AuthorizedView. Make sure that these methods pass the proper parameters along and that they target an authorized view.
  2. Write a PR for supporting authorized views calls for all methods of the TabularApiSurface class.

@product-auto-label product-auto-label bot added the size: s Pull request size is small. label Sep 23, 2024
@conventional-commit-lint-gcf
Copy link

conventional-commit-lint-gcf bot commented Sep 23, 2024

🤖 I detect that the PR title and the commit message differ and there's only one commit. To use the PR title for the commit history, you can use Github's automerge feature with squashing, or use automerge label. Good luck human!

-- conventional-commit-lint bot
https://conventionalcommits.org/

@product-auto-label product-auto-label bot added the api: bigtable Issues related to the googleapis/nodejs-bigtable API. label Sep 23, 2024
@danieljbruce danieljbruce marked this pull request as ready for review September 23, 2024 21:07
@danieljbruce danieljbruce requested a review from a team as a code owner September 23, 2024 21:07
@danieljbruce danieljbruce requested a review from a team September 23, 2024 21:07
@danieljbruce danieljbruce merged commit d293abd into bigtable-authorized-views Sep 30, 2024
@danieljbruce danieljbruce deleted the bigtable-authorized-views-create-view-change branch September 30, 2024 17:34
danieljbruce added a commit that referenced this pull request Nov 7, 2024
* Create the new tabular api service file

* feat: Bigtable authorized views - move the code over to the TabularApiSurface class (#1463)

* Move the constructor over to TabularApiService

* Move sampleRowKeys over

* Move sampleRowKeys functions over and use promisify

* Adjust the proxyquire to work with TabularAPIserv

* Move all the ReadRows functionality over

* Solve the issue with the is dependency

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Add header for new class

* Only include Table mocks that are necessary

* Remove TODO

* Rename TabularApiService to TabularApiSurface

* Change all imports to tabular-api-surface

* surface. not service

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

* feat: Bigtable Authorized Views - Allow checkAndMutate and ReadModifyWriteRow calls on Authorized Views (#1464)

* Move the constructor over to TabularApiService

* Move sampleRowKeys over

* Move sampleRowKeys functions over and use promisify

* Adjust the proxyquire to work with TabularAPIserv

* Move all the ReadRows functionality over

* Solve the issue with the is dependency

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Add header for new class

* Trying out the FilterInformation class

* Add a DataUtils module for the shared row function

* Outsource functionality of filter to helper

* debugging

* Adjust proxyquire to include mocks for moved fn

* Remove imports

* Outsource code to a createRulesUtil function

* Change proxyquire to include createRulesUtil

* Move increment over to the utils folder

* Move the functions into a static class for mocks

* Remove mockCreateRules and shorten mock

* Stub out FakeRowDataUtil

* Remove unused dependencies

* Add the functions to work with checkAndMutate

and readWriteModifyRow

* Fix regressions from the merge

* Add documentation for the class

* Document the new methods of table

* Change the interface of the rowUtils

* Pull the generateProperties code out avoid duplica

* Move duplicate code out into a getProperties object

* Remove console.log

* Add method for creating views

* Object for making grpc calls for authorized views

* Remove import

* Update the documentation for the Table

* More specific type

* Add documentation for each of the functions

* Remove TODO

* Add headers

* Add documentation for new class

* Remove imports

* Reintroduce before

* Remove unused import

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

* feat: Create a view on the instance, not on the table (#1476)

* Move view creation from the table class to instanc

* feat: Create a view on the instance, not on the table

* Add table name parameter to the documentation

* Remove Table

* feat: Create the unit tests for Authorized Views ensuring that requests are consistent (#1501)

* Create a test for authorized views

* Set the ReadRows options

* Add authorized view test for createreadstream

* Pass authorizedViewName along for createReadStream

* Add the unit test for getRows

* Add the unit test for getRows

* Take out the test mock for the request function

* Mutate rows request - test setup

* Made corrections and src code changes so unit test

passes

* Fix the readrows test to end the stream

Also add a test for insert and make the test easier to debug.

* Finish the sampleRowKeys tests

* Refactor part of the test for getting request opts

* Authorized views for readRows test should be one

assert

* Add the mock function for request

* Make mutate rows use the mockRequest function

* Setup the sampleRowKeys setup fn to use mockReq

* Add comments to the mocking functions

* Fix comments. Move functions to right place

* Setup the readModifyWriteRow tests

* For createRules test use new mockCallbackRequest

You need to call the callback in order to end the operation to createRules.

* Use the new mockCallbackRequest function

* Get rid of the unused mock function

* Create a test file for createRules not got

* increment

* Add the test for increment

* Change the response value for authorized view

* Add the console logs and change return type

* Flesh out response so that view call works

* Exclude appropriate properties using promisify.

* Removed console logs

* Finished the filter test

* Add the view call for filter

* Remove only

* Change to more readable values

* Remove only

* Add header to the test

* For tests, expect view to be excluded from promis

* run linter

* Add a few @params and @returns

* Add a comment about making requests for auth views

* Added more comments - auth views vs table

Also added a comment for calling increment

* feat: Bigtable authorized views integration tests (#1504)

* Create a test for authorized views

* Set the ReadRows options

* Add authorized view test for createreadstream

* Pass authorizedViewName along for createReadStream

* Add the unit test for getRows

* Add the unit test for getRows

* Take out the test mock for the request function

* Mutate rows request - test setup

* Made corrections and src code changes so unit test

passes

* Fix the readrows test to end the stream

Also add a test for insert and make the test easier to debug.

* Finish the sampleRowKeys tests

* Refactor part of the test for getting request opts

* Authorized views for readRows test should be one

assert

* Add the mock function for request

* Make mutate rows use the mockRequest function

* Setup the sampleRowKeys setup fn to use mockReq

* Add comments to the mocking functions

* Fix comments. Move functions to right place

* Setup the readModifyWriteRow tests

* For createRules test use new mockCallbackRequest

You need to call the callback in order to end the operation to createRules.

* Use the new mockCallbackRequest function

* Get rid of the unused mock function

* Create a test file for createRules not got

* increment

* Add the test for increment

* Change the response value for authorized view

* Add the console logs and change return type

* Flesh out response so that view call works

* Exclude appropriate properties using promisify.

* Removed console logs

* Finished the filter test

* Add the view call for filter

* Remove only

* Change to more readable values

* Remove only

* Add header to the test

* For tests, expect view to be excluded from promis

* run linter

* Create the before hook for auth views

* Note to self on auth views - TODO

* Add an insert statement

* Make a test for getRows

* Add the test for the getRows function.

* Finish ‘should fail when writing to a row not in v

* Add another mutate test, preserve table after test

Add after hook to make sure table values stay the same.

Add test for modifying from different column

* Remove TODO

* refactor the error message in the test

* Add mutate, insert and sampleRowKeys tests

* Fix sampleRowKeys test to require a fix upstream

* Create samplerowkeys and createreadstream tests

* Surround all tests in a try block

This allows for better error reporting

* Fixed the column filter so it works

* Reduce verbosity in tests

In many cases, 3 lines can be reduced to one variable. This is crucial for making the integration tests shorter.

* Replace verbose data with data variable

* Add an insert for multiple rows

* Fix the check and mutate test to ignore corrupt d

* Add the readModifyWriteRow tests

* Add awaits

* wrap columnFamily and columnIdInView in brackets

* Eliminate the TODO

* Remove only

* Add key back to filter config option

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Kevin Kim <kevkim@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigtable Issues related to the googleapis/nodejs-bigtable API. size: s Pull request size is small.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants