@shopify/shopify-api/lib/logger/log.ts

Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks

import {LogSeverity} from '../types';
import {ConfigInterface} from '../base-types';

import {LogContext} from './types';

export type LoggerFunction = (
  severity: LogSeverity,
  message: string,
  context?: Record<string, any>,
) => void;

export function log(config: ConfigInterface): LoggerFunction {
  return function (
    severity: LogSeverity,
    message: string,
    context: LogContext = {},
  ): void {
    if (severity > config.logger.level) {
      return;
    }

    const prefix: string[] = [];

    if (config.logger.timestamps) {
      prefix.push(`${new Date().toISOString().slice(0, -5)}Z`);
    }

    let packageString = context.package || 'shopify-api';
    delete context.package;

    switch (severity) {
      case LogSeverity.Debug:
        packageString = `${packageString}/DEBUG`;
        break;
      case LogSeverity.Info:
        packageString = `${packageString}/INFO`;
        break;
      case LogSeverity.Warning:
        packageString = `${packageString}/WARNING`;
        break;
      case LogSeverity.Error:
        packageString = `${packageString}/ERROR`;
        break;
    }

    prefix.push(packageString);

    const contextParts: string[] = [];
    Object.entries(context).forEach(([key, value]) => {
      contextParts.push(`${key}: ${value}`);
    });

    let suffix = '';
    if (contextParts.length > 0) {
      suffix = ` | {${contextParts.join(', ')}}`;
    }

    config.logger.log(severity, `[${prefix.join('] [')}] ${message}${suffix}`);
  };
}