Skip to content

Fix compiling lightning-invoice for no-std + serde#2187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TheBlueMatt merged 2 commits into from
Apr 17, 2023
Merged

Fix compiling lightning-invoice for no-std + serde #2187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
778c752
Fix compiling lightning-invoice for no-std + serde
benthecarman Apr 15, 2023
36f610c
Add CI test for compile no-std serde lightning-invoice
benthecarman Apr 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ci/ci-tests.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,11 @@ for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
popd
done
# This one only works for lightning-invoice
pushd lightning-invoice
# check that compile with no-std and serde works in lightning-invoice
cargo test --verbose --color always --no-default-features --features no-std --features serde
popd

echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
Expand Down
2 changes: 1 addition & 1 deletion lightning-invoice/src/lib.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1648,7 +1648,7 @@ impl<'de> Deserialize<'de> for Invoice {
fn deserialize<D>(deserializer: D) -> Result<Invoice, D::Error> where D: Deserializer<'de> {
let bolt11 = String::deserialize(deserializer)?
.parse::<Invoice>()
.map_err(|e| D::Error::custom(format!("{:?}", e)))?;
.map_err(|e| D::Error::custom(alloc::format!("{:?}", e)))?;

@KixunilKixunilApr 17, 2023

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.

Just changing format! to format_args! would've been better since it may avoid allocation.

@TheBlueMattTheBlueMattApr 17, 2023

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.

I don't think so? format_args holds a reference to everything passed, which in this case would mean it has a lifetime bound on the lifetime of e.

More generally, in practice would that ever actually avoid allocation? I'm not particularly farmiliar with serde, but we're passing a Display-implementing object to a generic error type, presumably it'll ~always store the string version of it?

@KixunilKixunilApr 18, 2023

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.

Firstly, if you call format! you have two allocations - one for the string stored inside serde error, the other for the temporary string. So it should be always better to use format_args!.

Secondly while it's true that most if not all serializers in practice do store string, it's possible that someone somewhere decides to write a serializer that directly logs the errors instead of storing them just to minimize allocations here.

@TheBlueMattTheBlueMattApr 21, 2023

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.

Right, but none of that addresses the fact that the extra lifetime implies this won't compile :)

@KixunilKixunilApr 22, 2023

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.

What extra lifetime? serde::de::Error::custom takes any T: Display, there's not 'static bound.

@TheBlueMattTheBlueMattMay 1, 2023

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, but the format_args will have a lifetime which is bounded by the e here which we're map_err'ing. That lifetime bound will fail because it's no longer a live reference once we return from the closure. Similar to how you can't use format_args in if let bounds.

@KixunilKixunilMay 4, 2023

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.

That's not a problem because E::custom doesn't store the argument inside (the signature prevents it). It either stores a String (possibly something exotic like Arc<str>) or logs it.

Anyway, no point in trying to convince you by arguing if I can make a PR :)

@TheBlueMattTheBlueMattMay 4, 2023

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.

Oh oh, I'd somehow read that as a enum variant, rather than a method, missing that the method turns it into a string, instead of trying to place the Display in an enum variant. I really hate Rust sometimes, so many cases of easily seeing what's going on, and a handful of cases where you can't tell what's up from reading the code.

@KixunilKixunilMay 4, 2023

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.

I see. I think casing (custom vs Custom) should've made it clear?

@TheBlueMattTheBlueMattMay 4, 2023

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.

If I'd read it more carefully it would have.


Ok(bolt11)
}
Expand Down
, '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" + '
Fix compiling lightning-invoice for no-std + serde by benthecarman · Pull Request #2187 · lightningdevkit/rust-lightning · GitHub
Skip to content
Fix compiling lightning-invoice for no-std + serde#2187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 17, 2023
 Merged


Fix compiling lightning-invoice for no-std + serde
#2187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
778c752

Fix compiling lightning-invoice for no-std + serde


benthecarman Apr 15, 2023
36f610c

Add CI test for compile no-std serde lightning-invoice


benthecarman Apr 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,11 @@ for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
	RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
	popd
done
# This one only works for lightning-invoice
pushd lightning-invoice
# check that compile with no-std and serde works in lightning-invoice
cargo test --verbose --color always --no-default-features --features no-std --features serde
popd

echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
Expand Down

2 changes: 1 addition & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1648,7 +1648,7 @@ impl<'de> Deserialize<'de> for Invoice {
	fn deserialize<D>(deserializer: D) -> Result<Invoice, D::Error> where D: Deserializer<'de> {
 let bolt11 = String::deserialize(deserializer)?
 .parse::<Invoice>()
 .map_err(|e| D::Error::custom(format!("{:?}", e)))?;
 .map_err(|e| D::Error::custom(alloc::format!("{:?}", e)))?;
@KixunilKixunilApr 17, 2023

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.

Just changing format! to format_args! would've been better since it may avoid allocation.
@TheBlueMattTheBlueMattApr 17, 2023

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.

I don't think so? format_args holds a reference to everything passed, which in this case would mean it has a lifetime bound on the lifetime of e.
More generally, in practice would that ever actually avoid allocation? I'm not particularly farmiliar with serde, but we're passing a Display-implementing object to a generic error type, presumably it'll ~always store the string version of it?
@KixunilKixunilApr 18, 2023

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.

Firstly, if you call format! you have two allocations - one for the string stored inside serde error, the other for the temporary string. So it should be always better to use format_args!.
Secondly while it's true that most if not all serializers in practice do store string, it's possible that someone somewhere decides to write a serializer that directly logs the errors instead of storing them just to minimize allocations here.
@TheBlueMattTheBlueMattApr 21, 2023

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.

Right, but none of that addresses the fact that the extra lifetime implies this won't compile :)
@KixunilKixunilApr 22, 2023

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.

What extra lifetime? serde::de::Error::custom takes any T: Display, there's not 'static bound.
@TheBlueMattTheBlueMattMay 1, 2023

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, but the format_args will have a lifetime which is bounded by the e here which we're map_err'ing. That lifetime bound will fail because it's no longer a live reference once we return from the closure. Similar to how you can't use format_args in if let bounds.
@KixunilKixunilMay 4, 2023

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.

That's not a problem because E::custom doesn't store the argument inside (the signature prevents it). It either stores a String (possibly something exotic like Arc<str>) or logs it.
Anyway, no point in trying to convince you by arguing if I can make a PR :)
@TheBlueMattTheBlueMattMay 4, 2023

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.

Oh oh, I'd somehow read that as a enum variant, rather than a method, missing that the method turns it into a string, instead of trying to place the Display in an enum variant. I really hate Rust sometimes, so many cases of easily seeing what's going on, and a handful of cases where you can't tell what's up from reading the code.
@KixunilKixunilMay 4, 2023

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.

I see. I think casing (custom vs Custom) should've made it clear?
@TheBlueMattTheBlueMattMay 4, 2023

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.

If I'd read it more carefully it would have.

 Ok(bolt11)
	}
Expand Down

, '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('^' + ".*" + '
Fix compiling lightning-invoice for no-std + serde by benthecarman · Pull Request #2187 · lightningdevkit/rust-lightning · GitHub
Skip to content
Fix compiling lightning-invoice for no-std + serde#2187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 17, 2023
 Merged


Fix compiling lightning-invoice for no-std + serde
#2187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
778c752

Fix compiling lightning-invoice for no-std + serde


benthecarman Apr 15, 2023
36f610c

Add CI test for compile no-std serde lightning-invoice


benthecarman Apr 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,11 @@ for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
	RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
	popd
done
# This one only works for lightning-invoice
pushd lightning-invoice
# check that compile with no-std and serde works in lightning-invoice
cargo test --verbose --color always --no-default-features --features no-std --features serde
popd

echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
Expand Down

2 changes: 1 addition & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1648,7 +1648,7 @@ impl<'de> Deserialize<'de> for Invoice {
	fn deserialize<D>(deserializer: D) -> Result<Invoice, D::Error> where D: Deserializer<'de> {
 let bolt11 = String::deserialize(deserializer)?
 .parse::<Invoice>()
 .map_err(|e| D::Error::custom(format!("{:?}", e)))?;
 .map_err(|e| D::Error::custom(alloc::format!("{:?}", e)))?;
@KixunilKixunilApr 17, 2023

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.

Just changing format! to format_args! would've been better since it may avoid allocation.
@TheBlueMattTheBlueMattApr 17, 2023

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.

I don't think so? format_args holds a reference to everything passed, which in this case would mean it has a lifetime bound on the lifetime of e.
More generally, in practice would that ever actually avoid allocation? I'm not particularly farmiliar with serde, but we're passing a Display-implementing object to a generic error type, presumably it'll ~always store the string version of it?
@KixunilKixunilApr 18, 2023

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.

Firstly, if you call format! you have two allocations - one for the string stored inside serde error, the other for the temporary string. So it should be always better to use format_args!.
Secondly while it's true that most if not all serializers in practice do store string, it's possible that someone somewhere decides to write a serializer that directly logs the errors instead of storing them just to minimize allocations here.
@TheBlueMattTheBlueMattApr 21, 2023

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.

Right, but none of that addresses the fact that the extra lifetime implies this won't compile :)
@KixunilKixunilApr 22, 2023

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.

What extra lifetime? serde::de::Error::custom takes any T: Display, there's not 'static bound.
@TheBlueMattTheBlueMattMay 1, 2023

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, but the format_args will have a lifetime which is bounded by the e here which we're map_err'ing. That lifetime bound will fail because it's no longer a live reference once we return from the closure. Similar to how you can't use format_args in if let bounds.
@KixunilKixunilMay 4, 2023

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.

That's not a problem because E::custom doesn't store the argument inside (the signature prevents it). It either stores a String (possibly something exotic like Arc<str>) or logs it.
Anyway, no point in trying to convince you by arguing if I can make a PR :)
@TheBlueMattTheBlueMattMay 4, 2023

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.

Oh oh, I'd somehow read that as a enum variant, rather than a method, missing that the method turns it into a string, instead of trying to place the Display in an enum variant. I really hate Rust sometimes, so many cases of easily seeing what's going on, and a handful of cases where you can't tell what's up from reading the code.
@KixunilKixunilMay 4, 2023

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.

I see. I think casing (custom vs Custom) should've made it clear?
@TheBlueMattTheBlueMattMay 4, 2023

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.

If I'd read it more carefully it would have.

 Ok(bolt11)
	}
Expand Down

, '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('^' + ".*" + '
Fix compiling lightning-invoice for no-std + serde by benthecarman · Pull Request #2187 · lightningdevkit/rust-lightning · GitHub
Skip to content
Fix compiling lightning-invoice for no-std + serde#2187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 17, 2023
 Merged


Fix compiling lightning-invoice for no-std + serde
#2187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
778c752

Fix compiling lightning-invoice for no-std + serde


benthecarman Apr 15, 2023
36f610c

Add CI test for compile no-std serde lightning-invoice


benthecarman Apr 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,11 @@ for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
	RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
	popd
done
# This one only works for lightning-invoice
pushd lightning-invoice
# check that compile with no-std and serde works in lightning-invoice
cargo test --verbose --color always --no-default-features --features no-std --features serde
popd

echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
Expand Down

2 changes: 1 addition & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1648,7 +1648,7 @@ impl<'de> Deserialize<'de> for Invoice {
	fn deserialize<D>(deserializer: D) -> Result<Invoice, D::Error> where D: Deserializer<'de> {
 let bolt11 = String::deserialize(deserializer)?
 .parse::<Invoice>()
 .map_err(|e| D::Error::custom(format!("{:?}", e)))?;
 .map_err(|e| D::Error::custom(alloc::format!("{:?}", e)))?;
@KixunilKixunilApr 17, 2023

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.

Just changing format! to format_args! would've been better since it may avoid allocation.
@TheBlueMattTheBlueMattApr 17, 2023

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.

I don't think so? format_args holds a reference to everything passed, which in this case would mean it has a lifetime bound on the lifetime of e.
More generally, in practice would that ever actually avoid allocation? I'm not particularly farmiliar with serde, but we're passing a Display-implementing object to a generic error type, presumably it'll ~always store the string version of it?
@KixunilKixunilApr 18, 2023

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.

Firstly, if you call format! you have two allocations - one for the string stored inside serde error, the other for the temporary string. So it should be always better to use format_args!.
Secondly while it's true that most if not all serializers in practice do store string, it's possible that someone somewhere decides to write a serializer that directly logs the errors instead of storing them just to minimize allocations here.
@TheBlueMattTheBlueMattApr 21, 2023

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.

Right, but none of that addresses the fact that the extra lifetime implies this won't compile :)
@KixunilKixunilApr 22, 2023

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.

What extra lifetime? serde::de::Error::custom takes any T: Display, there's not 'static bound.
@TheBlueMattTheBlueMattMay 1, 2023

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, but the format_args will have a lifetime which is bounded by the e here which we're map_err'ing. That lifetime bound will fail because it's no longer a live reference once we return from the closure. Similar to how you can't use format_args in if let bounds.
@KixunilKixunilMay 4, 2023

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.

That's not a problem because E::custom doesn't store the argument inside (the signature prevents it). It either stores a String (possibly something exotic like Arc<str>) or logs it.
Anyway, no point in trying to convince you by arguing if I can make a PR :)
@TheBlueMattTheBlueMattMay 4, 2023

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.

Oh oh, I'd somehow read that as a enum variant, rather than a method, missing that the method turns it into a string, instead of trying to place the Display in an enum variant. I really hate Rust sometimes, so many cases of easily seeing what's going on, and a handful of cases where you can't tell what's up from reading the code.
@KixunilKixunilMay 4, 2023

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.

I see. I think casing (custom vs Custom) should've made it clear?
@TheBlueMattTheBlueMattMay 4, 2023

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.

If I'd read it more carefully it would have.

 Ok(bolt11)
	}
Expand Down

, '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" + '
Fix compiling lightning-invoice for no-std + serde by benthecarman · Pull Request #2187 · lightningdevkit/rust-lightning · GitHub
Skip to content
Fix compiling lightning-invoice for no-std + serde#2187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 17, 2023
 Merged


Fix compiling lightning-invoice for no-std + serde
#2187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
778c752

Fix compiling lightning-invoice for no-std + serde


benthecarman Apr 15, 2023
36f610c

Add CI test for compile no-std serde lightning-invoice


benthecarman Apr 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,11 @@ for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
	RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
	popd
done
# This one only works for lightning-invoice
pushd lightning-invoice
# check that compile with no-std and serde works in lightning-invoice
cargo test --verbose --color always --no-default-features --features no-std --features serde
popd

echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
Expand Down

2 changes: 1 addition & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1648,7 +1648,7 @@ impl<'de> Deserialize<'de> for Invoice {
	fn deserialize<D>(deserializer: D) -> Result<Invoice, D::Error> where D: Deserializer<'de> {
 let bolt11 = String::deserialize(deserializer)?
 .parse::<Invoice>()
 .map_err(|e| D::Error::custom(format!("{:?}", e)))?;
 .map_err(|e| D::Error::custom(alloc::format!("{:?}", e)))?;
@KixunilKixunilApr 17, 2023

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.

Just changing format! to format_args! would've been better since it may avoid allocation.
@TheBlueMattTheBlueMattApr 17, 2023

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.

I don't think so? format_args holds a reference to everything passed, which in this case would mean it has a lifetime bound on the lifetime of e.
More generally, in practice would that ever actually avoid allocation? I'm not particularly farmiliar with serde, but we're passing a Display-implementing object to a generic error type, presumably it'll ~always store the string version of it?
@KixunilKixunilApr 18, 2023

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.

Firstly, if you call format! you have two allocations - one for the string stored inside serde error, the other for the temporary string. So it should be always better to use format_args!.
Secondly while it's true that most if not all serializers in practice do store string, it's possible that someone somewhere decides to write a serializer that directly logs the errors instead of storing them just to minimize allocations here.
@TheBlueMattTheBlueMattApr 21, 2023

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.

Right, but none of that addresses the fact that the extra lifetime implies this won't compile :)
@KixunilKixunilApr 22, 2023

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.

What extra lifetime? serde::de::Error::custom takes any T: Display, there's not 'static bound.
@TheBlueMattTheBlueMattMay 1, 2023

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, but the format_args will have a lifetime which is bounded by the e here which we're map_err'ing. That lifetime bound will fail because it's no longer a live reference once we return from the closure. Similar to how you can't use format_args in if let bounds.
@KixunilKixunilMay 4, 2023

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.

That's not a problem because E::custom doesn't store the argument inside (the signature prevents it). It either stores a String (possibly something exotic like Arc<str>) or logs it.
Anyway, no point in trying to convince you by arguing if I can make a PR :)
@TheBlueMattTheBlueMattMay 4, 2023

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.

Oh oh, I'd somehow read that as a enum variant, rather than a method, missing that the method turns it into a string, instead of trying to place the Display in an enum variant. I really hate Rust sometimes, so many cases of easily seeing what's going on, and a handful of cases where you can't tell what's up from reading the code.
@KixunilKixunilMay 4, 2023

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.

I see. I think casing (custom vs Custom) should've made it clear?
@TheBlueMattTheBlueMattMay 4, 2023

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.

If I'd read it more carefully it would have.

 Ok(bolt11)
	}
Expand Down

, '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('^' + ".*" + '
Fix compiling lightning-invoice for no-std + serde by benthecarman · Pull Request #2187 · lightningdevkit/rust-lightning · GitHub
Skip to content
Fix compiling lightning-invoice for no-std + serde#2187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 17, 2023
 Merged


Fix compiling lightning-invoice for no-std + serde
#2187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
778c752

Fix compiling lightning-invoice for no-std + serde


benthecarman Apr 15, 2023
36f610c

Add CI test for compile no-std serde lightning-invoice


benthecarman Apr 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,11 @@ for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
	RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
	popd
done
# This one only works for lightning-invoice
pushd lightning-invoice
# check that compile with no-std and serde works in lightning-invoice
cargo test --verbose --color always --no-default-features --features no-std --features serde
popd

echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
Expand Down

2 changes: 1 addition & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1648,7 +1648,7 @@ impl<'de> Deserialize<'de> for Invoice {
	fn deserialize<D>(deserializer: D) -> Result<Invoice, D::Error> where D: Deserializer<'de> {
 let bolt11 = String::deserialize(deserializer)?
 .parse::<Invoice>()
 .map_err(|e| D::Error::custom(format!("{:?}", e)))?;
 .map_err(|e| D::Error::custom(alloc::format!("{:?}", e)))?;
@KixunilKixunilApr 17, 2023

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.

Just changing format! to format_args! would've been better since it may avoid allocation.
@TheBlueMattTheBlueMattApr 17, 2023

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.

I don't think so? format_args holds a reference to everything passed, which in this case would mean it has a lifetime bound on the lifetime of e.
More generally, in practice would that ever actually avoid allocation? I'm not particularly farmiliar with serde, but we're passing a Display-implementing object to a generic error type, presumably it'll ~always store the string version of it?
@KixunilKixunilApr 18, 2023

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.

Firstly, if you call format! you have two allocations - one for the string stored inside serde error, the other for the temporary string. So it should be always better to use format_args!.
Secondly while it's true that most if not all serializers in practice do store string, it's possible that someone somewhere decides to write a serializer that directly logs the errors instead of storing them just to minimize allocations here.
@TheBlueMattTheBlueMattApr 21, 2023

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.

Right, but none of that addresses the fact that the extra lifetime implies this won't compile :)
@KixunilKixunilApr 22, 2023

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.

What extra lifetime? serde::de::Error::custom takes any T: Display, there's not 'static bound.
@TheBlueMattTheBlueMattMay 1, 2023

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, but the format_args will have a lifetime which is bounded by the e here which we're map_err'ing. That lifetime bound will fail because it's no longer a live reference once we return from the closure. Similar to how you can't use format_args in if let bounds.
@KixunilKixunilMay 4, 2023

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.

That's not a problem because E::custom doesn't store the argument inside (the signature prevents it). It either stores a String (possibly something exotic like Arc<str>) or logs it.
Anyway, no point in trying to convince you by arguing if I can make a PR :)
@TheBlueMattTheBlueMattMay 4, 2023

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.

Oh oh, I'd somehow read that as a enum variant, rather than a method, missing that the method turns it into a string, instead of trying to place the Display in an enum variant. I really hate Rust sometimes, so many cases of easily seeing what's going on, and a handful of cases where you can't tell what's up from reading the code.
@KixunilKixunilMay 4, 2023

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.

I see. I think casing (custom vs Custom) should've made it clear?
@TheBlueMattTheBlueMattMay 4, 2023

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.

If I'd read it more carefully it would have.

 Ok(bolt11)
	}
Expand Down

, '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); }
})();
})();
Fix compiling lightning-invoice for no-std + serde by benthecarman · Pull Request #2187 · lightningdevkit/rust-lightning · GitHub
Skip to content
Fix compiling lightning-invoice for no-std + serde#2187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TheBlueMatt
merged 2 commits into

from

Apr 17, 2023
 Merged


Fix compiling lightning-invoice for no-std + serde
#2187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
778c752

Fix compiling lightning-invoice for no-std + serde


benthecarman Apr 15, 2023
36f610c

Add CI test for compile no-std serde lightning-invoice


benthecarman Apr 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
ci/ci-tests.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,11 @@ for DIR in lightning lightning-invoice lightning-rapid-gossip-sync; do
	RUSTFLAGS="--cfg=c_bindings" cargo test --verbose --color always --no-default-features --features=no-std
	popd
done
# This one only works for lightning-invoice
pushd lightning-invoice
# check that compile with no-std and serde works in lightning-invoice
cargo test --verbose --color always --no-default-features --features no-std --features serde
popd

echo -e "\n\nTesting no-std build on a downstream no-std crate"
# check no-std compatibility across dependencies
Expand Down

2 changes: 1 addition & 1 deletion
lightning-invoice/src/lib.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1648,7 +1648,7 @@ impl<'de> Deserialize<'de> for Invoice {
	fn deserialize<D>(deserializer: D) -> Result<Invoice, D::Error> where D: Deserializer<'de> {
 let bolt11 = String::deserialize(deserializer)?
 .parse::<Invoice>()
 .map_err(|e| D::Error::custom(format!("{:?}", e)))?;
 .map_err(|e| D::Error::custom(alloc::format!("{:?}", e)))?;
@KixunilKixunilApr 17, 2023

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.

Just changing format! to format_args! would've been better since it may avoid allocation.
@TheBlueMattTheBlueMattApr 17, 2023

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.

I don't think so? format_args holds a reference to everything passed, which in this case would mean it has a lifetime bound on the lifetime of e.
More generally, in practice would that ever actually avoid allocation? I'm not particularly farmiliar with serde, but we're passing a Display-implementing object to a generic error type, presumably it'll ~always store the string version of it?
@KixunilKixunilApr 18, 2023

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.

Firstly, if you call format! you have two allocations - one for the string stored inside serde error, the other for the temporary string. So it should be always better to use format_args!.
Secondly while it's true that most if not all serializers in practice do store string, it's possible that someone somewhere decides to write a serializer that directly logs the errors instead of storing them just to minimize allocations here.
@TheBlueMattTheBlueMattApr 21, 2023

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.

Right, but none of that addresses the fact that the extra lifetime implies this won't compile :)
@KixunilKixunilApr 22, 2023

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.

What extra lifetime? serde::de::Error::custom takes any T: Display, there's not 'static bound.
@TheBlueMattTheBlueMattMay 1, 2023

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, but the format_args will have a lifetime which is bounded by the e here which we're map_err'ing. That lifetime bound will fail because it's no longer a live reference once we return from the closure. Similar to how you can't use format_args in if let bounds.
@KixunilKixunilMay 4, 2023

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.

That's not a problem because E::custom doesn't store the argument inside (the signature prevents it). It either stores a String (possibly something exotic like Arc<str>) or logs it.
Anyway, no point in trying to convince you by arguing if I can make a PR :)
@TheBlueMattTheBlueMattMay 4, 2023

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.

Oh oh, I'd somehow read that as a enum variant, rather than a method, missing that the method turns it into a string, instead of trying to place the Display in an enum variant. I really hate Rust sometimes, so many cases of easily seeing what's going on, and a handful of cases where you can't tell what's up from reading the code.
@KixunilKixunilMay 4, 2023

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.

I see. I think casing (custom vs Custom) should've made it clear?
@TheBlueMattTheBlueMattMay 4, 2023

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.

If I'd read it more carefully it would have.

 Ok(bolt11)
	}
Expand Down