feat: try `allDiffs` api first and fallback to `showChanges` when unavailable by JounQin · Pull Request #210

feat: try `allDiffs` api first and fallback to `showChanges` when unavailable by JounQin · Pull Request #210 · un-ts/changesets-gitlab

Walkthrough

This pull request updates the system’s logic for retrieving diff information. The code now attempts to use the allDiffs API first and falls back to showChanges if needed. In addition, type imports and error handling in src/comment.ts have been streamlined by removing the deprecated error interface and functions. A new changeset file documents this behavior, and a constant for HTTP status 404 has been added to src/utils.ts.

Changes

File(s)	Change Summary
`.changeset/neat-hats-breathe.md`	Added a changeset entry documenting the new feature: using `allDiffs` API first, with a fallback to `showChanges` when unavailable.
`src/comment.ts`	Updated type imports and function signature; simplified error handling by removing deprecated interfaces; implemented a fallback mechanism that tries `allDiffs` and defaults to `showChanges` on error.
`src/utils.ts`	Added a new constant `HTTP_STATUS_NOT_FOUND` set to `404`.

Sequence Diagram(s)

sequenceDiagram
    participant CM as Comment Module
    participant API as GitLab API
    CM->>API: Call allDiffs for diff retrieval
    API-->>CM: Return diff data or error
    alt Error is GitbeakerRequestError (or matching status)
        CM->>API: Call showChanges as fallback
        API-->>CM: Return diff data
    end

Assessment against linked issues

Objective	Addressed	Explanation
Use `allDiffs` for diff retrieval with a fallback to `showChanges` (#187)	✅

Poem

I'm hopping through code with a joyful beat,
Trying allDiffs first – oh, what a treat!
If it stumbles, I simply switch my pace,
Using showChanges to keep up the race.
From one hop to the next, the changes gleam,
Coding's a bright, bouncy rabbit dream!
🥕🐇

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/comment.ts

Oops! Something went wrong! :(

ESLint: 9.23.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@1stg/eslint-config' imported from /eslint.config.js
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

src/utils.ts

Oops! Something went wrong! :(

ESLint: 9.23.0

📜 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 842110d and 3f0d445.

📒 Files selected for processing (3)

.changeset/neat-hats-breathe.md (1 hunks)
src/comment.ts (5 hunks)
src/utils.ts (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

src/comment.ts (2)

src/utils.ts (2)

HTTP_STATUS_NOT_FOUND (181-181)

getChangedPackages (30-45)

src/get-changed-packages.ts (1)

getChangedPackages (24-197)

🔇 Additional comments (8)

src/utils.ts (1)

180-181: Good addition of HTTP status code constant.

Adding a constant for the HTTP 404 status code improves code readability and maintainability by replacing magic numbers with named constants.

.changeset/neat-hats-breathe.md (1)

1-5: LGTM! Proper changeset documentation.

The changeset correctly documents the feature change, specifying a minor version bump for "changesets-gitlab". The description accurately reflects the implementation changes in the code.

src/comment.ts (6)

7-15: Good update to type imports.

Updated imports reflect the transition from using MergeRequestChangesSchema to using CommitDiffSchema and MergeRequestDiffSchema, which is consistent with the API usage changes in the implementation.

24-24: Import updated to include new HTTP status constant.

The import statement correctly adds the new HTTP_STATUS_NOT_FOUND constant, which is used in the error handling logic.

210-221: Simplified hasChangesetBeenAdded function.

The function has been updated to work with the new diff format. The logic has been simplified while maintaining the same functionality, making it more readable and maintainable.

247-263: Excellent implementation of fallback mechanism.

The code now tries to use the allDiffs API first and falls back to showChanges when encountering a 404 error. This approach ensures backward compatibility and graceful degradation when the preferred API is not available.

270-272: Updated mapping to handle new diff format.

The mapping has been updated to extract new_path from each diff object, maintaining consistency with the original code's purpose.

357-371: Simplified error handling.

The error handling has been simplified to use the GitbeakerRequestError directly, which is cleaner and more maintainable than the previous approach.

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