feat: add Google Tag Manager environment ID and authorization token config values

[tmchow]

What are the changes introduced in this PR?

Adds Google Tag Manager settings for Environment ID and Authorization Token which is required for GTM to be used with environments.
https://support.google.com/tagmanager/answer/6311518?hl=en

What is the related Linear task?

n/a

Please explain the objectives of your changes below

Without this, GTM cannot be used to it's full extent with environment which limits it's utility in Rudderstack.

Corresponding change to the GTM script is here:
rudderlabs/rudder-sdk-js#2035

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new checks got introduced or modified in test suites. Please explain the changes.

N/A

---

Developer checklist

• My code follows the style guidelines of this project

• No breaking changes are being introduced.

• All related docs linked with the PR?

• All changes manually tested?

• Any documentation changes needed with this change?

• I have executed schemaGenerator tests and updated schema if needed

• Are sensitive fields marked as secret in definition config?

• My test cases and placeholders use only masked/sample values for sensitive fields

• Is the PR limited to 10 file changes & one task?

Reviewer checklist

• Is the type of change in the PR title appropriate as per the changes?

• Verified that there are no credentials or confidential data exposed with the changes.

Summary by CodeRabbit

• New Features
  • Introduced two new configuration fields for the GTM integration settings: one for specifying an environment identifier and one for entering an authorization token.
  • Enhanced input validation and guidance to help ensure accurate configuration and a smoother setup experience.

[contributor-support]

Thank you @tmchow for contributing this PR.
Please sign the Contributor License Agreement (CLA) before merging.

[coderabbitai]

Walkthrough

This pull request adds two new keys, environmentID and authorizationToken, to the Google Tag Manager (GTM) configuration. The changes are reflected across configuration files including the database configuration, JSON schema, and user interface configuration. The updates in the schema enforce string patterns and length constraints while the UI now includes text inputs for these keys with proper validation messages.

Changes

Files	Change Summary
src/configurations/destinations/gtm/db-config.json src/configurations/destinations/gtm/schema.json src/configurations/destinations/gtm/ui-config.json	db-config.json: Added environmentID and authorizationToken to the includeKeys array. schema.json: Introduced new string properties environmentID and authorizationToken with regex patterns and length constraints. ui-config.json: Added new text input fields for "Environment ID" and "Authorization Token" under Connection Settings with regex validations and error messages.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant UI as UI Config Form
    participant VAL as Schema Validator
    participant CFG as GTM Config Processor

    U->>UI: Enter Environment ID & Authorization Token
    UI->>VAL: Validate input using regex patterns
    VAL-->>UI: Return validation results
    UI->>CFG: Send updated configuration
    CFG-->>UI: Confirm configuration update

Loading

Possibly related PRs

• feat: onboard linkedin audience destination #1758: Introduces similar configuration key enhancements for a LinkedIn Audience destination.
• chore: add custom domain url labels for gtm and ga4 #1867: Modifies the ui-config.json for GTM by renaming an existing field, closely relating to the file changes in this PR.

Suggested reviewers

• lvrach
• am6010
• krishna2020
• debanjan97
• cisse21
• ruchiramoitra
• 1abhishekpandey
• sandeepdsvs
• ItsSudip
• yashasvibajpai
• shrouti1507

Poem

I'm a little rabbit with hops so light,
New keys in the code make everything bright.
"EnvironmentID" and "Auth Token" now play a part,
In GTM's design, they add a fresh start.
Dance and twirl in the configuration delight!
🐰💻 Hop along and celebrate our upgrade flight!

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd6bb8b and 776cee0.

📒 Files selected for processing (3)

• src/configurations/destinations/gtm/db-config.json (1 hunks)
• src/configurations/destinations/gtm/schema.json (1 hunks)
• src/configurations/destinations/gtm/ui-config.json (1 hunks)

🔇 Additional comments (4)

src/configurations/destinations/gtm/db-config.json (1)

9-10: Integrating New GTM Configuration Keys.
The new keys "environmentID" and "authorizationToken" have been added into the includeKeys array as expected. They follow the established naming and ordering conventions. Ensure that downstream consumers of db-config.json also update their processing to account for these new keys.

src/configurations/destinations/gtm/schema.json (1)

11-18: Schema Validation for New Environment Configuration.
The schema properly introduces "environmentID" and "authorizationToken" with string types and consistent regex patterns matching the existing validation for "containerID". This consistency helps maintain uniform configuration validation across GTM integration.

src/configurations/destinations/gtm/ui-config.json (2)

15-23: UI Field Addition for Environment ID.
The new text input field for "Environment ID" is configured correctly with a clear label, validation regex, error message, and a helpful placeholder. This addition aligns well with the updated config keys and enhances user clarity.

---

24-32: UI Field Addition for Authorization Token.
The "Authorization Token" field has been added with proper UI configuration including the regex validation, error messaging, and placeholder, ensuring consistency with the "Environment ID" field. This will allow users to input the authorization token correctly.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.