fix: back to thrift-typescript package

[ken-zlai]

Summary

While working with the types generated by the Thrift compiler, I noticed it was generating files using the require keyword. This is only compatible with a Node.js server and not usable in the browser. I attempted several fixes but couldn't find a solution.

Ultimately, I switched to the thrift-typescript package and managed to get it working. As of now, it provides everything we need for the exploration code.

Checklist

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

Summary by CodeRabbit

• Dependencies

  • Added @creditkarma/thrift-server-core (v1.0.4)
  • Added @creditkarma/thrift-typescript (v3.7.6)
  • Added glob (v9.0.0)

• Chores

  • Updated code generation script to improve Thrift file processing
  • Adjusted directory paths for Thrift file generation
  • Added command to clear output directory before generating new files

[coderabbitai]

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)

• frontend/package-lock.json is excluded by !**/package-lock.json

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces changes to the frontend's dependency management and code generation process. Two new Thrift-related dependencies are added to the package.json, and the codegen.sh script is refactored to use a more flexible method for generating TypeScript definitions from Thrift files. The changes reflect an updated approach to handling Thrift file processing and TypeScript type generation.

Changes

File	Change Summary
frontend/package.json	Added Thrift-related dependencies: - @creditkarma/thrift-server-core@^1.0.4 - @creditkarma/thrift-typescript@^3.7.6 - Added glob@^9.0.0 in overrides
frontend/scripts/codegen.sh	- Updated THRIFT_DIR path - Updated OUT_DIR path - Replaced Thrift file processing method - Added output directory clearing step

Possibly related PRs

• Add npm run up-deps and update deps to latest (Vite 5=>6, Svelte, etc) #150: Updates to frontend/package.json dependencies

Suggested reviewers

• sean-zlai
• nikhil-zlai

Poem

Thrift files dancing, TypeScript gleaming bright,
Code generation takes its flight! 🚀
Dependencies added with care,
Transforming paths with techie flair 💻
A script reborn, more flexible and light! ✨

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

frontend/scripts/codegen.sh (1)

14-20: Add error handling.

Add error checks for the npx command execution.

 npx thrift-typescript \
     --rootDir ".." \
     --outDir "$OUT_DIR" \
     --sourceDir "$THRIFT_DIR" \
     --target thrift-server \
     --fallbackNamespace none \
-    $THRIFT_FILES
+    $THRIFT_FILES || { echo "Thrift generation failed"; exit 1; }

📜 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 86f8f8e and 2912860.

⛔ Files ignored due to path filters (1)

• frontend/package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (2)

• frontend/package.json (1 hunks)
• frontend/scripts/codegen.sh (1 hunks)

🔇 Additional comments (3)

frontend/scripts/codegen.sh (2)

3-4: LGTM: Path changes are more explicit.

---

6-11: Verify unique filenames across directories.

Using basename could conflict if different directories have .thrift files with same names.

frontend/package.json (1)

61-62: Verify package versions for security.

The thrift packages are using older versions. Check for security advisories and newer versions.

[sean-zlai]