Skip to content

Add a separate PaymentSendFailure for idempotency violation - #1826

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err
Nov 16, 2022
Merged

Add a separate PaymentSendFailure for idempotency violation#1826
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err

Conversation

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Built on #1761, admittedly this should have gone into #1761 but that's done now and I was thinking I really wanted to overhaul the error types entirely, which I'm not sure is really true now.

When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.

Here we simply add a new PaymentSendFailure enum variant for
DuplicatePayment to allow for that.

@TheBlueMattTheBlueMatt added this to the 0.0.113 milestone Nov 2, 2022
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from e86760f to 34a6c1aCompareNovember 2, 2022 23:29
@codecov-commenter

codecov-commenter commented Nov 2, 2022

Copy link
Copy Markdown

Codecov Report

Base: 90.79% // Head: 91.27% // Increases project coverage by +0.47% 🎉

Coverage data is based on head (c7c134c) compared to base (790d26f).
Patch coverage: 58.33% of modified lines in pull request are covered.

Additional details and impacted files
@@ Coverage Diff @@## main #1826 +/- ##
==========================================
+ Coverage 90.79% 91.27% +0.47% 
==========================================
Files 87 87 Lines 47600 51304 +3704 Branches 47600 51304 +3704 ==========================================
+ Hits 43218 46826 +3608 - Misses 4382 4478 +96 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs93.46% <ø> (ø)
lightning/src/ln/payment_tests.rs98.88% <ø> (ø)
lightning-invoice/src/payment.rs93.24% <33.33%> (+3.29%)⬆️
lightning/src/ln/channelmanager.rs88.84% <62.50%> (+3.45%)⬆️
lightning/src/ln/functional_tests.rs97.03% <100.00%> (-0.06%)⬇️
lightning/src/chain/channelmonitor.rs90.70% <0.00%> (+0.05%)⬆️
lightning-net-tokio/src/lib.rs77.03% <0.00%> (+0.30%)⬆️
lightning-invoice/src/utils.rs95.84% <0.00%> (+0.64%)⬆️
lightning/src/routing/router.rs92.80% <0.00%> (+1.09%)⬆️
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch 2 times, most recently from 4d46352 to 5fa0a6bCompareNovember 3, 2022 22:40
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Rebased after dependent PR merge.

Comment threadlightning-invoice/src/payment.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from 5fa0a6b to 207374aCompareNovember 7, 2022 18:49

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Otherwise LGTM I think

Comment threadlightning/src/ln/channelmanager.rs
@valentinewallace

Copy link
Copy Markdown
Contributor

CI sad

valentinewallace
valentinewallace previously approved these changes Nov 9, 2022

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM after squash

It was pointed out that its quite confusing that
`AllFailedRetrySafe` does not allow you to call `retry_payment`,
though the documentation on it does specify this. Instead, we
simply rename it to `AllFailedResendSafe` to indicate that the
action that is safe to take is *resending*, not *retrying*.
When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.
Here we simply add a new `PaymentSendFailure` enum variant for
`DuplicatePayment` to allow for that.
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Squashed without further change.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

Two tiny doc nits, but feel free to merge as is.

/// for this payment.
AllFailedResendSafe(Vec<APIError>),
/// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or has been abandoned (via

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

No - "not yet completed or been abandoned" has the opposite meaning from "not yet completed or has been abandoned" :).

/// All paths which were attempted failed to send, with no channel state change taking place.
/// You can freely retry the payment in full (though you probably want to do so over different
/// You can freely resend the payment in full (though you probably want to do so over different
/// paths than the ones selected).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// paths than the ones selected).
/// paths than the ones previously selected).

@TheBlueMattTheBlueMattNov 16, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Would rather replace selected with attempted, but not sure its worth it - I don't think anyone is gonna be confused here.

@TheBlueMatt
TheBlueMatt merged commit d6aa1bc into lightningdevkit:mainNov 16, 2022
Sign up for freeto 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.

4 participants

@TheBlueMatt@codecov-commenter@valentinewallace@tnull
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add a separate PaymentSendFailure for idempotency violation by TheBlueMatt · Pull Request #1826 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add a separate PaymentSendFailure for idempotency violation - #1826

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err
Nov 16, 2022
Merged

Add a separate PaymentSendFailure for idempotency violation#1826
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err

Conversation

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Built on #1761, admittedly this should have gone into #1761 but that's done now and I was thinking I really wanted to overhaul the error types entirely, which I'm not sure is really true now.

When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.

Here we simply add a new PaymentSendFailure enum variant for
DuplicatePayment to allow for that.

@TheBlueMattTheBlueMatt added this to the 0.0.113 milestone Nov 2, 2022
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from e86760f to 34a6c1aCompareNovember 2, 2022 23:29
@codecov-commenter

codecov-commenter commented Nov 2, 2022

Copy link
Copy Markdown

Codecov Report

Base: 90.79% // Head: 91.27% // Increases project coverage by +0.47% 🎉

Coverage data is based on head (c7c134c) compared to base (790d26f).
Patch coverage: 58.33% of modified lines in pull request are covered.

Additional details and impacted files
@@ Coverage Diff @@## main #1826 +/- ##
==========================================
+ Coverage 90.79% 91.27% +0.47% 
==========================================
Files 87 87 Lines 47600 51304 +3704 Branches 47600 51304 +3704 ==========================================
+ Hits 43218 46826 +3608 - Misses 4382 4478 +96 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs93.46% <ø> (ø)
lightning/src/ln/payment_tests.rs98.88% <ø> (ø)
lightning-invoice/src/payment.rs93.24% <33.33%> (+3.29%)⬆️
lightning/src/ln/channelmanager.rs88.84% <62.50%> (+3.45%)⬆️
lightning/src/ln/functional_tests.rs97.03% <100.00%> (-0.06%)⬇️
lightning/src/chain/channelmonitor.rs90.70% <0.00%> (+0.05%)⬆️
lightning-net-tokio/src/lib.rs77.03% <0.00%> (+0.30%)⬆️
lightning-invoice/src/utils.rs95.84% <0.00%> (+0.64%)⬆️
lightning/src/routing/router.rs92.80% <0.00%> (+1.09%)⬆️
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch 2 times, most recently from 4d46352 to 5fa0a6bCompareNovember 3, 2022 22:40
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Rebased after dependent PR merge.

Comment threadlightning-invoice/src/payment.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from 5fa0a6b to 207374aCompareNovember 7, 2022 18:49

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Otherwise LGTM I think

Comment threadlightning/src/ln/channelmanager.rs
@valentinewallace

Copy link
Copy Markdown
Contributor

CI sad

valentinewallace
valentinewallace previously approved these changes Nov 9, 2022

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM after squash

It was pointed out that its quite confusing that
`AllFailedRetrySafe` does not allow you to call `retry_payment`,
though the documentation on it does specify this. Instead, we
simply rename it to `AllFailedResendSafe` to indicate that the
action that is safe to take is *resending*, not *retrying*.
When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.
Here we simply add a new `PaymentSendFailure` enum variant for
`DuplicatePayment` to allow for that.
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Squashed without further change.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

Two tiny doc nits, but feel free to merge as is.

/// for this payment.
AllFailedResendSafe(Vec<APIError>),
/// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or has been abandoned (via

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

No - "not yet completed or been abandoned" has the opposite meaning from "not yet completed or has been abandoned" :).

/// All paths which were attempted failed to send, with no channel state change taking place.
/// You can freely retry the payment in full (though you probably want to do so over different
/// You can freely resend the payment in full (though you probably want to do so over different
/// paths than the ones selected).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// paths than the ones selected).
/// paths than the ones previously selected).

@TheBlueMattTheBlueMattNov 16, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Would rather replace selected with attempted, but not sure its worth it - I don't think anyone is gonna be confused here.

@TheBlueMatt
TheBlueMatt merged commit d6aa1bc into lightningdevkit:mainNov 16, 2022
Sign up for freeto 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.

4 participants

@TheBlueMatt@codecov-commenter@valentinewallace@tnull
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add a separate PaymentSendFailure for idempotency violation by TheBlueMatt · Pull Request #1826 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add a separate PaymentSendFailure for idempotency violation - #1826

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err
Nov 16, 2022
Merged

Add a separate PaymentSendFailure for idempotency violation#1826
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err

Conversation

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Built on #1761, admittedly this should have gone into #1761 but that's done now and I was thinking I really wanted to overhaul the error types entirely, which I'm not sure is really true now.

When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.

Here we simply add a new PaymentSendFailure enum variant for
DuplicatePayment to allow for that.

@TheBlueMattTheBlueMatt added this to the 0.0.113 milestone Nov 2, 2022
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from e86760f to 34a6c1aCompareNovember 2, 2022 23:29
@codecov-commenter

codecov-commenter commented Nov 2, 2022

Copy link
Copy Markdown

Codecov Report

Base: 90.79% // Head: 91.27% // Increases project coverage by +0.47% 🎉

Coverage data is based on head (c7c134c) compared to base (790d26f).
Patch coverage: 58.33% of modified lines in pull request are covered.

Additional details and impacted files
@@ Coverage Diff @@## main #1826 +/- ##
==========================================
+ Coverage 90.79% 91.27% +0.47% 
==========================================
Files 87 87 Lines 47600 51304 +3704 Branches 47600 51304 +3704 ==========================================
+ Hits 43218 46826 +3608 - Misses 4382 4478 +96 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs93.46% <ø> (ø)
lightning/src/ln/payment_tests.rs98.88% <ø> (ø)
lightning-invoice/src/payment.rs93.24% <33.33%> (+3.29%)⬆️
lightning/src/ln/channelmanager.rs88.84% <62.50%> (+3.45%)⬆️
lightning/src/ln/functional_tests.rs97.03% <100.00%> (-0.06%)⬇️
lightning/src/chain/channelmonitor.rs90.70% <0.00%> (+0.05%)⬆️
lightning-net-tokio/src/lib.rs77.03% <0.00%> (+0.30%)⬆️
lightning-invoice/src/utils.rs95.84% <0.00%> (+0.64%)⬆️
lightning/src/routing/router.rs92.80% <0.00%> (+1.09%)⬆️
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch 2 times, most recently from 4d46352 to 5fa0a6bCompareNovember 3, 2022 22:40
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Rebased after dependent PR merge.

Comment threadlightning-invoice/src/payment.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from 5fa0a6b to 207374aCompareNovember 7, 2022 18:49

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Otherwise LGTM I think

Comment threadlightning/src/ln/channelmanager.rs
@valentinewallace

Copy link
Copy Markdown
Contributor

CI sad

valentinewallace
valentinewallace previously approved these changes Nov 9, 2022

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM after squash

It was pointed out that its quite confusing that
`AllFailedRetrySafe` does not allow you to call `retry_payment`,
though the documentation on it does specify this. Instead, we
simply rename it to `AllFailedResendSafe` to indicate that the
action that is safe to take is *resending*, not *retrying*.
When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.
Here we simply add a new `PaymentSendFailure` enum variant for
`DuplicatePayment` to allow for that.
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Squashed without further change.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

Two tiny doc nits, but feel free to merge as is.

/// for this payment.
AllFailedResendSafe(Vec<APIError>),
/// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or has been abandoned (via

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

No - "not yet completed or been abandoned" has the opposite meaning from "not yet completed or has been abandoned" :).

/// All paths which were attempted failed to send, with no channel state change taking place.
/// You can freely retry the payment in full (though you probably want to do so over different
/// You can freely resend the payment in full (though you probably want to do so over different
/// paths than the ones selected).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// paths than the ones selected).
/// paths than the ones previously selected).

@TheBlueMattTheBlueMattNov 16, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Would rather replace selected with attempted, but not sure its worth it - I don't think anyone is gonna be confused here.

@TheBlueMatt
TheBlueMatt merged commit d6aa1bc into lightningdevkit:mainNov 16, 2022
Sign up for freeto 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.

4 participants

@TheBlueMatt@codecov-commenter@valentinewallace@tnull
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add a separate PaymentSendFailure for idempotency violation by TheBlueMatt · Pull Request #1826 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add a separate PaymentSendFailure for idempotency violation - #1826

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err
Nov 16, 2022
Merged

Add a separate PaymentSendFailure for idempotency violation#1826
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err

Conversation

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Built on #1761, admittedly this should have gone into #1761 but that's done now and I was thinking I really wanted to overhaul the error types entirely, which I'm not sure is really true now.

When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.

Here we simply add a new PaymentSendFailure enum variant for
DuplicatePayment to allow for that.

@TheBlueMattTheBlueMatt added this to the 0.0.113 milestone Nov 2, 2022
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from e86760f to 34a6c1aCompareNovember 2, 2022 23:29
@codecov-commenter

codecov-commenter commented Nov 2, 2022

Copy link
Copy Markdown

Codecov Report

Base: 90.79% // Head: 91.27% // Increases project coverage by +0.47% 🎉

Coverage data is based on head (c7c134c) compared to base (790d26f).
Patch coverage: 58.33% of modified lines in pull request are covered.

Additional details and impacted files
@@ Coverage Diff @@## main #1826 +/- ##
==========================================
+ Coverage 90.79% 91.27% +0.47% 
==========================================
Files 87 87 Lines 47600 51304 +3704 Branches 47600 51304 +3704 ==========================================
+ Hits 43218 46826 +3608 - Misses 4382 4478 +96 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs93.46% <ø> (ø)
lightning/src/ln/payment_tests.rs98.88% <ø> (ø)
lightning-invoice/src/payment.rs93.24% <33.33%> (+3.29%)⬆️
lightning/src/ln/channelmanager.rs88.84% <62.50%> (+3.45%)⬆️
lightning/src/ln/functional_tests.rs97.03% <100.00%> (-0.06%)⬇️
lightning/src/chain/channelmonitor.rs90.70% <0.00%> (+0.05%)⬆️
lightning-net-tokio/src/lib.rs77.03% <0.00%> (+0.30%)⬆️
lightning-invoice/src/utils.rs95.84% <0.00%> (+0.64%)⬆️
lightning/src/routing/router.rs92.80% <0.00%> (+1.09%)⬆️
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch 2 times, most recently from 4d46352 to 5fa0a6bCompareNovember 3, 2022 22:40
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Rebased after dependent PR merge.

Comment threadlightning-invoice/src/payment.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from 5fa0a6b to 207374aCompareNovember 7, 2022 18:49

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Otherwise LGTM I think

Comment threadlightning/src/ln/channelmanager.rs
@valentinewallace

Copy link
Copy Markdown
Contributor

CI sad

valentinewallace
valentinewallace previously approved these changes Nov 9, 2022

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM after squash

It was pointed out that its quite confusing that
`AllFailedRetrySafe` does not allow you to call `retry_payment`,
though the documentation on it does specify this. Instead, we
simply rename it to `AllFailedResendSafe` to indicate that the
action that is safe to take is *resending*, not *retrying*.
When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.
Here we simply add a new `PaymentSendFailure` enum variant for
`DuplicatePayment` to allow for that.
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Squashed without further change.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

Two tiny doc nits, but feel free to merge as is.

/// for this payment.
AllFailedResendSafe(Vec<APIError>),
/// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or has been abandoned (via

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

No - "not yet completed or been abandoned" has the opposite meaning from "not yet completed or has been abandoned" :).

/// All paths which were attempted failed to send, with no channel state change taking place.
/// You can freely retry the payment in full (though you probably want to do so over different
/// You can freely resend the payment in full (though you probably want to do so over different
/// paths than the ones selected).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// paths than the ones selected).
/// paths than the ones previously selected).

@TheBlueMattTheBlueMattNov 16, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Would rather replace selected with attempted, but not sure its worth it - I don't think anyone is gonna be confused here.

@TheBlueMatt
TheBlueMatt merged commit d6aa1bc into lightningdevkit:mainNov 16, 2022
Sign up for freeto 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.

4 participants

@TheBlueMatt@codecov-commenter@valentinewallace@tnull
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Add a separate PaymentSendFailure for idempotency violation by TheBlueMatt · Pull Request #1826 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add a separate PaymentSendFailure for idempotency violation - #1826

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err
Nov 16, 2022
Merged

Add a separate PaymentSendFailure for idempotency violation#1826
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err

Conversation

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Built on #1761, admittedly this should have gone into #1761 but that's done now and I was thinking I really wanted to overhaul the error types entirely, which I'm not sure is really true now.

When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.

Here we simply add a new PaymentSendFailure enum variant for
DuplicatePayment to allow for that.

@TheBlueMattTheBlueMatt added this to the 0.0.113 milestone Nov 2, 2022
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from e86760f to 34a6c1aCompareNovember 2, 2022 23:29
@codecov-commenter

codecov-commenter commented Nov 2, 2022

Copy link
Copy Markdown

Codecov Report

Base: 90.79% // Head: 91.27% // Increases project coverage by +0.47% 🎉

Coverage data is based on head (c7c134c) compared to base (790d26f).
Patch coverage: 58.33% of modified lines in pull request are covered.

Additional details and impacted files
@@ Coverage Diff @@## main #1826 +/- ##
==========================================
+ Coverage 90.79% 91.27% +0.47% 
==========================================
Files 87 87 Lines 47600 51304 +3704 Branches 47600 51304 +3704 ==========================================
+ Hits 43218 46826 +3608 - Misses 4382 4478 +96 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs93.46% <ø> (ø)
lightning/src/ln/payment_tests.rs98.88% <ø> (ø)
lightning-invoice/src/payment.rs93.24% <33.33%> (+3.29%)⬆️
lightning/src/ln/channelmanager.rs88.84% <62.50%> (+3.45%)⬆️
lightning/src/ln/functional_tests.rs97.03% <100.00%> (-0.06%)⬇️
lightning/src/chain/channelmonitor.rs90.70% <0.00%> (+0.05%)⬆️
lightning-net-tokio/src/lib.rs77.03% <0.00%> (+0.30%)⬆️
lightning-invoice/src/utils.rs95.84% <0.00%> (+0.64%)⬆️
lightning/src/routing/router.rs92.80% <0.00%> (+1.09%)⬆️
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch 2 times, most recently from 4d46352 to 5fa0a6bCompareNovember 3, 2022 22:40
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Rebased after dependent PR merge.

Comment threadlightning-invoice/src/payment.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from 5fa0a6b to 207374aCompareNovember 7, 2022 18:49

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Otherwise LGTM I think

Comment threadlightning/src/ln/channelmanager.rs
@valentinewallace

Copy link
Copy Markdown
Contributor

CI sad

valentinewallace
valentinewallace previously approved these changes Nov 9, 2022

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM after squash

It was pointed out that its quite confusing that
`AllFailedRetrySafe` does not allow you to call `retry_payment`,
though the documentation on it does specify this. Instead, we
simply rename it to `AllFailedResendSafe` to indicate that the
action that is safe to take is *resending*, not *retrying*.
When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.
Here we simply add a new `PaymentSendFailure` enum variant for
`DuplicatePayment` to allow for that.
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Squashed without further change.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

Two tiny doc nits, but feel free to merge as is.

/// for this payment.
AllFailedResendSafe(Vec<APIError>),
/// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or has been abandoned (via

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

No - "not yet completed or been abandoned" has the opposite meaning from "not yet completed or has been abandoned" :).

/// All paths which were attempted failed to send, with no channel state change taking place.
/// You can freely retry the payment in full (though you probably want to do so over different
/// You can freely resend the payment in full (though you probably want to do so over different
/// paths than the ones selected).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// paths than the ones selected).
/// paths than the ones previously selected).

@TheBlueMattTheBlueMattNov 16, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Would rather replace selected with attempted, but not sure its worth it - I don't think anyone is gonna be confused here.

@TheBlueMatt
TheBlueMatt merged commit d6aa1bc into lightningdevkit:mainNov 16, 2022
Sign up for freeto 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.

4 participants

@TheBlueMatt@codecov-commenter@valentinewallace@tnull
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add a separate PaymentSendFailure for idempotency violation by TheBlueMatt · Pull Request #1826 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add a separate PaymentSendFailure for idempotency violation - #1826

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err
Nov 16, 2022
Merged

Add a separate PaymentSendFailure for idempotency violation#1826
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err

Conversation

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Built on #1761, admittedly this should have gone into #1761 but that's done now and I was thinking I really wanted to overhaul the error types entirely, which I'm not sure is really true now.

When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.

Here we simply add a new PaymentSendFailure enum variant for
DuplicatePayment to allow for that.

@TheBlueMattTheBlueMatt added this to the 0.0.113 milestone Nov 2, 2022
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from e86760f to 34a6c1aCompareNovember 2, 2022 23:29
@codecov-commenter

codecov-commenter commented Nov 2, 2022

Copy link
Copy Markdown

Codecov Report

Base: 90.79% // Head: 91.27% // Increases project coverage by +0.47% 🎉

Coverage data is based on head (c7c134c) compared to base (790d26f).
Patch coverage: 58.33% of modified lines in pull request are covered.

Additional details and impacted files
@@ Coverage Diff @@## main #1826 +/- ##
==========================================
+ Coverage 90.79% 91.27% +0.47% 
==========================================
Files 87 87 Lines 47600 51304 +3704 Branches 47600 51304 +3704 ==========================================
+ Hits 43218 46826 +3608 - Misses 4382 4478 +96 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs93.46% <ø> (ø)
lightning/src/ln/payment_tests.rs98.88% <ø> (ø)
lightning-invoice/src/payment.rs93.24% <33.33%> (+3.29%)⬆️
lightning/src/ln/channelmanager.rs88.84% <62.50%> (+3.45%)⬆️
lightning/src/ln/functional_tests.rs97.03% <100.00%> (-0.06%)⬇️
lightning/src/chain/channelmonitor.rs90.70% <0.00%> (+0.05%)⬆️
lightning-net-tokio/src/lib.rs77.03% <0.00%> (+0.30%)⬆️
lightning-invoice/src/utils.rs95.84% <0.00%> (+0.64%)⬆️
lightning/src/routing/router.rs92.80% <0.00%> (+1.09%)⬆️
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch 2 times, most recently from 4d46352 to 5fa0a6bCompareNovember 3, 2022 22:40
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Rebased after dependent PR merge.

Comment threadlightning-invoice/src/payment.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from 5fa0a6b to 207374aCompareNovember 7, 2022 18:49

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Otherwise LGTM I think

Comment threadlightning/src/ln/channelmanager.rs
@valentinewallace

Copy link
Copy Markdown
Contributor

CI sad

valentinewallace
valentinewallace previously approved these changes Nov 9, 2022

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM after squash

It was pointed out that its quite confusing that
`AllFailedRetrySafe` does not allow you to call `retry_payment`,
though the documentation on it does specify this. Instead, we
simply rename it to `AllFailedResendSafe` to indicate that the
action that is safe to take is *resending*, not *retrying*.
When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.
Here we simply add a new `PaymentSendFailure` enum variant for
`DuplicatePayment` to allow for that.
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Squashed without further change.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

Two tiny doc nits, but feel free to merge as is.

/// for this payment.
AllFailedResendSafe(Vec<APIError>),
/// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or has been abandoned (via

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

No - "not yet completed or been abandoned" has the opposite meaning from "not yet completed or has been abandoned" :).

/// All paths which were attempted failed to send, with no channel state change taking place.
/// You can freely retry the payment in full (though you probably want to do so over different
/// You can freely resend the payment in full (though you probably want to do so over different
/// paths than the ones selected).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// paths than the ones selected).
/// paths than the ones previously selected).

@TheBlueMattTheBlueMattNov 16, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Would rather replace selected with attempted, but not sure its worth it - I don't think anyone is gonna be confused here.

@TheBlueMatt
TheBlueMatt merged commit d6aa1bc into lightningdevkit:mainNov 16, 2022
Sign up for freeto 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.

4 participants

@TheBlueMatt@codecov-commenter@valentinewallace@tnull
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add a separate PaymentSendFailure for idempotency violation by TheBlueMatt · Pull Request #1826 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add a separate PaymentSendFailure for idempotency violation - #1826

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err
Nov 16, 2022
Merged

Add a separate PaymentSendFailure for idempotency violation#1826
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err

Conversation

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Built on #1761, admittedly this should have gone into #1761 but that's done now and I was thinking I really wanted to overhaul the error types entirely, which I'm not sure is really true now.

When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.

Here we simply add a new PaymentSendFailure enum variant for
DuplicatePayment to allow for that.

@TheBlueMattTheBlueMatt added this to the 0.0.113 milestone Nov 2, 2022
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from e86760f to 34a6c1aCompareNovember 2, 2022 23:29
@codecov-commenter

codecov-commenter commented Nov 2, 2022

Copy link
Copy Markdown

Codecov Report

Base: 90.79% // Head: 91.27% // Increases project coverage by +0.47% 🎉

Coverage data is based on head (c7c134c) compared to base (790d26f).
Patch coverage: 58.33% of modified lines in pull request are covered.

Additional details and impacted files
@@ Coverage Diff @@## main #1826 +/- ##
==========================================
+ Coverage 90.79% 91.27% +0.47% 
==========================================
Files 87 87 Lines 47600 51304 +3704 Branches 47600 51304 +3704 ==========================================
+ Hits 43218 46826 +3608 - Misses 4382 4478 +96 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs93.46% <ø> (ø)
lightning/src/ln/payment_tests.rs98.88% <ø> (ø)
lightning-invoice/src/payment.rs93.24% <33.33%> (+3.29%)⬆️
lightning/src/ln/channelmanager.rs88.84% <62.50%> (+3.45%)⬆️
lightning/src/ln/functional_tests.rs97.03% <100.00%> (-0.06%)⬇️
lightning/src/chain/channelmonitor.rs90.70% <0.00%> (+0.05%)⬆️
lightning-net-tokio/src/lib.rs77.03% <0.00%> (+0.30%)⬆️
lightning-invoice/src/utils.rs95.84% <0.00%> (+0.64%)⬆️
lightning/src/routing/router.rs92.80% <0.00%> (+1.09%)⬆️
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch 2 times, most recently from 4d46352 to 5fa0a6bCompareNovember 3, 2022 22:40
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Rebased after dependent PR merge.

Comment threadlightning-invoice/src/payment.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from 5fa0a6b to 207374aCompareNovember 7, 2022 18:49

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Otherwise LGTM I think

Comment threadlightning/src/ln/channelmanager.rs
@valentinewallace

Copy link
Copy Markdown
Contributor

CI sad

valentinewallace
valentinewallace previously approved these changes Nov 9, 2022

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM after squash

It was pointed out that its quite confusing that
`AllFailedRetrySafe` does not allow you to call `retry_payment`,
though the documentation on it does specify this. Instead, we
simply rename it to `AllFailedResendSafe` to indicate that the
action that is safe to take is *resending*, not *retrying*.
When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.
Here we simply add a new `PaymentSendFailure` enum variant for
`DuplicatePayment` to allow for that.
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Squashed without further change.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

Two tiny doc nits, but feel free to merge as is.

/// for this payment.
AllFailedResendSafe(Vec<APIError>),
/// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or has been abandoned (via

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

No - "not yet completed or been abandoned" has the opposite meaning from "not yet completed or has been abandoned" :).

/// All paths which were attempted failed to send, with no channel state change taking place.
/// You can freely retry the payment in full (though you probably want to do so over different
/// You can freely resend the payment in full (though you probably want to do so over different
/// paths than the ones selected).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// paths than the ones selected).
/// paths than the ones previously selected).

@TheBlueMattTheBlueMattNov 16, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Would rather replace selected with attempted, but not sure its worth it - I don't think anyone is gonna be confused here.

@TheBlueMatt
TheBlueMatt merged commit d6aa1bc into lightningdevkit:mainNov 16, 2022
Sign up for freeto 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.

4 participants

@TheBlueMatt@codecov-commenter@valentinewallace@tnull
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Add a separate PaymentSendFailure for idempotency violation by TheBlueMatt · Pull Request #1826 · lightningdevkit/rust-lightning · GitHub
Skip to content

Add a separate PaymentSendFailure for idempotency violation - #1826

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err
Nov 16, 2022
Merged

Add a separate PaymentSendFailure for idempotency violation#1826
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
TheBlueMatt:2022-10-idempotency-err

Conversation

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Built on #1761, admittedly this should have gone into #1761 but that's done now and I was thinking I really wanted to overhaul the error types entirely, which I'm not sure is really true now.

When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.

Here we simply add a new PaymentSendFailure enum variant for
DuplicatePayment to allow for that.

@TheBlueMattTheBlueMatt added this to the 0.0.113 milestone Nov 2, 2022
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from e86760f to 34a6c1aCompareNovember 2, 2022 23:29
@codecov-commenter

codecov-commenter commented Nov 2, 2022

Copy link
Copy Markdown

Codecov Report

Base: 90.79% // Head: 91.27% // Increases project coverage by +0.47% 🎉

Coverage data is based on head (c7c134c) compared to base (790d26f).
Patch coverage: 58.33% of modified lines in pull request are covered.

Additional details and impacted files
@@ Coverage Diff @@## main #1826 +/- ##
==========================================
+ Coverage 90.79% 91.27% +0.47% 
==========================================
Files 87 87 Lines 47600 51304 +3704 Branches 47600 51304 +3704 ==========================================
+ Hits 43218 46826 +3608 - Misses 4382 4478 +96 
Impacted FilesCoverage Δ
lightning/src/ln/functional_test_utils.rs93.46% <ø> (ø)
lightning/src/ln/payment_tests.rs98.88% <ø> (ø)
lightning-invoice/src/payment.rs93.24% <33.33%> (+3.29%)⬆️
lightning/src/ln/channelmanager.rs88.84% <62.50%> (+3.45%)⬆️
lightning/src/ln/functional_tests.rs97.03% <100.00%> (-0.06%)⬇️
lightning/src/chain/channelmonitor.rs90.70% <0.00%> (+0.05%)⬆️
lightning-net-tokio/src/lib.rs77.03% <0.00%> (+0.30%)⬆️
lightning-invoice/src/utils.rs95.84% <0.00%> (+0.64%)⬆️
lightning/src/routing/router.rs92.80% <0.00%> (+1.09%)⬆️
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch 2 times, most recently from 4d46352 to 5fa0a6bCompareNovember 3, 2022 22:40
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Rebased after dependent PR merge.

Comment threadlightning-invoice/src/payment.rs Outdated
Comment threadlightning/src/ln/channelmanager.rs Outdated
@TheBlueMatt
TheBlueMattforce-pushed the 2022-10-idempotency-err branch from 5fa0a6b to 207374aCompareNovember 7, 2022 18:49

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Otherwise LGTM I think

Comment threadlightning/src/ln/channelmanager.rs
@valentinewallace

Copy link
Copy Markdown
Contributor

CI sad

valentinewallace
valentinewallace previously approved these changes Nov 9, 2022

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM after squash

It was pointed out that its quite confusing that
`AllFailedRetrySafe` does not allow you to call `retry_payment`,
though the documentation on it does specify this. Instead, we
simply rename it to `AllFailedResendSafe` to indicate that the
action that is safe to take is *resending*, not *retrying*.
When a user attempts to send a payment but it fails due to
idempotency key violation, they need to know that this was the
reason as they need to handle the error programmatically
differently from other errors.
Here we simply add a new `PaymentSendFailure` enum variant for
`DuplicatePayment` to allow for that.
@TheBlueMatt

Copy link
Copy Markdown
CollaboratorAuthor

Squashed without further change.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

Two tiny doc nits, but feel free to merge as is.

/// for this payment.
AllFailedResendSafe(Vec<APIError>),
/// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
/// yet completed (i.e. generated an [`Event::PaymentSent`]) or has been abandoned (via

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

No - "not yet completed or been abandoned" has the opposite meaning from "not yet completed or has been abandoned" :).

/// All paths which were attempted failed to send, with no channel state change taking place.
/// You can freely retry the payment in full (though you probably want to do so over different
/// You can freely resend the payment in full (though you probably want to do so over different
/// paths than the ones selected).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// paths than the ones selected).
/// paths than the ones previously selected).

@TheBlueMattTheBlueMattNov 16, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Would rather replace selected with attempted, but not sure its worth it - I don't think anyone is gonna be confused here.

@TheBlueMatt
TheBlueMatt merged commit d6aa1bc into lightningdevkit:mainNov 16, 2022
Sign up for freeto 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.

4 participants

@TheBlueMatt@codecov-commenter@valentinewallace@tnull