feat(bigquery): support custom oauth header name

[Genesis929]

Adds support for custom OAuth header and updates documentation.

Description

Should include a concise description of the changes (bug or feature), it's
impact, along with a summary of the solution

PR Checklist

Thank you for opening a Pull Request! Before submitting your PR, there are a
few things you can do to make sure it goes smoothly:

• Make sure you reviewed
  CONTRIBUTING.md
• Make sure to open an issue as a
  bug/issue
  before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
• Ensure the tests and linter pass
• Code coverage does not decrease (if any source code was changed)
• Appropriate docs were updated (if necessary)
• Make sure to add ! if this involve a breaking change

🛠️ Fixes #<issue_number_goes_here>

[gemini-code-assist]

Summary of Changes

Hello @Genesis929, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the BigQuery integration by providing more control over how OAuth access tokens are passed. Previously, tokens were always expected in the 'Authorization' header. With this change, users can now configure a custom header name, which is particularly useful for avoiding conflicts in complex deployment scenarios. The underlying BigQuery source and all dependent tools have been adapted to support this new configuration, ensuring seamless operation with the custom header.

Highlights

• Custom OAuth Header Support: Introduced the ability to specify a custom HTTP header name for passing OAuth access tokens to BigQuery, moving beyond the default 'Authorization' header. This allows for greater flexibility in environments where the standard header might conflict with other services.
• Configuration Update: The useClientOAuth configuration parameter for BigQuery sources has been updated from a boolean to a string. It can now accept 'true', 'false', or a custom header name (e.g., 'X-Looker-Auth').
• Internal Logic Refinement: Modified the internal BigQuery source configuration and initialization logic to correctly parse and utilize the new string-based useClientOAuth parameter and the newly introduced AuthTokenHeaderName field.
• Tool Integration: All BigQuery-related tools (e.g., bigqueryanalyzecontribution, bigqueryconversationalanalytics, bigqueryexecutesql) were updated to dynamically retrieve the OAuth token header name from the BigQuery source configuration, ensuring they respect the custom header setting.
• Documentation Updates: Updated both the BIGQUERY_README.md and bigquery.md documentation files to reflect the new useClientOAuth parameter behavior and provide examples for specifying a custom OAuth header.

Changelog

• docs/BIGQUERY_README.md
  • Updated the BIGQUERY_USE_CLIENT_OAUTH environment variable description to include support for custom header names.
• docs/en/resources/sources/bigquery.md
  • Expanded the explanation for Authentication via User's OAuth Access Token to detail the use of custom header names.
  • Changed the useClientOAuth parameter type from bool to string in the configuration table.
• internal/sources/bigquery/bigquery.go
  • Modified the UseClientOAuth field in the Config struct from bool to string.
  • Added a new AuthTokenHeaderName field to the Config and Source structs.
  • Updated validation logic for WriteModeProtected and ImpersonateServiceAccount to correctly interpret the string value of UseClientOAuth.
  • Adjusted the Initialize method to set the AuthTokenHeaderName based on the useClientOAuth configuration.
  • Introduced a GetAuthTokenHeaderName() method to the Source struct.
  • Refactored the UseClientAuthorization() method to parse the string value of UseClientOAuth.
  • Updated the lazyInitDataplexClient function to use the new UseClientAuthorization() method.
• internal/sources/bigquery/bigquery_test.go
  • Updated existing test cases to reflect the UseClientOAuth field as a string.
  • Added a new test case to verify the parsing of a custom OAuth header name.
• internal/tools/bigquery/bigqueryanalyzecontribution/bigqueryanalyzecontribution.go
  • Added GetAuthTokenHeaderName() to the compatibleSource interface.
  • Implemented GetAuthTokenHeaderName() to retrieve the custom header name from the source.
• internal/tools/bigquery/bigqueryconversationalanalytics/bigqueryconversationalanalytics.go
  • Added GetAuthTokenHeaderName() to the compatibleSource interface.
  • Modified the Invoke method to use the dynamically retrieved AuthTokenHeaderName when constructing HTTP headers.
  • Implemented GetAuthTokenHeaderName() to retrieve the custom header name from the source.
• internal/tools/bigquery/bigqueryexecutesql/bigqueryexecutesql.go
  • Added GetAuthTokenHeaderName() to the compatibleSource interface.
  • Implemented GetAuthTokenHeaderName() to retrieve the custom header name from the source.
• internal/tools/bigquery/bigqueryforecast/bigqueryforecast.go
  • Added GetAuthTokenHeaderName() to the compatibleSource interface.
  • Implemented GetAuthTokenHeaderName() to retrieve the custom header name from the source.
• internal/tools/bigquery/bigquerygetdatasetinfo/bigquerygetdatasetinfo.go
  • Added GetAuthTokenHeaderName() to the compatibleSource interface.
  • Implemented GetAuthTokenHeaderName() to retrieve the custom header name from the source.
• internal/tools/bigquery/bigquerygettableinfo/bigquerygettableinfo.go
  • Added GetAuthTokenHeaderName() to the compatibleSource interface.
  • Implemented GetAuthTokenHeaderName() to retrieve the custom header name from the source.
• internal/tools/bigquery/bigquerylistdatasetids/bigquerylistdatasetids.go
  • Added GetAuthTokenHeaderName() to the compatibleSource interface.
  • Implemented GetAuthTokenHeaderName() to retrieve the custom header name from the source.
• internal/tools/bigquery/bigquerylisttableids/bigquerylisttableids.go
  • Added GetAuthTokenHeaderName() to the compatibleSource interface.
  • Implemented GetAuthTokenHeaderName() to retrieve the custom header name from the source.
• internal/tools/bigquery/bigquerysearchcatalog/bigquerysearchcatalog.go
  • Added GetAuthTokenHeaderName() to the compatibleSource interface.
  • Implemented GetAuthTokenHeaderName() to retrieve the custom header name from the source.
• internal/tools/bigquery/bigquerysql/bigquerysql.go
  • Added GetAuthTokenHeaderName() to the compatibleSource interface.
  • Implemented GetAuthTokenHeaderName() to retrieve the custom header name from the source.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds a useful feature to support custom OAuth header names for BigQuery authentication. The implementation correctly propagates this custom header to the tools that need it.

My main feedback is around the configuration API in internal/sources/bigquery/bigquery.go. The introduction of a new AuthTokenHeaderName field in the Config struct, while also overloading the UseClientOAuth field to hold the header name, creates a confusing and redundant API for users. I've suggested a refactoring to simplify this by using only the UseClientOAuth field for this configuration.

I've also provided a suggestion to clarify the documentation for the useClientOAuth parameter in docs/en/resources/sources/bigquery.md to make it clearer for users how to use this new functionality.

[averikitsch]

/gcbrun

[averikitsch]

/gcbrun

[duwenxin99]

/gcbrun