feat: modernization part 2 #1748

feywind · 2025-12-11T21:57:54Z

This is a follow-up for these two PRs:

This takes care of some missing pieces that were discovered by further discussion:

GcRuleBuilder is a more TypeScript-heavy way to validate ModifyColumnFamilies garbage collection rules, with type checking taking care of a lot of the constraints, and some minimal runtime checking for JavaScript users.
Rather than raw GAPIC, the focus has shifted to selective GAPIC subclasses that can augment them. This is specifically done to assist with RestoreTable and waiting for table consistency.
Data plane samples have been removed, as we don't want to encourage users to use them.
Generated samples and tests have been auto-edited to use the selective GAPIC classes.
Manual sample snippets have been updated to reflect the expected admin access and GcRuleBuilder usage.

There is still a CI issue that will need to be corrected before this can be merged. I don't think it's the result of this change, but I also don't want to chance it.

…ization-2

snippet-bot · 2025-12-11T21:58:00Z

Here is the summary of changes.

You are about to add 3 region tags.

samples/api-reference-doc-snippets/backups.restore.js:23, tag bigtableadmin_v2_generated_BigtableTableAdmin_RestoreTable_async
samples/api-reference-doc-snippets/table.waitconsistency.js:19, tag bigtable_api_consistency
samples/generated/admin/v2/bigtable_table_admin.restore_table.js:24, tag bigtableadmin_v2_generated_BigtableTableAdmin_RestoreTable_async_internal

You are about to delete 13 region tags.

samples/api-reference-doc-snippets/table.js:456, tag bigtable_api_consistency
samples/generated/admin/v2/bigtable_table_admin.restore_table.js:24, tag bigtableadmin_v2_generated_BigtableTableAdmin_RestoreTable_async
samples/generated/v2/bigtable.check_and_mutate_row.js:28, tag bigtable_v2_generated_Bigtable_CheckAndMutateRow_async
samples/generated/v2/bigtable.execute_query.js:28, tag bigtable_v2_generated_Bigtable_ExecuteQuery_async
samples/generated/v2/bigtable.generate_initial_change_stream_partitions.js:28, tag bigtable_v2_generated_Bigtable_GenerateInitialChangeStreamPartitions_async
samples/generated/v2/bigtable.mutate_row.js:28, tag bigtable_v2_generated_Bigtable_MutateRow_async
samples/generated/v2/bigtable.mutate_rows.js:28, tag bigtable_v2_generated_Bigtable_MutateRows_async
samples/generated/v2/bigtable.ping_and_warm.js:28, tag bigtable_v2_generated_Bigtable_PingAndWarm_async
samples/generated/v2/bigtable.prepare_query.js:28, tag bigtable_v2_generated_Bigtable_PrepareQuery_async
samples/generated/v2/bigtable.read_change_stream.js:28, tag bigtable_v2_generated_Bigtable_ReadChangeStream_async
samples/generated/v2/bigtable.read_modify_write_row.js:28, tag bigtable_v2_generated_Bigtable_ReadModifyWriteRow_async
samples/generated/v2/bigtable.read_rows.js:28, tag bigtable_v2_generated_Bigtable_ReadRows_async
samples/generated/v2/bigtable.sample_row_keys.js:28, tag bigtable_v2_generated_Bigtable_SampleRowKeys_async

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

generated-files-bot · 2025-12-11T21:58:02Z

Warning: This pull request is touching the following templated files:

README.md - README.md is managed by synthtool. However, a partials file can be used to update the README, e.g.: https://github.com/googleapis/nodejs-storage/blob/main/.readme-partials.yaml

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

…s-bigtable into modernization-2

feywind · 2025-12-17T19:27:23Z

The CI is really not cooperating here (timeouts, quota errors, etc) but the code itself should be okay to review.

mutianf

Where did all the data API examples go?

mutianf · 2026-01-05T18:26:01Z

samples/generated/admin/v2/bigtable_table_admin.check_consistency.js


  // Imports the Admin library
-  const {BigtableTableAdminClient} = require('@google-cloud/bigtable').admin.v2;
+  const {TableAdminClient} = require('@google-cloud/bigtable').admin;


should this sample reflect the new CUJ?

await tableAdmin.waitForConsistency('tablename');

or

const [token] = await tableAdmin.generateConsistencyToken({ name: 'tablename', }); // overload/etc, may be a separate method await tableAdmin.waitForConsistency(token);

There's now a separate sample for waitForConsistency:

https://github.com/googleapis/nodejs-bigtable/blob/modernization-2/samples/api-reference-doc-snippets/table.waitconsistency.js

I don't want to remove the existing one just because those methods are still valid and work.

Same comment re: https://github.com/googleapis/nodejs-bigtable/pull/1748/files/95e039f8357066000eff23da6209444a5f12a41a#diff-62c218b67c00831efea64940e11a8199680f7dc96b31440302f8a7ca779d14f0

I figure as long as we want this sample to show up for the bigtableadmin_v2_generated_BigtableTableAdmin_CheckConsistency_async region tags then this should be fine, but I'm not sure what the requirements are here.

We talked about this a bit in the last meeting, but since there's another tomorrow, let's just ask again.

samples/generated/admin/v2/bigtable_table_admin.generate_consistency_token.js

samples/generated/admin/v2/bigtable_table_admin.restore_table.js

mutianf · 2026-01-05T19:06:58Z

samples/tableadmin.js

-      versions: 1,
-    },
-  };
+  const updatedMetadata = GcRuleBuilder.rule({


I wonder if this example can be added to the modifyColumnFamilies example as well?

I might've missed one, but I agree.

Actually I'm not sure I see where it's missing - can you paste a link?

@mutianf Were you talking about https://github.com/googleapis/nodejs-bigtable/pull/1748/changes/BASE..95e039f8357066000eff23da6209444a5f12a41a#diff-7d7f18b5a162a0662ec29b46106e166c5d47c01dea9b048ce05f32c39a79840fR155? It looks like it builds the rule using union, but was there another that uses the rule method?

src/admin/gc-rule-builder.ts

src/admin/table.ts

…ization-2

…and restore optimization

danieljbruce · 2026-01-27T19:06:38Z

samples/api-reference-doc-snippets/backups.restore.js

+        await adminClient.checkOptimizeRestoredTableProgress(
+          optimizeTableOperationName,
+        );
+      const [table] = await optimizeLRO.promise();


I think I remember modelling my code after the Python code which performs two operations shown by each of the await calls deleted above. Does the checkOptimizeRestoredTableProgress call basically return the same LRO as the gax.operation( call in the deleted snippet?

Yeah, it's basically a copy of gapic's checkRestoreTableProgress, but modified to work with the optimize operation:

nodejs-bigtable/src/admin/table.ts

Line 89 in 9732446

async checkOptimizeRestoredTableProgress(

I don't have the original handy, but IIRC it had similarities.

src/admin/clients.ts

danieljbruce · 2026-01-27T20:07:25Z

test/admin/gc-rule-builder.ts

+import {describe, it} from 'mocha';
+
+describe('GcRuleBuilder', () => {
+  it('has working TypeScript types', () => {


With the new changes, are there tests anywhere that ensure the full sample from the doc https://docs.google.com/document/d/14aOXOpEbwpYJe7-p6E-PUgoy0vn4AKI7zP0Man0prLo/edit?tab=t.0#heading=h.d7jxtor70ekh runs without errors?

I'm pretty sure there's a very similar one in the table admin tests, but maybe we could update that one to do what's in the doc, since it's more comprehensive?

danieljbruce

LGTM with a few nits and checks.

danieljbruce

Left a few more responses.

danieljbruce · 2026-01-27T20:21:37Z

samples/generated/admin/v2/bigtable_table_admin.check_consistency.js


  // Imports the Admin library
-  const {BigtableTableAdminClient} = require('@google-cloud/bigtable').admin.v2;
+  const {TableAdminClient} = require('@google-cloud/bigtable').admin;


I figure as long as we want this sample to show up for the bigtableadmin_v2_generated_BigtableTableAdmin_CheckConsistency_async region tags then this should be fine, but I'm not sure what the requirements are here.

samples/generated/admin/v2/bigtable_table_admin.restore_table.js

danieljbruce · 2026-01-27T20:29:50Z

samples/tableadmin.js

-      versions: 1,
-    },
-  };
+  const updatedMetadata = GcRuleBuilder.rule({


@mutianf Were you talking about https://github.com/googleapis/nodejs-bigtable/pull/1748/changes/BASE..95e039f8357066000eff23da6209444a5f12a41a#diff-7d7f18b5a162a0662ec29b46106e166c5d47c01dea9b048ce05f32c39a79840fR155? It looks like it builds the rule using union, but was there another that uses the rule method?

feywind added 15 commits November 12, 2025 21:13

feat: update from selective gapic updates

e315220

feat: work in progress on updated admin tools

af2380d

feat: update proposed gcrule builder

a5af05c

feat: more updates on the CUJs

1386820

feat: updates from comments on new modernization features

de68524

fix: implement the rest of the old GcRule rules

edf5710

fix: clean up waitForConsistency

c85d815

docs: typo

6ab7541

fix: a couple more pieces of backwards compat

a1f40d6

samples: don't publish data plane generated samples

f3338b9

feat: move admin builder methods to be more namespaced

c2064de

fix: updated GcRuleBuilder import

61fecdd

build: transform class names for selective gapic

c828192

feat: adjust BigtableAdmin for recent doc updates

795ac42

chore: merge remote-tracking branch 'remotes/origin/main' into modern…

ee02f5e

…ization-2

feywind self-assigned this Dec 11, 2025

feywind requested review from a team as code owners December 11, 2025 21:57

feywind added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Dec 11, 2025

product-auto-label bot added the size: xl Pull request size is extra large. label Dec 11, 2025

product-auto-label bot added the api: bigtable Issues related to the googleapis/nodejs-bigtable API. label Dec 11, 2025

feywind changed the title ~~Modernization part 2~~ feat: modernization part 2 Dec 11, 2025

feywind added owl-bot-copy owlbot:run Add this label to trigger the Owlbot post processor. labels Dec 11, 2025

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 11, 2025

gcf-owl-bot bot added 3 commits December 11, 2025 22:05

🦉 Updates from OwlBot post-processor

cecdfff

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

🦉 Updates from OwlBot post-processor

f1da03f

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

Merge branch 'modernization-2' of https://github.com/googleapis/nodej…

5e89e77

…s-bigtable into modernization-2

feywind removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Dec 17, 2025

mutianf reviewed Jan 6, 2026

View reviewed changes

feywind added 12 commits January 13, 2026 13:57

Merge branch 'main' into modernization-2

d0ef0de

chore: bump dates in headers for year rollover

e91cb35

chore: merge remote-tracking branch 'remotes/origin/main' into modern…

8edaac3

…ization-2

feat: allow the user to pass in an existing wait token

9dc41aa

docs: exclude implementation comment from jsdocs

b577172

docs: wordsmithing for GcRuleBuilder errors

3652a06

tests: add system tests for consistency tokens via gapic

4da92e3

chore: linter nits

5e95985

tests: finish up system tests for gapic backups

22e0ba0

tests: bug fixes for waitForConsistency system tests

d98c9a7

samples: update existing samples to use selective gapic classes

e101182

samples: update samples for veneer functions for waiting consistency …

476784c

…and restore optimization

product-auto-label bot added size: xl Pull request size is extra large. and removed size: l Pull request size is large. labels Jan 23, 2026

feywind added the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 26, 2026

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 26, 2026

feywind added 2 commits January 26, 2026 15:56

build: tweak sample tag for internal sample

98c4f7f

samples: fix tag munging for restoreTable

ad8d91e

feywind added the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 26, 2026

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 26, 2026

tests: keep random position test more in line with fixed position test

9732446

danieljbruce reviewed Jan 27, 2026

View reviewed changes

src/admin/clients.ts Outdated Show resolved Hide resolved

danieljbruce reviewed Jan 27, 2026

View reviewed changes

fix: just keep one set of client options for the admin wrapper

9f6b62b

feat: modernization part 2 #1748

Are you sure you want to change the base?

feat: modernization part 2 #1748

Uh oh!

Conversation

feywind commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

snippet-bot bot commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

generated-files-bot bot commented Dec 11, 2025

Uh oh!

feywind commented Dec 17, 2025

Uh oh!

mutianf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

danieljbruce left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

danieljbruce left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feywind commented Dec 11, 2025 •

edited

Loading

snippet-bot bot commented Dec 11, 2025 •

edited

Loading

danieljbruce left a comment •

edited

Loading