feat: Separate update event into the update, soft remove and recover events #8403

spotykatch · 2021-11-23T12:03:39Z

Closes: #8398

BREAKING CHANGE: update listeners and subscriber no longer triggered by soft-remove and recover

Fixes: #6179

Description of change

Separate update event into the update, soft remove and recover events

Pull-Request Checklist

Code is up-to-date with the master branch
npm run lint passes with this change
npm run test passes with this change
This pull request links relevant issues as Fixes #0000
There are new or updated unit tests validating the change
Documentation has been updated to reflect this change [ Need help with Chinese docs ]
The new commits follow conventions explained in CONTRIBUTING.md

spotykatch · 2021-11-23T12:06:08Z

~~Don't really get how listeners are registered. I get this output.~~

BEFORE_UPDATE_LISTENER_CALL
BEFORE_UPDATE_SUBSCRIBER_CALL
AFTER_UPDATE_LISTENER_CALL
AFTER_UPDATE_SUBSCRIBER_CALL
0 // <-- metadata.updateListeners.length
BEFORE_SOFT_REMOVE_SUBSCRIBER_CALL
AFTER_SOFT_REMOVE_SUBSCRIBER_CALL
BEFORE_RECOVER_SUBSCRIBER_CALL
AFTER_RECOVER_SUBSCRIBER_CALL

~~Any help? Where listeners are registered?~~

spotykatch · 2021-11-23T14:38:42Z

~~callListethis.expressionMap.callListenersners is false for some reason oO~~
Ok. found.

spotykatch · 2021-11-24T05:44:50Z

LOL. Did not expect checks will be passed so soon) Maybe there should be more checks?
I'll push docs changes. And I think I will need some help here because my English is not good enough to write docs I guess.
Also, I need some guidance to make sure users understand, that update events are no longer triggered by soft remove and recover.

spotykatch · 2021-11-24T06:38:15Z

~~Sorry, can you, please, change it back to draft.~~

spotykatch · 2021-11-26T04:13:55Z

In Chinese documentation, I only changed English words 😶‍🌫️

spotykatch · 2021-11-26T06:27:37Z

Should there be tests for relations?
I'll change it ready for review to get comments. It's not ready still.

pleerock · 2021-12-11T08:07:06Z

docs/decorator-reference.md

@@ -700,6 +706,82 @@ export class Post {

 Learn more about [listeners](listeners-and-subscribers.md).

+#### `@BeforeSoftRemove`
+
+You can define a method with any name in the entity and mark it with `@BeforeRemove`


I think @BeforeRemove should be @BeforeSoftRemove here

pleerock · 2021-12-11T08:07:19Z

docs/decorator-reference.md

+@Entity()
+export class Post {
+
+    @BeforeRemove()


pleerock · 2021-12-11T08:07:23Z

docs/decorator-reference.md

+
+#### `@AfterSoftRemove`
+
+You can define a method with any name in the entity and mark it with `@AfterRemove`


pleerock · 2021-12-11T08:07:27Z

docs/decorator-reference.md

+@Entity()
+export class Post {
+
+    @AfterRemove()


pleerock · 2021-12-11T08:07:36Z

docs/decorator-reference.md

+@Entity()
+export class Post {
+
+    @BeforeRemove()


pleerock · 2021-12-11T08:07:43Z

docs/decorator-reference.md

+
+#### `@AfterRecover`
+
+You can define a method with any name in the entity and mark it with `@AfterRemove`


pleerock · 2021-12-11T08:07:46Z

docs/decorator-reference.md

+@Entity()
+export class Post {
+
+    @AfterRemove()


pleerock · 2021-12-11T08:08:15Z

docs/listeners-and-subscribers.md

+    * [`@BeforeSoftRemove`](#beforeremove)
+    * [`@AfterSoftRemove`](#afterremove)
+    * [`@BeforeRecover`](#beforeremove)
+    * [`@AfterRecover`](#afterremove)


incorrect links all above ^

pleerock · 2021-12-11T08:08:37Z

docs/listeners-and-subscribers.md

@@ -89,6 +94,7 @@ export class Post {

 You can define a method with any name in the entity and mark it with `@AfterUpdate`
 and TypeORM will call it after an existing entity is updated using repository/manager `save`.
+> :warning: **@AfterUpdate is no longer triggered by `softRemove` and `recover`


I don't think we need these warnings above, just remove the all

pleerock · 2021-12-11T08:08:49Z

docs/listeners-and-subscribers.md

+@Entity()
+export class Post {
+
+    @BeforeRemove()


pleerock · 2021-12-11T08:09:01Z

docs/listeners-and-subscribers.md

+@Entity()
+export class Post {
+
+    @BeforeRemove()


pleerock · 2021-12-11T08:09:36Z

docs/decorator-reference.md

+#### `@AfterSoftRemove`
+
+You can define a method with any name in the entity and mark it with `@AfterRemove`
+and TypeORM will call it after the entity is soft removed using repository/manager `remove`.


using softRemove ?

pleerock · 2021-12-11T08:10:17Z

docs/decorator-reference.md

+#### `@BeforeSoftRemove`
+
+You can define a method with any name in the entity and mark it with `@BeforeRemove`
+and TypeORM will call it before a entity is soft removed using repository/manager `remove`.


using softRemove ?

pleerock · 2021-12-11T08:13:19Z

docs/zh_CN/decorator-reference.md

+    * [`@BeforeSoftRemove`](#beforeremove)
+    * [`@AfterSoftRemove`](#afterremove)
+    * [`@BeforeRecover`](#beforeremove)
+    * [`@AfterRecover`](#afterremove)


links are broken ^

pleerock · 2021-12-11T08:15:09Z

docs/zh_CN/listeners-and-subscribers.md

+  * [`@BeforeSoftRemove`](#beforeremove)
+  * [`@AfterSoftRemove`](#afterremove)
+  * [`@BeforeRecover`](#beforeremove)
+  * [`@AfterRecover`](#afterremove)


links are broken ^

pleerock · 2021-12-11T08:15:29Z

docs/zh_CN/listeners-and-subscribers.md

+
+### `@AfterSoftRemove`
+
+你可以在实体中定义一个具有任何名称的方法，并使用`@ AfterSoftRemove`标记它，TypeORM 将在使用 repository/manager `softRemove`删除实体后调用它。


redundant space

and missing spaces

pleerock · 2021-12-11T08:15:52Z

docs/zh_CN/listeners-and-subscribers.md

+
+### `@BeforeRecover`
+
+你可以在实体中定义具有任何名称的方法，并使用`@BeforeRecover`标记它，并且 TypeORM 将在使用 repository/manager `recover`删除实体之前调用它。


and missing spaces

pleerock · 2021-12-11T08:16:08Z

docs/zh_CN/listeners-and-subscribers.md

+
+### `@AfterRecover`
+
+你可以在实体中定义一个具有任何名称的方法，并使用`@ AfterRecover`标记它，TypeORM 将在使用 repository/manager `recover`删除实体后调用它。


and missing spaces

pleerock · 2021-12-11T08:20:07Z

src/query-builder/SoftDeleteQueryBuilder.ts

+                if (this.expressionMap.queryType === "soft-delete")
+                    await queryRunner.broadcaster.broadcast("BeforeSoftRemove", this.expressionMap.mainAlias!.metadata);
+                else if (this.expressionMap.queryType === "restore")
+                    await queryRunner.broadcaster.broadcast("AfterSoftRemove", this.expressionMap.mainAlias!.metadata);


I guess it should be BeforeRecover here?

pleerock · 2021-12-11T08:24:06Z

Since this PR contains many small typos and copy-paste issues I recommend to go through the code once again (in case if I missing something) and make sure no issues left. Good job on a PR itself

spotykatch · 2021-12-21T17:16:03Z

del

pleerock · 2022-01-31T12:42:17Z

@spotykatch were you able to fix the remaining issues before we can merge this one?

spotykatch · 2022-01-31T18:13:55Z

Chinese docs are the only got left. I hope Chinese users will fix it themselves 😺

pleerock · 2022-02-01T11:59:02Z

Closes: #8398 BREAKING CHANGE: update listeners and subscriber no longer triggered by soft-remove and recover

spotykatch changed the title 2 Separate update event into the update, soft remove and restore events Nov 23, 2021

pleerock added the breaking change label Nov 23, 2021

spotykatch marked this pull request as ready for review November 24, 2021 06:33

spotykatch changed the title ~~Separate update event into the update, soft remove and restore events~~ Separate update event into the update, soft remove and recover events Nov 26, 2021

spotykatch marked this pull request as draft November 26, 2021 04:37

spotykatch marked this pull request as ready for review November 26, 2021 12:40

spotykatch mentioned this pull request Dec 7, 2021

softRemove does not trigger BeforeRemove/AfterRemove #6179

Closed

spotykatch changed the title ~~Separate update event into the update, soft remove and recover events~~ feat: Separate update event into the update, soft remove and recover events Dec 7, 2021