feat: Use public GitHub API for Nushell assets query, try to make it work for GitHub Enterprise

[hustcer]

feat: Use public GitHub API for Nushell assets query, try to make it work for GitHub Enterprise

Summary by CodeRabbit

• Bug Fixes
  • Improved release retrieval to ensure seamless support for both public GitHub API and GitHub Enterprise configurations.

[github-actions]

Code Analysis

• Key observations:
  • The change introduces a base URL configuration for Octokit, which improves compatibility with GitHub Enterprise
  • The comment suggests this is specifically for Nushell assets query, but the change affects all GitHub API calls
  • The code still directly uses the raw githubToken without any validation or sanitization

Security Review

• Vulnerability findings:
  • ❗ The GitHub token is passed directly without any validation (potential credential exposure risk)
  • ⚠️ No rate limiting or error handling for GitHub API requests (potential API abuse vector)
  • Missing input validation for the tool parameter (could lead to SSRF if attacker controls input)

Optimization Suggestions

• Performance improvements:
  • Consider implementing request caching for GitHub API responses to reduce API calls
  • Add request timeout configuration to prevent hanging requests
  • Implement exponential backoff for failed requests

Overall Quality: 3

Additional recommendations:

1. Security:

• Add input validation for the tool parameter
• Consider using environment variables for sensitive tokens
• Implement proper error handling for API requests

2. Performance:

const octokit = new Octokit({
  auth: tool.githubToken,
  baseUrl: 'https://api.github.com',
  request: {
    timeout: 5000 // Add timeout
  }
});

3. Reliability:

• Add retry logic for failed requests
• Implement proper type checking for the response data
• Consider adding circuit breaker pattern for API calls

[coderabbitai]

Walkthrough

The change updates the instantiation of the Octokit client in the getRelease function within src/setup.ts. Previously, only the auth parameter was provided; the new implementation adds a baseUrl parameter set to 'https://api.github.com' to ensure compatibility with the public GitHub API and GitHub Enterprise configurations. The rest of the function's logic, including release handling based on flags, remains unchanged.

Changes

File(s)	Description
src/setup.ts	Updated the getRelease function to instantiate Octokit with an additional baseUrl parameter, ensuring API compatibility.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant GR as getRelease()
    participant OC as Octokit Client
    participant API as GitHub API

    Caller->>GR: Call getRelease(isNightly, checkLatest)
    GR->>OC: Instantiate Octokit({ auth, baseUrl: "https://api.github.com" })
    OC->>API: Query for releases
    API-->>OC: Return release data
    OC-->>GR: Deliver release data
    GR-->>Caller: Send response

Loading

Poem

From my burrow, I leaped in code delight,
Adding a base URL so our API runs just right.
Octokit now sets the stage with a friendly URL key,
Whether GitHub’s public or Enterprise, I’m free!
Hopping over issues with a spring in my stride,
Here's to smooth releases and a joyful ride!
🐇✨

---

📜 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 9859855 and 985211f.

⛔ Files ignored due to path filters (1)

• dist/index.js is excluded by !**/dist/**

📒 Files selected for processing (1)

• src/setup.ts (1 hunks)

🔇 Additional comments (1)

src/setup.ts (1)

215-216: LGTM! Good fix for GitHub Enterprise compatibility.

Adding the explicit baseUrl parameter to the Octokit constructor ensures that the client will always connect to the public GitHub API, regardless of the environment it's running in (including GitHub Enterprise). This is a clean approach to ensure Nushell assets can be queried consistently.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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 plan to trigger planning for file edits and PR creation.
• @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.

[Copilot]

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

[Copilot]

Hardcoding the baseUrl limits support for GitHub Enterprise environments that use a different API endpoint. Consider making the baseUrl configurable based on the tool settings.

Suggested change

	const octokit = new Octokit({ auth: tool.githubToken, baseUrl: 'https://api.github.com' });
	const octokit = new Octokit({ auth: tool.githubToken, baseUrl });