Skip to content

feat: For client side metrics, record metrics as MUTATE_ROW for single row mutates #1650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Aug 1, 2025
Merged

feat: For client side metrics, record metrics as MUTATE_ROW for single row mutates #1650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a9be9d2
Remove unused import
danieljbruce Jul 28, 2025
8633fc3
Move mutateInternal into an internal method
danieljbruce Jul 28, 2025
b35d42b
Eliminate unused dependencies
danieljbruce Jul 28, 2025
41b9ce6
Adjust mocks so tests pass
danieljbruce Jul 28, 2025
fe4fbe9
Fix mocks to mock out mutate internal
danieljbruce Jul 28, 2025
b7c598c
Add mutateRow test suite 1
danieljbruce Jul 29, 2025
d8a665d
Add handler tests for MutateRow
danieljbruce Jul 29, 2025
e89e98a
Add header
danieljbruce Jul 29, 2025
c524df0
Merge branch 'main' of https://github.com/googleapis/nodejs-bigtable …
danieljbruce Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion src/row.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ import {
MethodName,
StreamingState,
} from './client-side-metrics/client-side-metrics-attributes';
import {mutateInternal} from './utils/mutateInternal';

export interface Rule {
column: string;
Expand Down Expand Up @@ -830,7 +831,19 @@ export class Row {
method: Mutation.methods.INSERT,
} as {} as Entry;
this.data = {};
this.table.mutate(mutation, gaxOptions as {} as MutateOptions, callback);
const metricsCollector =
this.bigtable._metricsConfigManager.createOperation(
MethodName.MUTATE_ROW,
StreamingState.UNARY,
this.table,
);
mutateInternal(
this.table,
metricsCollector,
mutation,
gaxOptions as {} as MutateOptions,
callback,
);
}
}

Expand Down
207 changes: 2 additions & 205 deletions src/tabular-api-surface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ import {BackoffSettings} from 'google-gax/build/src/gax';
import {google} from '../protos/protos';
import {CallOptions, grpc, ServiceError} from 'google-gax';
import {Transform} from 'stream';
import * as is from 'is';
import {GoogleInnerError} from './table';
import {createReadStreamInternal} from './utils/createReadStreamInternal';
import {getRowsInternal} from './utils/getRowsInternal';
import {
MethodName,
StreamingState,
} from './client-side-metrics/client-side-metrics-attributes';
import {mutateInternal} from './utils/mutateInternal';

// See protos/google/rpc/code.proto
// (4=DEADLINE_EXCEEDED, 8=RESOURCE_EXHAUSTED, 10=ABORTED, 14=UNAVAILABLE)
Expand Down Expand Up @@ -333,216 +333,13 @@ Please use the format 'prezzy' or '${instance.name}/tables/prezzy'.`);
optionsOrCallback?: MutateOptions | MutateCallback,
cb?: MutateCallback,
): void | Promise<MutateResponse> {
const callback =
typeof optionsOrCallback === 'function' ? optionsOrCallback : cb!;
const options =
typeof optionsOrCallback === 'object' ? optionsOrCallback : {};
const entries: Entry[] = (arrify(entriesRaw) as Entry[]).reduce(
(a, b) => a.concat(b),
[],
);
const collectMetricsCallback = (
originalError: ServiceError | null,
err: ServiceError | PartialFailureError | null,
apiResponse?: google.protobuf.Empty,
) => {
// originalError is the error that was sent from the gapic layer. The
// compiler guarantees that it contains a code which needs to be
// provided when an operation is marked complete.
//
// err is the error we intend to send back to the user. Often it is the
// same as originalError, but in one case we construct a
// PartialFailureError and send that back to the user instead. In this
// case, we still need to pass the originalError into the method
// because the PartialFailureError doesn't have a code, but we need to
// communicate a code to the metrics collector.
//
const code = originalError ? originalError.code : 0;
metricsCollector.onOperationComplete(code);
callback(err, apiResponse);
};

const metricsCollector =
this.bigtable._metricsConfigManager.createOperation(
MethodName.MUTATE_ROWS,
StreamingState.STREAMING,
this,
);
/*
The following line of code sets the timeout if it was provided while
creating the client. This will be used to determine if the client should
retry on errors. Eventually, this will be handled downstream in google-gax.
*/
const timeout =
options?.gaxOptions?.timeout ||
(this?.bigtable?.options?.BigtableClient?.clientConfig?.interfaces &&
this?.bigtable?.options?.BigtableClient?.clientConfig?.interfaces[
'google.bigtable.v2.Bigtable'
]?.methods['MutateRows']?.timeout_millis);
const callTimeMillis = new Date().getTime();

let numRequestsMade = 0;

const maxRetries = is.number(this.maxRetries) ? this.maxRetries! : 3;
const pendingEntryIndices = new Set(
entries.map((entry: Entry, index: number) => index),
);
const entryToIndex = new Map(
entries.map((entry: Entry, index: number) => [entry, index]),
);
const mutationErrorsByEntryIndex = new Map();

const isRetryable = (
err: ServiceError | null,
timeoutExceeded: boolean,
) => {
if (timeoutExceeded) {
// If the timeout has been exceeded then do not retry.
return false;
}
// Don't retry if there are no more entries or retry attempts
if (pendingEntryIndices.size === 0 || numRequestsMade >= maxRetries + 1) {
return false;
}
// If the error is empty but there are still outstanding mutations,
// it means that there are retryable errors in the mutate response
// even when the RPC succeeded
return !err || RETRYABLE_STATUS_CODES.has(err.code);
};

const onBatchResponse = (err: ServiceError | null) => {
// Return if the error happened before a request was made
if (numRequestsMade === 0) {
collectMetricsCallback(err, err);
return;
}

const timeoutExceeded = !!(
timeout && timeout < new Date().getTime() - callTimeMillis
);
if (isRetryable(err, timeoutExceeded)) {
// If the timeout or max retries is exceeded or if there are no
// pending indices left then the client doesn't retry.
// Otherwise, the client will retry if there is no error or if the
// error has a retryable status code.
const backOffSettings =
options.gaxOptions?.retry?.backoffSettings ||
DEFAULT_BACKOFF_SETTINGS;
const nextDelay = getNextDelay(numRequestsMade, backOffSettings);
metricsCollector.onAttemptComplete(err ? err.code : 0);
setTimeout(makeNextBatchRequest, nextDelay);
return;
}

// If there's no more pending mutations, set the error
// to null
if (pendingEntryIndices.size === 0) {
err = null;
}

const mutationErrors = Array.from(mutationErrorsByEntryIndex.values());
if (mutationErrorsByEntryIndex.size !== 0) {
collectMetricsCallback(
err,
new PartialFailureError(mutationErrors, err),
);
return;
}
if (err) {
/* If there's an RPC level failure and the mutation entries don't have
a status code, the RPC level failure error code will be used as the
entry failure code.
*/
(err as ServiceError & {errors?: ServiceError[]}).errors =
mutationErrors.concat(
[...pendingEntryIndices]
.filter(index => !mutationErrorsByEntryIndex.has(index))
.map(() => err),
);
collectMetricsCallback(err, err);
return;
}
collectMetricsCallback(null, null);
};

metricsCollector.onOperationStart();
const makeNextBatchRequest = () => {
metricsCollector.onAttemptStart();
const entryBatch = entries.filter((entry: Entry, index: number) => {
return pendingEntryIndices.has(index);
});

// If the viewName is provided then request will be made for an
// authorized view. Otherwise, the request is made for a table.
const baseReqOpts = (
this.viewName
? {
authorizedViewName: `${this.name}/authorizedViews/${this.viewName}`,
}
: {
tableName: this.name,
}
) as google.bigtable.v2.IReadRowsRequest;
const reqOpts = Object.assign(baseReqOpts, {
appProfileId: this.bigtable.appProfileId,
entries: options.rawMutation
? entryBatch
: entryBatch.map(Mutation.parse),
});

const retryOpts = {
currentRetryAttempt: numRequestsMade,
// Handling retries in this client. Specify the retry options to
// make sure nothing is retried in retry-request.
noResponseRetries: 0,
shouldRetryFn: (_: any) => {
return false;
},
};

options.gaxOptions = populateAttemptHeader(
numRequestsMade,
options.gaxOptions,
);

const requestStream =
this.bigtable.request<google.bigtable.v2.MutateRowsResponse>({
client: 'BigtableClient',
method: 'mutateRows',
reqOpts,
gaxOpts: options.gaxOptions,
retryOpts,
});
metricsCollector.wrapRequest(requestStream);
requestStream
.on('error', (err: ServiceError) => {
onBatchResponse(err);
})
.on('data', (obj: google.bigtable.v2.IMutateRowsResponse) => {
obj.entries!.forEach(entry => {
const originalEntry = entryBatch[entry.index as number];
const originalEntriesIndex = entryToIndex.get(originalEntry)!;

// Mutation was successful.
if (entry.status!.code === 0) {
pendingEntryIndices.delete(originalEntriesIndex);
mutationErrorsByEntryIndex.delete(originalEntriesIndex);
return;
}
if (!RETRYABLE_STATUS_CODES.has(entry.status!.code!)) {
pendingEntryIndices.delete(originalEntriesIndex);
}
const errorDetails = entry.status;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(errorDetails as any).entry = originalEntry;
mutationErrorsByEntryIndex.set(originalEntriesIndex, errorDetails);
});
})
.on('end', onBatchResponse);
numRequestsMade++;
};

makeNextBatchRequest();
mutateInternal(this, metricsCollector, entriesRaw, optionsOrCallback, cb);
}

/**
Expand Down
4 changes: 0 additions & 4 deletions src/utils/createReadStreamInternal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ import {
} from '../chunktransformer';
import {TableUtils} from './table';
import {Duplex, PassThrough, Transform} from 'stream';
import {
MethodName,
StreamingState,
} from '../client-side-metrics/client-side-metrics-attributes';
import {google} from '../../protos/protos';
const pumpify = require('pumpify');
import {grpc, ServiceError} from 'google-gax';
Expand Down
Loading
Loading