Skip to content

chore: rename query function to proceed for onquery plugin #167

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
merged 2 commits into from
Aug 14, 2025
Merged

chore: rename query function to proceed for onquery plugin #167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
979a6fd
chore: rename query function to proceed for onquery plugin
ymc9 Aug 14, 2025
ff366fc
update test
ymc9 Aug 14, 2025
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,9 +289,9 @@ ORM query interception allows you to intercept the high-level ORM API calls. The
```ts
db.$use({
id: 'cost-logger',
onQuery: async ({ model, operation, args, query }) => {
onQuery: async ({ model, operation, args, proceed }) => {
const start = Date.now();
const result = await query(args);
const result = await proceed(args);
console.log(`[cost] ${model} ${operation} took ${Date.now() - start}ms`);
return result;
},
Expand Down
2 changes: 1 addition & 1 deletion packages/runtime/src/client/client-impl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ function createModelCrudHandler<Schema extends SchemaDef, Model extends GetModel
const onQuery = plugin.onQuery;
if (onQuery) {
const _proceed = proceed;
proceed = () => onQuery({ client, model, operation, args, query: _proceed }) as Promise<unknown>;
proceed = () => onQuery({ client, model, operation, args, proceed: _proceed }) as Promise<unknown>;
}
}

Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/src/client/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ type OnQueryHookContext<Schema extends SchemaDef> = {
args: unknown;

/**
* The query function to proceed with the original query.
* The function to proceed with the original query.
* It takes the same arguments as the operation method.
*
* @param args The query arguments.
*/
query: (args: unknown) => Promise<unknown>;
proceed: (args: unknown) => Promise<unknown>;

/**
* The ZenStack client that is performing the operation.
Expand Down
20 changes: 10 additions & 10 deletions packages/runtime/test/plugin/on-query-hooks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ describe('On query hooks tests', () => {
} else if (ctx.operation === 'update') {
updateHookCalled = true;
}
return ctx.query(ctx.args);
return ctx.proceed(ctx.args);
},
});

Expand All @@ -61,7 +61,7 @@ describe('On query hooks tests', () => {
hooksCalled = true;
expect(ctx.model).toBe('User');
}
return ctx.query(ctx.args);
return ctx.proceed(ctx.args);
},
});
await expect(
Expand All @@ -84,7 +84,7 @@ describe('On query hooks tests', () => {
hooksCalled = true;
expect(ctx.model).toBe('User');
expect(ctx.operation).toBe('findFirst');
return ctx.query(ctx.args);
return ctx.proceed(ctx.args);
},
});
await expect(
Expand All @@ -106,9 +106,9 @@ describe('On query hooks tests', () => {
onQuery: async (ctx) => {
if (ctx.model === 'User' && ctx.operation === 'findFirst') {
hooksCalled = true;
return ctx.query({ where: { id: 'non-exist' } });
return ctx.proceed({ where: { id: 'non-exist' } });
} else {
return ctx.query(ctx.args);
return ctx.proceed(ctx.args);
}
},
});
Expand All @@ -132,11 +132,11 @@ describe('On query hooks tests', () => {
onQuery: async (ctx) => {
if (ctx.model === 'User' && ctx.operation === 'findFirst') {
hooksCalled = true;
const result = await ctx.query(ctx.args);
const result = await ctx.proceed(ctx.args);
(result as any).happy = true;
return result;
} else {
return ctx.query(ctx.args);
return ctx.proceed(ctx.args);
}
},
});
Expand All @@ -159,10 +159,10 @@ describe('On query hooks tests', () => {
onQuery: async (ctx) => {
if (ctx.model === 'User' && ctx.operation === 'create') {
hooksCalled = true;
await ctx.query(ctx.args);
await ctx.proceed(ctx.args);
throw new Error('trigger error');
} else {
return ctx.query(ctx.args);
return ctx.proceed(ctx.args);
}
},
});
Expand Down Expand Up @@ -194,7 +194,7 @@ describe('On query hooks tests', () => {
id: 'test-plugin',
onQuery: (ctx) => {
findHookCalled = true;
return ctx.query(ctx.args);
return ctx.proceed(ctx.args);
},
});

Expand Down
20 changes: 10 additions & 10 deletions packages/runtime/test/policy/client-extensions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ describe('client extensions tests for policies', () => {

const ext = definePlugin({
id: 'prisma-extension-queryOverride',
onQuery: async ({ args, query }: any) => {
onQuery: async ({ args, proceed }: any) => {
args = args ?? {};
args.where = { ...args.where, y: { lt: 300 } };
return query(args);
return proceed(args);
},
});

Expand Down Expand Up @@ -54,10 +54,10 @@ describe('client extensions tests for policies', () => {

const ext = definePlugin({
id: 'prisma-extension-queryOverride',
onQuery: async ({ args, query }: any) => {
onQuery: async ({ args, proceed }: any) => {
args = args ?? {};
args.where = { ...args.where, y: { lt: 300 } };
return query(args);
return proceed(args);
},
});

Expand Down Expand Up @@ -85,10 +85,10 @@ describe('client extensions tests for policies', () => {

const ext = definePlugin({
id: 'prisma-extension-queryOverride',
onQuery: async ({ args, query }: any) => {
onQuery: async ({ args, proceed }: any) => {
args = args ?? {};
args.where = { ...args.where, y: { lt: 300 } };
return query(args);
return proceed(args);
},
});

Expand Down Expand Up @@ -116,10 +116,10 @@ describe('client extensions tests for policies', () => {

const ext = definePlugin({
id: 'prisma-extension-queryOverride',
onQuery: async ({ args, query }: any) => {
onQuery: async ({ args, proceed }: any) => {
args = args ?? {};
args.where = { ...args.where, y: { lt: 300 } };
return query(args);
return proceed(args);
},
});

Expand All @@ -145,8 +145,8 @@ describe('client extensions tests for policies', () => {

const ext = definePlugin({
id: 'prisma-extension-resultMutation',
onQuery: async ({ args, query }: any) => {
const r: any = await query(args);
onQuery: async ({ args, proceed }: any) => {
const r: any = await proceed(args);
for (let i = 0; i < r.length; i++) {
r[i].value = r[i].value + 1;
}
Expand Down
4 changes: 2 additions & 2 deletions samples/blog/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ async function main() {
},
}).$use({
id: 'cost-logger',
onQuery: async ({ model, operation, args, query }) => {
onQuery: async ({ model, operation, args, proceed }) => {
const start = Date.now();
const result = await query(args);
const result = await proceed(args);
console.log(`[cost] ${model} ${operation} took ${Date.now() - start}ms`);
return result;
},
Expand Down