Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(cli): exit 1 when compilation fail #2650

Merged
merged 3 commits into from
Aug 29, 2024

Conversation

bodinsamuel
Copy link
Collaborator

@bodinsamuel bodinsamuel commented Aug 29, 2024

Describe your changes

Fixes https://linear.app/nango/issue/NAN-1622/github-actions-doesnt-fail-on-compilation-error

  • Correctly exit 1 when compilation fail
  • Add missing error when calling nango compile

Summary by CodeRabbit

  • New Features

    • Enhanced console logging for the compilation process, providing clearer feedback on success or failure.
  • Bug Fixes

    • Improved handling of undefined scriptName in the compilation logic to prevent unexpected failures.
  • Refactor

    • Minor formatting adjustments for improved code readability without altering functionality.

@bodinsamuel bodinsamuel self-assigned this Aug 29, 2024
Copy link

linear bot commented Aug 29, 2024

Copy link

coderabbitai bot commented Aug 29, 2024

Walkthrough

The changes involve enhancements to the compilation process within the CLI package. A new console log statement has been introduced to inform users about the success or failure of the compilation. The compileAllFiles function has been modified to explicitly handle cases where the scriptName is undefined, improving control flow. Additionally, minor formatting adjustments were made to enhance code readability.

Changes

Files Change Summary
packages/cli/lib/index.ts Added a console log statement to indicate compilation success or failure.
packages/cli/lib/services/compile.service.ts Updated compileAllFiles to set success to false if scriptName is not provided. Minor formatting change in the compile function by removing an empty line.

Poem

🐰 In the land of code, where bunnies hop,
A log now shines, no need to stop!
If scripts are lost, they’ll surely know,
With clearer paths, the fixes flow.
So compile with joy, let errors flee,
For every hop brings clarity! 🌼


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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
packages/cli/lib/services/compile.service.ts (1)

70-71: Review the usage of compileAllFiles to ensure consistency with the new signature.

The compileAllFiles function is called in several places without the scriptName parameter, which may lead to issues if the function expects it to be defined. Please review the following instances to ensure correct usage:

  • packages/cli/lib/index.ts: Line 70
  • packages/cli/lib/services/verification.service.ts: Lines 70, 75, 80
  • packages/cli/lib/cli.ts: Line 70
  • packages/cli/lib/services/deploy.service.ts: Lines 70, 75

Ensure that the scriptName parameter is included where necessary to avoid potential issues.

Analysis chain

LGTM! But verify the function usage in the codebase.

The changes enhance the control flow by explicitly handling the case where scriptName is undefined, ensuring that the function behaves predictably in such scenarios.

The code changes are approved.

Run the following script to verify the function usage:

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `compileAllFiles` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type ts -A 5 $'compileAllFiles'

Length of output: 10607

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bc468da and d0e494a.

Files selected for processing (2)
  • packages/cli/lib/index.ts (1 hunks)
  • packages/cli/lib/services/compile.service.ts (2 hunks)
Additional comments not posted (2)
packages/cli/lib/services/compile.service.ts (1)

Line range hint 237-237: LGTM!

The formatting change improves the code's readability without altering the logic.

The code changes are approved.

packages/cli/lib/index.ts (1)

237-237: LGTM!

The new console log statement enhances user experience by providing clearer feedback on the compilation status, which may help in troubleshooting issues related to file compilation.

The code changes are approved.

coderabbitai[bot]

This comment was marked as outdated.

@bodinsamuel bodinsamuel enabled auto-merge (squash) August 29, 2024 18:44
@bodinsamuel bodinsamuel merged commit bccde14 into master Aug 29, 2024
22 checks passed
@bodinsamuel bodinsamuel deleted the fix/cli-exit-on-broken-compilation branch August 29, 2024 18:52
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.

2 participants