Rename Event PaymentFailed -> PaymentPathFailed - #1084

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed
Sep 21, 2021
Merged

Rename Event PaymentFailed -> PaymentPathFailed#1084
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed

Conversation

@valentinewallace

Copy link
Copy Markdown
Contributor

And add path field to PaymentPathFailed.

Closes#1081

@codecov

codecovBot commented Sep 20, 2021

Copy link
Copy Markdown

Codecov Report

Merging #1084 (0302b7d) into main (2cf42aa) will decrease coverage by 0.00%.
The diff coverage is 87.17%.

❗ Current head 0302b7d differs from pull request most recent head e5310dd. Consider uploading reports for the commit e5310dd to get more accurate results
Impacted file tree graph

@@ Coverage Diff @@## main #1084 +/- ##
==========================================
- Coverage 90.72% 90.72% -0.01% 
==========================================
Files 65 65 Lines 34212 34225 +13 ==========================================
+ Hits 31039 31049 +10 - Misses 3173 3176 +3 
Impacted FilesCoverage Δ
lightning/src/util/events.rs32.65% <16.66%> (-0.16%)⬇️
lightning/src/ln/chanmon_update_fail_tests.rs97.76% <100.00%> (ø)
lightning/src/ln/channelmanager.rs84.92% <100.00%> (-0.02%)⬇️
lightning/src/ln/functional_test_utils.rs95.08% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs97.37% <100.00%> (+0.01%)⬆️
lightning/src/ln/onion_route_tests.rs97.09% <100.00%> (ø)
lightning/src/routing/network_graph.rs92.14% <100.00%> (+0.01%)⬆️
lightning/src/routing/router.rs95.99% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5262e77...e5310dd. Read the comment docs.

Comment on lines +149 to +205
/// The payment path that failed.
path: Vec<RouteHop>,

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.

So this will be empty for backwards compatibility rather than None? I think that's probably ok but just want to make sure.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

True. Is that an issue for the scorer? It could be an option

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

@jkczyzjkczyzSep 20, 2021

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.

True. Is that an issue for the scorer? It could be an option

Nah, would be better if neither event used Option for symmetry.

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

Do we tag PRs that need to be reflected in the release? Or should we update as we go?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We currently don't have a process for release notes, I generally write the compat section by reading the full-release diff and looking at serialization sections to see the implications of stuff when we cut the release. In the future, we should move towards including release note updates in the PR itself, maybe in a subfolder that just has a long list of release note files. Either way, doesn't have to happen here.

Comment threadlightning/src/ln/functional_test_utils.rs
@jkczyzjkczyz mentioned this pull request Sep 21, 2021
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Will take after #997.

@TheBlueMattTheBlueMatt added this to the 0.0.101 milestone Sep 21, 2021
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch 2 times, most recently from b6fc74d to 0302b7dCompareSeptember 21, 2021 20:49
@valentinewallace

Copy link
Copy Markdown
ContributorAuthor

Rebased!

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Will land after CI, range-diff is:

$ git range-diff 801d6e5256d6ac91d5d5668da1fa5a2b55303246..af73857278bd3d94e86ccc059fedde85697aea82 5262e77ae186e4ea58294a7c6ee05e5649a12fc5..e5310dd5f0347fcaaf21b2742a1084f97fc84bd8
1: 8ef997c8 ! 1: bf16dfd1 Rename PaymentFailed -> PaymentPathFailed
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_permane
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail
check_closed_broadcast!(nodes[0], true);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_tempora
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn test_monitor_update_on_pending_forwards() {
let events = nodes[0].node.get_and_clear_pending_events();
@@ lightning/src/ln/functional_test_utils.rs: pub fn fail_payment_along_route<'a, '
## lightning/src/ln/functional_tests.rs ##
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use
- let events = nodes[1].node.get_and_clear_pending_events();
- assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
- match events[0] {
+ _ => panic!("Unexepected event"),
+ }
+ match events[1] {
- Event::PaymentFailed { ref payment_hash, .. } => {
+ Event::PaymentPathFailed { ref payment_hash, .. } => {
assert_eq!(*payment_hash, fourth_payment_hash);
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backwar
assert!(failed_htlcs.insert(payment_hash.0));
assert!(network_update.is_some());
},
+@@ lightning/src/ln/functional_tests.rs: fn fail_backward_pending_htlc_upon_channel_failure() {
+ assert_eq!(events.len(), 2);
+ // Check that Alice fails backward the pending HTLC from the second payment.
+ match events[0] {
+- Event::PaymentFailed { payment_hash, .. } => {
++ Event::PaymentPathFailed { payment_hash, .. } => {
+ assert_eq!(payment_hash, failed_payment_hash);
+ },
+ _ => panic!("Unexpected event"),
@@ lightning/src/ln/functional_tests.rs: fn test_simple_peer_disconnect() {
_ => panic!("Unexpected event"),
}
2: af738572 ! 2: e5310dd5 Add path field to PaymentPathFailed event
@@ lightning/src/routing/router.rs: use core::cmp;
pub pubkey: PublicKey,
## lightning/src/util/events.rs ##
-@@ lightning/src/util/events.rs: use chain::keysinterface::SpendableOutputDescriptor;
- use ln::msgs;
+@@ lightning/src/util/events.rs: use ln::msgs::DecodeError;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use routing::network_graph::NetworkUpdate;
+ use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
+use routing::router::RouteHop;
- use util::ser::{Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
use bitcoin::blockdata::script::Script;
+ @@ lightning/src/util/events.rs: pub enum Event {
/// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
/// larger MPP payment were still in flight when this event was generated.

Since we don't want to imply to users that a payment has
completely failed when it really has just partially
failed
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch from 0302b7d to e5310ddCompareSeptember 21, 2021 21:40
@TheBlueMatt
TheBlueMatt merged commit 0273ac5 into lightningdevkit:mainSep 21, 2021
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.

Rename PaymentFailed event

3 participants

@valentinewallace@TheBlueMatt@jkczyz
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Rename Event PaymentFailed -> PaymentPathFailed - #1084

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed
Sep 21, 2021
Merged

Rename Event PaymentFailed -> PaymentPathFailed#1084
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed

Conversation

@valentinewallace

Copy link
Copy Markdown
Contributor

And add path field to PaymentPathFailed.

Closes#1081

@codecov

codecovBot commented Sep 20, 2021

Copy link
Copy Markdown

Codecov Report

Merging #1084 (0302b7d) into main (2cf42aa) will decrease coverage by 0.00%.
The diff coverage is 87.17%.

❗ Current head 0302b7d differs from pull request most recent head e5310dd. Consider uploading reports for the commit e5310dd to get more accurate results
Impacted file tree graph

@@ Coverage Diff @@## main #1084 +/- ##
==========================================
- Coverage 90.72% 90.72% -0.01% 
==========================================
Files 65 65 Lines 34212 34225 +13 ==========================================
+ Hits 31039 31049 +10 - Misses 3173 3176 +3 
Impacted FilesCoverage Δ
lightning/src/util/events.rs32.65% <16.66%> (-0.16%)⬇️
lightning/src/ln/chanmon_update_fail_tests.rs97.76% <100.00%> (ø)
lightning/src/ln/channelmanager.rs84.92% <100.00%> (-0.02%)⬇️
lightning/src/ln/functional_test_utils.rs95.08% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs97.37% <100.00%> (+0.01%)⬆️
lightning/src/ln/onion_route_tests.rs97.09% <100.00%> (ø)
lightning/src/routing/network_graph.rs92.14% <100.00%> (+0.01%)⬆️
lightning/src/routing/router.rs95.99% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5262e77...e5310dd. Read the comment docs.

Comment on lines +149 to +205
/// The payment path that failed.
path: Vec<RouteHop>,

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.

So this will be empty for backwards compatibility rather than None? I think that's probably ok but just want to make sure.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

True. Is that an issue for the scorer? It could be an option

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

@jkczyzjkczyzSep 20, 2021

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.

True. Is that an issue for the scorer? It could be an option

Nah, would be better if neither event used Option for symmetry.

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

Do we tag PRs that need to be reflected in the release? Or should we update as we go?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We currently don't have a process for release notes, I generally write the compat section by reading the full-release diff and looking at serialization sections to see the implications of stuff when we cut the release. In the future, we should move towards including release note updates in the PR itself, maybe in a subfolder that just has a long list of release note files. Either way, doesn't have to happen here.

Comment threadlightning/src/ln/functional_test_utils.rs
@jkczyzjkczyz mentioned this pull request Sep 21, 2021
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Will take after #997.

@TheBlueMattTheBlueMatt added this to the 0.0.101 milestone Sep 21, 2021
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch 2 times, most recently from b6fc74d to 0302b7dCompareSeptember 21, 2021 20:49
@valentinewallace

Copy link
Copy Markdown
ContributorAuthor

Rebased!

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Will land after CI, range-diff is:

$ git range-diff 801d6e5256d6ac91d5d5668da1fa5a2b55303246..af73857278bd3d94e86ccc059fedde85697aea82 5262e77ae186e4ea58294a7c6ee05e5649a12fc5..e5310dd5f0347fcaaf21b2742a1084f97fc84bd8
1: 8ef997c8 ! 1: bf16dfd1 Rename PaymentFailed -> PaymentPathFailed
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_permane
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail
check_closed_broadcast!(nodes[0], true);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_tempora
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn test_monitor_update_on_pending_forwards() {
let events = nodes[0].node.get_and_clear_pending_events();
@@ lightning/src/ln/functional_test_utils.rs: pub fn fail_payment_along_route<'a, '
## lightning/src/ln/functional_tests.rs ##
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use
- let events = nodes[1].node.get_and_clear_pending_events();
- assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
- match events[0] {
+ _ => panic!("Unexepected event"),
+ }
+ match events[1] {
- Event::PaymentFailed { ref payment_hash, .. } => {
+ Event::PaymentPathFailed { ref payment_hash, .. } => {
assert_eq!(*payment_hash, fourth_payment_hash);
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backwar
assert!(failed_htlcs.insert(payment_hash.0));
assert!(network_update.is_some());
},
+@@ lightning/src/ln/functional_tests.rs: fn fail_backward_pending_htlc_upon_channel_failure() {
+ assert_eq!(events.len(), 2);
+ // Check that Alice fails backward the pending HTLC from the second payment.
+ match events[0] {
+- Event::PaymentFailed { payment_hash, .. } => {
++ Event::PaymentPathFailed { payment_hash, .. } => {
+ assert_eq!(payment_hash, failed_payment_hash);
+ },
+ _ => panic!("Unexpected event"),
@@ lightning/src/ln/functional_tests.rs: fn test_simple_peer_disconnect() {
_ => panic!("Unexpected event"),
}
2: af738572 ! 2: e5310dd5 Add path field to PaymentPathFailed event
@@ lightning/src/routing/router.rs: use core::cmp;
pub pubkey: PublicKey,
## lightning/src/util/events.rs ##
-@@ lightning/src/util/events.rs: use chain::keysinterface::SpendableOutputDescriptor;
- use ln::msgs;
+@@ lightning/src/util/events.rs: use ln::msgs::DecodeError;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use routing::network_graph::NetworkUpdate;
+ use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
+use routing::router::RouteHop;
- use util::ser::{Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
use bitcoin::blockdata::script::Script;
+ @@ lightning/src/util/events.rs: pub enum Event {
/// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
/// larger MPP payment were still in flight when this event was generated.

Since we don't want to imply to users that a payment has
completely failed when it really has just partially
failed
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch from 0302b7d to e5310ddCompareSeptember 21, 2021 21:40
@TheBlueMatt
TheBlueMatt merged commit 0273ac5 into lightningdevkit:mainSep 21, 2021
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.

Rename PaymentFailed event

3 participants

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

Rename Event PaymentFailed -> PaymentPathFailed - #1084

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed
Sep 21, 2021
Merged

Rename Event PaymentFailed -> PaymentPathFailed#1084
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed

Conversation

@valentinewallace

Copy link
Copy Markdown
Contributor

And add path field to PaymentPathFailed.

Closes#1081

@codecov

codecovBot commented Sep 20, 2021

Copy link
Copy Markdown

Codecov Report

Merging #1084 (0302b7d) into main (2cf42aa) will decrease coverage by 0.00%.
The diff coverage is 87.17%.

❗ Current head 0302b7d differs from pull request most recent head e5310dd. Consider uploading reports for the commit e5310dd to get more accurate results
Impacted file tree graph

@@ Coverage Diff @@## main #1084 +/- ##
==========================================
- Coverage 90.72% 90.72% -0.01% 
==========================================
Files 65 65 Lines 34212 34225 +13 ==========================================
+ Hits 31039 31049 +10 - Misses 3173 3176 +3 
Impacted FilesCoverage Δ
lightning/src/util/events.rs32.65% <16.66%> (-0.16%)⬇️
lightning/src/ln/chanmon_update_fail_tests.rs97.76% <100.00%> (ø)
lightning/src/ln/channelmanager.rs84.92% <100.00%> (-0.02%)⬇️
lightning/src/ln/functional_test_utils.rs95.08% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs97.37% <100.00%> (+0.01%)⬆️
lightning/src/ln/onion_route_tests.rs97.09% <100.00%> (ø)
lightning/src/routing/network_graph.rs92.14% <100.00%> (+0.01%)⬆️
lightning/src/routing/router.rs95.99% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5262e77...e5310dd. Read the comment docs.

Comment on lines +149 to +205
/// The payment path that failed.
path: Vec<RouteHop>,

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.

So this will be empty for backwards compatibility rather than None? I think that's probably ok but just want to make sure.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

True. Is that an issue for the scorer? It could be an option

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

@jkczyzjkczyzSep 20, 2021

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.

True. Is that an issue for the scorer? It could be an option

Nah, would be better if neither event used Option for symmetry.

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

Do we tag PRs that need to be reflected in the release? Or should we update as we go?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We currently don't have a process for release notes, I generally write the compat section by reading the full-release diff and looking at serialization sections to see the implications of stuff when we cut the release. In the future, we should move towards including release note updates in the PR itself, maybe in a subfolder that just has a long list of release note files. Either way, doesn't have to happen here.

Comment threadlightning/src/ln/functional_test_utils.rs
@jkczyzjkczyz mentioned this pull request Sep 21, 2021
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Will take after #997.

@TheBlueMattTheBlueMatt added this to the 0.0.101 milestone Sep 21, 2021
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch 2 times, most recently from b6fc74d to 0302b7dCompareSeptember 21, 2021 20:49
@valentinewallace

Copy link
Copy Markdown
ContributorAuthor

Rebased!

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Will land after CI, range-diff is:

$ git range-diff 801d6e5256d6ac91d5d5668da1fa5a2b55303246..af73857278bd3d94e86ccc059fedde85697aea82 5262e77ae186e4ea58294a7c6ee05e5649a12fc5..e5310dd5f0347fcaaf21b2742a1084f97fc84bd8
1: 8ef997c8 ! 1: bf16dfd1 Rename PaymentFailed -> PaymentPathFailed
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_permane
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail
check_closed_broadcast!(nodes[0], true);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_tempora
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn test_monitor_update_on_pending_forwards() {
let events = nodes[0].node.get_and_clear_pending_events();
@@ lightning/src/ln/functional_test_utils.rs: pub fn fail_payment_along_route<'a, '
## lightning/src/ln/functional_tests.rs ##
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use
- let events = nodes[1].node.get_and_clear_pending_events();
- assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
- match events[0] {
+ _ => panic!("Unexepected event"),
+ }
+ match events[1] {
- Event::PaymentFailed { ref payment_hash, .. } => {
+ Event::PaymentPathFailed { ref payment_hash, .. } => {
assert_eq!(*payment_hash, fourth_payment_hash);
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backwar
assert!(failed_htlcs.insert(payment_hash.0));
assert!(network_update.is_some());
},
+@@ lightning/src/ln/functional_tests.rs: fn fail_backward_pending_htlc_upon_channel_failure() {
+ assert_eq!(events.len(), 2);
+ // Check that Alice fails backward the pending HTLC from the second payment.
+ match events[0] {
+- Event::PaymentFailed { payment_hash, .. } => {
++ Event::PaymentPathFailed { payment_hash, .. } => {
+ assert_eq!(payment_hash, failed_payment_hash);
+ },
+ _ => panic!("Unexpected event"),
@@ lightning/src/ln/functional_tests.rs: fn test_simple_peer_disconnect() {
_ => panic!("Unexpected event"),
}
2: af738572 ! 2: e5310dd5 Add path field to PaymentPathFailed event
@@ lightning/src/routing/router.rs: use core::cmp;
pub pubkey: PublicKey,
## lightning/src/util/events.rs ##
-@@ lightning/src/util/events.rs: use chain::keysinterface::SpendableOutputDescriptor;
- use ln::msgs;
+@@ lightning/src/util/events.rs: use ln::msgs::DecodeError;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use routing::network_graph::NetworkUpdate;
+ use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
+use routing::router::RouteHop;
- use util::ser::{Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
use bitcoin::blockdata::script::Script;
+ @@ lightning/src/util/events.rs: pub enum Event {
/// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
/// larger MPP payment were still in flight when this event was generated.

Since we don't want to imply to users that a payment has
completely failed when it really has just partially
failed
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch from 0302b7d to e5310ddCompareSeptember 21, 2021 21:40
@TheBlueMatt
TheBlueMatt merged commit 0273ac5 into lightningdevkit:mainSep 21, 2021
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.

Rename PaymentFailed event

3 participants

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

Rename Event PaymentFailed -> PaymentPathFailed - #1084

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed
Sep 21, 2021
Merged

Rename Event PaymentFailed -> PaymentPathFailed#1084
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed

Conversation

@valentinewallace

Copy link
Copy Markdown
Contributor

And add path field to PaymentPathFailed.

Closes#1081

@codecov

codecovBot commented Sep 20, 2021

Copy link
Copy Markdown

Codecov Report

Merging #1084 (0302b7d) into main (2cf42aa) will decrease coverage by 0.00%.
The diff coverage is 87.17%.

❗ Current head 0302b7d differs from pull request most recent head e5310dd. Consider uploading reports for the commit e5310dd to get more accurate results
Impacted file tree graph

@@ Coverage Diff @@## main #1084 +/- ##
==========================================
- Coverage 90.72% 90.72% -0.01% 
==========================================
Files 65 65 Lines 34212 34225 +13 ==========================================
+ Hits 31039 31049 +10 - Misses 3173 3176 +3 
Impacted FilesCoverage Δ
lightning/src/util/events.rs32.65% <16.66%> (-0.16%)⬇️
lightning/src/ln/chanmon_update_fail_tests.rs97.76% <100.00%> (ø)
lightning/src/ln/channelmanager.rs84.92% <100.00%> (-0.02%)⬇️
lightning/src/ln/functional_test_utils.rs95.08% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs97.37% <100.00%> (+0.01%)⬆️
lightning/src/ln/onion_route_tests.rs97.09% <100.00%> (ø)
lightning/src/routing/network_graph.rs92.14% <100.00%> (+0.01%)⬆️
lightning/src/routing/router.rs95.99% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5262e77...e5310dd. Read the comment docs.

Comment on lines +149 to +205
/// The payment path that failed.
path: Vec<RouteHop>,

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.

So this will be empty for backwards compatibility rather than None? I think that's probably ok but just want to make sure.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

True. Is that an issue for the scorer? It could be an option

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

@jkczyzjkczyzSep 20, 2021

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.

True. Is that an issue for the scorer? It could be an option

Nah, would be better if neither event used Option for symmetry.

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

Do we tag PRs that need to be reflected in the release? Or should we update as we go?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We currently don't have a process for release notes, I generally write the compat section by reading the full-release diff and looking at serialization sections to see the implications of stuff when we cut the release. In the future, we should move towards including release note updates in the PR itself, maybe in a subfolder that just has a long list of release note files. Either way, doesn't have to happen here.

Comment threadlightning/src/ln/functional_test_utils.rs
@jkczyzjkczyz mentioned this pull request Sep 21, 2021
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Will take after #997.

@TheBlueMattTheBlueMatt added this to the 0.0.101 milestone Sep 21, 2021
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch 2 times, most recently from b6fc74d to 0302b7dCompareSeptember 21, 2021 20:49
@valentinewallace

Copy link
Copy Markdown
ContributorAuthor

Rebased!

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Will land after CI, range-diff is:

$ git range-diff 801d6e5256d6ac91d5d5668da1fa5a2b55303246..af73857278bd3d94e86ccc059fedde85697aea82 5262e77ae186e4ea58294a7c6ee05e5649a12fc5..e5310dd5f0347fcaaf21b2742a1084f97fc84bd8
1: 8ef997c8 ! 1: bf16dfd1 Rename PaymentFailed -> PaymentPathFailed
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_permane
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail
check_closed_broadcast!(nodes[0], true);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_tempora
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn test_monitor_update_on_pending_forwards() {
let events = nodes[0].node.get_and_clear_pending_events();
@@ lightning/src/ln/functional_test_utils.rs: pub fn fail_payment_along_route<'a, '
## lightning/src/ln/functional_tests.rs ##
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use
- let events = nodes[1].node.get_and_clear_pending_events();
- assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
- match events[0] {
+ _ => panic!("Unexepected event"),
+ }
+ match events[1] {
- Event::PaymentFailed { ref payment_hash, .. } => {
+ Event::PaymentPathFailed { ref payment_hash, .. } => {
assert_eq!(*payment_hash, fourth_payment_hash);
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backwar
assert!(failed_htlcs.insert(payment_hash.0));
assert!(network_update.is_some());
},
+@@ lightning/src/ln/functional_tests.rs: fn fail_backward_pending_htlc_upon_channel_failure() {
+ assert_eq!(events.len(), 2);
+ // Check that Alice fails backward the pending HTLC from the second payment.
+ match events[0] {
+- Event::PaymentFailed { payment_hash, .. } => {
++ Event::PaymentPathFailed { payment_hash, .. } => {
+ assert_eq!(payment_hash, failed_payment_hash);
+ },
+ _ => panic!("Unexpected event"),
@@ lightning/src/ln/functional_tests.rs: fn test_simple_peer_disconnect() {
_ => panic!("Unexpected event"),
}
2: af738572 ! 2: e5310dd5 Add path field to PaymentPathFailed event
@@ lightning/src/routing/router.rs: use core::cmp;
pub pubkey: PublicKey,
## lightning/src/util/events.rs ##
-@@ lightning/src/util/events.rs: use chain::keysinterface::SpendableOutputDescriptor;
- use ln::msgs;
+@@ lightning/src/util/events.rs: use ln::msgs::DecodeError;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use routing::network_graph::NetworkUpdate;
+ use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
+use routing::router::RouteHop;
- use util::ser::{Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
use bitcoin::blockdata::script::Script;
+ @@ lightning/src/util/events.rs: pub enum Event {
/// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
/// larger MPP payment were still in flight when this event was generated.

Since we don't want to imply to users that a payment has
completely failed when it really has just partially
failed
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch from 0302b7d to e5310ddCompareSeptember 21, 2021 21:40
@TheBlueMatt
TheBlueMatt merged commit 0273ac5 into lightningdevkit:mainSep 21, 2021
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.

Rename PaymentFailed event

3 participants

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

Rename Event PaymentFailed -> PaymentPathFailed - #1084

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed
Sep 21, 2021
Merged

Rename Event PaymentFailed -> PaymentPathFailed#1084
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed

Conversation

@valentinewallace

Copy link
Copy Markdown
Contributor

And add path field to PaymentPathFailed.

Closes#1081

@codecov

codecovBot commented Sep 20, 2021

Copy link
Copy Markdown

Codecov Report

Merging #1084 (0302b7d) into main (2cf42aa) will decrease coverage by 0.00%.
The diff coverage is 87.17%.

❗ Current head 0302b7d differs from pull request most recent head e5310dd. Consider uploading reports for the commit e5310dd to get more accurate results
Impacted file tree graph

@@ Coverage Diff @@## main #1084 +/- ##
==========================================
- Coverage 90.72% 90.72% -0.01% 
==========================================
Files 65 65 Lines 34212 34225 +13 ==========================================
+ Hits 31039 31049 +10 - Misses 3173 3176 +3 
Impacted FilesCoverage Δ
lightning/src/util/events.rs32.65% <16.66%> (-0.16%)⬇️
lightning/src/ln/chanmon_update_fail_tests.rs97.76% <100.00%> (ø)
lightning/src/ln/channelmanager.rs84.92% <100.00%> (-0.02%)⬇️
lightning/src/ln/functional_test_utils.rs95.08% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs97.37% <100.00%> (+0.01%)⬆️
lightning/src/ln/onion_route_tests.rs97.09% <100.00%> (ø)
lightning/src/routing/network_graph.rs92.14% <100.00%> (+0.01%)⬆️
lightning/src/routing/router.rs95.99% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5262e77...e5310dd. Read the comment docs.

Comment on lines +149 to +205
/// The payment path that failed.
path: Vec<RouteHop>,

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.

So this will be empty for backwards compatibility rather than None? I think that's probably ok but just want to make sure.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

True. Is that an issue for the scorer? It could be an option

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

@jkczyzjkczyzSep 20, 2021

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.

True. Is that an issue for the scorer? It could be an option

Nah, would be better if neither event used Option for symmetry.

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

Do we tag PRs that need to be reflected in the release? Or should we update as we go?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We currently don't have a process for release notes, I generally write the compat section by reading the full-release diff and looking at serialization sections to see the implications of stuff when we cut the release. In the future, we should move towards including release note updates in the PR itself, maybe in a subfolder that just has a long list of release note files. Either way, doesn't have to happen here.

Comment threadlightning/src/ln/functional_test_utils.rs
@jkczyzjkczyz mentioned this pull request Sep 21, 2021
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Will take after #997.

@TheBlueMattTheBlueMatt added this to the 0.0.101 milestone Sep 21, 2021
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch 2 times, most recently from b6fc74d to 0302b7dCompareSeptember 21, 2021 20:49
@valentinewallace

Copy link
Copy Markdown
ContributorAuthor

Rebased!

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Will land after CI, range-diff is:

$ git range-diff 801d6e5256d6ac91d5d5668da1fa5a2b55303246..af73857278bd3d94e86ccc059fedde85697aea82 5262e77ae186e4ea58294a7c6ee05e5649a12fc5..e5310dd5f0347fcaaf21b2742a1084f97fc84bd8
1: 8ef997c8 ! 1: bf16dfd1 Rename PaymentFailed -> PaymentPathFailed
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_permane
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail
check_closed_broadcast!(nodes[0], true);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_tempora
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn test_monitor_update_on_pending_forwards() {
let events = nodes[0].node.get_and_clear_pending_events();
@@ lightning/src/ln/functional_test_utils.rs: pub fn fail_payment_along_route<'a, '
## lightning/src/ln/functional_tests.rs ##
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use
- let events = nodes[1].node.get_and_clear_pending_events();
- assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
- match events[0] {
+ _ => panic!("Unexepected event"),
+ }
+ match events[1] {
- Event::PaymentFailed { ref payment_hash, .. } => {
+ Event::PaymentPathFailed { ref payment_hash, .. } => {
assert_eq!(*payment_hash, fourth_payment_hash);
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backwar
assert!(failed_htlcs.insert(payment_hash.0));
assert!(network_update.is_some());
},
+@@ lightning/src/ln/functional_tests.rs: fn fail_backward_pending_htlc_upon_channel_failure() {
+ assert_eq!(events.len(), 2);
+ // Check that Alice fails backward the pending HTLC from the second payment.
+ match events[0] {
+- Event::PaymentFailed { payment_hash, .. } => {
++ Event::PaymentPathFailed { payment_hash, .. } => {
+ assert_eq!(payment_hash, failed_payment_hash);
+ },
+ _ => panic!("Unexpected event"),
@@ lightning/src/ln/functional_tests.rs: fn test_simple_peer_disconnect() {
_ => panic!("Unexpected event"),
}
2: af738572 ! 2: e5310dd5 Add path field to PaymentPathFailed event
@@ lightning/src/routing/router.rs: use core::cmp;
pub pubkey: PublicKey,
## lightning/src/util/events.rs ##
-@@ lightning/src/util/events.rs: use chain::keysinterface::SpendableOutputDescriptor;
- use ln::msgs;
+@@ lightning/src/util/events.rs: use ln::msgs::DecodeError;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use routing::network_graph::NetworkUpdate;
+ use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
+use routing::router::RouteHop;
- use util::ser::{Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
use bitcoin::blockdata::script::Script;
+ @@ lightning/src/util/events.rs: pub enum Event {
/// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
/// larger MPP payment were still in flight when this event was generated.

Since we don't want to imply to users that a payment has
completely failed when it really has just partially
failed
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch from 0302b7d to e5310ddCompareSeptember 21, 2021 21:40
@TheBlueMatt
TheBlueMatt merged commit 0273ac5 into lightningdevkit:mainSep 21, 2021
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.

Rename PaymentFailed event

3 participants

@valentinewallace@TheBlueMatt@jkczyz
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Rename Event PaymentFailed -> PaymentPathFailed - #1084

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed
Sep 21, 2021
Merged

Rename Event PaymentFailed -> PaymentPathFailed#1084
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed

Conversation

@valentinewallace

Copy link
Copy Markdown
Contributor

And add path field to PaymentPathFailed.

Closes#1081

@codecov

codecovBot commented Sep 20, 2021

Copy link
Copy Markdown

Codecov Report

Merging #1084 (0302b7d) into main (2cf42aa) will decrease coverage by 0.00%.
The diff coverage is 87.17%.

❗ Current head 0302b7d differs from pull request most recent head e5310dd. Consider uploading reports for the commit e5310dd to get more accurate results
Impacted file tree graph

@@ Coverage Diff @@## main #1084 +/- ##
==========================================
- Coverage 90.72% 90.72% -0.01% 
==========================================
Files 65 65 Lines 34212 34225 +13 ==========================================
+ Hits 31039 31049 +10 - Misses 3173 3176 +3 
Impacted FilesCoverage Δ
lightning/src/util/events.rs32.65% <16.66%> (-0.16%)⬇️
lightning/src/ln/chanmon_update_fail_tests.rs97.76% <100.00%> (ø)
lightning/src/ln/channelmanager.rs84.92% <100.00%> (-0.02%)⬇️
lightning/src/ln/functional_test_utils.rs95.08% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs97.37% <100.00%> (+0.01%)⬆️
lightning/src/ln/onion_route_tests.rs97.09% <100.00%> (ø)
lightning/src/routing/network_graph.rs92.14% <100.00%> (+0.01%)⬆️
lightning/src/routing/router.rs95.99% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5262e77...e5310dd. Read the comment docs.

Comment on lines +149 to +205
/// The payment path that failed.
path: Vec<RouteHop>,

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.

So this will be empty for backwards compatibility rather than None? I think that's probably ok but just want to make sure.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

True. Is that an issue for the scorer? It could be an option

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

@jkczyzjkczyzSep 20, 2021

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.

True. Is that an issue for the scorer? It could be an option

Nah, would be better if neither event used Option for symmetry.

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

Do we tag PRs that need to be reflected in the release? Or should we update as we go?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We currently don't have a process for release notes, I generally write the compat section by reading the full-release diff and looking at serialization sections to see the implications of stuff when we cut the release. In the future, we should move towards including release note updates in the PR itself, maybe in a subfolder that just has a long list of release note files. Either way, doesn't have to happen here.

Comment threadlightning/src/ln/functional_test_utils.rs
@jkczyzjkczyz mentioned this pull request Sep 21, 2021
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Will take after #997.

@TheBlueMattTheBlueMatt added this to the 0.0.101 milestone Sep 21, 2021
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch 2 times, most recently from b6fc74d to 0302b7dCompareSeptember 21, 2021 20:49
@valentinewallace

Copy link
Copy Markdown
ContributorAuthor

Rebased!

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Will land after CI, range-diff is:

$ git range-diff 801d6e5256d6ac91d5d5668da1fa5a2b55303246..af73857278bd3d94e86ccc059fedde85697aea82 5262e77ae186e4ea58294a7c6ee05e5649a12fc5..e5310dd5f0347fcaaf21b2742a1084f97fc84bd8
1: 8ef997c8 ! 1: bf16dfd1 Rename PaymentFailed -> PaymentPathFailed
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_permane
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail
check_closed_broadcast!(nodes[0], true);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_tempora
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn test_monitor_update_on_pending_forwards() {
let events = nodes[0].node.get_and_clear_pending_events();
@@ lightning/src/ln/functional_test_utils.rs: pub fn fail_payment_along_route<'a, '
## lightning/src/ln/functional_tests.rs ##
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use
- let events = nodes[1].node.get_and_clear_pending_events();
- assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
- match events[0] {
+ _ => panic!("Unexepected event"),
+ }
+ match events[1] {
- Event::PaymentFailed { ref payment_hash, .. } => {
+ Event::PaymentPathFailed { ref payment_hash, .. } => {
assert_eq!(*payment_hash, fourth_payment_hash);
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backwar
assert!(failed_htlcs.insert(payment_hash.0));
assert!(network_update.is_some());
},
+@@ lightning/src/ln/functional_tests.rs: fn fail_backward_pending_htlc_upon_channel_failure() {
+ assert_eq!(events.len(), 2);
+ // Check that Alice fails backward the pending HTLC from the second payment.
+ match events[0] {
+- Event::PaymentFailed { payment_hash, .. } => {
++ Event::PaymentPathFailed { payment_hash, .. } => {
+ assert_eq!(payment_hash, failed_payment_hash);
+ },
+ _ => panic!("Unexpected event"),
@@ lightning/src/ln/functional_tests.rs: fn test_simple_peer_disconnect() {
_ => panic!("Unexpected event"),
}
2: af738572 ! 2: e5310dd5 Add path field to PaymentPathFailed event
@@ lightning/src/routing/router.rs: use core::cmp;
pub pubkey: PublicKey,
## lightning/src/util/events.rs ##
-@@ lightning/src/util/events.rs: use chain::keysinterface::SpendableOutputDescriptor;
- use ln::msgs;
+@@ lightning/src/util/events.rs: use ln::msgs::DecodeError;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use routing::network_graph::NetworkUpdate;
+ use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
+use routing::router::RouteHop;
- use util::ser::{Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
use bitcoin::blockdata::script::Script;
+ @@ lightning/src/util/events.rs: pub enum Event {
/// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
/// larger MPP payment were still in flight when this event was generated.

Since we don't want to imply to users that a payment has
completely failed when it really has just partially
failed
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch from 0302b7d to e5310ddCompareSeptember 21, 2021 21:40
@TheBlueMatt
TheBlueMatt merged commit 0273ac5 into lightningdevkit:mainSep 21, 2021
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.

Rename PaymentFailed event

3 participants

@valentinewallace@TheBlueMatt@jkczyz
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Rename Event PaymentFailed -> PaymentPathFailed - #1084

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed
Sep 21, 2021
Merged

Rename Event PaymentFailed -> PaymentPathFailed#1084
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed

Conversation

@valentinewallace

Copy link
Copy Markdown
Contributor

And add path field to PaymentPathFailed.

Closes#1081

@codecov

codecovBot commented Sep 20, 2021

Copy link
Copy Markdown

Codecov Report

Merging #1084 (0302b7d) into main (2cf42aa) will decrease coverage by 0.00%.
The diff coverage is 87.17%.

❗ Current head 0302b7d differs from pull request most recent head e5310dd. Consider uploading reports for the commit e5310dd to get more accurate results
Impacted file tree graph

@@ Coverage Diff @@## main #1084 +/- ##
==========================================
- Coverage 90.72% 90.72% -0.01% 
==========================================
Files 65 65 Lines 34212 34225 +13 ==========================================
+ Hits 31039 31049 +10 - Misses 3173 3176 +3 
Impacted FilesCoverage Δ
lightning/src/util/events.rs32.65% <16.66%> (-0.16%)⬇️
lightning/src/ln/chanmon_update_fail_tests.rs97.76% <100.00%> (ø)
lightning/src/ln/channelmanager.rs84.92% <100.00%> (-0.02%)⬇️
lightning/src/ln/functional_test_utils.rs95.08% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs97.37% <100.00%> (+0.01%)⬆️
lightning/src/ln/onion_route_tests.rs97.09% <100.00%> (ø)
lightning/src/routing/network_graph.rs92.14% <100.00%> (+0.01%)⬆️
lightning/src/routing/router.rs95.99% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5262e77...e5310dd. Read the comment docs.

Comment on lines +149 to +205
/// The payment path that failed.
path: Vec<RouteHop>,

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.

So this will be empty for backwards compatibility rather than None? I think that's probably ok but just want to make sure.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

True. Is that an issue for the scorer? It could be an option

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

@jkczyzjkczyzSep 20, 2021

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.

True. Is that an issue for the scorer? It could be an option

Nah, would be better if neither event used Option for symmetry.

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

Do we tag PRs that need to be reflected in the release? Or should we update as we go?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We currently don't have a process for release notes, I generally write the compat section by reading the full-release diff and looking at serialization sections to see the implications of stuff when we cut the release. In the future, we should move towards including release note updates in the PR itself, maybe in a subfolder that just has a long list of release note files. Either way, doesn't have to happen here.

Comment threadlightning/src/ln/functional_test_utils.rs
@jkczyzjkczyz mentioned this pull request Sep 21, 2021
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Will take after #997.

@TheBlueMattTheBlueMatt added this to the 0.0.101 milestone Sep 21, 2021
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch 2 times, most recently from b6fc74d to 0302b7dCompareSeptember 21, 2021 20:49
@valentinewallace

Copy link
Copy Markdown
ContributorAuthor

Rebased!

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Will land after CI, range-diff is:

$ git range-diff 801d6e5256d6ac91d5d5668da1fa5a2b55303246..af73857278bd3d94e86ccc059fedde85697aea82 5262e77ae186e4ea58294a7c6ee05e5649a12fc5..e5310dd5f0347fcaaf21b2742a1084f97fc84bd8
1: 8ef997c8 ! 1: bf16dfd1 Rename PaymentFailed -> PaymentPathFailed
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_permane
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail
check_closed_broadcast!(nodes[0], true);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_tempora
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn test_monitor_update_on_pending_forwards() {
let events = nodes[0].node.get_and_clear_pending_events();
@@ lightning/src/ln/functional_test_utils.rs: pub fn fail_payment_along_route<'a, '
## lightning/src/ln/functional_tests.rs ##
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use
- let events = nodes[1].node.get_and_clear_pending_events();
- assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
- match events[0] {
+ _ => panic!("Unexepected event"),
+ }
+ match events[1] {
- Event::PaymentFailed { ref payment_hash, .. } => {
+ Event::PaymentPathFailed { ref payment_hash, .. } => {
assert_eq!(*payment_hash, fourth_payment_hash);
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backwar
assert!(failed_htlcs.insert(payment_hash.0));
assert!(network_update.is_some());
},
+@@ lightning/src/ln/functional_tests.rs: fn fail_backward_pending_htlc_upon_channel_failure() {
+ assert_eq!(events.len(), 2);
+ // Check that Alice fails backward the pending HTLC from the second payment.
+ match events[0] {
+- Event::PaymentFailed { payment_hash, .. } => {
++ Event::PaymentPathFailed { payment_hash, .. } => {
+ assert_eq!(payment_hash, failed_payment_hash);
+ },
+ _ => panic!("Unexpected event"),
@@ lightning/src/ln/functional_tests.rs: fn test_simple_peer_disconnect() {
_ => panic!("Unexpected event"),
}
2: af738572 ! 2: e5310dd5 Add path field to PaymentPathFailed event
@@ lightning/src/routing/router.rs: use core::cmp;
pub pubkey: PublicKey,
## lightning/src/util/events.rs ##
-@@ lightning/src/util/events.rs: use chain::keysinterface::SpendableOutputDescriptor;
- use ln::msgs;
+@@ lightning/src/util/events.rs: use ln::msgs::DecodeError;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use routing::network_graph::NetworkUpdate;
+ use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
+use routing::router::RouteHop;
- use util::ser::{Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
use bitcoin::blockdata::script::Script;
+ @@ lightning/src/util/events.rs: pub enum Event {
/// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
/// larger MPP payment were still in flight when this event was generated.

Since we don't want to imply to users that a payment has
completely failed when it really has just partially
failed
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch from 0302b7d to e5310ddCompareSeptember 21, 2021 21:40
@TheBlueMatt
TheBlueMatt merged commit 0273ac5 into lightningdevkit:mainSep 21, 2021
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.

Rename PaymentFailed event

3 participants

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

Rename Event PaymentFailed -> PaymentPathFailed - #1084

Merged
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed
Sep 21, 2021
Merged

Rename Event PaymentFailed -> PaymentPathFailed#1084
TheBlueMatt merged 2 commits into
lightningdevkit:mainfrom
valentinewallace:2021-09-rename-paymentfailed

Conversation

@valentinewallace

Copy link
Copy Markdown
Contributor

And add path field to PaymentPathFailed.

Closes#1081

@codecov

codecovBot commented Sep 20, 2021

Copy link
Copy Markdown

Codecov Report

Merging #1084 (0302b7d) into main (2cf42aa) will decrease coverage by 0.00%.
The diff coverage is 87.17%.

❗ Current head 0302b7d differs from pull request most recent head e5310dd. Consider uploading reports for the commit e5310dd to get more accurate results
Impacted file tree graph

@@ Coverage Diff @@## main #1084 +/- ##
==========================================
- Coverage 90.72% 90.72% -0.01% 
==========================================
Files 65 65 Lines 34212 34225 +13 ==========================================
+ Hits 31039 31049 +10 - Misses 3173 3176 +3 
Impacted FilesCoverage Δ
lightning/src/util/events.rs32.65% <16.66%> (-0.16%)⬇️
lightning/src/ln/chanmon_update_fail_tests.rs97.76% <100.00%> (ø)
lightning/src/ln/channelmanager.rs84.92% <100.00%> (-0.02%)⬇️
lightning/src/ln/functional_test_utils.rs95.08% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs97.37% <100.00%> (+0.01%)⬆️
lightning/src/ln/onion_route_tests.rs97.09% <100.00%> (ø)
lightning/src/routing/network_graph.rs92.14% <100.00%> (+0.01%)⬆️
lightning/src/routing/router.rs95.99% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5262e77...e5310dd. Read the comment docs.

Comment on lines +149 to +205
/// The payment path that failed.
path: Vec<RouteHop>,

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.

So this will be empty for backwards compatibility rather than None? I think that's probably ok but just want to make sure.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

True. Is that an issue for the scorer? It could be an option

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

@jkczyzjkczyzSep 20, 2021

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.

True. Is that an issue for the scorer? It could be an option

Nah, would be better if neither event used Option for symmetry.

Yes, vec_type is an option, basically. I agree I think its fine, but should be called out in release notes.

Do we tag PRs that need to be reflected in the release? Or should we update as we go?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

We currently don't have a process for release notes, I generally write the compat section by reading the full-release diff and looking at serialization sections to see the implications of stuff when we cut the release. In the future, we should move towards including release note updates in the PR itself, maybe in a subfolder that just has a long list of release note files. Either way, doesn't have to happen here.

Comment threadlightning/src/ln/functional_test_utils.rs
@jkczyzjkczyz mentioned this pull request Sep 21, 2021
@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Will take after #997.

@TheBlueMattTheBlueMatt added this to the 0.0.101 milestone Sep 21, 2021
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch 2 times, most recently from b6fc74d to 0302b7dCompareSeptember 21, 2021 20:49
@valentinewallace

Copy link
Copy Markdown
ContributorAuthor

Rebased!

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Will land after CI, range-diff is:

$ git range-diff 801d6e5256d6ac91d5d5668da1fa5a2b55303246..af73857278bd3d94e86ccc059fedde85697aea82 5262e77ae186e4ea58294a7c6ee05e5649a12fc5..e5310dd5f0347fcaaf21b2742a1084f97fc84bd8
1: 8ef997c8 ! 1: bf16dfd1 Rename PaymentFailed -> PaymentPathFailed
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_permane
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_temporary_update_fail(disconnect: bool, persister_fail
check_closed_broadcast!(nodes[0], true);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn do_test_simple_monitor_tempora
+ // PaymentPathFailed event
assert_eq!(nodes[0].node.list_channels().len(), 0);
- }
+ check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
@@ lightning/src/ln/chanmon_update_fail_tests.rs: fn test_monitor_update_on_pending_forwards() {
let events = nodes[0].node.get_and_clear_pending_events();
@@ lightning/src/ln/functional_test_utils.rs: pub fn fail_payment_along_route<'a, '
## lightning/src/ln/functional_tests.rs ##
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use
- let events = nodes[1].node.get_and_clear_pending_events();
- assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
- match events[0] {
+ _ => panic!("Unexepected event"),
+ }
+ match events[1] {
- Event::PaymentFailed { ref payment_hash, .. } => {
+ Event::PaymentPathFailed { ref payment_hash, .. } => {
assert_eq!(*payment_hash, fourth_payment_hash);
@@ lightning/src/ln/functional_tests.rs: fn do_test_commitment_revoked_fail_backwar
assert!(failed_htlcs.insert(payment_hash.0));
assert!(network_update.is_some());
},
+@@ lightning/src/ln/functional_tests.rs: fn fail_backward_pending_htlc_upon_channel_failure() {
+ assert_eq!(events.len(), 2);
+ // Check that Alice fails backward the pending HTLC from the second payment.
+ match events[0] {
+- Event::PaymentFailed { payment_hash, .. } => {
++ Event::PaymentPathFailed { payment_hash, .. } => {
+ assert_eq!(payment_hash, failed_payment_hash);
+ },
+ _ => panic!("Unexpected event"),
@@ lightning/src/ln/functional_tests.rs: fn test_simple_peer_disconnect() {
_ => panic!("Unexpected event"),
}
2: af738572 ! 2: e5310dd5 Add path field to PaymentPathFailed event
@@ lightning/src/routing/router.rs: use core::cmp;
pub pubkey: PublicKey,
## lightning/src/util/events.rs ##
-@@ lightning/src/util/events.rs: use chain::keysinterface::SpendableOutputDescriptor;
- use ln::msgs;
+@@ lightning/src/util/events.rs: use ln::msgs::DecodeError;
use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use routing::network_graph::NetworkUpdate;
+ use util::ser::{BigSize, FixedLengthReader, Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
+use routing::router::RouteHop;
- use util::ser::{Writeable, Writer, MaybeReadable, Readable, VecReadWrapper, VecWriteWrapper};
use bitcoin::blockdata::script::Script;
+ @@ lightning/src/util/events.rs: pub enum Event {
/// failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
/// larger MPP payment were still in flight when this event was generated.

Since we don't want to imply to users that a payment has
completely failed when it really has just partially
failed
@valentinewallace
valentinewallaceforce-pushed the 2021-09-rename-paymentfailed branch from 0302b7d to e5310ddCompareSeptember 21, 2021 21:40
@TheBlueMatt
TheBlueMatt merged commit 0273ac5 into lightningdevkit:mainSep 21, 2021
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.

Rename PaymentFailed event

3 participants

@valentinewallace@TheBlueMatt@jkczyz