Skip to content

fix(orm): diagnostics should return slow queries sorted by duration #2483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ymc9 merged 3 commits into from
Mar 13, 2026
Merged

fix(orm): diagnostics should return slow queries sorted by duration #2483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e50ced4
fix(orm): diagnostics should return slow queries sorted by duration
ymc9 Mar 13, 2026
031701b
fix: change $diagnostics to a property
ymc9 Mar 13, 2026
23c86ad
update test
ymc9 Mar 13, 2026
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
8 changes: 4 additions & 4 deletions packages/orm/src/client/client-impl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,11 +440,11 @@ export class ClientImpl {
return this.$setOptions(newOptions);
}

async $diagnostics(): Promise<Diagnostics> {
return {
get $diagnostics(): Promise<Diagnostics> {
return Promise.resolve({
zodCache: this.inputValidator.zodFactory.cacheStats,
slowQueries: this.slowQueries.map((q) => ({ ...q })),
};
slowQueries: this.slowQueries.map((q) => ({ ...q })).sort((a, b) => b.durationMs - a.durationMs),
});
}

$executeRaw(query: TemplateStringsArray, ...values: any[]) {
Expand Down
2 changes: 1 addition & 1 deletion packages/orm/src/client/contract.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ export type ClientContract<
/**
* Returns diagnostics information such as cache and slow query statistics.
*/
$diagnostics(): Promise<Diagnostics>;
get $diagnostics(): Promise<Diagnostics>;
Comment thread
ymc9 marked this conversation as resolved.
} & {
[Key in GetSlicedModels<Schema, Options> as Uncapitalize<Key>]: ModelOperations<Schema, Key, Options, ExtQueryArgs>;
} & ProcedureOperations<Schema, Options> &
Expand Down
26 changes: 13 additions & 13 deletions tests/e2e/orm/client-api/diagnostics.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ describe('Client $diagnostics tests', () => {
it('returns zod cache stats', async () => {
const client = await createTestClient(schema);
try {
const diagnostics = await client.$diagnostics();
const diagnostics = await client.$diagnostics;
expect(diagnostics.zodCache).toEqual({ size: 0, keys: [] });
} finally {
await client.$disconnect();
Expand All @@ -18,7 +18,7 @@ describe('Client $diagnostics tests', () => {
const client = await createTestClient(schema);
try {
await client.user.create({ data: { email: 'u1@test.com' } });
const diagnostics = await client.$diagnostics();
const diagnostics = await client.$diagnostics;
expect(diagnostics.zodCache.size).toBeGreaterThan(0);
expect(diagnostics.zodCache.keys.length).toBe(diagnostics.zodCache.size);
} finally {
Expand All @@ -31,7 +31,7 @@ describe('Client $diagnostics tests', () => {
try {
await client.user.create({ data: { email: 'u1@test.com' } });
await client.user.findMany();
const diagnostics = await client.$diagnostics();
const diagnostics = await client.$diagnostics;
expect(diagnostics.slowQueries).toEqual([]);
} finally {
await client.$disconnect();
Expand All @@ -48,7 +48,7 @@ describe('Client $diagnostics tests', () => {
await client.user.create({ data: { email: 'u1@test.com' } });
await client.user.findMany();

const diagnostics = await client.$diagnostics();
const diagnostics = await client.$diagnostics;
expect(diagnostics.slowQueries.length).toBeGreaterThan(0);
for (const query of diagnostics.slowQueries) {
expect(query.startedAt).toBeInstanceOf(Date);
Expand All @@ -68,7 +68,7 @@ describe('Client $diagnostics tests', () => {
await client.user.create({ data: { email: 'u1@test.com' } });
await client.user.findMany();

const diagnostics = await client.$diagnostics();
const diagnostics = await client.$diagnostics;
expect(diagnostics.slowQueries).toEqual([]);
} finally {
await client.$disconnect();
Expand All @@ -82,8 +82,8 @@ describe('Client $diagnostics tests', () => {
try {
await client.user.create({ data: { email: 'u1@test.com' } });

const diagnostics1 = await client.$diagnostics();
const diagnostics2 = await client.$diagnostics();
const diagnostics1 = await client.$diagnostics;
const diagnostics2 = await client.$diagnostics;
expect(diagnostics1.slowQueries).not.toBe(diagnostics2.slowQueries);
expect(diagnostics1.slowQueries).toEqual(diagnostics2.slowQueries);
} finally {
Expand All @@ -102,8 +102,8 @@ describe('Client $diagnostics tests', () => {
await derivedClient.user.findMany();

// both clients should see the same slow queries
const parentDiag = await client.$diagnostics();
const derivedDiag = await derivedClient.$diagnostics();
const parentDiag = await client.$diagnostics;
const derivedDiag = await derivedClient.$diagnostics;
expect(parentDiag.slowQueries).toEqual(derivedDiag.slowQueries);
} finally {
await client.$disconnect();
Expand All @@ -119,7 +119,7 @@ describe('Client $diagnostics tests', () => {
await tx.user.create({ data: { email: 'u1@test.com' } });
});

const diagnostics = await client.$diagnostics();
const diagnostics = await client.$diagnostics;
expect(diagnostics.slowQueries.length).toBeGreaterThan(0);
} finally {
await client.$disconnect();
Expand All @@ -141,7 +141,7 @@ describe('Client $diagnostics tests', () => {
await client.user.create({ data: { email: `u${i}@test.com` } });
}

const diagnostics = await client.$diagnostics();
const diagnostics = await client.$diagnostics;
expect(diagnostics.slowQueries.length).toBeLessThanOrEqual(maxRecords);
} finally {
await client.$disconnect();
Expand All @@ -160,7 +160,7 @@ describe('Client $diagnostics tests', () => {
await client.user.create({ data: { email: `u${i}@test.com` } });
}

const diagnostics = await client.$diagnostics();
const diagnostics = await client.$diagnostics;
expect(diagnostics.slowQueries.length).toBeGreaterThanOrEqual(5);
} finally {
await client.$disconnect();
Expand All @@ -180,7 +180,7 @@ describe('Client $diagnostics tests', () => {
await client.user.create({ data: { email: `u${i}@test.com` } });
}

const diagnostics = await client.$diagnostics();
const diagnostics = await client.$diagnostics;
expect(diagnostics.slowQueries.length).toBeLessThanOrEqual(maxRecords);
for (const query of diagnostics.slowQueries) {
expect(query.startedAt).toBeInstanceOf(Date);
Expand Down
Loading