Enhancement: Auto-balance Refill and Initial Credit Assignment for New Users

[derhelge]

What features would you like to see added?

I've hacked a simple patch that automatically assigns an initial balance to newly registered OIDC users, although it's currently in a basic form. Additionally, I've set up a script able to replenish user balances with npm run refill-balances x

If there's interest, I could refine these implementations and submit them as separate pull requests.

Please let me know if this aligns with your roadmap and whether I should proceed.

More details

I use npm run refill-balances x in a simple cronjob on the host-system.

Which components are impacted by your request?

General

Pictures

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[mattj2332]

Hi @derhelge

Very keen for this, I am looking at doing exactly the same thing. Are you able to share the changes you've made so far in their current form?

Cheers

[djuillard]

Hello,

interested into this feature as well !!

[Mrs-cmd]

I've been struggling for days with automatically balancing initial credit assignments for new users. Any help, please?

[derhelge]

Hi @Mrs-cmd,

i can post my cronjob Script on monday.

[Mrs-cmd]

Hi @derhelge

Thanks a lot for sharing your script! I really appreciate your help 😊

[derhelge]

Here is a simple/hacky (i am not a js dev) script, adapted from add-balance.js.
And my cronjob cat /etc/cron.d/refill-balances
cat
0 0 1 * * root docker exec LibreChat npm run refill-balances 5000000

So every month every balance from all users is refilled to 5000000.

const path = require('path');
require('module-alias')({ base: path.resolve(__dirname, '..', 'api') });
const { silentExit } = require('./helpers');
const { Transaction } = require('~/models/Transaction');
const User = require('~/models/User');
const Balance = require('~/models/Balance');
const connect = require('./connect');


(async () => {
  await connect();

  console.purple('-----------------------------');
  console.purple('Refilling all user balances through transactions');
  console.purple('-----------------------------');

  let refillAmount = process.argv[2];
  if (!refillAmount) {
    console.red('Usage: npm run refill-balances <amount>');
    silentExit(1);
  }

  refillAmount = parseInt(refillAmount);

  const users = await User.find({});
  let totalRefill = 0; // Variable to keep track of the total refill amount

  for (const user of users) {
    const balance = await Balance.findOne({ user: user._id });
    let currentBalance = balance ? balance.tokenCredits : 0;
    const difference = refillAmount - currentBalance;

    if (difference > 0) {
      // Perform transaction to update the balance
      let result;
      try {
        result = await Transaction.create({
          user: user._id,
          tokenType: 'credits',
          context: 'admin',
          rawAmount: difference,
        });
      } catch (error) {
        console.red(`Error: ${error.message}`);
        console.error(error);
        continue; // Continue with the next user
      }

      if (result && result.balance) {
        totalRefill += difference; // Add the difference to the total refill amount
        const oldBalanceFormatted = currentBalance;
        const refillFormatted = difference;
        const newBalanceFormatted = result.balance;

        console.green(
          `Balanced refilled for ${user.name}. ${oldBalanceFormatted} + ${refillFormatted} = ${newBalanceFormatted}`,
        );
      } else {
        console.red(`Failed to update balance for ${user.name}`);
      }
    } else {
      console.yellow(
        `No refill needed for ${user.name}. Current balance: ${currentBalance}`,
      );
    }
  }

  // Output total refill value
  console.purple('-----------------------------');
  console.purple(`Total amount: ${totalRefill}`);
  console.purple('-----------------------------');

  silentExit(0);
})();

process.on('uncaughtException', (err) => {
  console.error('There was an uncaught error:', err);
  process.exit(1);
});
``