infisical icon indicating copy to clipboard operation
infisical copied to clipboard

feat(secrets-ui): Add direct reference warning on secrets updates and add secret sync warning on deletion

Open carlosmonastyrski opened this issue 8 months ago • 2 comments

Description 📣

Add secret syncs to secret deletion warning, and also added a confirmation modal for secret updates (only for direct references as those are going to be directly affected by this change, for imports and secret-syncs that's the change is more organic and it can be a little tedious to update many when the entire folder is imported).

https://github.com/user-attachments/assets/6dff96c2-faee-4eda-9165-b0eff96fea88

Type ✨

  • [ ] Bug fix
  • [ ] New feature
  • [ ] Improvement
  • [ ] Breaking change
  • [ ] Documentation

Tests 🛠️

# Here's some code block to paste some code snippets

Summary by CodeRabbit

  • New Features

    • Added visibility into which secret syncs are using a given secret, now displayed in secret overview and details views.
    • Enhanced secret import information with more detailed references, including unique identifiers for referenced secrets.
    • When editing a secret that is imported by other environments or folders, users are now prompted with a confirmation modal showing where the secret is imported.
    • Secret sync usage is now integrated into the UI, allowing users to view and navigate to related secret syncs.
  • Improvements

    • Delete and edit confirmation modals now display more comprehensive information about secret imports and syncs.
    • UI components for secret management have been updated to support and display the new secret sync and import reference data.
  • API Changes

    • Secret overview and details endpoints now include additional metadata about secret sync usage and referenced secret IDs.

carlosmonastyrski avatar Apr 25 '25 20:04 carlosmonastyrski

"""

Walkthrough

This change set introduces enhancements to both backend and frontend components for managing secrets and their relationships in a dashboard environment. On the backend, new fields such as referencedSecretEnv are added to secret reference objects, and a new optional array usedBySecretSyncs is included in the responses of /secrets-overview and /secrets-details endpoints to indicate secret sync usage. A new service method, listSecretSyncsBySecretPath, is implemented to retrieve secret syncs associated with a specific secret path and environment. Type definitions and data access layers are updated accordingly. The secretSyncServiceFactory is also modified to depend on the secret import data access layer.

On the frontend, component props and types are extended to handle and display the new usedBySecretSyncs data and enriched import relationships, including the referencedSecretEnv. UI components such as SecretEditRow, SecretItem, and SelectionPanel are updated to provide user confirmation modals when editing secrets imported elsewhere and to visually represent secret sync usage. Data preparation and filtering logic is adjusted to support these new features, with changes propagated through relevant components including SecretListView, ActionBar, and CollapsibleSecretImports.

Possibly related PRs

  • Infisical/infisical#3356: This PR adds importedByEnvs data and warnings about secrets imported by other folders, modifying the same dashboard routes and secret import service layers as the current changes, making it closely related in terms of handling secret references and usage.
  • Infisical/infisical#3343: This PR introduces the secret rotations v2 feature with new service methods, types, schemas, routes, and frontend components, representing a related feature area involving secret management.

Suggested reviewers

  • maidul98 """
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

🪧 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in 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.

coderabbitai[bot] avatar Apr 25 '25 20:04 coderabbitai[bot]

:tada: Snyk checks have passed. No issues have been found so far.

:white_check_mark: security/snyk check is complete. No issues have been found. (View Details)

maidul98 avatar Apr 25 '25 20:04 maidul98