Skip to content
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.

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

fix(mongoose): fix prehook when insertMany is used to hook method #2959

Merged
merged 1 commit into from
Jan 15, 2025
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
4 changes: 2 additions & 2 deletions packages/orm/mongoose/src/decorators/postHook.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ describe("@PostHook()", () => {
const fn = vi.fn();

// WHEN
@PostHook("method", fn)
@PostHook("save", fn)
class Test {}

// THEN
Expand All @@ -17,7 +17,7 @@ describe("@PostHook()", () => {
expect(options).toEqual({
post: [
{
method: "method",
method: "save",
fn,
options: undefined
}
Expand Down
10 changes: 5 additions & 5 deletions packages/orm/mongoose/src/decorators/postHook.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {decoratorTypeOf, DecoratorTypes, StaticMethodDecorator} from "@tsed/core";

import {MongooseHookOptions, MongoosePostHookCB} from "../interfaces/MongooseSchemaOptions.js";
import {MongooseHookOptions, MongooseMethods, MongoosePostHookCB} from "../interfaces/MongooseSchemaOptions.js";
import {schemaOptions} from "../utils/schemaOptions.js";

/**
Expand Down Expand Up @@ -46,10 +46,10 @@ import {schemaOptions} from "../utils/schemaOptions.js";
* @mongoose
* @class
*/
export function PostHook<T = any>(method: string, fn: MongoosePostHookCB<T>): ClassDecorator;
export function PostHook<T = any>(method: string, fn: MongoosePostHookCB<T>, options: MongooseHookOptions): ClassDecorator;
export function PostHook<T = any>(method: string, options: MongooseHookOptions): StaticMethodDecorator;
export function PostHook<T = any>(method: string, ...params: any[]): Function {
export function PostHook<T = any>(method: MongooseMethods, fn: MongoosePostHookCB<T>): ClassDecorator;
export function PostHook<T = any>(method: MongooseMethods, fn: MongoosePostHookCB<T>, options: MongooseHookOptions): ClassDecorator;
export function PostHook<T = any>(method: MongooseMethods, options: MongooseHookOptions): StaticMethodDecorator;
export function PostHook<T = any>(method: MongooseMethods, ...params: any[]): ClassDecorator | StaticMethodDecorator {
return ((...args: any[]) => {
let options: MongooseHookOptions = params[1];
let fn: MongoosePostHookCB<T> = params[0];
Expand Down
8 changes: 4 additions & 4 deletions packages/orm/mongoose/src/decorators/preHook.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ describe("@PreHook()", () => {
const fn = vi.fn();

// WHEN
@PreHook("method", fn, {query: true})
@PreHook("save", fn as any, {query: true})
class Test {}

// THEN
Expand All @@ -16,7 +16,7 @@ describe("@PreHook()", () => {
expect(options).toEqual({
pre: [
{
method: "method",
method: "save",
fn,
options: {
query: true
Expand All @@ -32,7 +32,7 @@ describe("@PreHook()", () => {
});

// WHEN
@PreHook("method", fn, {query: true})
@PreHook("save", fn, {query: true})
class Test {}

// THEN
Expand All @@ -41,7 +41,7 @@ describe("@PreHook()", () => {
expect(options).toEqual({
pre: [
{
method: "method",
method: "save",
fn,
options: {
query: true
Expand Down
45 changes: 27 additions & 18 deletions packages/orm/mongoose/src/decorators/preHook.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {decoratorTypeOf, DecoratorTypes} from "@tsed/core";
import {decoratorTypeOf, DecoratorTypes, StaticMethodDecorator} from "@tsed/core";

import {MongooseHookOptions, MongoosePreHookCB} from "../interfaces/MongooseSchemaOptions.js";
import type {MongooseHookOptions, MongooseMethods, MongoosePreHookCB} from "../interfaces/MongooseSchemaOptions.js";
import {schemaOptions} from "../utils/schemaOptions.js";

/**
Expand Down Expand Up @@ -43,28 +43,37 @@ import {schemaOptions} from "../utils/schemaOptions.js";
*
* This will execute the pre-save hook each time a `CarModel` document is saved.
*
* @param {string} method
* @param fn
* @param options
* @returns {Function}
* @decorator
* @class
* @param method
* @param fn
* @param options
*/
export function PreHook<T = any>(method: string, fn?: MongoosePreHookCB<T> | MongooseHookOptions, options?: MongooseHookOptions): Function {
export function PreHook<T = any>(method: MongooseMethods, fn: MongoosePreHookCB<T>, options?: MongooseHookOptions): ClassDecorator;
export function PreHook<T = any>(method: MongooseMethods, options?: MongooseHookOptions): StaticMethodDecorator;
export function PreHook<T = any>(method: MongooseMethods, ...decoratorArgs: any[]): ClassDecorator | StaticMethodDecorator {
return (...args: any[]) => {
if (decoratorTypeOf(args) === DecoratorTypes.METHOD_STC) {
options = fn as MongooseHookOptions;
fn = args[0][args[1]].bind(args[0]);
schemaOptions(args[0], {
pre: [
{
method,
fn: args[0][args[1]].bind(args[0]),
options: decoratorArgs[0]
}
]
});
} else {
schemaOptions(args[0], {
pre: [
{
method,
fn: decoratorArgs[0],
options: decoratorArgs[1]
}
]
});
}
Romakita marked this conversation as resolved.
Show resolved Hide resolved

schemaOptions(args[0], {
pre: [
{
method,
fn: fn as MongoosePreHookCB<T>,
options
}
]
});
};
}
46 changes: 28 additions & 18 deletions packages/orm/mongoose/src/interfaces/MongooseSchemaOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,42 @@ import {type IndexOptions, Schema, SchemaOptions} from "mongoose";

import {MongooseDocument} from "./MongooseDocument.js";

export type MongooseNextCB = (err?: Error) => void;

export interface MongooseHookOptions {
document?: boolean;
query?: boolean;
parallel?: boolean;
}
export type MongooseMethod =
| "aggregate"
| "bulkWrite"
| "createCollection"
| "save"
| "insertMany"
| "estimatedDocumentCount"
| "countDocuments"
| "deleteMany"
| "distinct"
| "find"
| "findOne"
| "findOneAndDelete"
| "findOneAndReplace"
| "findOneAndUpdate"
| "replaceOne"
| "updateMany"
| "init"
| "validate";

export type MongooseMethods = MongooseMethod | RegExp | MongooseMethod[];

export type MongooseHookPromised<T = any> = (doc: T | MongooseDocument<T>) => Promise<void> | void;

export type MongoosePreHookCB<T = any> = ((doc: T | MongooseDocument<T>, next: MongooseNextCB) => void) | MongooseHookPromised;

export type MongoosePostHookCB<T = any> =
| ((doc: T | MongooseDocument<T>, error: Error, next: MongooseNextCB) => void)
| ((doc: T | MongooseDocument<T>, error: Error) => Promise<void> | void)
| ((doc: T | MongooseDocument<T>, next: MongooseNextCB) => void)
| MongooseHookPromised;
export type MongooseNextCB = (err?: Error) => void;
export type MongooseHookOptions = Record<string, unknown>;
export type MongooseHookPromised<T = any> = (doc: T | MongooseDocument<T>) => Promise<void>;
export type MongoosePreHookCB<T = any> = (doc: T | MongooseDocument<T>, ...args: unknown[]) => Promise<void> | void;
export type MongoosePostHookCB<T = any> = (doc: T | MongooseDocument<T>, ...args: unknown[]) => Promise<void> | void;
Romakita marked this conversation as resolved.
Show resolved Hide resolved

export interface MongoosePreHook<T = any> {
method: string | RegExp;
method: MongooseMethods;
fn: MongoosePreHookCB<T>;
options?: MongooseHookOptions;
}

export interface MongoosePostHook<T = any> {
method: string | RegExp;
method: MongooseMethods;
fn: MongoosePostHookCB<T>;
options?: MongooseHookOptions;
}
Expand Down
6 changes: 3 additions & 3 deletions packages/orm/mongoose/src/utils/schemaOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import {Schema} from "mongoose";
import {MONGOOSE_SCHEMA_OPTIONS} from "../constants/constants.js";
import {
MongooseHookPromised,
MongooseNextCB,
MongoosePostHook,
MongoosePreHook,
MongoosePreHookCB,
Expand Down Expand Up @@ -40,8 +39,9 @@ export function buildPreHook(fn: MongoosePreHookCB) {
? function () {
return (fn as MongooseHookPromised)(this);
}
: function (next: MongooseNextCB) {
return fn(this, next);
: // we need to explicitly gives args to avoid a bug with mongoose
Romakita marked this conversation as resolved.
Show resolved Hide resolved
function (next: Function, arg1: unknown, arg2: unknown) {
return (fn as any)(this, next, arg1, arg2);
};
}

Expand Down
Loading