Fix Unknown command error when disabling Bolt12 offers on CLN

[s373nZ]

Fixes a typo to change camel case to lowercase, match CLN's gRPC method name.

Fixes #1433

Summary by CodeRabbit

• Bug Fixes
  • Updated the URL for disabling offers to ensure proper request handling on the server.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifying the URL used in the disableOffer function within the backend/controllers/cln/offers.js file. The endpoint for the POST request has been altered from /v1/disableOffer to /v1/disableoffer, changing the case sensitivity of the URL. This alteration is significant as it may affect how the server processes the request, but all other functionalities in the code remain unchanged.

Changes

File Path	Change Summary
backend/controllers/cln/offers.js	Modified the URL in the disableOffer function from /v1/disableOffer to /v1/disableoffer.

Assessment against linked issues

Objective	Addressed	Explanation
Fix the issue of disabling an offer (#1433)	✅

Poem

In the code where offers lay,
A change was made to save the day.
From disableOffer, now a new way,
With a lowercase twist, it’s here to stay!
Hopping along, we cheer and play! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

🧹 Outside diff range and nitpick comments (2)

backend/controllers/cln/offers.js (2)

86-86: Approve the URL change and suggest a minor improvement.

The change from /v1/disableOffer to /v1/disableoffer correctly addresses the "Unknown command" error mentioned in the PR objectives and issue #1433. This modification aligns the URL with the gRPC method name used by Core Lightning (CLN).

For consistency, consider extracting the base URL and endpoint into constants. This approach would make future updates easier and reduce the risk of similar typos.

Consider refactoring the URL construction as follows:

const BASE_URL = req.session.selectedNode.settings.lnServerUrl;
const DISABLE_OFFER_ENDPOINT = '/v1/disableoffer';

options.url = `${BASE_URL}${DISABLE_OFFER_ENDPOINT}`;

This change would improve maintainability and reduce the likelihood of similar issues in the future.

---

Line range hint 1-95: Consider a broader refactoring for consistency and maintainability.

While the current change effectively addresses the immediate issue, there's an opportunity to improve the overall code structure to prevent similar problems in the future.

Consider the following suggestions:

1. Create a constants file (e.g., apiEndpoints.js) to store all API endpoints:

// apiEndpoints.js
export const API_ENDPOINTS = {
  LIST_OFFERS: '/v1/listoffers',
  CREATE_OFFER: '/v1/offer',
  FETCH_INVOICE: '/v1/fetchinvoice',
  DISABLE_OFFER: '/v1/disableoffer',
  // Add other endpoints here
};

2. Update the offers.js file to use these constants:

import { API_ENDPOINTS } from '../../utils/apiEndpoints.js';

// In each function:
options.url = `${req.session.selectedNode.settings.lnServerUrl}${API_ENDPOINTS.DISABLE_OFFER}`;

This approach would:

• Centralize API endpoint management
• Reduce the risk of typos and inconsistencies
• Make it easier to update endpoints across the application

Additionally, consider creating a utility function for constructing API URLs to further reduce code duplication and improve maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6027167 and 91ad075.

📒 Files selected for processing (1)

• backend/controllers/cln/offers.js (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

backend/controllers/cln/offers.js (1)

Line range hint 1-95: Summary of the review

The change successfully addresses the "Unknown command" error when disabling Bolt12 offers on CLN. The modification is minimal and focused, reducing the risk of introducing new issues.

Key points:

1. The URL change in the disableOffer function resolves the reported issue.
2. Suggestions for improving code consistency and maintainability have been provided.
3. No other significant issues were found in the file.

Overall, this change achieves the PR objectives and improves the functionality of the RTL application. The suggested refactoring would further enhance the code quality and prevent similar issues in the future.