sqldb+invoices: fix incorrectly stored invoice expiries when using native SQL #8855

bhandras · 2024-06-21T17:12:51Z

Previously, when using the native schema, invoice expiries were incorrectly stored as 64-bit values (expiry in nanoseconds instead of seconds), causing overflow issues. Since we cannot determine the original values, we will set the expiries for existing invoices to 1 hour with this migration.

Based on #8854 only the last 5 commits are part of this PR.

coderabbitai · 2024-06-21T17:12:58Z

Important

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (1)

llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

saubyk · 2024-06-25T15:34:42Z

Since we cannot determine the original values

Question: Can you please elaborate on this? Is it because the precision will be lost when dividing the stored values by 1,000,000,000 to convert the nanoseconds into seconds?

bhandras · 2024-06-25T17:12:26Z

Since we cannot determine the original values

Question: Can you please elaborate on this? Is it because the precision will be lost when dividing the stored values by 1,000,000,000 to convert the nanoseconds into seconds?

Since 64-bit nanosecond values are truncated to 32 bits, we lose 32 bits of information, making it impossible to accurately determine the original intended values. Please note that this issue only affects newly stored invoices and only impacts users who are using native SQL.

sqldb/sqlc/migrations/000004_invoice_expiry_fix.down.sql

ProofOfKeags · 2024-06-26T21:47:58Z

sqldb/sqlc/migrations/000004_invoice_expiry_fix.up.sql

+-- Update the expiry to 3600 seconds (1 hour) for all records in the invoices
+-- table. This is needed as previously we stored raw time.Duration values which
+-- are 64 bit integers and are used to express duration in nanoseconds however
+-- the intent is to store invoice expiry in seconds.
+UPDATE invoices SET expiry = 3600;


sqldb/sqlite.go

ellemouton

Nice - tACK - LGTM ✅

tested the following:

Before this PR:

Add invoice
see that expiry watcher uses correct expiry
but incorrect expiry persisted
on restart, invoice immediately expired & payer cannot pay

Transitioning to this PR:

on master, add the invoice.
restart LND with this PR
see that persisted expiry is 3600
invoice is loaded & payer can pay

My main comment is around potentially matching the default expiry that LND actually uses for new invoices though, which is 24 hrs, not 1 hr.

sqldb/sqlc/migrations/000004_invoice_expiry_fix.down.sql

sqldb/migrations.go

sqldb/sqlite.go

sqldb/sqlc/migrations/000004_invoice_expiry_fix.up.sql

bhandras

Thank you for the thorough review and insightful comments @ellemouton! Much appreciated :)

sqldb/sqlite.go

sqldb/migrations.go

sqldb/sqlc/migrations/000004_invoice_expiry_fix.up.sql

sqldb/sqlite.go

docs/release-notes/release-notes-0.18.2.md

saubyk

LGTM 💾

ellemouton · 2024-07-01T17:01:17Z

@bhandras - just picked this up while going through some route blinding stuff: I see that for AMP invoices, our default is actually 30 days (instead of 24 hours like as for non-amp invoices). Is that potentially something we want to take into account?

bhandras · 2024-07-01T18:05:38Z

@bhandras - just picked this up while going through some route blinding stuff: I see that for AMP invoices, our default is actually 30 days (instead of 24 hours like as for non-amp invoices). Is that potentially something we want to take into account?

Good catch, thank you! Let me update the PR to also fix times for AMP invoices before we merge. Will re-req when done.

bhandras · 2024-07-02T17:12:23Z

List of changes since last round:

AMP invoices are migrated to 30d expiry
Fixed some issues with the postgres test helpers
Added coverage for AMP invoices as well as running the migration test for both sqlite and postgres
Switched from pq to pgx for consistency and because it is better maintained

Diff: https://github.com/lightningnetwork/lnd/compare/a50d8bd58bbc08bd0f75761315a6551a502664bc..b5661d6263cba46773971ccbf357dc70e7572460

PTAL :)

ellemouton

LGTM! 🚢

sqldb/migrations_test.go

Previously, when using the native schema, invoice expiries were incorrectly stored as 64-bit values (expiry in nanoseconds instead of seconds), causing overflow issues. Since we cannot determine the original values, we will set the expiries for existing invoices to 1 hour with this migration.

Based on: lightninglabs/taproot-assets#707

Completely switch to the better maintained pgx driver.

bhandras added the database Related to the database/storage of LND label Jun 21, 2024

bhandras self-assigned this Jun 21, 2024

bhandras added the migration label Jun 21, 2024

bhandras mentioned this pull request Jun 21, 2024

invoices: migrate KV invoices to native SQL for users of KV SQL backends #8831

Merged

saubyk modified the milestones: 0.19.0, v0.18.1 Jun 21, 2024

bhandras marked this pull request as ready for review June 24, 2024 14:07

bhandras force-pushed the invoice-expiry-migration branch from 8a4ca1c to ea7f097 Compare June 25, 2024 13:57

saubyk added the P1 MUST be fixed or reviewed label Jun 25, 2024

saubyk requested review from ellemouton and ProofOfKeags June 25, 2024 16:42

ProofOfKeags approved these changes Jun 26, 2024

View reviewed changes

bhandras force-pushed the invoice-expiry-migration branch from ea7f097 to 1dd86ad Compare June 27, 2024 20:48

ProofOfKeags approved these changes Jun 27, 2024

View reviewed changes

ellemouton approved these changes Jun 27, 2024

View reviewed changes

bhandras force-pushed the invoice-expiry-migration branch 2 times, most recently from c0fb4df to afe3d2e Compare June 28, 2024 13:42

bhandras commented Jun 28, 2024

View reviewed changes

sqldb/sqlite.go Outdated Show resolved Hide resolved

sqldb/migrations.go Outdated Show resolved Hide resolved

sqldb/sqlc/migrations/000004_invoice_expiry_fix.up.sql Outdated Show resolved Hide resolved

sqldb/sqlite.go Show resolved Hide resolved

saubyk requested changes Jun 29, 2024

View reviewed changes

docs/release-notes/release-notes-0.18.2.md Outdated Show resolved Hide resolved

bhandras force-pushed the invoice-expiry-migration branch from afe3d2e to a50d8bd Compare June 29, 2024 07:01

bhandras requested a review from saubyk June 29, 2024 07:01

saubyk approved these changes Jun 29, 2024

View reviewed changes

bhandras force-pushed the invoice-expiry-migration branch from a50d8bd to a779bc3 Compare July 2, 2024 17:10

bhandras requested a review from ellemouton July 2, 2024 17:11

bhandras force-pushed the invoice-expiry-migration branch 2 times, most recently from b5661d6 to eed34f8 Compare July 8, 2024 08:19

ellemouton approved these changes Jul 9, 2024

View reviewed changes

sqldb/migrations_test.go Show resolved Hide resolved

bhandras added 6 commits July 9, 2024 08:39

sqldb: extract migration into method

5292c76

Based on: lightninglabs/taproot-assets#707

sqldb: add helpers to create test DBs migrated up to a select version

ed36598

sqldb: add unit test for the invoice expiry migration

95b9942

sqldb: switch away from pq to pgx for Postgres

d0c1cec

Completely switch to the better maintained pgx driver.

docs: update release notes for 0.18.3-beta

053faa6

bhandras force-pushed the invoice-expiry-migration branch from eed34f8 to 053faa6 Compare July 9, 2024 06:40

guggero approved these changes Jul 9, 2024

View reviewed changes

guggero merged commit a965535 into lightningnetwork:master Jul 9, 2024
30 of 34 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sqldb+invoices: fix incorrectly stored invoice expiries when using native SQL #8855

sqldb+invoices: fix incorrectly stored invoice expiries when using native SQL #8855

bhandras commented Jun 21, 2024 •

edited

Loading

coderabbitai bot commented Jun 21, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

saubyk commented Jun 25, 2024 •

edited

Loading

bhandras commented Jun 25, 2024

ProofOfKeags Jun 26, 2024

ellemouton left a comment

bhandras left a comment

saubyk left a comment

ellemouton commented Jul 1, 2024

bhandras commented Jul 1, 2024

bhandras commented Jul 2, 2024 •

edited

Loading

ellemouton left a comment

sqldb+invoices: fix incorrectly stored invoice expiries when using native SQL #8855

sqldb+invoices: fix incorrectly stored invoice expiries when using native SQL #8855

Conversation

bhandras commented Jun 21, 2024 • edited Loading

coderabbitai bot commented Jun 21, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

saubyk commented Jun 25, 2024 • edited Loading

bhandras commented Jun 25, 2024

ProofOfKeags Jun 26, 2024

Choose a reason for hiding this comment

ellemouton left a comment

Choose a reason for hiding this comment

Before this PR:

Transitioning to this PR:

bhandras left a comment

Choose a reason for hiding this comment

saubyk left a comment

Choose a reason for hiding this comment

ellemouton commented Jul 1, 2024

bhandras commented Jul 1, 2024

bhandras commented Jul 2, 2024 • edited Loading

ellemouton left a comment

Choose a reason for hiding this comment

bhandras commented Jun 21, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

saubyk commented Jun 25, 2024 •

edited

Loading

bhandras commented Jul 2, 2024 •

edited

Loading