import { autoService, singleton, location } from 'knifecycle';
import { noop } from '../utils/utils.js';
import { type LogService } from './log.js';

export type RandomService = () => number;

/**
 * Instantiate the random service
 * @name initRandom
 * @function
 * @param  {Object}   services           The services to inject
 * @param  {Object}   [services.log = noop]     A logging function
 * @return {Promise<Function>}           A promise of the random function
 * @example
 * import {
 *   DEFAULT_LOGGER,
 *   initLog,
 *   initRandom
 * } from 'common-services';
 *
 * const log = await initLog({
 *   logger: DEFAULT_LOGGER,
 * });
 *
 * const random = await initRandom({
 *   log,
 * });
 */
async function initRandom({
  log = noop,
}: {
  log?: LogService;
}): Promise<RandomService> {
  log('debug', '🎲 - Random service initialized.');

  return random;

  /**
   * Returns a new random number
   * @return {number}   The random number
   * @example
   * random()
   * // Prints: 0.3141592653589793
   */
  function random(): number {
    const num = Math.random();

    log('debug', '🎲 - Created a random number:', num);

    return num;
  }
}

/* Architecture Note #1.3: Random

The `random` service is just proxying [`Math.random`
](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Math/random)
 in a mockable manner.
*/

export default location(singleton(autoService(initRandom)), import.meta.url);