Add custom inference logger for @hf/inference (#1598)

The goal is to pass a custom logging tool (needed mainly by moon). 

I chose a global overwrite instead of an option like fetch to avoid too
many code changes (btw, there are some places where fetch is not
properly overwritten by the options).

I think the best approach would be to have a separate package for
logging to use the same module in the hf.js ecosystem

Author: Kakulukian

packages/inference/src/index.ts

@@ -5,5 +5,6 @@ export * from "./tasks/index.js";
 import * as snippets from "./snippets/index.js";
 export * from "./lib/getProviderHelper.js";
 export * from "./lib/makeRequestOptions.js";
+export { setLogger } from "./lib/logger.js";
 
 export { snippets };

packages/inference/src/lib/getInferenceProviderMapping.ts

@@ -5,6 +5,7 @@ import { EQUIVALENT_SENTENCE_TRANSFORMERS_TASKS } from "../providers/hf-inferenc
 import type { InferenceProvider, InferenceProviderMappingEntry, InferenceProviderOrPolicy, ModelId } from "../types.js";
 import { typedInclude } from "../utils/typedInclude.js";
 import { InferenceClientHubApiError, InferenceClientInputError } from "../errors.js";
+import { getLogger } from "./logger.js";
 
 export const inferenceProviderMappingCache = new Map<ModelId, InferenceProviderMappingEntry[]>();
 
@@ -122,6 +123,7 @@ export async function getInferenceProviderMapping(
 		fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
 	}
 ): Promise<InferenceProviderMappingEntry | null> {
+	const logger = getLogger();
 	if (HARDCODED_MODEL_INFERENCE_MAPPING[params.provider][params.modelId]) {
 		return HARDCODED_MODEL_INFERENCE_MAPPING[params.provider][params.modelId];
 	}
@@ -138,7 +140,7 @@ export async function getInferenceProviderMapping(
 			);
 		}
 		if (providerMapping.status === "staging") {
-			console.warn(
+			logger.warn(
 				`Model ${params.modelId} is in staging mode for provider ${params.provider}. Meant for test purposes only.`
 			);
 		}
@@ -152,6 +154,7 @@ export async function resolveProvider(
 	modelId?: string,
 	endpointUrl?: string
 ): Promise<InferenceProvider> {
+	const logger = getLogger();
 	if (endpointUrl) {
 		if (provider) {
 			throw new InferenceClientInputError("Specifying both endpointUrl and provider is not supported.");
@@ -160,7 +163,7 @@ export async function resolveProvider(
 		return "hf-inference";
 	}
 	if (!provider) {
-		console.log(
+		logger.log(
 			"Defaulting to 'auto' which will select the first provider available for the model, sorted by the user's order in https://hf.co/settings/inference-providers."
 		);
 		provider = "auto";
@@ -171,7 +174,7 @@ export async function resolveProvider(
 		}
 		const mappings = await fetchInferenceProviderMappingForModel(modelId);
 		provider = mappings[0]?.provider as InferenceProvider | undefined;
-		console.log("Auto selected provider:", provider);
+		logger.log("Auto selected provider:", provider);
 	}
 	if (!provider) {
 		throw new InferenceClientInputError(`No Inference Provider available for model ${modelId}.`);

packages/inference/src/lib/logger.ts

@@ -0,0 +1,11 @@
+import type { Logger } from "../types.js";
+
+let globalLogger: Logger = console;
+
+export function setLogger(logger: Logger): void {
+	globalLogger = logger;
+}
+
+export function getLogger(): Logger {
+	return globalLogger;
+}

packages/inference/src/providers/black-forest-labs.ts

@@ -19,6 +19,7 @@ import {
 	InferenceClientProviderApiError,
 	InferenceClientProviderOutputError,
 } from "../errors.js";
+import { getLogger } from "../lib/logger.js";
 import type { BodyParams, HeaderParams, UrlParams } from "../types.js";
 import { delay } from "../utils/delay.js";
 import { omit } from "../utils/omit.js";
@@ -67,10 +68,11 @@ export class BlackForestLabsTextToImageTask extends TaskProviderHelper implement
 		headers?: HeadersInit,
 		outputType?: "url" | "blob"
 	): Promise<string | Blob> {
+		const logger = getLogger();
 		const urlObj = new URL(response.polling_url);
 		for (let step = 0; step < 5; step++) {
 			await delay(1000);
-			console.debug(`Polling Black Forest Labs API for the result... ${step + 1}/5`);
+			logger.debug(`Polling Black Forest Labs API for the result... ${step + 1}/5`);
 			urlObj.searchParams.set("attempt", step.toString(10));
 			const resp = await fetch(urlObj, { headers: { "Content-Type": "application/json" } });
 			if (!resp.ok) {

packages/inference/src/snippets/getInferenceSnippets.ts

@@ -12,6 +12,7 @@ import { getProviderHelper } from "../lib/getProviderHelper.js";
 import { makeRequestOptionsFromResolvedModel } from "../lib/makeRequestOptions.js";
 import type { InferenceProviderMappingEntry, InferenceProviderOrPolicy, InferenceTask, RequestArgs } from "../types.js";
 import { templates } from "./templates.exported.js";
+import { getLogger } from "../lib/logger.js";
 
 export type InferenceSnippetOptions = {
 	streaming?: boolean;
@@ -140,6 +141,7 @@ const snippetGenerator = (templateName: string, inputPreparationFn?: InputPrepar
 		inferenceProviderMapping?: InferenceProviderMappingEntry,
 		opts?: InferenceSnippetOptions
 	): InferenceSnippet[] => {
+		const logger = getLogger();
 		const providerModelId = inferenceProviderMapping?.providerId ?? model.id;
 		/// Hacky: hard-code conversational templates here
 		let task = model.pipeline_tag as InferenceTask;
@@ -156,7 +158,7 @@ const snippetGenerator = (templateName: string, inputPreparationFn?: InputPrepar
 		try {
 			providerHelper = getProviderHelper(provider, task);
 		} catch (e) {
-			console.error(`Failed to get provider helper for ${provider} (${task})`, e);
+			logger.error(`Failed to get provider helper for ${provider} (${task})`, e);
 			return [];
 		}
 
@@ -191,7 +193,7 @@ const snippetGenerator = (templateName: string, inputPreparationFn?: InputPrepar
 			try {
 				providerInputs = JSON.parse(bodyAsObj);
 			} catch (e) {
-				console.error("Failed to parse body as JSON", e);
+				logger.error("Failed to parse body as JSON", e);
 			}
 		}
 

packages/inference/src/tasks/custom/request.ts

@@ -2,6 +2,7 @@ import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
 import { getProviderHelper } from "../../lib/getProviderHelper.js";
 import type { InferenceTask, Options, RequestArgs } from "../../types.js";
 import { innerRequest } from "../../utils/request.js";
+import { getLogger } from "../../lib/logger.js";
 
 /**
  * Primitive to make custom calls to the inference provider
@@ -14,7 +15,8 @@ export async function request<T>(
 		task?: InferenceTask;
 	}
 ): Promise<T> {
-	console.warn(
+	const logger = getLogger();
+	logger.warn(
 		"The request method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead."
 	);
 	const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);

packages/inference/src/tasks/custom/streamingRequest.ts

@@ -2,6 +2,7 @@ import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
 import { getProviderHelper } from "../../lib/getProviderHelper.js";
 import type { InferenceTask, Options, RequestArgs } from "../../types.js";
 import { innerStreamingRequest } from "../../utils/request.js";
+import { getLogger } from "../../lib/logger.js";
 
 /**
  * Primitive to make custom inference calls that expect server-sent events, and returns the response through a generator
@@ -14,7 +15,8 @@ export async function* streamingRequest<T>(
 		task?: InferenceTask;
 	}
 ): AsyncGenerator<T> {
-	console.warn(
+	const logger = getLogger();
+	logger.warn(
 		"The streamingRequest method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead."
 	);
 	const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);

packages/inference/src/types.ts

@@ -5,6 +5,14 @@ import type { ChatCompletionInput, PipelineType, WidgetType } from "@huggingface
  */
 export type ModelId = string;
 
+export interface Logger {
+	debug: (message: string, ...args: unknown[]) => void;
+	info: (message: string, ...args: unknown[]) => void;
+	warn: (message: string, ...args: unknown[]) => void;
+	error: (message: string, ...args: unknown[]) => void;
+	log: (message: string, ...args: unknown[]) => void;
+}
+
 export interface Options {
 	/**
 	 * (Default: true) Boolean. If a request 503s, the request will be retried with the same parameters.