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

ymc9 · web-flow · commit 7363096e4692 · 2026-03-13T12:57:18.000-07:00
diff --git a/packages/orm/src/client/client-impl.ts b/packages/orm/src/client/client-impl.ts
@@ -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[]) {
diff --git a/packages/orm/src/client/contract.ts b/packages/orm/src/client/contract.ts
@@ -216,7 +216,7 @@ export type ClientContract<
     /**
      * Returns diagnostics information such as cache and slow query statistics.
      */
-    $diagnostics(): Promise<Diagnostics>;
+    get $diagnostics(): Promise<Diagnostics>;
 } & {
     [Key in GetSlicedModels<Schema, Options> as Uncapitalize<Key>]: ModelOperations<Schema, Key, Options, ExtQueryArgs>;
 } & ProcedureOperations<Schema, Options> &
diff --git a/tests/e2e/orm/client-api/diagnostics.test.ts b/tests/e2e/orm/client-api/diagnostics.test.ts
@@ -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();
@@ -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 {
@@ -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();
@@ -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);
@@ -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();
@@ -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 {
@@ -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();
@@ -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();
@@ -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();
@@ -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();
@@ -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);

Original file line number	Diff line number	Diff line change
`@@ -440,11 +440,11 @@ export class ClientImpl {`
`440`	`440`	`return this.$setOptions(newOptions);`
`441`	`441`	`}`
`442`	`442`
`443`		`- async $diagnostics(): Promise<Diagnostics> {`
`444`		`- return {`
	`443`	`+ get $diagnostics(): Promise<Diagnostics> {`
	`444`	`+ return Promise.resolve({`
`445`	`445`	`zodCache: this.inputValidator.zodFactory.cacheStats,`
`446`		`- slowQueries: this.slowQueries.map((q) => ({ ...q })),`
`447`		`- };`
	`446`	`+ slowQueries: this.slowQueries.map((q) => ({ ...q })).sort((a, b) => b.durationMs - a.durationMs),`
	`447`	`+ });`
`448`	`448`	`}`
`449`	`449`
`450`	`450`	`$executeRaw(query: TemplateStringsArray, ...values: any[]) {`