Skip to content

feat(generator): add internalTelemetryInfo configuration to nunjucks templates #9174

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

Draft
shivanee-p wants to merge 1 commit into from
+36 −0
Draft

feat(generator): add internalTelemetryInfo configuration to nunjucks templates #9174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions ...c-generator-typescript/templates/cjs/typescript_gapic/src/$version/$service_client.ts.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,15 @@ export class {{ service.name }}Client {
}
{%- endif %}

{%- if api.enableTelemetryTracing %}
opts.internalTelemetryInfo = {
gcpClientService: '{{ api.loggingName }}',
gcpClientVersion: '{{ api.naming.version }}',
gcpRepo: 'googleapis/google-cloud-node',
gcpArtifact: '{{ api.publishName }}',
}
{%- endif %}
Comment on lines +200 to +207

@gemini-code-assist gemini-code-assist Bot Aug 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Directly mutating the opts object passed to the constructor is unsafe and can lead to unexpected side-effects if the user reuses the options object across multiple clients. Additionally, since opts is optional (opts?: ClientOptions), attempting to set properties on it directly will throw a TypeError at runtime if the client is instantiated without options.

To prevent both issues, create a shallow copy of opts using Object.assign({}, opts) before assigning the telemetry info. This safely handles undefined (resulting in an empty object {}) and protects the user's original configuration from mutation.

    {%- if api.enableTelemetryTracing %}
      opts = Object.assign({}, opts);
      opts.internalTelemetryInfo = {
        gcpClientService: '{{ api.loggingName }}',
        gcpClientVersion: '{{ api.naming.version }}',
        gcpRepo: 'googleapis/google-cloud-node',
        gcpArtifact: '{{ api.publishName }}',
      };
    {%- endif %}


// Choose either gRPC or proto-over-HTTP implementation of google-gax.
this._gaxModule = {% if not api.legacyProtoLoad %}opts.fallback ? gaxInstance.fallback : gaxInstance{% else %}gax{% endif %};

Expand Down Expand Up @@ -398,6 +407,15 @@ export class {{ service.name }}Client {
, 'x-goog-api-version': '{{ service.apiVersion }}'
{%- endif -%}});

{%- if api.enableTelemetryTracing %}
if (opts.enableTelemetryTracing) {
for (const methodName of Object.keys(this._defaults)) {
this._defaults[methodName].enableTelemetryTracing = opts.enableTelemetryTracing;
this._defaults[methodName].internalTelemetryInfo = opts.internalTelemetryInfo;
}
}
{%- endif %}

// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
Expand Down
18 changes: 18 additions & 0 deletions ...nerator-typescript/templates/esm/typescript_gapic/esm/src/$version/$service_client.ts.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,15 @@ export class {{ service.name }}Client {
gaxInstance = gax as typeof gax;
}
{%- endif %}

{%- if api.enableTelemetryTracing %}
opts.internalTelemetryInfo = {
gcpClientService: '{{ api.loggingName }}',
gcpClientVersion: '{{ api.naming.version }}',
gcpRepo: 'googleapis/google-cloud-node',
gcpArtifact: '{{ api.publishName }}',
}
{%- endif %}
Comment on lines +207 to +214

@gemini-code-assist gemini-code-assist Bot Aug 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Directly mutating the opts object passed to the constructor is unsafe and can lead to unexpected side-effects if the user reuses the options object across multiple clients. Additionally, since opts is optional (opts?: ClientOptions), attempting to set properties on it directly will throw a TypeError at runtime if the client is instantiated without options.

To prevent both issues, create a shallow copy of opts using Object.assign({}, opts) before assigning the telemetry info. This safely handles undefined (resulting in an empty object {}) and protects the user's original configuration from mutation.

    {%- if api.enableTelemetryTracing %}
      opts = Object.assign({}, opts);
      opts.internalTelemetryInfo = {
        gcpClientService: '{{ api.loggingName }}',
        gcpClientVersion: '{{ api.naming.version }}',
        gcpRepo: 'googleapis/google-cloud-node',
        gcpArtifact: '{{ api.publishName }}',
      };
    {%- endif %}


// Choose either gRPC or proto-over-HTTP implementation of google-gax.
this._gaxModule = {% if not api.legacyProtoLoad %}opts.fallback ? gaxInstance.fallback : gaxInstance{% else %}gax{% endif %};
Expand Down Expand Up @@ -409,6 +418,15 @@ export class {{ service.name }}Client {
, 'x-goog-api-version': '{{ service.apiVersion }}'
{%- endif %}});

{%- if api.enableTelemetryTracing %}
if (opts.enableTelemetryTracing) {
for (const methodName of Object.keys(this._defaults)) {
this._defaults[methodName].enableTelemetryTracing = opts.enableTelemetryTracing;
this._defaults[methodName].internalTelemetryInfo = opts.internalTelemetryInfo;
}
}
{%- endif %}

// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
Expand Down
Loading