encore.dev 1.35.3 → 1.36.1

package/log/mod.ts

@@ -1,5 +1,5 @@
-import * as runtime from "../internal/runtime/mod";
 import { getCurrentRequest } from "../internal/reqtrack/mod";
+import * as runtime from "../internal/runtime/mod";
 
 export type { Logger };
 
@@ -110,7 +110,7 @@ class Logger {
     level: runtime.LogLevel,
     errOrMsg: unknown,
     msgOrFields?: unknown,
-    possibleFields?: unknown,
+    possibleFields?: unknown
   ) {
     let err: Error | undefined;
     let msg: string;
@@ -122,10 +122,6 @@ class Logger {
       err = undefined;
       msg = errOrMsg;
       fields = msgOrFields as FieldsObject | undefined;
-
-      // if (possibleFields) {
-      //   throw new Error("Invalid arguments to log");
-      // }
     } else if (typeof msgOrFields === "string") {
       // log(err, msg, fields?)
       if (errOrMsg) {
@@ -157,11 +153,10 @@ class Logger {
 
     const req = getCurrentRequest();
 
-    this.impl.log(req, level, msg, err, fields);
+    this.impl.log(req, level, msg, err, undefined, fields);
   }
 }
 
-// TODO make this resolve to the current request logger instead.
 const log = new Logger(runtime.RT.logger());
 
 /**
@@ -197,20 +192,20 @@ export function warn(err: Error | unknown, fields?: FieldsObject): void;
 export function warn(
   err: Error | unknown,
   msg: string,
-  fields?: FieldsObject,
+  fields?: FieldsObject
 ): void;
 export function warn(msg: string, fields?: FieldsObject): void;
 export function warn(
   errOrMsg: unknown,
   msgOrFields: unknown,
-  fields?: unknown,
+  fields?: unknown
 ) {
   // the type cast here is just for TSC to be happy - the underlying method uses the same overloads so
   // will type check the arguments correctly
   log.warn(
     errOrMsg as Error,
     msgOrFields as string,
-    fields as FieldsObject | undefined,
+    fields as FieldsObject | undefined
   );
 }
 
@@ -221,20 +216,20 @@ export function error(err: Error | unknown, fields?: FieldsObject): void;
 export function error(
   err: Error | unknown,
   msg: string,
-  fields?: FieldsObject,
+  fields?: FieldsObject
 ): void;
 export function error(msg: string, fields?: FieldsObject): void;
 export function error(
   errOrMsg: unknown,
   msgOrFields: unknown,
-  fields?: unknown,
+  fields?: unknown
 ) {
   // the type cast here is just for TSC to be happy - the underlying method uses the same overloads so
   // will type check the arguments correctly
   log.error(
     errOrMsg as Error,
     msgOrFields as string,
-    fields as FieldsObject | undefined,
+    fields as FieldsObject | undefined
   );
 }
 
@@ -245,19 +240,19 @@ export function fatal(err: Error | unknown, fields?: FieldsObject): void;
 export function fatal(
   err: Error | unknown,
   msg: string,
-  fields?: FieldsObject,
+  fields?: FieldsObject
 ): void;
 export function fatal(msg: string, fields?: FieldsObject): void;
 export function fatal(
   errOrMsg: unknown,
   msgOrFields: unknown,
-  fields?: unknown,
+  fields?: unknown
 ) {
   // the type cast here is just for TSC to be happy - the underlying method uses the same overloads so
   // will type check the arguments correctly
   log.fatal(
     errOrMsg as Error,
     msgOrFields as string,
-    fields as FieldsObject | undefined,
+    fields as FieldsObject | undefined
   );
 }

package/mod.ts

@@ -1,4 +1,4 @@
-export { appMeta } from "./meta";
+export { appMeta } from "./app_meta";
 export type {
   AppMeta,
   BuildMeta,
@@ -6,4 +6,14 @@ export type {
   DeployMeta,
   EnvironmentMeta,
   EnvironmentType,
-} from "./meta";
+} from "./app_meta";
+
+export { currentRequest } from "./req_meta";
+export type {
+  APICallMeta,
+  APIDesc,
+  Method,
+  PubSubMessageMeta,
+  RequestMeta,
+  TraceData,
+} from "./req_meta";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "encore.dev",
   "description": "Encore's JavaScript/TypeScript SDK",
-  "version": "1.35.3",
+  "version": "1.36.1",
   "license": "MPL-2.0",
   "bugs": {
     "url": "https://github.com/encoredev/encore/issues"

package/req_meta.ts

@@ -0,0 +1,100 @@
+import { getCurrentRequest } from "./internal/reqtrack/mod";
+
+export interface APIDesc {
+  service: string;
+  endpoint: string;
+  raw: boolean;
+}
+
+export type Method =
+  | "GET"
+  | "POST"
+  | "PUT"
+  | "PATCH"
+  | "DELETE"
+  | "HEAD"
+  | "OPTIONS"
+  | "CONNECT"
+  | "TRACE";
+
+export interface APICallMeta {
+  type: "api-call";
+  api: APIDesc;
+  method: Method;
+  path: string;
+  pathAndQuery: string;
+  pathParams: Record<string, any>;
+  headers: Record<string, string | string[]>;
+  parsedPayload?: Record<string, any>;
+}
+
+export interface PubSubMessageMeta {
+  type: "pubsub-message";
+  service: string;
+  topic: string;
+  subscription: string;
+  messageId: string;
+  deliveryAttempt: number;
+  parsedPayload?: Record<string, any>;
+}
+
+export interface TraceData {
+  traceId: string;
+  spanId: string;
+  parentTraceId?: string;
+  parentSpanId?: string;
+  extCorrelationId?: string;
+}
+
+interface BaseRequestMeta {
+  trace?: TraceData;
+}
+
+export type RequestMeta = (APICallMeta | PubSubMessageMeta) & BaseRequestMeta;
+
+// Returns metadata about the running Encore application.
+//
+// The metadata is cached and is the same object each call,
+// and therefore must not be modified by the caller.
+export function currentRequest(): RequestMeta | undefined {
+  const req = getCurrentRequest();
+  if (!req) {
+    return undefined;
+  }
+  const meta = req.meta();
+
+  const base: BaseRequestMeta = {
+    trace: meta.trace,
+  };
+
+  if (meta.apiCall) {
+    const api: APICallMeta = {
+      type: "api-call",
+      api: {
+        service: meta.apiCall.api.service,
+        endpoint: meta.apiCall.api.endpoint,
+        raw: meta.apiCall.api.raw,
+      },
+      method: meta.apiCall.method as Method,
+      path: meta.apiCall.path,
+      pathAndQuery: meta.apiCall.pathAndQuery,
+      pathParams: meta.apiCall.pathParams ?? {},
+      parsedPayload: meta.apiCall.parsedPayload,
+      headers: meta.apiCall.headers,
+    };
+    return { ...base, ...api };
+  } else if (meta.pubsubMessage) {
+    const msg: PubSubMessageMeta = {
+      type: "pubsub-message",
+      service: meta.pubsubMessage.service,
+      topic: meta.pubsubMessage.topic,
+      subscription: meta.pubsubMessage.subscription,
+      messageId: meta.pubsubMessage.id,
+      deliveryAttempt: meta.pubsubMessage.deliveryAttempt,
+      parsedPayload: meta.pubsubMessage.parsedPayload,
+    };
+    return { ...base, ...msg };
+  } else {
+    return undefined;
+  }
+}

package/dist/meta.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"meta.js","sourceRoot":"","sources":["../meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,wBAAwB,CAAC;AA2ElD,yDAAyD;AACzD,EAAE;AACF,2DAA2D;AAC3D,oDAAoD;AACpD,MAAM,UAAU,OAAO;IACrB,qCAAqC;IACrC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,IAAI,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,GAAG;YACP,KAAK,EAAE,EAAE,CAAC,KAAK;YACf,UAAU,EAAE,EAAE,CAAC,UAAU;YACzB,WAAW,EAAE;gBACX,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI;gBACzB,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC;gBAClC,KAAK,EAAE,aAAa,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC;aAC3C;YACD,KAAK,EAAE;gBACL,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ;gBAC3B,kBAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,kBAAkB;aAChD;YACD,MAAM,EAAE;gBACN,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE;aACjB;SACF,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,OAAO,CAAC,MAA+B;IAC9C,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,OAAO,CAAC,eAAe,CAAC,UAAU;YACrC,OAAO,YAAY,CAAC;QACtB,KAAK,OAAO,CAAC,eAAe,CAAC,WAAW;YACtC,OAAO,aAAa,CAAC;QACvB,KAAK,OAAO,CAAC,eAAe,CAAC,SAAS;YACpC,OAAO,WAAW,CAAC;QACrB,KAAK,OAAO,CAAC,eAAe,CAAC,IAAI;YAC/B,OAAO,MAAM,CAAC;QAChB;YACE,OAAO,aAAa,CAAC;IACzB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,MAA6B;IAClD,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,OAAO,CAAC,aAAa,CAAC,GAAG;YAC5B,OAAO,KAAK,CAAC;QACf,KAAK,OAAO,CAAC,aAAa,CAAC,GAAG;YAC5B,OAAO,KAAK,CAAC;QACf,KAAK,OAAO,CAAC,aAAa,CAAC,KAAK;YAC9B,OAAO,OAAO,CAAC;QACjB,KAAK,OAAO,CAAC,aAAa,CAAC,MAAM;YAC/B,OAAO,QAAQ,CAAC;QAClB,KAAK,OAAO,CAAC,aAAa,CAAC,KAAK;YAC9B,OAAO,OAAO,CAAC;QACjB;YACE,OAAO,OAAO,CAAC;IACnB,CAAC;AACH,CAAC;AAED,6CAA6C;AAC7C,IAAI,MAAM,GAAmB,IAAI,CAAC"}