Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/remove-flush-async.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"braintrust": major
---

ref!: Remove `flushAsync` option
1 change: 0 additions & 1 deletion e2e/helpers/prod-forwarding.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,6 @@ export async function initializeProdForwarding(): Promise<void> {
const logger = initLogger({
apiKey,
appUrl: process.env.BRAINTRUST_APP_URL,
asyncFlush: false,
forceLogin: true,
projectName,
});
Expand Down
15 changes: 5 additions & 10 deletions integrations/langchain-js/src/BraintrustCallbackHandler.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,23 +11,18 @@ import {
type LangChainCallbackHandlerOptions,
} from "braintrust";

type BraintrustCallbackHandlerOptions<IsAsyncFlush extends boolean> =
LangChainCallbackHandlerOptions<IsAsyncFlush>;
type BraintrustCallbackHandlerOptions = LangChainCallbackHandlerOptions;

/**
* A Braintrust tracer for LangChain.js that logs LLM calls, chains, and tools.
*/
export class BraintrustCallbackHandler<
IsAsyncFlush extends boolean,
> extends BaseCallbackHandler {
export class BraintrustCallbackHandler extends BaseCallbackHandler {
name = "BraintrustCallbackHandler";
private inner: BraintrustLangChainCallbackHandler<IsAsyncFlush>;
private inner: BraintrustLangChainCallbackHandler;

constructor(
options?: Partial<BraintrustCallbackHandlerOptions<IsAsyncFlush>>,
) {
constructor(options?: Partial<BraintrustCallbackHandlerOptions>) {
super();
this.inner = new BraintrustLangChainCallbackHandler<IsAsyncFlush>(options);
this.inner = new BraintrustLangChainCallbackHandler(options);
}

handleLLMStart(
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -118,7 +118,7 @@ function getTimeElapsed(end?: string, start?: string): number | undefined {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe(
TEST_SUITE_OPTIONS,
() => {
let backgroundLogger: TestBackgroundLogger;
let _logger: Logger<false>;
let _logger: Logger;
let Agent: any;
let run: any;
let tool: any;
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand Down
3 changes: 0 additions & 3 deletions js/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,11 @@ export type {
InitLoggerOptions,
InitOptions,
LoadPromptOptions,
LogOptions,
LoginOptions,
Logs3OverflowInputRow,
Logs3OverflowUpload,
MetricSummary,
ObjectMetadata,
PromiseUnless,
PropagationContext,
PromptRowWithId,
ScoreSummary,
Expand DownExpand Up@@ -125,7 +123,6 @@ export {
withCurrent,
withDataset,
withExperiment,
withLogger,
withParent,
wrapTraced,
registerOtelFlush,
Expand Down
4 changes: 2 additions & 2 deletions js/src/instrumentation/providers/eve-instrumentation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -585,7 +585,7 @@ class EveBridge {
turn: TurnState,
event: { input?: unknown; output?: unknown },
): void {
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
root_span_id: turn.rootSpanId,
span_id: turn.spanId,
Expand DownExpand Up@@ -637,7 +637,7 @@ class EveBridge {
if (Object.keys(totals).length === 0) {
return;
}
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
metrics: totals,
root_span_id: turn.rootSpanId,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand DownExpand Up@@ -180,7 +180,7 @@ function parseUsageMetrics(usage: unknown): Record<string, number> {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
70 changes: 69 additions & 1 deletion js/src/logger.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/consistent-type-assertions */

import { vi, expect, test, describe, beforeEach, afterEach } from "vitest";
import {
vi,
expect,
expectTypeOf,
test,
describe,
beforeEach,
afterEach,
} from "vitest";
import {
_exportsForTestingOnly,
init,
Expand All@@ -11,6 +19,7 @@ import {
loadPrompt,
loadParameters,
wrapTraced,
traced,
currentSpan,
withParent,
startSpan,
Expand All@@ -19,6 +28,8 @@ import {
deepCopyEvent,
ReadonlyExperiment,
renderMessageImpl,
flush,
type InitLoggerOptions,
} from "./logger";

import { configureNode } from "./node/config";
Expand All@@ -31,6 +42,12 @@ import { SpanCache } from "./span-cache";

configureNode();

type InitLoggerHasAsyncFlush = "asyncFlush" extends keyof InitLoggerOptions
? true
: false;

expectTypeOf<InitLoggerHasAsyncFlush>().toEqualTypeOf<false>();

test("renderMessage with file content parts", () => {
const message = {
role: "user" as const,
Expand DownExpand Up@@ -426,6 +443,57 @@ test("verify MemoryBackgroundLogger intercepts logs", async () => {
_exportsForTestingOnly.clearTestBackgroundLogger(); // can go back to normal
});

test("logger and tracing APIs preserve return shapes without implicit flushing", async () => {
await _exportsForTestingOnly.simulateLoginForTests();
const backgroundLogger = _exportsForTestingOnly.useTestBackgroundLogger();
const flushSpy = vi.spyOn(backgroundLogger, "flush");

try {
const logger = initLogger({
projectName: "test",
projectId: "test-project-id",
});

const id = logger.log({ input: "input" });
expectTypeOf(id).toEqualTypeOf<string>();

const loggerSyncResult = logger.traced(() => 42 as const);
expectTypeOf(loggerSyncResult).toEqualTypeOf<42>();
expect(loggerSyncResult).toBe(42);

const loggerAsyncResult = logger.traced(async () => 43);
expectTypeOf(loggerAsyncResult).toEqualTypeOf<Promise<number>>();
await expect(loggerAsyncResult).resolves.toBe(43);

const tracedSyncResult = traced(() => "sync" as const);
expectTypeOf(tracedSyncResult).toEqualTypeOf<"sync">();
expect(tracedSyncResult).toBe("sync");

const syncFunction = (value: number) => value + 1;
const wrappedSyncFunction = wrapTraced(syncFunction);
expectTypeOf(wrappedSyncFunction).toEqualTypeOf<typeof syncFunction>();
expect(wrappedSyncFunction(1)).toBe(2);

const asyncFunction = async (value: number) => value + 1;
const wrappedAsyncFunction = wrapTraced(asyncFunction);
expectTypeOf(wrappedAsyncFunction).toEqualTypeOf<typeof asyncFunction>();
await expect(wrappedAsyncFunction(2)).resolves.toBe(3);

expect(flushSpy).not.toHaveBeenCalled();

await logger.flush();
const span = logger.startSpan({ name: "explicit-flush" });
span.end();
await span.flush();
await flush();

expect(flushSpy).toHaveBeenCalledTimes(3);
} finally {
_exportsForTestingOnly.clearTestBackgroundLogger();
_exportsForTestingOnly.simulateLogoutForTests();
}
});

test("init validation", () => {
expect(() => init({})).toThrow(
"Must specify at least one of project or projectId",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
ref!: Remove `flushAsync` option by lforst · Pull Request #2409 · braintrustdata/braintrust-sdk-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/remove-flush-async.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"braintrust": major
---

ref!: Remove `flushAsync` option
1 change: 0 additions & 1 deletion e2e/helpers/prod-forwarding.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,6 @@ export async function initializeProdForwarding(): Promise<void> {
const logger = initLogger({
apiKey,
appUrl: process.env.BRAINTRUST_APP_URL,
asyncFlush: false,
forceLogin: true,
projectName,
});
Expand Down
15 changes: 5 additions & 10 deletions integrations/langchain-js/src/BraintrustCallbackHandler.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,23 +11,18 @@ import {
type LangChainCallbackHandlerOptions,
} from "braintrust";

type BraintrustCallbackHandlerOptions<IsAsyncFlush extends boolean> =
LangChainCallbackHandlerOptions<IsAsyncFlush>;
type BraintrustCallbackHandlerOptions = LangChainCallbackHandlerOptions;

/**
* A Braintrust tracer for LangChain.js that logs LLM calls, chains, and tools.
*/
export class BraintrustCallbackHandler<
IsAsyncFlush extends boolean,
> extends BaseCallbackHandler {
export class BraintrustCallbackHandler extends BaseCallbackHandler {
name = "BraintrustCallbackHandler";
private inner: BraintrustLangChainCallbackHandler<IsAsyncFlush>;
private inner: BraintrustLangChainCallbackHandler;

constructor(
options?: Partial<BraintrustCallbackHandlerOptions<IsAsyncFlush>>,
) {
constructor(options?: Partial<BraintrustCallbackHandlerOptions>) {
super();
this.inner = new BraintrustLangChainCallbackHandler<IsAsyncFlush>(options);
this.inner = new BraintrustLangChainCallbackHandler(options);
}

handleLLMStart(
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -118,7 +118,7 @@ function getTimeElapsed(end?: string, start?: string): number | undefined {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe(
TEST_SUITE_OPTIONS,
() => {
let backgroundLogger: TestBackgroundLogger;
let _logger: Logger<false>;
let _logger: Logger;
let Agent: any;
let run: any;
let tool: any;
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand Down
3 changes: 0 additions & 3 deletions js/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,11 @@ export type {
InitLoggerOptions,
InitOptions,
LoadPromptOptions,
LogOptions,
LoginOptions,
Logs3OverflowInputRow,
Logs3OverflowUpload,
MetricSummary,
ObjectMetadata,
PromiseUnless,
PropagationContext,
PromptRowWithId,
ScoreSummary,
Expand DownExpand Up@@ -125,7 +123,6 @@ export {
withCurrent,
withDataset,
withExperiment,
withLogger,
withParent,
wrapTraced,
registerOtelFlush,
Expand Down
4 changes: 2 additions & 2 deletions js/src/instrumentation/providers/eve-instrumentation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -585,7 +585,7 @@ class EveBridge {
turn: TurnState,
event: { input?: unknown; output?: unknown },
): void {
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
root_span_id: turn.rootSpanId,
span_id: turn.spanId,
Expand DownExpand Up@@ -637,7 +637,7 @@ class EveBridge {
if (Object.keys(totals).length === 0) {
return;
}
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
metrics: totals,
root_span_id: turn.rootSpanId,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand DownExpand Up@@ -180,7 +180,7 @@ function parseUsageMetrics(usage: unknown): Record<string, number> {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
70 changes: 69 additions & 1 deletion js/src/logger.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/consistent-type-assertions */

import { vi, expect, test, describe, beforeEach, afterEach } from "vitest";
import {
vi,
expect,
expectTypeOf,
test,
describe,
beforeEach,
afterEach,
} from "vitest";
import {
_exportsForTestingOnly,
init,
Expand All@@ -11,6 +19,7 @@ import {
loadPrompt,
loadParameters,
wrapTraced,
traced,
currentSpan,
withParent,
startSpan,
Expand All@@ -19,6 +28,8 @@ import {
deepCopyEvent,
ReadonlyExperiment,
renderMessageImpl,
flush,
type InitLoggerOptions,
} from "./logger";

import { configureNode } from "./node/config";
Expand All@@ -31,6 +42,12 @@ import { SpanCache } from "./span-cache";

configureNode();

type InitLoggerHasAsyncFlush = "asyncFlush" extends keyof InitLoggerOptions
? true
: false;

expectTypeOf<InitLoggerHasAsyncFlush>().toEqualTypeOf<false>();

test("renderMessage with file content parts", () => {
const message = {
role: "user" as const,
Expand DownExpand Up@@ -426,6 +443,57 @@ test("verify MemoryBackgroundLogger intercepts logs", async () => {
_exportsForTestingOnly.clearTestBackgroundLogger(); // can go back to normal
});

test("logger and tracing APIs preserve return shapes without implicit flushing", async () => {
await _exportsForTestingOnly.simulateLoginForTests();
const backgroundLogger = _exportsForTestingOnly.useTestBackgroundLogger();
const flushSpy = vi.spyOn(backgroundLogger, "flush");

try {
const logger = initLogger({
projectName: "test",
projectId: "test-project-id",
});

const id = logger.log({ input: "input" });
expectTypeOf(id).toEqualTypeOf<string>();

const loggerSyncResult = logger.traced(() => 42 as const);
expectTypeOf(loggerSyncResult).toEqualTypeOf<42>();
expect(loggerSyncResult).toBe(42);

const loggerAsyncResult = logger.traced(async () => 43);
expectTypeOf(loggerAsyncResult).toEqualTypeOf<Promise<number>>();
await expect(loggerAsyncResult).resolves.toBe(43);

const tracedSyncResult = traced(() => "sync" as const);
expectTypeOf(tracedSyncResult).toEqualTypeOf<"sync">();
expect(tracedSyncResult).toBe("sync");

const syncFunction = (value: number) => value + 1;
const wrappedSyncFunction = wrapTraced(syncFunction);
expectTypeOf(wrappedSyncFunction).toEqualTypeOf<typeof syncFunction>();
expect(wrappedSyncFunction(1)).toBe(2);

const asyncFunction = async (value: number) => value + 1;
const wrappedAsyncFunction = wrapTraced(asyncFunction);
expectTypeOf(wrappedAsyncFunction).toEqualTypeOf<typeof asyncFunction>();
await expect(wrappedAsyncFunction(2)).resolves.toBe(3);

expect(flushSpy).not.toHaveBeenCalled();

await logger.flush();
const span = logger.startSpan({ name: "explicit-flush" });
span.end();
await span.flush();
await flush();

expect(flushSpy).toHaveBeenCalledTimes(3);
} finally {
_exportsForTestingOnly.clearTestBackgroundLogger();
_exportsForTestingOnly.simulateLogoutForTests();
}
});

test("init validation", () => {
expect(() => init({})).toThrow(
"Must specify at least one of project or projectId",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' ref!: Remove `flushAsync` option by lforst · Pull Request #2409 · braintrustdata/braintrust-sdk-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/remove-flush-async.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"braintrust": major
---

ref!: Remove `flushAsync` option
1 change: 0 additions & 1 deletion e2e/helpers/prod-forwarding.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,6 @@ export async function initializeProdForwarding(): Promise<void> {
const logger = initLogger({
apiKey,
appUrl: process.env.BRAINTRUST_APP_URL,
asyncFlush: false,
forceLogin: true,
projectName,
});
Expand Down
15 changes: 5 additions & 10 deletions integrations/langchain-js/src/BraintrustCallbackHandler.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,23 +11,18 @@ import {
type LangChainCallbackHandlerOptions,
} from "braintrust";

type BraintrustCallbackHandlerOptions<IsAsyncFlush extends boolean> =
LangChainCallbackHandlerOptions<IsAsyncFlush>;
type BraintrustCallbackHandlerOptions = LangChainCallbackHandlerOptions;

/**
* A Braintrust tracer for LangChain.js that logs LLM calls, chains, and tools.
*/
export class BraintrustCallbackHandler<
IsAsyncFlush extends boolean,
> extends BaseCallbackHandler {
export class BraintrustCallbackHandler extends BaseCallbackHandler {
name = "BraintrustCallbackHandler";
private inner: BraintrustLangChainCallbackHandler<IsAsyncFlush>;
private inner: BraintrustLangChainCallbackHandler;

constructor(
options?: Partial<BraintrustCallbackHandlerOptions<IsAsyncFlush>>,
) {
constructor(options?: Partial<BraintrustCallbackHandlerOptions>) {
super();
this.inner = new BraintrustLangChainCallbackHandler<IsAsyncFlush>(options);
this.inner = new BraintrustLangChainCallbackHandler(options);
}

handleLLMStart(
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -118,7 +118,7 @@ function getTimeElapsed(end?: string, start?: string): number | undefined {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe(
TEST_SUITE_OPTIONS,
() => {
let backgroundLogger: TestBackgroundLogger;
let _logger: Logger<false>;
let _logger: Logger;
let Agent: any;
let run: any;
let tool: any;
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand Down
3 changes: 0 additions & 3 deletions js/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,11 @@ export type {
InitLoggerOptions,
InitOptions,
LoadPromptOptions,
LogOptions,
LoginOptions,
Logs3OverflowInputRow,
Logs3OverflowUpload,
MetricSummary,
ObjectMetadata,
PromiseUnless,
PropagationContext,
PromptRowWithId,
ScoreSummary,
Expand DownExpand Up@@ -125,7 +123,6 @@ export {
withCurrent,
withDataset,
withExperiment,
withLogger,
withParent,
wrapTraced,
registerOtelFlush,
Expand Down
4 changes: 2 additions & 2 deletions js/src/instrumentation/providers/eve-instrumentation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -585,7 +585,7 @@ class EveBridge {
turn: TurnState,
event: { input?: unknown; output?: unknown },
): void {
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
root_span_id: turn.rootSpanId,
span_id: turn.spanId,
Expand DownExpand Up@@ -637,7 +637,7 @@ class EveBridge {
if (Object.keys(totals).length === 0) {
return;
}
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
metrics: totals,
root_span_id: turn.rootSpanId,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand DownExpand Up@@ -180,7 +180,7 @@ function parseUsageMetrics(usage: unknown): Record<string, number> {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
70 changes: 69 additions & 1 deletion js/src/logger.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/consistent-type-assertions */

import { vi, expect, test, describe, beforeEach, afterEach } from "vitest";
import {
vi,
expect,
expectTypeOf,
test,
describe,
beforeEach,
afterEach,
} from "vitest";
import {
_exportsForTestingOnly,
init,
Expand All@@ -11,6 +19,7 @@ import {
loadPrompt,
loadParameters,
wrapTraced,
traced,
currentSpan,
withParent,
startSpan,
Expand All@@ -19,6 +28,8 @@ import {
deepCopyEvent,
ReadonlyExperiment,
renderMessageImpl,
flush,
type InitLoggerOptions,
} from "./logger";

import { configureNode } from "./node/config";
Expand All@@ -31,6 +42,12 @@ import { SpanCache } from "./span-cache";

configureNode();

type InitLoggerHasAsyncFlush = "asyncFlush" extends keyof InitLoggerOptions
? true
: false;

expectTypeOf<InitLoggerHasAsyncFlush>().toEqualTypeOf<false>();

test("renderMessage with file content parts", () => {
const message = {
role: "user" as const,
Expand DownExpand Up@@ -426,6 +443,57 @@ test("verify MemoryBackgroundLogger intercepts logs", async () => {
_exportsForTestingOnly.clearTestBackgroundLogger(); // can go back to normal
});

test("logger and tracing APIs preserve return shapes without implicit flushing", async () => {
await _exportsForTestingOnly.simulateLoginForTests();
const backgroundLogger = _exportsForTestingOnly.useTestBackgroundLogger();
const flushSpy = vi.spyOn(backgroundLogger, "flush");

try {
const logger = initLogger({
projectName: "test",
projectId: "test-project-id",
});

const id = logger.log({ input: "input" });
expectTypeOf(id).toEqualTypeOf<string>();

const loggerSyncResult = logger.traced(() => 42 as const);
expectTypeOf(loggerSyncResult).toEqualTypeOf<42>();
expect(loggerSyncResult).toBe(42);

const loggerAsyncResult = logger.traced(async () => 43);
expectTypeOf(loggerAsyncResult).toEqualTypeOf<Promise<number>>();
await expect(loggerAsyncResult).resolves.toBe(43);

const tracedSyncResult = traced(() => "sync" as const);
expectTypeOf(tracedSyncResult).toEqualTypeOf<"sync">();
expect(tracedSyncResult).toBe("sync");

const syncFunction = (value: number) => value + 1;
const wrappedSyncFunction = wrapTraced(syncFunction);
expectTypeOf(wrappedSyncFunction).toEqualTypeOf<typeof syncFunction>();
expect(wrappedSyncFunction(1)).toBe(2);

const asyncFunction = async (value: number) => value + 1;
const wrappedAsyncFunction = wrapTraced(asyncFunction);
expectTypeOf(wrappedAsyncFunction).toEqualTypeOf<typeof asyncFunction>();
await expect(wrappedAsyncFunction(2)).resolves.toBe(3);

expect(flushSpy).not.toHaveBeenCalled();

await logger.flush();
const span = logger.startSpan({ name: "explicit-flush" });
span.end();
await span.flush();
await flush();

expect(flushSpy).toHaveBeenCalledTimes(3);
} finally {
_exportsForTestingOnly.clearTestBackgroundLogger();
_exportsForTestingOnly.simulateLogoutForTests();
}
});

test("init validation", () => {
expect(() => init({})).toThrow(
"Must specify at least one of project or projectId",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' ref!: Remove `flushAsync` option by lforst · Pull Request #2409 · braintrustdata/braintrust-sdk-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/remove-flush-async.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"braintrust": major
---

ref!: Remove `flushAsync` option
1 change: 0 additions & 1 deletion e2e/helpers/prod-forwarding.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,6 @@ export async function initializeProdForwarding(): Promise<void> {
const logger = initLogger({
apiKey,
appUrl: process.env.BRAINTRUST_APP_URL,
asyncFlush: false,
forceLogin: true,
projectName,
});
Expand Down
15 changes: 5 additions & 10 deletions integrations/langchain-js/src/BraintrustCallbackHandler.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,23 +11,18 @@ import {
type LangChainCallbackHandlerOptions,
} from "braintrust";

type BraintrustCallbackHandlerOptions<IsAsyncFlush extends boolean> =
LangChainCallbackHandlerOptions<IsAsyncFlush>;
type BraintrustCallbackHandlerOptions = LangChainCallbackHandlerOptions;

/**
* A Braintrust tracer for LangChain.js that logs LLM calls, chains, and tools.
*/
export class BraintrustCallbackHandler<
IsAsyncFlush extends boolean,
> extends BaseCallbackHandler {
export class BraintrustCallbackHandler extends BaseCallbackHandler {
name = "BraintrustCallbackHandler";
private inner: BraintrustLangChainCallbackHandler<IsAsyncFlush>;
private inner: BraintrustLangChainCallbackHandler;

constructor(
options?: Partial<BraintrustCallbackHandlerOptions<IsAsyncFlush>>,
) {
constructor(options?: Partial<BraintrustCallbackHandlerOptions>) {
super();
this.inner = new BraintrustLangChainCallbackHandler<IsAsyncFlush>(options);
this.inner = new BraintrustLangChainCallbackHandler(options);
}

handleLLMStart(
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -118,7 +118,7 @@ function getTimeElapsed(end?: string, start?: string): number | undefined {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe(
TEST_SUITE_OPTIONS,
() => {
let backgroundLogger: TestBackgroundLogger;
let _logger: Logger<false>;
let _logger: Logger;
let Agent: any;
let run: any;
let tool: any;
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand Down
3 changes: 0 additions & 3 deletions js/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,11 @@ export type {
InitLoggerOptions,
InitOptions,
LoadPromptOptions,
LogOptions,
LoginOptions,
Logs3OverflowInputRow,
Logs3OverflowUpload,
MetricSummary,
ObjectMetadata,
PromiseUnless,
PropagationContext,
PromptRowWithId,
ScoreSummary,
Expand DownExpand Up@@ -125,7 +123,6 @@ export {
withCurrent,
withDataset,
withExperiment,
withLogger,
withParent,
wrapTraced,
registerOtelFlush,
Expand Down
4 changes: 2 additions & 2 deletions js/src/instrumentation/providers/eve-instrumentation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -585,7 +585,7 @@ class EveBridge {
turn: TurnState,
event: { input?: unknown; output?: unknown },
): void {
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
root_span_id: turn.rootSpanId,
span_id: turn.spanId,
Expand DownExpand Up@@ -637,7 +637,7 @@ class EveBridge {
if (Object.keys(totals).length === 0) {
return;
}
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
metrics: totals,
root_span_id: turn.rootSpanId,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand DownExpand Up@@ -180,7 +180,7 @@ function parseUsageMetrics(usage: unknown): Record<string, number> {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
70 changes: 69 additions & 1 deletion js/src/logger.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/consistent-type-assertions */

import { vi, expect, test, describe, beforeEach, afterEach } from "vitest";
import {
vi,
expect,
expectTypeOf,
test,
describe,
beforeEach,
afterEach,
} from "vitest";
import {
_exportsForTestingOnly,
init,
Expand All@@ -11,6 +19,7 @@ import {
loadPrompt,
loadParameters,
wrapTraced,
traced,
currentSpan,
withParent,
startSpan,
Expand All@@ -19,6 +28,8 @@ import {
deepCopyEvent,
ReadonlyExperiment,
renderMessageImpl,
flush,
type InitLoggerOptions,
} from "./logger";

import { configureNode } from "./node/config";
Expand All@@ -31,6 +42,12 @@ import { SpanCache } from "./span-cache";

configureNode();

type InitLoggerHasAsyncFlush = "asyncFlush" extends keyof InitLoggerOptions
? true
: false;

expectTypeOf<InitLoggerHasAsyncFlush>().toEqualTypeOf<false>();

test("renderMessage with file content parts", () => {
const message = {
role: "user" as const,
Expand DownExpand Up@@ -426,6 +443,57 @@ test("verify MemoryBackgroundLogger intercepts logs", async () => {
_exportsForTestingOnly.clearTestBackgroundLogger(); // can go back to normal
});

test("logger and tracing APIs preserve return shapes without implicit flushing", async () => {
await _exportsForTestingOnly.simulateLoginForTests();
const backgroundLogger = _exportsForTestingOnly.useTestBackgroundLogger();
const flushSpy = vi.spyOn(backgroundLogger, "flush");

try {
const logger = initLogger({
projectName: "test",
projectId: "test-project-id",
});

const id = logger.log({ input: "input" });
expectTypeOf(id).toEqualTypeOf<string>();

const loggerSyncResult = logger.traced(() => 42 as const);
expectTypeOf(loggerSyncResult).toEqualTypeOf<42>();
expect(loggerSyncResult).toBe(42);

const loggerAsyncResult = logger.traced(async () => 43);
expectTypeOf(loggerAsyncResult).toEqualTypeOf<Promise<number>>();
await expect(loggerAsyncResult).resolves.toBe(43);

const tracedSyncResult = traced(() => "sync" as const);
expectTypeOf(tracedSyncResult).toEqualTypeOf<"sync">();
expect(tracedSyncResult).toBe("sync");

const syncFunction = (value: number) => value + 1;
const wrappedSyncFunction = wrapTraced(syncFunction);
expectTypeOf(wrappedSyncFunction).toEqualTypeOf<typeof syncFunction>();
expect(wrappedSyncFunction(1)).toBe(2);

const asyncFunction = async (value: number) => value + 1;
const wrappedAsyncFunction = wrapTraced(asyncFunction);
expectTypeOf(wrappedAsyncFunction).toEqualTypeOf<typeof asyncFunction>();
await expect(wrappedAsyncFunction(2)).resolves.toBe(3);

expect(flushSpy).not.toHaveBeenCalled();

await logger.flush();
const span = logger.startSpan({ name: "explicit-flush" });
span.end();
await span.flush();
await flush();

expect(flushSpy).toHaveBeenCalledTimes(3);
} finally {
_exportsForTestingOnly.clearTestBackgroundLogger();
_exportsForTestingOnly.simulateLogoutForTests();
}
});

test("init validation", () => {
expect(() => init({})).toThrow(
"Must specify at least one of project or projectId",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' ref!: Remove `flushAsync` option by lforst · Pull Request #2409 · braintrustdata/braintrust-sdk-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/remove-flush-async.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"braintrust": major
---

ref!: Remove `flushAsync` option
1 change: 0 additions & 1 deletion e2e/helpers/prod-forwarding.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,6 @@ export async function initializeProdForwarding(): Promise<void> {
const logger = initLogger({
apiKey,
appUrl: process.env.BRAINTRUST_APP_URL,
asyncFlush: false,
forceLogin: true,
projectName,
});
Expand Down
15 changes: 5 additions & 10 deletions integrations/langchain-js/src/BraintrustCallbackHandler.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,23 +11,18 @@ import {
type LangChainCallbackHandlerOptions,
} from "braintrust";

type BraintrustCallbackHandlerOptions<IsAsyncFlush extends boolean> =
LangChainCallbackHandlerOptions<IsAsyncFlush>;
type BraintrustCallbackHandlerOptions = LangChainCallbackHandlerOptions;

/**
* A Braintrust tracer for LangChain.js that logs LLM calls, chains, and tools.
*/
export class BraintrustCallbackHandler<
IsAsyncFlush extends boolean,
> extends BaseCallbackHandler {
export class BraintrustCallbackHandler extends BaseCallbackHandler {
name = "BraintrustCallbackHandler";
private inner: BraintrustLangChainCallbackHandler<IsAsyncFlush>;
private inner: BraintrustLangChainCallbackHandler;

constructor(
options?: Partial<BraintrustCallbackHandlerOptions<IsAsyncFlush>>,
) {
constructor(options?: Partial<BraintrustCallbackHandlerOptions>) {
super();
this.inner = new BraintrustLangChainCallbackHandler<IsAsyncFlush>(options);
this.inner = new BraintrustLangChainCallbackHandler(options);
}

handleLLMStart(
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -118,7 +118,7 @@ function getTimeElapsed(end?: string, start?: string): number | undefined {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe(
TEST_SUITE_OPTIONS,
() => {
let backgroundLogger: TestBackgroundLogger;
let _logger: Logger<false>;
let _logger: Logger;
let Agent: any;
let run: any;
let tool: any;
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand Down
3 changes: 0 additions & 3 deletions js/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,11 @@ export type {
InitLoggerOptions,
InitOptions,
LoadPromptOptions,
LogOptions,
LoginOptions,
Logs3OverflowInputRow,
Logs3OverflowUpload,
MetricSummary,
ObjectMetadata,
PromiseUnless,
PropagationContext,
PromptRowWithId,
ScoreSummary,
Expand DownExpand Up@@ -125,7 +123,6 @@ export {
withCurrent,
withDataset,
withExperiment,
withLogger,
withParent,
wrapTraced,
registerOtelFlush,
Expand Down
4 changes: 2 additions & 2 deletions js/src/instrumentation/providers/eve-instrumentation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -585,7 +585,7 @@ class EveBridge {
turn: TurnState,
event: { input?: unknown; output?: unknown },
): void {
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
root_span_id: turn.rootSpanId,
span_id: turn.spanId,
Expand DownExpand Up@@ -637,7 +637,7 @@ class EveBridge {
if (Object.keys(totals).length === 0) {
return;
}
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
metrics: totals,
root_span_id: turn.rootSpanId,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand DownExpand Up@@ -180,7 +180,7 @@ function parseUsageMetrics(usage: unknown): Record<string, number> {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
70 changes: 69 additions & 1 deletion js/src/logger.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/consistent-type-assertions */

import { vi, expect, test, describe, beforeEach, afterEach } from "vitest";
import {
vi,
expect,
expectTypeOf,
test,
describe,
beforeEach,
afterEach,
} from "vitest";
import {
_exportsForTestingOnly,
init,
Expand All@@ -11,6 +19,7 @@ import {
loadPrompt,
loadParameters,
wrapTraced,
traced,
currentSpan,
withParent,
startSpan,
Expand All@@ -19,6 +28,8 @@ import {
deepCopyEvent,
ReadonlyExperiment,
renderMessageImpl,
flush,
type InitLoggerOptions,
} from "./logger";

import { configureNode } from "./node/config";
Expand All@@ -31,6 +42,12 @@ import { SpanCache } from "./span-cache";

configureNode();

type InitLoggerHasAsyncFlush = "asyncFlush" extends keyof InitLoggerOptions
? true
: false;

expectTypeOf<InitLoggerHasAsyncFlush>().toEqualTypeOf<false>();

test("renderMessage with file content parts", () => {
const message = {
role: "user" as const,
Expand DownExpand Up@@ -426,6 +443,57 @@ test("verify MemoryBackgroundLogger intercepts logs", async () => {
_exportsForTestingOnly.clearTestBackgroundLogger(); // can go back to normal
});

test("logger and tracing APIs preserve return shapes without implicit flushing", async () => {
await _exportsForTestingOnly.simulateLoginForTests();
const backgroundLogger = _exportsForTestingOnly.useTestBackgroundLogger();
const flushSpy = vi.spyOn(backgroundLogger, "flush");

try {
const logger = initLogger({
projectName: "test",
projectId: "test-project-id",
});

const id = logger.log({ input: "input" });
expectTypeOf(id).toEqualTypeOf<string>();

const loggerSyncResult = logger.traced(() => 42 as const);
expectTypeOf(loggerSyncResult).toEqualTypeOf<42>();
expect(loggerSyncResult).toBe(42);

const loggerAsyncResult = logger.traced(async () => 43);
expectTypeOf(loggerAsyncResult).toEqualTypeOf<Promise<number>>();
await expect(loggerAsyncResult).resolves.toBe(43);

const tracedSyncResult = traced(() => "sync" as const);
expectTypeOf(tracedSyncResult).toEqualTypeOf<"sync">();
expect(tracedSyncResult).toBe("sync");

const syncFunction = (value: number) => value + 1;
const wrappedSyncFunction = wrapTraced(syncFunction);
expectTypeOf(wrappedSyncFunction).toEqualTypeOf<typeof syncFunction>();
expect(wrappedSyncFunction(1)).toBe(2);

const asyncFunction = async (value: number) => value + 1;
const wrappedAsyncFunction = wrapTraced(asyncFunction);
expectTypeOf(wrappedAsyncFunction).toEqualTypeOf<typeof asyncFunction>();
await expect(wrappedAsyncFunction(2)).resolves.toBe(3);

expect(flushSpy).not.toHaveBeenCalled();

await logger.flush();
const span = logger.startSpan({ name: "explicit-flush" });
span.end();
await span.flush();
await flush();

expect(flushSpy).toHaveBeenCalledTimes(3);
} finally {
_exportsForTestingOnly.clearTestBackgroundLogger();
_exportsForTestingOnly.simulateLogoutForTests();
}
});

test("init validation", () => {
expect(() => init({})).toThrow(
"Must specify at least one of project or projectId",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' ref!: Remove `flushAsync` option by lforst · Pull Request #2409 · braintrustdata/braintrust-sdk-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/remove-flush-async.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"braintrust": major
---

ref!: Remove `flushAsync` option
1 change: 0 additions & 1 deletion e2e/helpers/prod-forwarding.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,6 @@ export async function initializeProdForwarding(): Promise<void> {
const logger = initLogger({
apiKey,
appUrl: process.env.BRAINTRUST_APP_URL,
asyncFlush: false,
forceLogin: true,
projectName,
});
Expand Down
15 changes: 5 additions & 10 deletions integrations/langchain-js/src/BraintrustCallbackHandler.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,23 +11,18 @@ import {
type LangChainCallbackHandlerOptions,
} from "braintrust";

type BraintrustCallbackHandlerOptions<IsAsyncFlush extends boolean> =
LangChainCallbackHandlerOptions<IsAsyncFlush>;
type BraintrustCallbackHandlerOptions = LangChainCallbackHandlerOptions;

/**
* A Braintrust tracer for LangChain.js that logs LLM calls, chains, and tools.
*/
export class BraintrustCallbackHandler<
IsAsyncFlush extends boolean,
> extends BaseCallbackHandler {
export class BraintrustCallbackHandler extends BaseCallbackHandler {
name = "BraintrustCallbackHandler";
private inner: BraintrustLangChainCallbackHandler<IsAsyncFlush>;
private inner: BraintrustLangChainCallbackHandler;

constructor(
options?: Partial<BraintrustCallbackHandlerOptions<IsAsyncFlush>>,
) {
constructor(options?: Partial<BraintrustCallbackHandlerOptions>) {
super();
this.inner = new BraintrustLangChainCallbackHandler<IsAsyncFlush>(options);
this.inner = new BraintrustLangChainCallbackHandler(options);
}

handleLLMStart(
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -118,7 +118,7 @@ function getTimeElapsed(end?: string, start?: string): number | undefined {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe(
TEST_SUITE_OPTIONS,
() => {
let backgroundLogger: TestBackgroundLogger;
let _logger: Logger<false>;
let _logger: Logger;
let Agent: any;
let run: any;
let tool: any;
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand Down
3 changes: 0 additions & 3 deletions js/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,11 @@ export type {
InitLoggerOptions,
InitOptions,
LoadPromptOptions,
LogOptions,
LoginOptions,
Logs3OverflowInputRow,
Logs3OverflowUpload,
MetricSummary,
ObjectMetadata,
PromiseUnless,
PropagationContext,
PromptRowWithId,
ScoreSummary,
Expand DownExpand Up@@ -125,7 +123,6 @@ export {
withCurrent,
withDataset,
withExperiment,
withLogger,
withParent,
wrapTraced,
registerOtelFlush,
Expand Down
4 changes: 2 additions & 2 deletions js/src/instrumentation/providers/eve-instrumentation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -585,7 +585,7 @@ class EveBridge {
turn: TurnState,
event: { input?: unknown; output?: unknown },
): void {
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
root_span_id: turn.rootSpanId,
span_id: turn.spanId,
Expand DownExpand Up@@ -637,7 +637,7 @@ class EveBridge {
if (Object.keys(totals).length === 0) {
return;
}
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
metrics: totals,
root_span_id: turn.rootSpanId,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand DownExpand Up@@ -180,7 +180,7 @@ function parseUsageMetrics(usage: unknown): Record<string, number> {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
70 changes: 69 additions & 1 deletion js/src/logger.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/consistent-type-assertions */

import { vi, expect, test, describe, beforeEach, afterEach } from "vitest";
import {
vi,
expect,
expectTypeOf,
test,
describe,
beforeEach,
afterEach,
} from "vitest";
import {
_exportsForTestingOnly,
init,
Expand All@@ -11,6 +19,7 @@ import {
loadPrompt,
loadParameters,
wrapTraced,
traced,
currentSpan,
withParent,
startSpan,
Expand All@@ -19,6 +28,8 @@ import {
deepCopyEvent,
ReadonlyExperiment,
renderMessageImpl,
flush,
type InitLoggerOptions,
} from "./logger";

import { configureNode } from "./node/config";
Expand All@@ -31,6 +42,12 @@ import { SpanCache } from "./span-cache";

configureNode();

type InitLoggerHasAsyncFlush = "asyncFlush" extends keyof InitLoggerOptions
? true
: false;

expectTypeOf<InitLoggerHasAsyncFlush>().toEqualTypeOf<false>();

test("renderMessage with file content parts", () => {
const message = {
role: "user" as const,
Expand DownExpand Up@@ -426,6 +443,57 @@ test("verify MemoryBackgroundLogger intercepts logs", async () => {
_exportsForTestingOnly.clearTestBackgroundLogger(); // can go back to normal
});

test("logger and tracing APIs preserve return shapes without implicit flushing", async () => {
await _exportsForTestingOnly.simulateLoginForTests();
const backgroundLogger = _exportsForTestingOnly.useTestBackgroundLogger();
const flushSpy = vi.spyOn(backgroundLogger, "flush");

try {
const logger = initLogger({
projectName: "test",
projectId: "test-project-id",
});

const id = logger.log({ input: "input" });
expectTypeOf(id).toEqualTypeOf<string>();

const loggerSyncResult = logger.traced(() => 42 as const);
expectTypeOf(loggerSyncResult).toEqualTypeOf<42>();
expect(loggerSyncResult).toBe(42);

const loggerAsyncResult = logger.traced(async () => 43);
expectTypeOf(loggerAsyncResult).toEqualTypeOf<Promise<number>>();
await expect(loggerAsyncResult).resolves.toBe(43);

const tracedSyncResult = traced(() => "sync" as const);
expectTypeOf(tracedSyncResult).toEqualTypeOf<"sync">();
expect(tracedSyncResult).toBe("sync");

const syncFunction = (value: number) => value + 1;
const wrappedSyncFunction = wrapTraced(syncFunction);
expectTypeOf(wrappedSyncFunction).toEqualTypeOf<typeof syncFunction>();
expect(wrappedSyncFunction(1)).toBe(2);

const asyncFunction = async (value: number) => value + 1;
const wrappedAsyncFunction = wrapTraced(asyncFunction);
expectTypeOf(wrappedAsyncFunction).toEqualTypeOf<typeof asyncFunction>();
await expect(wrappedAsyncFunction(2)).resolves.toBe(3);

expect(flushSpy).not.toHaveBeenCalled();

await logger.flush();
const span = logger.startSpan({ name: "explicit-flush" });
span.end();
await span.flush();
await flush();

expect(flushSpy).toHaveBeenCalledTimes(3);
} finally {
_exportsForTestingOnly.clearTestBackgroundLogger();
_exportsForTestingOnly.simulateLogoutForTests();
}
});

test("init validation", () => {
expect(() => init({})).toThrow(
"Must specify at least one of project or projectId",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); ref!: Remove `flushAsync` option by lforst · Pull Request #2409 · braintrustdata/braintrust-sdk-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/remove-flush-async.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"braintrust": major
---

ref!: Remove `flushAsync` option
1 change: 0 additions & 1 deletion e2e/helpers/prod-forwarding.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,7 +31,6 @@ export async function initializeProdForwarding(): Promise<void> {
const logger = initLogger({
apiKey,
appUrl: process.env.BRAINTRUST_APP_URL,
asyncFlush: false,
forceLogin: true,
projectName,
});
Expand Down
15 changes: 5 additions & 10 deletions integrations/langchain-js/src/BraintrustCallbackHandler.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,23 +11,18 @@ import {
type LangChainCallbackHandlerOptions,
} from "braintrust";

type BraintrustCallbackHandlerOptions<IsAsyncFlush extends boolean> =
LangChainCallbackHandlerOptions<IsAsyncFlush>;
type BraintrustCallbackHandlerOptions = LangChainCallbackHandlerOptions;

/**
* A Braintrust tracer for LangChain.js that logs LLM calls, chains, and tools.
*/
export class BraintrustCallbackHandler<
IsAsyncFlush extends boolean,
> extends BaseCallbackHandler {
export class BraintrustCallbackHandler extends BaseCallbackHandler {
name = "BraintrustCallbackHandler";
private inner: BraintrustLangChainCallbackHandler<IsAsyncFlush>;
private inner: BraintrustLangChainCallbackHandler;

constructor(
options?: Partial<BraintrustCallbackHandlerOptions<IsAsyncFlush>>,
) {
constructor(options?: Partial<BraintrustCallbackHandlerOptions>) {
super();
this.inner = new BraintrustLangChainCallbackHandler<IsAsyncFlush>(options);
this.inner = new BraintrustLangChainCallbackHandler(options);
}

handleLLMStart(
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -118,7 +118,7 @@ function getTimeElapsed(end?: string, start?: string): number | undefined {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ describe(
TEST_SUITE_OPTIONS,
() => {
let backgroundLogger: TestBackgroundLogger;
let _logger: Logger<false>;
let _logger: Logger;
let Agent: any;
let run: any;
let tool: any;
Expand Down
2 changes: 1 addition & 1 deletion integrations/openai-agents-js/src/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand Down
3 changes: 0 additions & 3 deletions js/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,13 +31,11 @@ export type {
InitLoggerOptions,
InitOptions,
LoadPromptOptions,
LogOptions,
LoginOptions,
Logs3OverflowInputRow,
Logs3OverflowUpload,
MetricSummary,
ObjectMetadata,
PromiseUnless,
PropagationContext,
PromptRowWithId,
ScoreSummary,
Expand DownExpand Up@@ -125,7 +123,6 @@ export {
withCurrent,
withDataset,
withExperiment,
withLogger,
withParent,
wrapTraced,
registerOtelFlush,
Expand Down
4 changes: 2 additions & 2 deletions js/src/instrumentation/providers/eve-instrumentation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -585,7 +585,7 @@ class EveBridge {
turn: TurnState,
event: { input?: unknown; output?: unknown },
): void {
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
root_span_id: turn.rootSpanId,
span_id: turn.spanId,
Expand DownExpand Up@@ -637,7 +637,7 @@ class EveBridge {
if (Object.keys(totals).length === 0) {
return;
}
currentLogger<true>()?.updateSpan({
currentLogger()?.updateSpan({
id: turn.rowId,
metrics: totals,
root_span_id: turn.rootSpanId,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ type TraceMetadata = {
};

export interface OpenAIAgentsTraceProcessorOptions {
logger?: Logger<any>;
logger?: Logger;
maxTraces?: number;
}

Expand DownExpand Up@@ -180,7 +180,7 @@ function parseUsageMetrics(usage: unknown): Record<string, number> {
export class OpenAIAgentsTraceProcessor {
private static readonly DEFAULT_MAX_TRACES = 10000;

private logger?: Logger<any>;
private logger?: Logger;
private maxTraces: number;
private traceSpans = new Map<
string,
Expand Down
70 changes: 69 additions & 1 deletion js/src/logger.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
/* eslint-disable @typescript-eslint/consistent-type-assertions */

import { vi, expect, test, describe, beforeEach, afterEach } from "vitest";
import {
vi,
expect,
expectTypeOf,
test,
describe,
beforeEach,
afterEach,
} from "vitest";
import {
_exportsForTestingOnly,
init,
Expand All@@ -11,6 +19,7 @@ import {
loadPrompt,
loadParameters,
wrapTraced,
traced,
currentSpan,
withParent,
startSpan,
Expand All@@ -19,6 +28,8 @@ import {
deepCopyEvent,
ReadonlyExperiment,
renderMessageImpl,
flush,
type InitLoggerOptions,
} from "./logger";

import { configureNode } from "./node/config";
Expand All@@ -31,6 +42,12 @@ import { SpanCache } from "./span-cache";

configureNode();

type InitLoggerHasAsyncFlush = "asyncFlush" extends keyof InitLoggerOptions
? true
: false;

expectTypeOf<InitLoggerHasAsyncFlush>().toEqualTypeOf<false>();

test("renderMessage with file content parts", () => {
const message = {
role: "user" as const,
Expand DownExpand Up@@ -426,6 +443,57 @@ test("verify MemoryBackgroundLogger intercepts logs", async () => {
_exportsForTestingOnly.clearTestBackgroundLogger(); // can go back to normal
});

test("logger and tracing APIs preserve return shapes without implicit flushing", async () => {
await _exportsForTestingOnly.simulateLoginForTests();
const backgroundLogger = _exportsForTestingOnly.useTestBackgroundLogger();
const flushSpy = vi.spyOn(backgroundLogger, "flush");

try {
const logger = initLogger({
projectName: "test",
projectId: "test-project-id",
});

const id = logger.log({ input: "input" });
expectTypeOf(id).toEqualTypeOf<string>();

const loggerSyncResult = logger.traced(() => 42 as const);
expectTypeOf(loggerSyncResult).toEqualTypeOf<42>();
expect(loggerSyncResult).toBe(42);

const loggerAsyncResult = logger.traced(async () => 43);
expectTypeOf(loggerAsyncResult).toEqualTypeOf<Promise<number>>();
await expect(loggerAsyncResult).resolves.toBe(43);

const tracedSyncResult = traced(() => "sync" as const);
expectTypeOf(tracedSyncResult).toEqualTypeOf<"sync">();
expect(tracedSyncResult).toBe("sync");

const syncFunction = (value: number) => value + 1;
const wrappedSyncFunction = wrapTraced(syncFunction);
expectTypeOf(wrappedSyncFunction).toEqualTypeOf<typeof syncFunction>();
expect(wrappedSyncFunction(1)).toBe(2);

const asyncFunction = async (value: number) => value + 1;
const wrappedAsyncFunction = wrapTraced(asyncFunction);
expectTypeOf(wrappedAsyncFunction).toEqualTypeOf<typeof asyncFunction>();
await expect(wrappedAsyncFunction(2)).resolves.toBe(3);

expect(flushSpy).not.toHaveBeenCalled();

await logger.flush();
const span = logger.startSpan({ name: "explicit-flush" });
span.end();
await span.flush();
await flush();

expect(flushSpy).toHaveBeenCalledTimes(3);
} finally {
_exportsForTestingOnly.clearTestBackgroundLogger();
_exportsForTestingOnly.simulateLogoutForTests();
}
});

test("init validation", () => {
expect(() => init({})).toThrow(
"Must specify at least one of project or projectId",
Expand Down
Loading