Skip to content

Conversation

@mikeallisonJS
Copy link
Collaborator

@mikeallisonJS mikeallisonJS commented Mar 12, 2025

Summary by CodeRabbit

Release Notes:
This update refines internal processes to match the new project structure while ensuring reliable functionality. These internal improvements streamline the asset generation pipeline for GraphQL services and help maintain long-term consistency. End-users will experience the same excellent performance without any visible adjustments.

  • Chores
    • Updated internal configurations to align GraphQL asset generation with the revised organizational structure, streamlining development workflows and enhancing maintainability.

@mikeallisonJS mikeallisonJS requested a review from Kneesal March 12, 2025 20:01
@mikeallisonJS mikeallisonJS self-assigned this Mar 12, 2025
@linear
Copy link

linear bot commented Mar 12, 2025

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 12, 2025

Walkthrough

The update modifies the file paths in the generate method of the GraphQLFederationDefinitionsFactory used by the typings generation script. In both the source GraphQL schema path and the output TypeScript file path, the prefix was changed from apps to apis. No other functionality or control flow was altered.

Changes

File Change Summary
tools/.../generate-typings.ts Updated the input schema path from apps/${process.argv[2]}/src/app/**/*.graphql to apis/${process.argv[2]}/src/app/**/*.graphql and the output file path from apps/${process.argv[2]}/src/app/__generated__/graphql.ts to apis/${process.argv[2]}/src/app/__generated__/graphql.ts.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 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 130041f and 1eca584.

⛔ Files ignored due to path filters (1)
  • apis/api-journeys/src/app/__generated__/graphql.ts is excluded by !**/__generated__/**
📒 Files selected for processing (1)
  • tools/scripts/generate-typings.ts (1 hunks)
🔇 Additional comments (2)
tools/scripts/generate-typings.ts (2)

8-8: Path update for GraphQL schema files looks good

The change from apps/${process.argv[2]} to apis/${process.argv[2]} aligns with the fix mentioned in the PR title. This ensures the type generator is looking in the correct directory structure for api-journeys.


16-16: Path update for generated output file is consistent

This change correctly updates the output path to match the new directory structure, ensuring the generated TypeScript definitions are placed in the same apis directory as the source files. The change is consistent with the update on line 8.

✨ Finishing Touches
  • 📝 Generate Docstrings

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

@stage-branch-merger
Copy link

I see you added the "on stage" label, I'll get this merged to the stage branch!

@mikeallisonJS mikeallisonJS added this pull request to the merge queue Mar 12, 2025
Merged via the queue into main with commit aec1a02 Mar 12, 2025
24 checks passed
@mikeallisonJS mikeallisonJS deleted the mikeallison/eng-2021-fix-bad-api-codegen-no-qa branch March 12, 2025 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants