fix(gate): skip unnecessary secret decryption step on SYNC_FORCE_REMOVE

[michael-0acf4]

Migration notes

None

• The change comes with new or modified tests
• Hard-to-understand functions have explanatory comments
• End-user documentation is updated to reflect the change

Summary by CodeRabbit

• New Features

  • Introduced a secure, improved mechanism for downloading type graph data, enhancing the retrieval process and ensuring sensitive data is handled safely.

• Refactor

  • Updated processes to consistently leverage the new download approach, streamlining functionality and reinforcing robust error handling.

[linear]

MET-822 `SYNC_FORCE_REMOVE` doesn't work2

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes add a new asynchronous method downloadTypegraph to the TypegraphStore class, which retrieves and parses a type graph along with an encrypted secrets string. The existing download method is modified to leverage this new method, decrypt the secrets, and return a tuple with a TypeGraphDS and a SecretManager. Additionally, in the Typegate class, a call to the download method in the forceRemove function is updated to call downloadTypegraph instead.

Changes

File	Change Summary
src/typegate/src/sync/typegraph.ts	- Added downloadTypegraph(id: TypegraphId) returning [TypeGraphDS, string] using the satisfies operator. - Modified download(id: TypegraphId) to decrypt secrets and return [TypeGraphDS, SecretManager].
src/typegate/src/typegate/mod.ts	- Updated forceRemove method to replace download with downloadTypegraph when retrieving the type graph.

Sequence Diagram(s)

sequenceDiagram
  participant Caller as Typegate.forceRemove
  participant Store as TypegraphStore

  Caller->>Store: downloadTypegraph(typegraphId)
  Store-->>Caller: [TypeGraphDS, encryptedSecret]

Loading

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 47d1005 and 0de9880.

📒 Files selected for processing (2)

• src/typegate/src/sync/typegraph.ts (1 hunks)
• src/typegate/src/typegate/mod.ts (1 hunks)

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

• GitHub Check: test-full
• GitHub Check: lint-compat (macos-14, aarch64-apple-darwin, false)
• GitHub Check: bulid-docker (linux/arm64, custom-arm)
• GitHub Check: lint-compat (macos-13, x86_64-apple-darwin, false)
• GitHub Check: bulid-docker (linux/amd64, custom-ubuntu-large)
• GitHub Check: pre-commit

🔇 Additional comments (3)

src/typegate/src/sync/typegraph.ts (2)

66-77: LGTM! Clean separation of concerns.

The new downloadTypegraph method effectively separates the typegraph download from secret decryption, which aligns with the PR objective. The use of the satisfies operator ensures type safety.

---

79-87: LGTM! Clear return type and proper error handling.

The modified download method now has an explicit return type and properly handles the secret decryption step.

src/typegate/src/typegate/mod.ts (1)

421-423: LGTM! Performance optimization.

The change to use downloadTypegraph instead of download is a good optimization as it skips the unnecessary secret decryption step during force removal.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.85%. Comparing base (82600b5) to head (0de9880).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #976   +/-   ##
=======================================
  Coverage   77.85%   77.85%           
=======================================
  Files         160      160           
  Lines       19641    19647    +6     
  Branches     1969     1968    -1     
=======================================
+ Hits        15291    15297    +6     
  Misses       4329     4329           
  Partials       21       21           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.