feat(wren-ui): add awsSecretKey to sensitive properties for redshift

[fredalai]

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of sensitive information by ensuring that AWS secret keys are properly masked and excluded from general connection info.
  • Updated data source forms to consistently treat AWS secret keys like passwords, masking them and preventing accidental exposure.

[coderabbitai]

Walkthrough

The changes expand the handling of sensitive information for data source connections, specifically by including the awsSecretKey field alongside existing sensitive fields like password. This affects both server-side filtering of connection info and UI-side form data transformations, ensuring consistent masking and omission of sensitive credentials.

Changes

Files	Change Summary
wren-ui/src/apollo/server/services/projectService.ts	Added awsSecretKey to the set of sensitive property names filtered from general connection info.
wren-ui/src/hooks/useSetupConnectionDataSource.tsx	Updated form transformation logic to handle awsSecretKey similarly to password for masking and placeholders.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI (Form)
    participant useSetupConnectionDataSource
    participant Server (projectService)

    User->>UI (Form): Enter data source credentials (password/awsSecretKey)
    UI (Form)->>useSetupConnectionDataSource: Submit form data
    useSetupConnectionDataSource->>useSetupConnectionDataSource: transformFormToProperties (mask sensitive fields)
    useSetupConnectionDataSource->>Server (projectService): Send properties
    Server (projectService)->>Server (projectService): Filter out sensitive fields (password, awsSecretKey)
    Server (projectService)-->>UI (Form): Return general connection info (without sensitive fields)

Loading

Possibly related PRs

• feat(wren-ui): Support Redshift connector #1761: Introduces Redshift support with connection types and authentication methods, closely related as both PRs modify Redshift connection handling and sensitive credential management.

Suggested labels

wren-ui

Suggested reviewers

• onlyjackfrost

Poem

Beneath the fields where secrets sleep,
A rabbit hops with data to keep.
Passwords masked, secrets tucked tight,
Now awsSecretKey stays out of sight.
With careful paws and gentle cheer,
Sensitive info disappears—
Safe and sound, the code is clear! 🐇✨

---

📜 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 e505aaa and 15ecf91.

📒 Files selected for processing (2)

• wren-ui/src/apollo/server/services/projectService.ts (1 hunks)
• wren-ui/src/hooks/useSetupConnectionDataSource.tsx (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Analyze (python)
• GitHub Check: Analyze (actions)
• GitHub Check: Analyze (go)

🔇 Additional comments (3)

wren-ui/src/apollo/server/services/projectService.ts (1)

32-36: LGTM! Security enhancement properly implemented.

The addition of awsSecretKey to the sensitive properties set ensures consistent filtering of AWS credentials alongside existing sensitive fields. This change properly extends the security model to protect AWS secret keys in connection information.

wren-ui/src/hooks/useSetupConnectionDataSource.tsx (2)

84-87: LGTM! Consistent sensitive data handling.

The awsSecretKey handling correctly mirrors the existing password logic, ensuring that placeholder values are properly filtered out during form-to-properties transformation.

---

118-119: LGTM! Proper conditional handling for Redshift authentication.

The conditional logic correctly handles awsSecretKey for non-password Redshift authentication methods, providing appropriate placeholder values when the field is missing. This aligns with the existing password handling pattern.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch fix/redshift-password-fields

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @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.

[andreashimin]

lgtm