Merge pull request #1773 from giselles-ai/feat-add-logger-types-and-fix-log

feat-add-logger-types-and-fix-log

Author: toyamarinyon

apps/studio.giselles.ai/app/giselle-engine.ts

@@ -27,6 +27,7 @@ import {
 	isProPlan,
 } from "@/services/teams";
 import supabaseStorageDriver from "@/supabase-storage-driver";
+import { logger } from "../lib/logger";
 import {
 	gitHubPullRequestQueryService,
 	gitHubQueryService,
@@ -301,4 +302,5 @@ export const giselleEngine = NextGiselleEngine({
 		xTitle:
 			process.env.VERCEL_ENV === "preview" ? "Giselle(preview)" : "Giselle",
 	},
+	logger,
 });

packages/giselle/package.json

@@ -48,6 +48,7 @@
 		"@types/pg": "catalog:",
 		"@types/react": "catalog:",
 		"@zod/core": "0.11.6",
+		"pino": "catalog:",
 		"tsup": "catalog:",
 		"vitest": "catalog:"
 	},

packages/giselle/src/engine/generations/generate-text.ts

@@ -39,6 +39,7 @@ export function generateText(args: {
 	useAiGateway: boolean;
 	useResumableGeneration: boolean;
 }) {
+	args.context.logger.info("generating text");
 	return useGenerationExecutor({
 		context: args.context,
 		generation: args.generation,

packages/giselle/src/engine/index.ts

@@ -8,6 +8,7 @@ import type {
 	Workspace,
 	WorkspaceId,
 } from "@giselle-sdk/data-type";
+import { noopLogger } from "../logger/noop-logger";
 import {
 	type CreateActInputs,
 	type CreateAndStartActInputs,
@@ -84,6 +85,7 @@ export function GiselleEngine(config: GiselleEngineConfig) {
 		llmProviders: config.llmProviders ?? [],
 		integrationConfigs: config.integrationConfigs ?? {},
 		callbacks: config.callbacks,
+		logger: config.logger ?? noopLogger,
 	};
 	return {
 		copyWorkspace: async (workspaceId: WorkspaceId, name?: string) => {

packages/giselle/src/engine/types.ts

@@ -11,6 +11,7 @@ import type { LanguageModelProvider } from "@giselle-sdk/language-model";
 import type { EmbeddingMetrics, QueryService } from "@giselle-sdk/rag";
 import type { ModelMessage, ProviderMetadata } from "ai";
 import type { Storage } from "unstorage";
+import type { GiselleLogger } from "../logger/types";
 import type { GiselleStorage } from "./experimental_storage";
 import type { VectorStore } from "./experimental_vector-store/types/interface";
 import type {
@@ -71,6 +72,7 @@ export interface GiselleEngineContext {
 		httpReferer: string;
 		xTitle: string;
 	};
+	logger: GiselleLogger;
 }
 
 interface GitHubInstalltionAppAuthResolver {
@@ -154,4 +156,5 @@ export interface GiselleEngineConfig {
 		httpReferer: string;
 		xTitle: string;
 	};
+	logger?: GiselleLogger;
 }

packages/giselle/src/index.ts

@@ -3,4 +3,5 @@ export type {
 	LanguageModelProviders,
 } from "@giselle-sdk/language-model";
 export * from "./engine";
+export * from "./logger/types";
 export * from "./utils";

packages/giselle/src/logger/noop-logger.ts

@@ -0,0 +1,12 @@
+import type { GiselleLogger } from "./types";
+
+const noop = (..._args: unknown[]): void => {};
+
+export const noopLogger: GiselleLogger = {
+	info: noop,
+	warn: noop,
+	error: noop,
+	debug: noop,
+	trace: noop,
+	fatal: noop,
+};

packages/giselle/src/logger/types.ts

@@ -0,0 +1,6 @@
+import type { Logger } from "pino";
+
+export type GiselleLogger = Pick<
+	Logger,
+	"info" | "warn" | "error" | "debug" | "trace" | "fatal"
+>;

pnpm-lock.yaml

@@ -92,3 +92,4 @@ catalog:
   "@aws-sdk/client-s3": 3.842.0
   "@ai-sdk/provider": 2.0.0
   nuqs: 2.4.3
+  pino: 9.9.0