LoggingServiceV2Client loses automatic WriteLogEntries batching after the logging-api split

Offen
#9,658 2 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
54/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
google-cloud, node.js, typescript
Bereich
api, backend

Rechercherichtung

Start by reading the logging-api onboarding change in PR #8863 and the package split in PR #8929, then inspect the LoggingServiceV2Client generation configuration and historical logging_gapic.yaml linked in the issue. Confirm where bundling defaults and the WriteLogEntries batching descriptor are configured. Done means compatible separate writes are coalesced into one transport request in v12, with a regression test covering that behavior.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Please make sure you have searched for information in the following guides.
Library Name

@google-cloud/logging — comparing 11.2.1 and 12.0.0

A screenshot that you have tested with "Try this API".

Not applicable: this issue concerns client-side request batching in the generated Node.js SDK. API Explorer sends requests directly and cannot exercise the SDK's google-gax batching scheduler.

The linked reproduction uses mocked transport calls and exercises the actual generated client wrappers and google-gax scheduler. It requires no credentials or Google Cloud project and makes no real Google Cloud API calls.

No API Explorer test was performed.

Link to the code that reproduces this issue. A link to a public Github Repository or gist with a minimal reproduction.

https://github.com/jacekerd/google-logging-batching-repro

A step-by-step description of how to reproduce the issue, based on the linked reproduction.

Requirements: Node.js 22 or newer and npm.

  1. Clone the reproduction:

    git clone https://github.com/jacekerd/google-logging-batching-repro.git
    cd google-logging-batching-repro
    
  2. Install the two locked dependency trees:

    npm ci --prefix versions/v11 --ignore-scripts --no-audit --no-fund
    npm ci --prefix versions/v12 --ignore-scripts --no-audit --no-fund
    
  3. Inspect batching metadata and exercise compatible writes:

    npm run check:v11
    npm run check:v12
    npm run behavior
    npm test
    
  4. Run the assertion that v12 should preserve v11 batching behavior:

    npm run test:expect-v11
    

Observed results:

  • v11.2.1 has descriptors.batching.writeLogEntries; two compatible writes produce one mocked transport invocation containing both entries.
  • v12.0.0 has an empty descriptors.batching object; the same writes produce two separate mocked transport invocations.
  • npm test passes five tests documenting these observations.
  • npm run test:expect-v11 intentionally exits 1, with one failed parity assertion.

The reproduction uses real generated wrappers and google-gax scheduling, with the transport stubbed. No credentials or real Cloud API requests are required.

A clear and concise description of what the bug is, and what you expected to happen.

Automatic WriteLogEntries batching differs between @google-cloud/[email protected] and @google-cloud/[email protected].

In 11.2.1, LoggingServiceV2Client initializes descriptors.batching.writeLogEntries and combines compatible calls into one transport request.

In 12.0.0, LoggingServiceV2Client is re-exported from @google-cloud/[email protected]. That generated implementation has an empty batching descriptor object and lacks the corresponding bundling defaults and batching descriptor selection.

Expected: compatible WriteLogEntries calls retain automatic batching.

Actual: two compatible calls produce two transport requests instead of one.

Explicit higher-level log.write([entry1, entry2]) remains supported. The issue concerns automatic coalescing across separate GAPIC calls.

These versions establish the behavioral difference; they do not identify the first affected intermediate release.

A clear and concise description WHY you expect this behavior, i.e., was it a recent change, there is documentation that points to this behavior, etc. **

@google-cloud/[email protected] automatically combines compatible WriteLogEntries calls. I expected this behavior to remain available after upgrading to 12.0.0.

The historical Node.js generation target explicitly supplied google/logging/v2/logging_gapic.yaml, which defines batching for WriteLogEntries. Investigation indicates that the logging-api onboarding omitted nodejs.bundle_config from librarian.yaml, causing the generated client to lose its batching descriptor, bundling defaults, and batching descriptor selection.

The reproduction demonstrates one mocked transport invocation for two compatible writes in v11, versus two invocations in v12. Restoring the missing configuration in memory restores batching with v12's existing google-gax runtime.

Relevant references:

I'd expect the automatic GAPIC batching to be preserved across this migration.

Vorherrschende Sprache
TypeScript
Sterne
3.2k
Forks
732
Ø Merge
2 T. 11 Std.
Gemergte PRs (30 T.)
99

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus googleapis/google-cloud-node

Alle Issues in googleapis/google-cloud-node

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.