chore: effect-log.PrettyLogger -> Effect.Logger.pretty

.changeset/young-cars-tell.md

@@ -0,0 +1,7 @@
+---
+"uploadthing": minor
+---
+
+feat: allow different log formats
+
+You can now set any of the [built-in log formats](https://effect.website/docs/guides/observability/logging#built-in-loggers) by passing in the `logFormat` config option.

docs/src/app/(docs)/api-reference/server/page.mdx

@@ -244,6 +244,15 @@ Environment variables follows the naming convention of `UPLOADTHING_<NAME>`
     Enable more verbose logging.
     <Note>If using an older version of the SDK, levels might vary.</Note>
   </Property>
+  <Property
+    name="logFormat"
+    type="json | logFmt | structured | pretty"
+    since="7.1"
+    defaultValue="pretty in development, else json"
+  >
+    What format log entries should be in. [Read more about the log formats
+    here](https://effect.website/docs/guides/observability/logging#built-in-loggers).
+  </Property>
   <Property
     name="isDev"
     type="boolean"

docs/src/app/(docs)/api-reference/ut-api/page.mdx

@@ -69,6 +69,15 @@ Environment variables follows the naming convention of `UPLOADTHING_<NAME>`
     Enable more verbose logging.
     <Note>If using an older version of the SDK, levels might vary.</Note>
   </Property>
+  <Property
+    name="logFormat"
+    type="json | logFmt | structured | pretty"
+    since="7.1"
+    defaultValue="pretty in development, else json"
+  >
+    What format log entries should be in. [Read more about the log formats
+    here](https://effect.website/docs/guides/observability/logging#built-in-loggers).
+  </Property>
   <Property
     name="defaultKeyType"
     type="'fileKey' | 'customId'"

examples/minimal-appdir/src/app/api/uploadthing/route.ts

@@ -6,6 +6,7 @@ export const { GET, POST } = createRouteHandler({
   router: uploadRouter,
   config: {
     logLevel: "Debug",
+    logFormat: "json",
     // handleDaemonPromise: "await",
   },
 });

packages/uploadthing/package.json

@@ -154,8 +154,7 @@
     "@effect/schema": "0.72.2",
     "@uploadthing/mime-types": "workspace:*",
     "@uploadthing/shared": "workspace:*",
-    "effect": "3.7.2",
-    "effect-log": "0.32.0"
+    "effect": "3.7.2"
   },
   "devDependencies": {
     "@remix-run/server-runtime": "^2.12.0",

packages/uploadthing/src/internal/handler.ts

@@ -9,7 +9,6 @@ import {
   HttpServerResponse,
 } from "@effect/platform";
 import * as S from "@effect/schema/Schema";
-import { PrettyLogger } from "effect-log";
 import * as Config from "effect/Config";
 import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";
@@ -32,7 +31,7 @@ import * as pkgJson from "../../package.json";
 import { configProvider, IngestUrl, IsDevelopment, UTToken } from "./config";
 import { formatError } from "./error-formatter";
 import { handleJsonLineStream } from "./jsonl";
-import { withMinimalLogLevel } from "./logger";
+import { withLogFormat, withMinimalLogLevel } from "./logger";
 import { getParseFn } from "./parser";
 import { assertFilesMeetConfig, extractRouterConfig } from "./route-config";
 import {
@@ -69,7 +68,7 @@ export const makeAdapterHandler = <Args extends any[]>(
 ): ((...args: Args) => Promise<Response>) => {
   const layer = Layer.provide(
     Layer.mergeAll(
-      PrettyLogger.layer({ showFiberId: false }),
+      withLogFormat,
       withMinimalLogLevel,
       HttpClient.layer,
       Layer.succeed(

packages/uploadthing/src/internal/logger.ts

@@ -6,6 +6,8 @@ import * as LogLevel from "effect/LogLevel";
 
 import { UploadThingError } from "@uploadthing/shared";
 
+import { IsDevelopment } from "./config";
+
 export const withMinimalLogLevel = Config.logLevel("logLevel").pipe(
   Config.withDefault(LogLevel.Info),
   Effect.andThen((level) => Logger.minimumLogLevel(level)),
@@ -23,3 +25,29 @@ export const withMinimalLogLevel = Config.logLevel("logLevel").pipe(
   ),
   Layer.unwrapEffect,
 );
+
+export const LogFormat = Config.literal(
+  "json",
+  "logFmt",
+  "structured",
+  "pretty",
+)("logFormat");
+
+export const withLogFormat = Effect.gen(function* () {
+  const isDev = yield* IsDevelopment;
+  const logFormat = yield* LogFormat.pipe(
+    Config.withDefault(isDev ? "pretty" : "json"),
+  );
+  return Logger[logFormat];
+}).pipe(
+  Effect.catchTag(
+    "ConfigError",
+    (e) =>
+      new UploadThingError({
+        code: "INVALID_SERVER_CONFIG",
+        message: "Invalid server configuration",
+        cause: e,
+      }),
+  ),
+  Layer.unwrapEffect,
+);

packages/uploadthing/src/internal/types.ts

@@ -1,4 +1,5 @@
 import type { Schema } from "@effect/schema/Schema";
+import type * as Config from "effect/Config";
 import type * as LogLevel from "effect/LogLevel";
 
 import type {
@@ -13,6 +14,7 @@ import type {
   UploadThingError,
 } from "@uploadthing/shared";
 
+import type { LogFormat } from "./logger";
 import type { JsonParser } from "./parser";
 import type {
   FileUploadDataWithCustomId,
@@ -173,6 +175,12 @@ export type FileRouter<TParams extends AnyParams = AnyParams> = Record<
 
 export type RouteHandlerConfig = {
   logLevel?: LogLevel.Literal;
+  /**
+   * What format log entries should be in
+   * @default "pretty" in development, else "json"
+   * @see https://effect.website/docs/guides/observability/logging#built-in-loggers
+   */
+  logFormat?: Config.Config.Success<typeof LogFormat>;
   callbackUrl?: string;
   token?: string;
   /**

packages/uploadthing/src/sdk/index.ts

@@ -4,7 +4,6 @@ import {
   HttpClientResponse,
 } from "@effect/platform";
 import * as S from "@effect/schema/Schema";
-import { PrettyLogger } from "effect-log";
 import * as Arr from "effect/Array";
 import * as Effect from "effect/Effect";
 import * as Layer from "effect/Layer";
@@ -28,7 +27,7 @@ import {
   UPLOADTHING_VERSION,
   UTToken,
 } from "../internal/config";
-import { withMinimalLogLevel } from "../internal/logger";
+import { withLogFormat, withMinimalLogLevel } from "../internal/logger";
 import type {
   ACLUpdateOptions,
   DeleteFilesOptions,
@@ -96,17 +95,18 @@ export class UTApi {
     program: Effect.Effect<A, E, HttpClient.HttpClient.Default>,
     signal?: AbortSignal,
   ) => {
-    return program.pipe(
-      Effect.provide(PrettyLogger.layer({ showFiberId: false })),
-      Effect.provide(withMinimalLogLevel),
-      Effect.provide(HttpClient.layer),
-      Effect.provide(
-        Layer.effect(
-          HttpClient.Fetch,
-          Effect.succeed(this.fetch as typeof globalThis.fetch),
-        ),
+    const layer = Layer.provide(
+      Layer.mergeAll(
+        withLogFormat,
+        withMinimalLogLevel,
+        HttpClient.layer,
+        Layer.succeed(HttpClient.Fetch, this.fetch as typeof globalThis.fetch),
       ),
-      Effect.provide(Layer.setConfigProvider(configProvider(this.opts))),
+      Layer.setConfigProvider(configProvider(this.opts)),
+    );
+
+    return program.pipe(
+      Effect.provide(layer),
       Effect.withLogSpan("utapi.#executeAsync"),
       (e) => Effect.runPromise(e, signal ? { signal } : undefined),
     );

packages/uploadthing/src/sdk/types.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-empty-interface */
 
 import type { Blob as NodeBlob } from "buffer";
+import type * as Config from "effect/Config";
 import type * as LogLevel from "effect/LogLevel";
 
 import type {
@@ -13,6 +14,7 @@ import type {
   Time,
 } from "@uploadthing/shared";
 
+import type { LogFormat } from "../internal/logger";
 import type { UploadedFileData } from "../types";
 
 export interface UTApiOptions {
@@ -30,6 +32,12 @@ export interface UTApiOptions {
    * @default "info"
    */
   logLevel?: LogLevel.Literal;
+  /**
+   * What format log entries should be in
+   * @default "pretty" in development, else "json"
+   * @see https://effect.website/docs/guides/observability/logging#built-in-loggers
+   */
+  logFormat?: Config.Config.Success<typeof LogFormat>;
   /**
    * Set the default key type for file operations. Allows you to set your preferred filter
    * for file keys or custom identifiers without needing to specify it on every call.