Skip to content

Conversation

@ken-zlai
Copy link
Contributor

@ken-zlai ken-zlai commented Jan 13, 2025

Summary

The Thrift TypeScript generator wasn't properly handling imports between generated files, causing the Window type from common.thrift to be unresolved in api_types.d.ts. This was leading to TypeScript incorrectly defaulting to the DOM Window interface.

Using the js:node,ts generator ensures proper type imports between generated files.

Checklist

  • Added Unit Tests
  • Covered by existing CI
  • Integration tested
  • Documentation update

Summary by CodeRabbit

  • Chores
    • Updated code generation script to improve TypeScript and Node.js compatibility for Thrift file compilation.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

Walkthrough

The pull request modifies the codegen.sh script in the frontend directory, specifically updating the Thrift code generation command. The change adjusts the JavaScript generation options from --gen js:ts to --gen "js:node,ts", explicitly adding Node.js-specific generation support to the existing TypeScript generation process.

Changes

File Change Summary
frontend/scripts/codegen.sh Updated Thrift compiler generation options to include Node.js-specific JavaScript generation

Possibly related PRs

Suggested reviewers

  • nikhil-zlai
  • piyush-zlai

Poem

🌟 Thrift's magic wand now waves anew,
Node.js whispers, "I'm coming through!"
Code generation, a subtle art,
Transforming scripts with a gentle start 🚀
Compiler's dance, a rhythmic view

Warning

Review ran into problems

🔥 Problems

GitHub Actions: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository.

Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 7f9775e and 530351f.

📒 Files selected for processing (1)
  • frontend/scripts/codegen.sh (1 hunks)
🔇 Additional comments (1)
frontend/scripts/codegen.sh (1)

9-9: LGTM! The js:node,ts generator should fix the type imports.

Let's verify the fix resolves the Window type import:

✅ Verification successful

✅ Window type is properly resolved with js:node,ts generator

The Window type is correctly defined in common_types.d.ts and properly referenced across the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify Window type resolution after codegen

# Run codegen and check the generated files
mkdir -p src/lib/types/codegen
thrift -r -out src/lib/types/codegen --gen "js:node,ts" ../api/thrift/common.thrift
thrift -r -out src/lib/types/codegen --gen "js:node,ts" ../api/thrift/api.thrift

# Check if Window type is properly imported in api_types.d.ts
rg -A 3 "import.*Window" src/lib/types/codegen/api_types.d.ts

Length of output: 532


Script:

#!/bin/bash
# Find existing generated files and Window type usage
fd "api_types.d.ts|common_types.d.ts" 
rg "Window" -A 3 -g "*.ts" -g "*.thrift"

Length of output: 7495


🪧 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.

@ken-zlai ken-zlai marked this pull request as ready for review January 13, 2025 17:52
@ken-zlai ken-zlai requested a review from sean-zlai January 13, 2025 17:52
Copy link
Contributor

@sean-zlai sean-zlai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@ken-zlai ken-zlai closed this Jan 13, 2025
@sean-zlai sean-zlai deleted the ken/different-thrift-gen branch May 12, 2025 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants