Events overhaul: loose coupling + plugin pipe timeout removal #1613
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## 2-dev #1613 +/- ##
==========================================
+ Coverage 93.31% 93.34% +0.03%
==========================================
Files 104 105 +1
Lines 7060 7082 +22
==========================================
+ Hits 6588 6611 +23
+ Misses 472 471 -1
Continue to review full report at Codecov.
|
Aschen
suggested changes
May 2, 2020
|
About the |
Aschen
approved these changes
May 4, 2020
|
@Aschen > I just added a commit, making Use cases: logs, statistics... and cluster synchronization. |
|
Kudos, SonarCloud Quality Gate passed!
|
Aschen
approved these changes
May 6, 2020
alexandrebouthinon
approved these changes
May 12, 2020
Aschen
added a commit
that referenced
this pull request
May 15, 2020
# [2.2.0](https://github.com/kuzzleio/kuzzle/releases/tag/2.2.0) (2020-05-15) #### Bug fixes - [ [#1626](#1626) ] Returns a token expired error when using expired jwt ([Aschen](https://github.com/Aschen)) - [ [#1623](#1623) ] Fix refresh propagation for document:delete ([Aschen](https://github.com/Aschen)) - [ [#1611](#1611) ] Create user before credentials ([benoitvidis](https://github.com/benoitvidis)) - [ [#1596](#1596) ] Keep the number of opened scroll contexts in check ([scottinet](https://github.com/scottinet)) #### New features - [ [#1614](#1614) ] Add bulk:deleteByQuery ([Aschen](https://github.com/Aschen)) #### Enhancements - [ [#1613](#1613) ] Events overhaul: loose coupling + plugin pipe timeout removal ([scottinet](https://github.com/scottinet)) - [ [#1617](#1617) ] Allows inter-plugins method calls with side-effect ([Aschen](https://github.com/Aschen)) - [ [#1618](#1618) ] Add user ID in forbidden error log ([Aschen](https://github.com/Aschen)) - [ [#1599](#1599) ] Prevent user overriding with admin:loadSecurities ([Aschen](https://github.com/Aschen)) - [ [#1606](#1606) ] Lighter and faster MQTT server ([scottinet](https://github.com/scottinet)) - [ [#1598](#1598) ] Add token hash in API key ([Aschen](https://github.com/Aschen)) - [ [#1602](#1602) ] Automatically index new fields after collection:update ([Yoann-Abbes](https://github.com/Yoann-Abbes)) ---
scottinet
added a commit
that referenced
this pull request
May 21, 2020
…1631) # Description This is an emergency patch, fixing a behavior broken by #1613 Plugins can attach either functions or function names to pipe events. When using function names, plugin developpers have no way of controlling the context used to invoke their functions, and Kuzzle expects the function to exist within the plugin main object (this is verified with assertions when plugins are loaded by Kuzzle). With Kuzzle 2.2.0, plugin pipes defined using function names are invoked with an undefined context, breaking existing implementations. This PR fixes that by binding the plugin pipe function to its object of origin, when loading the plugin. This is only applied to plugin pipes defined with function names: when using functions, plugin developpers are responsible of the function's context, as Kuzzle has no way of knowing in what object the function belongs. # How to test Load a plugin with a pipe function declared using a function name, and use `this` in the function. Example: ```js 'use strict'; class Foo { constructor() { this.foo = 'bar'; } async init (config, context) { this.config = config; this.context = context; this.pipes = { 'server:beforeNow': '_lol' }; } async _lol (rq) { console.log('============= LOL: ', this.foo); return rq; } } module.exports = Foo; ``` Without this fix, this fails with a `PluginImplementationError` stating that the `foo` property cannot be read from `undefined`. With the fix, this pipe runs as expected. # Other changes * Simplify unit tests a bit
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR changes how events are handled by Kuzzle's core component:
KuzzleEventEmitterobject, localized in the newcore/eventsdirectoryask:Pipes listenable by core functions and the new ask events are meant to loosely couple Kuzzle objects: instead of invoking objects directly (and sometimes manipulate their properties from the outside), objects will now be able to submit side-effect to all listening core functions without knowing which ones.
And they will be able to request information without having any knowledge about what object will ultimately answer, or from where the information will come from.
In other words, this PR aims at restoring the principle of single responsibility to objects, freeing them of knowing what side-effect should be applied to what object.
This also introduces modularity, as we'll now be able to replace (or deactivate) parts of the code with ease.
Other changes
Optimizations