chore: Enhances User-Agent with additional metadata support

[EspenAlbert]

Description

This PR introduces enhanced user agent context propagation and analytics metadata for all resource, data source, and function operations. The changes include:

• Addition of the UserAgentExtra to internal/config/transport.go struct and related helpers to capture operation type, name, and action for every provider call.
• Addition of the WrappedProviderServer in internal/provider/wrapper_provider_server.go. A new file that wraps the provider server to inject detailed operation metadata into the context for every gRPC entrypoint. This wrapper ensures that all resource, data source, and function operations are enriched with type, name, and operation metadata, enabling improved observability, analytics, and debugging. The wrapper works by intercepting each call and using AddUserAgentExtra.
• New UserAgentTransport HTTP middleware that reads the UserAgentExtra and updates the request header.

These changes improve observability, analytics, and debugging capabilities by making operation context available for logging and downstream systems.

Link to any related issue(s): CLOUDP-329015

Sequence diagram

sequenceDiagram
    autonumber
    participant Terraform as Terraform CLI/Cloud
    participant Wrapped as WrappedProviderServer
    participant Old as OldProviderServer
    participant Logic as Resource/Data Logic
    participant HTTP as HTTP RoundTripper/API

    Terraform->>Wrapped: gRPC Request (e.g., ReadResource)
    Wrapped->>Wrapped: AddUserAgentExtra(ctx, type, name, operation)
    Wrapped->>Old: Call OldProviderServer.ReadResource(ctx, req)
    Old->>Logic: Resource/Data Logic (uses ctx)
    Logic->>HTTP: HTTP Request with context    
    HTTP->>HTTP: UserAgentTransport:<br/>Read UserAgentExtra from ctx<br/>Modify User-Agent header
    HTTP->>HTTP: TerraformLoggingTransport:<br/>Log request with final User-Agent
    HTTP->>HTTP: DigestTransport:<br/>Prepare for digest auth
    HTTP->>HTTP: Rest of the chain
    HTTP-->>Logic: API Response
    Logic-->>Old: Resource/Data Response
    Old-->>Wrapped: Response
    Wrapped-->>Terraform: Response

Loading

1. Terraform CLI initiates the grpc call
2. gRPC request is received by the WrappedProviderServer.{FuncName} (internal/provider/wrapper_provider_server.go) which adds AddUserAgentExtra (internal/config/transport.go)
   • The type of operation (Resource, Datasource, Function, Ephemeral)
   • The name of the resource/data/function (from the request)
   • The operation (the gRPC method name, e.g., ReadResource internal/provider/wrapper_provider_server.go)
3. It then calls the OldProviderServer.{FuncName}(updated_ctx, req) (the new context has the extra metadata)
4. Any Resource/Data source is called as before.
   Any logic, logging, or HTTP requests made further down the stack (including SDK calls) can now read this metadata from the context.
5. For any API Call the Transport chain processes the API Calls.
6. UserAgentTransport reads the ctx and updates the user agent
7. Processing as before

Type of change:

• New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
• Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
• Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
• This change requires a documentation update
• Documentation fix/enhancement

Required Checklist:

• I have signed the MongoDB CLA
• I have read the contributing guides
• I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
• I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
• I have added any necessary documentation (if appropriate)
• I have run make fmt and formatted my code
• If changes include deprecations or removals I have added appropriate changelog entries.
• If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

[Copilot]

Pull Request Overview

This PR enhances user agent functionality by adding comprehensive operation metadata support to all provider operations. The changes enable detailed tracking and analytics by propagating operation type, name, and action information through context to HTTP requests.

• Addition of UserAgentExtra struct and related utilities for capturing operation metadata
• Implementation of a WrappedProviderServer that intercepts all gRPC calls to inject operation context
• Integration of UserAgentTransport middleware to modify HTTP headers based on context metadata

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
internal/config/transport.go	Adds UserAgentExtra struct, context utilities, and UserAgentTransport middleware
internal/config/transport_test.go	Comprehensive test coverage for new user agent functionality
internal/provider/wrapper_provider_server.go	New wrapper that intercepts all provider operations to inject metadata
internal/provider/provider.go	Updates provider factory to use the new wrapped server
internal/config/client.go	Integrates UserAgentTransport into the HTTP transport chain

Comments suppressed due to low confidence (1)

internal/config/transport.go:110

• [nitpick] The variable name newVar is unclear and doesn't describe its purpose. Consider renaming to updatedUserAgent or enhancedUserAgent.

		newVar := extra.ToHeaderValue(userAgent)

[marcosuma]

I am guessing we are going to wait for checking for other use cases and ask Hashicorp, yes?

[EspenAlbert]

I am guessing we are going to wait for checking for other use cases and ask Hashicorp, yes?

Yes, putting this back to draft meanwhile

[EspenAlbert]

Done in #3618