mirror of
https://github.com/IT4Change/gradido.git
synced 2025-12-12 23:35:50 +00:00
migrate data types to decimal initial commit
This commit is contained in:
parent
3fef891073
commit
3ffdf24f80
222
database/migrations/0027-decimal_types.ts
Normal file
222
database/migrations/0027-decimal_types.ts
Normal file
@ -0,0 +1,222 @@
|
||||
/* MIGRATION TO INTRODUCE THE DECIMAL TYPE
|
||||
*
|
||||
* This migration adds fields of type DECIMAL
|
||||
* and corrects the corresponding values of
|
||||
* each by recalculating the history of all
|
||||
* user transactions.
|
||||
*
|
||||
* Furthermore it increases precision of the
|
||||
* stored values and stores additional data
|
||||
* points to avoid repetitive calculations.
|
||||
*
|
||||
* It will also add a link to the last
|
||||
* transaction, creating a linked list
|
||||
*
|
||||
* And it will convert all timestamps to
|
||||
* datetime.
|
||||
*/
|
||||
|
||||
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
|
||||
import Decimal from 'decimal.js-light'
|
||||
|
||||
// Set precision value
|
||||
Decimal.set({
|
||||
precision: 20,
|
||||
rounding: Decimal.ROUND_HALF_UP,
|
||||
})
|
||||
|
||||
const DECAY_START_TIME = new Date('2021-05-13 17:46:31') // GMT+0
|
||||
|
||||
interface Decay {
|
||||
balance: Decimal
|
||||
decay: Decimal | null
|
||||
start: Date | null
|
||||
end: Date | null
|
||||
duration: number | null
|
||||
startBlock: Date
|
||||
}
|
||||
|
||||
export enum TransactionTypeId {
|
||||
CREATION = 1,
|
||||
SEND = 2,
|
||||
RECEIVE = 3,
|
||||
}
|
||||
|
||||
function decayFormula(amount: Decimal, seconds: number): Decimal {
|
||||
return amount.mul(
|
||||
new Decimal('0.9999999780350404897320120231676707941346052083737611936473').pow(seconds),
|
||||
)
|
||||
}
|
||||
|
||||
function calculateDecay(amount: Decimal, from: Date, to: Date): Decay {
|
||||
const fromMs = from.getTime()
|
||||
const toMs = to.getTime()
|
||||
const decayStartBlockMs = DECAY_START_TIME.getTime()
|
||||
|
||||
if (toMs < fromMs) {
|
||||
throw new Error('to < from, reverse decay calculation is invalid')
|
||||
}
|
||||
|
||||
// Initialize with no decay
|
||||
const decay: Decay = {
|
||||
balance: amount,
|
||||
decay: null,
|
||||
start: null,
|
||||
end: null,
|
||||
duration: null,
|
||||
startBlock: DECAY_START_TIME,
|
||||
}
|
||||
|
||||
// decay started after end date; no decay
|
||||
if (decayStartBlockMs > toMs) {
|
||||
return decay
|
||||
}
|
||||
// decay started before start date; decay for full duration
|
||||
if (decayStartBlockMs < fromMs) {
|
||||
decay.start = from
|
||||
decay.duration = (toMs - fromMs) / 1000
|
||||
}
|
||||
// decay started between start and end date; decay from decay start till end date
|
||||
else {
|
||||
decay.start = DECAY_START_TIME
|
||||
decay.duration = (toMs - decayStartBlockMs) / 1000
|
||||
}
|
||||
|
||||
decay.end = to
|
||||
decay.balance = decayFormula(amount, decay.duration)
|
||||
decay.decay = decay.balance.minus(amount)
|
||||
return decay
|
||||
}
|
||||
|
||||
export async function upgrade(queryFn: (query: string, values?: any[]) => Promise<Array<any>>) {
|
||||
// Add Columns
|
||||
|
||||
// add column `previous` for a link to the previous transaction
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` ADD COLUMN `previous` int(10) unsigned DEFAULT NULL AFTER `user_id`;',
|
||||
)
|
||||
// add column `dec_amount` with temporary NULL and DEFAULT NULL definition
|
||||
// TODO default
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` ADD COLUMN `dec_amount` DECIMAL(36,20) NULL DEFAULT NULL AFTER `type_id`;',
|
||||
)
|
||||
// add column `dec_balance` with temporary NULL and DEFAULT NULL definition
|
||||
// TODO default
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` ADD COLUMN `dec_balance` DECIMAL(36,20) NULL DEFAULT NULL AFTER `dec_amount`;',
|
||||
)
|
||||
// add new column `dec_decay` with temporary NULL and DEFAULT NULL definition
|
||||
// TODO default
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` ADD COLUMN `dec_decay` DECIMAL(36,20) NULL DEFAULT NULL AFTER `dec_balance`;',
|
||||
)
|
||||
// add new column `decay_start` with temporary NULL and DEFAULT NULL definition
|
||||
// TODO default
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` ADD COLUMN `decay_start` datetime DEFAULT NULL AFTER `dec_decay`;',
|
||||
)
|
||||
|
||||
// Modify columns
|
||||
|
||||
// modify date type of `balance_date` to datetime
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` MODIFY COLUMN `balance_date` datetime NOT NULL DEFAULT current_timestamp() AFTER `dec_balance`;',
|
||||
)
|
||||
// modify date type of `creation_date` to datetime
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` MODIFY COLUMN `creation_date` datetime NULL DEFAULT NULL AFTER `balance`;',
|
||||
)
|
||||
|
||||
// Temporary columns
|
||||
|
||||
// temporary decimal column `temp_dec_send_sender_final_balance`
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` ADD COLUMN `temp_dec_send_sender_final_balance` DECIMAL(36,20) NULL DEFAULT NULL AFTER `linked_transaction_id`;',
|
||||
)
|
||||
// temporary decimal column `temp_dec_diff_send_sender_final_balance`
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` ADD COLUMN `temp_dec_diff_send_sender_final_balance` DECIMAL(36,20) NULL DEFAULT NULL AFTER `temp_dec_send_sender_final_balance`;',
|
||||
)
|
||||
// temporary decimal column `temp_dec_old_balance`
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` ADD COLUMN `temp_dec_old_balance` DECIMAL(36,20) NULL DEFAULT NULL AFTER `temp_dec_diff_send_sender_final_balance`;',
|
||||
)
|
||||
// temporary decimal column `temp_dec_diff_balance`
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` ADD COLUMN `temp_dec_diff_balance` DECIMAL(36,20) NULL DEFAULT NULL AFTER `temp_dec_old_balance`;',
|
||||
)
|
||||
|
||||
// Find all users & loop over them
|
||||
const users = await queryFn('SELECT user_id FROM transactions GROUP BY user_id')
|
||||
for (let u = 0; u < users.length; u++) {
|
||||
// find all transactions for a user
|
||||
const transactions = await queryFn(
|
||||
`SELECT * FROM transactions WHERE user_id = ${users[u].user_id} ORDER BY balance_date ASC;`,
|
||||
)
|
||||
let previous = null
|
||||
let balance = new Decimal(0)
|
||||
for (let t = 0; t < transactions.length; t++) {
|
||||
const transaction = transactions[t]
|
||||
|
||||
// This should also fix the rounding error on amount
|
||||
let decAmount = new Decimal(transaction.amount).dividedBy(10000).toDecimalPlaces(2)
|
||||
if (transaction.type_id === TransactionTypeId.SEND) {
|
||||
decAmount = decAmount.mul(-1)
|
||||
}
|
||||
// dec_decay
|
||||
const decayStart = previous ? previous.balance_date : transaction.balance_date
|
||||
const decay = calculateDecay(balance, decayStart, transaction.balance_date)
|
||||
balance = decay.balance.add(decAmount)
|
||||
const tempDecSendSenderFinalBalance = transaction.send_sender_final_balance
|
||||
? new Decimal(transaction.send_sender_final_balance).dividedBy(10000)
|
||||
: null
|
||||
const tempDecDiffSendSenderFinalBalance = tempDecSendSenderFinalBalance
|
||||
? balance.minus(tempDecSendSenderFinalBalance)
|
||||
: null
|
||||
const tempDecOldBalance = new Decimal(transaction.balance).dividedBy(10000)
|
||||
const tempDecDiffBalance = balance.minus(tempDecOldBalance)
|
||||
|
||||
// Update
|
||||
await queryFn(`
|
||||
UPDATE transactions SET
|
||||
previous = ${previous ? previous.id : null},
|
||||
dec_amount = ${decAmount.toString()},
|
||||
dec_balance = ${balance.toString()},
|
||||
dec_decay = ${decay.decay ? decay.decay.toString() : '0'},
|
||||
decay_start = "${decayStart.toISOString().slice(0, 19).replace('T', ' ')}",
|
||||
temp_dec_send_sender_final_balance = ${
|
||||
tempDecSendSenderFinalBalance ? tempDecSendSenderFinalBalance.toString() : null
|
||||
},
|
||||
temp_dec_diff_send_sender_final_balance = ${
|
||||
tempDecDiffSendSenderFinalBalance ? tempDecDiffSendSenderFinalBalance.toString() : null
|
||||
},
|
||||
temp_dec_old_balance = ${tempDecOldBalance.toString()},
|
||||
temp_dec_diff_balance = ${tempDecDiffBalance.toString()}
|
||||
WHERE id = ${transaction.id};
|
||||
`)
|
||||
|
||||
// previous
|
||||
previous = transaction
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export async function downgrade(queryFn: (query: string, values?: any[]) => Promise<Array<any>>) {
|
||||
await queryFn('ALTER TABLE `transactions` DROP COLUMN `temp_dec_diff_balance`')
|
||||
await queryFn('ALTER TABLE `transactions` DROP COLUMN `temp_dec_old_balance`;')
|
||||
await queryFn('ALTER TABLE `transactions` DROP COLUMN `temp_dec_diff_send_sender_final_balance`;')
|
||||
await queryFn('ALTER TABLE `transactions` DROP COLUMN `temp_dec_send_sender_final_balance`;')
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` MODIFY COLUMN `creation_date` timestamp NULL DEFAULT NULL AFTER `balance`;',
|
||||
)
|
||||
await queryFn(
|
||||
'ALTER TABLE `transactions` MODIFY COLUMN `balance_date` timestamp NOT NULL DEFAULT current_timestamp() AFTER `dec_balance`;',
|
||||
)
|
||||
await queryFn('ALTER TABLE `transactions` DROP COLUMN `decay_start`;')
|
||||
await queryFn('ALTER TABLE `transactions` DROP COLUMN `dec_decay`;')
|
||||
await queryFn('ALTER TABLE `transactions` DROP COLUMN `dec_balance`;')
|
||||
await queryFn('ALTER TABLE `transactions` DROP COLUMN `dec_amount`;')
|
||||
await queryFn('ALTER TABLE `transactions` DROP COLUMN `previous`;')
|
||||
}
|
||||
@ -38,6 +38,7 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"crypto": "^1.0.1",
|
||||
"decimal.js-light": "^2.5.1",
|
||||
"dotenv": "^10.0.0",
|
||||
"faker": "^5.5.3",
|
||||
"mysql2": "^2.3.0",
|
||||
|
||||
@ -560,6 +560,11 @@ decamelize@^1.2.0:
|
||||
resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290"
|
||||
integrity sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=
|
||||
|
||||
decimal.js-light@^2.5.1:
|
||||
version "2.5.1"
|
||||
resolved "https://registry.yarnpkg.com/decimal.js-light/-/decimal.js-light-2.5.1.tgz#134fd32508f19e208f4fb2f8dac0d2626a867934"
|
||||
integrity sha512-qIMFpTMZmny+MMIitAB6D7iVPEorVw6YQRWkvarTkT4tBeSLLiHzcwj6q0MmYSFCiVpiqPJTJEYIrpcPzVEIvg==
|
||||
|
||||
deep-is@^0.1.3:
|
||||
version "0.1.3"
|
||||
resolved "https://registry.yarnpkg.com/deep-is/-/deep-is-0.1.3.tgz#b369d6fb5dbc13eecf524f91b070feedc357cf34"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user