Documentation for wildcard events #299

thomasarbona · 2019-05-27T16:13:45Z

What does this PR do?

add documentation for wildcard events (Add pipes & hooks wildcard event kuzzle#1305)

How should this be manually tested?

npm install && npm run dev
visit http://localhost:8080/core/1/plugins/plugins/events/wildcard-events/

Boyscout

[ @xbill82 ] Disabled C++ and Java tests from local execution
fix pages sorting (page with an order set to 0 isn't classified first)

scottinet · 2019-06-03T12:35:08Z

package.json

@@ -29,6 +29,7 @@
    "js-cookie": "^2.1.4",
    "lunr": "^2.3.6",
    "moment": "^2.24.0",
+    "mqtt": "^3.0.0",


Some tests failed because mqtt dependency is missing

I made the effort and checked: that module is indeed used by the Javascript IoT guide.

this change should appear in your PR description: without it, it's impossible for reviewers to get why this module has been added

the package-lock.json file must also be updated (with an up-to-date version of the npm CLI).

since this is only used to test the documentation, then that module must be installed in the devDependencies part of the package.json file

This should already be fixed without needing to include the module: https://github.com/kuzzleio/documentation/pull/304/files#diff-594d211f65655f937e62cb7d0f75fb99R16

So it should be removed from this project's package.json file.

scottinet · 2019-06-03T12:37:48Z

src/.vuepress/util.js

@@ -148,10 +148,10 @@ function sortPagesByOrderAndTitle(p1, p2) {
  const o1 = get(p1, 'frontmatter.order', null);
  const o2 = get(p2, 'frontmatter.order', null);

-  if ((o1 === null || typeof o1 === 'undefined') && o2) {
+  if ((o1 === null || typeof o1 === 'undefined') && !isNaN(o2)) {


if o1 or o2 is NaN, then that function returns 1 (because any comparison operation on a NaN value ends up returning false)

also, I don't get the purpose of that test, what does it do?

Both if serve to check if o1 and o2 are valids. I added !isNaN() because without that, if o1 or o2 equals to zero, the sorting is broken

I don't get it, because NaN is not 0

(and what do you mean by broken?)

When o2 is equal to zero, the condition consider that o2 is not a valid number. This produce broken sorting of pages because a page with order set to zero wasn't the first page in the list

src/core/1/plugins/plugins/events/wildcard-events/index.md

…o/documentation into KZL-291-wildcarded-event

xbill82

Nice one, just one sentence to clarify

src/core/1/plugins/guides/events/wildcard-events/index.md

src/.vuepress/util.js

…o/documentation into KZL-291-wildcarded-event

scottinet

The package-lock.json file must be unstaged

scottinet

A couple wording issues but apart from that, this looks good to me.

scottinet · 2019-06-12T11:44:09Z

src/core/1/plugins/guides/events/wildcard-events/index.md

+
+```javascript
+this.pipes = 
+  // listener function will trigger at each


// the listener function is executed every time an // event is triggered by the "document" controller

scottinet · 2019-06-12T11:45:00Z

src/core/1/plugins/guides/events/wildcard-events/index.md

+
+```javascript
+this.pipes = 
+  // listener function will trigger after each


Beware copy/pasted examples:

// the listener function is executed after every successful // API action performed by the "document" controller

src/core/1/plugins/guides/events/wildcard-events/index.md

Co-Authored-By: Yoann-Abbes <[email protected]>

…o/documentation into KZL-291-wildcarded-event

xbill82 · 2019-06-12T12:41:38Z

I've restored the package-lock.json to its consistent state after the migration.

# [3.0.0](https://github.com/kuzzleio/documentation/releases/tag/3.0.0) (2019-06-12) #### Bug fixes - [ [#298](#298) ] Fix bulk import return ([Aschen](https://github.com/Aschen)) - [ [#325](#325) ] Adapt legacy redirection ([Aschen](https://github.com/Aschen)) - [ [#322](#322) ] Fix remaining dead links and add check_link to CI ([Aschen](https://github.com/Aschen)) - [ [#304](#304) ] Fix sdk js tests ([benoitvidis](https://github.com/benoitvidis)) #### New features - [ [#299](#299) ] Documentation for wildcard events ([thomasarbona](https://github.com/thomasarbona)) - [ [#321](#321) ] Add guide about secrets management with the Vault ([Aschen](https://github.com/Aschen)) - [ [#300](#300) ] Add page about bulk:write and bulk:mwrite ([Aschen](https://github.com/Aschen)) #### Enhancements - [ [#327](#327) ] SPA mode ([xbill82](https://github.com/xbill82)) - [ [#324](#324) ] Update Redis version ([Aschen](https://github.com/Aschen)) - [ [#316](#316) ] Sdks authenticated connected props ([Aschen](https://github.com/Aschen)) - [ [#317](#317) ] Add new way for updateSpecifications & validateSpecifications ([thomasarbona](https://github.com/thomasarbona)) - [ [#296](#296) ] Rewrite the Realtime guide ([Aschen](https://github.com/Aschen)) - [ [#301](#301) ] Deprecate realtime join ([Aschen](https://github.com/Aschen)) - [ [#291](#291) ] Getting started React + improve snippetManager ([thomasarbona](https://github.com/thomasarbona)) - [ [#294](#294) ] Add s3 plugin ([Aschen](https://github.com/Aschen)) - [ [#292](#292) ] Add since ([Aschen](https://github.com/Aschen)) - [ [#276](#276) ] [KZL-907] Getting started dev plugin ([Yoann-Abbes](https://github.com/Yoann-Abbes)) - [ [#284](#284) ] Extending the JS SDK with controllers ([Aschen](https://github.com/Aschen)) - [ [#271](#271) ] Add documentation page about mappings ([Aschen](https://github.com/Aschen)) #### Others - [ [#314](#314) ] Add a clustering guide ([scottinet](https://github.com/scottinet)) - [ [#319](#319) ] Getting-started-sdk-JS6-architecture ([berthieresteban](https://github.com/berthieresteban)) - [ [#311](#311) ] Add PDF sending example for Request.setResult ([Aschen](https://github.com/Aschen)) - [ [#315](#315) ] Normalize directories and generate redirections ([Aschen](https://github.com/Aschen)) - [ [#309](#309) ] Port #284 to 3-dev ([berthieresteban](https://github.com/berthieresteban)) - [ [#308](#308) ] Port #283 to 3-dev ([berthieresteban](https://github.com/berthieresteban)) - [ [#307](#307) ] Port #282 to 3-dev ([berthieresteban](https://github.com/berthieresteban)) - [ [#306](#306) ] Port #280 to 3-dev ([berthieresteban](https://github.com/berthieresteban)) - [ [#312](#312) ] Port 278 to 3-dev ([Aschen](https://github.com/Aschen)) - [ [#310](#310) ] Port #277 to 3-dev ([Aschen](https://github.com/Aschen)) - [ [#305](#305) ] Port #275 to 3-dev ([Aschen](https://github.com/Aschen)) - [ [#303](#303) ] Port #274 to 3-dev ([Aschen](https://github.com/Aschen)) - [ [#302](#302) ] Port #271 to 3-dev ([Aschen](https://github.com/Aschen)) - [ [#313](#313) ] Port #266 to 3-dev ([Yoann-Abbes](https://github.com/Yoann-Abbes)) - [ [#290](#290) ] [KZL-1050] Role template example in the documentation ([Yoann-Abbes](https://github.com/Yoann-Abbes)) - [ [#293](#293) ] [KZL-1036] Add available plugins ([Yoann-Abbes](https://github.com/Yoann-Abbes)) - [ [#286](#286) ] Embedded protocols ([benoitvidis](https://github.com/benoitvidis)) ---

documentation for wildcard events

9f239db

thomasarbona requested a review from xbill82 May 27, 2019 16:13

thomasarbona self-assigned this May 28, 2019

add mqtt dependency

1f05f5d

thomasarbona added changelog:new-features v3 labels May 28, 2019

scottinet suggested changes Jun 3, 2019

View reviewed changes

scottinet and others added 8 commits June 4, 2019 11:02

Merge branch '3-dev' into KZL-291-wildcarded-event

c149bec

Merge branch '3-dev' into KZL-291-wildcarded-event

469c026

fix arborescence

a8a8407

fix mqtt dependency

16a4932

Merge branch 'KZL-291-wildcarded-event' of https://github.com/kuzzlei…

b1a5fe8

…o/documentation into KZL-291-wildcarded-event

fix naming template

7fd88b7

clean sorting utils + fix wildcard events params type

5552edb

Merge branch '3-dev' into KZL-291-wildcarded-event

8008176

thomasarbona requested a review from scottinet June 5, 2019 12:55

Yoann-Abbes approved these changes Jun 5, 2019

View reviewed changes

alexandrebouthinon approved these changes Jun 5, 2019

View reviewed changes

alexandrebouthinon and others added 2 commits June 5, 2019 15:52

Merge branch '3-dev' into KZL-291-wildcarded-event

30a4092

Merge branch '3-dev' into KZL-291-wildcarded-event

6cd9d7a

xbill82 suggested changes Jun 6, 2019

View reviewed changes

src/core/1/plugins/guides/events/wildcard-events/index.md Outdated Show resolved Hide resolved

xbill82 reviewed Jun 6, 2019

View reviewed changes

src/.vuepress/util.js Show resolved Hide resolved

benoitvidis mentioned this pull request Jun 6, 2019

Kzl 1154 ci build #320

Merged

thomasarbona and others added 5 commits June 11, 2019 12:26

merge + suggestions

5277712

Fix package-lock.json

e81a573

Merge branch '3-dev' into KZL-291-wildcarded-event

a7a3244

Merge branch '3-dev' into KZL-291-wildcarded-event

55fc156

Merge branch '3-dev' into KZL-291-wildcarded-event

519adfc

xbill82 approved these changes Jun 12, 2019

View reviewed changes

Merge branch '3-dev' into KZL-291-wildcarded-event

56466b0

Aschen and others added 5 commits June 12, 2019 10:54

Merge branch '3-dev' into KZL-291-wildcarded-event

e539e38

delete mqtt dependency

b7d6a31

Merge branch 'KZL-291-wildcarded-event' of https://github.com/kuzzlei…

e1bd1ac

…o/documentation into KZL-291-wildcarded-event

Merge branch '3-dev' into KZL-291-wildcarded-event

8fd40b2

Merge branch '3-dev' into KZL-291-wildcarded-event

7b1d78f

scottinet suggested changes Jun 12, 2019

View reviewed changes

Yoann-Abbes suggested changes Jun 12, 2019

View reviewed changes

src/core/1/plugins/guides/events/wildcard-events/index.md Outdated Show resolved Hide resolved

xbill82 and others added 5 commits June 12, 2019 14:24

Update src/core/1/plugins/guides/events/wildcard-events/index.md

1e933a1

Co-Authored-By: Yoann-Abbes <[email protected]>

Merge branch '3-dev' into KZL-291-wildcarded-event

94c8ac4

unstage package-lock.json + fix snippets wording

39df911

Merge branch 'KZL-291-wildcarded-event' of https://github.com/kuzzlei…

99fa98b

…o/documentation into KZL-291-wildcarded-event

[merge] restored package-lock.json

d1cf84c

scottinet approved these changes Jun 12, 2019

View reviewed changes

Disabled Java and C++ tests from local execution

de97917

xbill82 merged commit ef6ddea into 3-dev Jun 12, 2019

xbill82 deleted the KZL-291-wildcarded-event branch June 12, 2019 12:49

This was referenced Jun 12, 2019

Release 1.1.0 #336

Closed

Release 3.0.0 #337

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation for wildcard events #299

Documentation for wildcard events #299

thomasarbona commented May 27, 2019 •

edited by xbill82

Loading

scottinet Jun 3, 2019

thomasarbona Jun 5, 2019

scottinet Jun 5, 2019 •

edited

Loading

benoitvidis Jun 6, 2019

scottinet Jun 12, 2019

scottinet Jun 3, 2019

thomasarbona Jun 5, 2019

scottinet Jun 5, 2019 •

edited

Loading

thomasarbona Jun 5, 2019

xbill82 left a comment

scottinet left a comment

scottinet left a comment

scottinet Jun 12, 2019

scottinet Jun 12, 2019 •

edited

Loading

xbill82 commented Jun 12, 2019

Documentation for wildcard events #299

Documentation for wildcard events #299

Conversation

thomasarbona commented May 27, 2019 • edited by xbill82 Loading

What does this PR do?

How should this be manually tested?

Boyscout

Choose a reason for hiding this comment

Choose a reason for hiding this comment

scottinet Jun 5, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

scottinet Jun 5, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xbill82 left a comment

Choose a reason for hiding this comment

scottinet left a comment

Choose a reason for hiding this comment

scottinet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

scottinet Jun 12, 2019 • edited Loading

Choose a reason for hiding this comment

xbill82 commented Jun 12, 2019

thomasarbona commented May 27, 2019 •

edited by xbill82

Loading

scottinet Jun 5, 2019 •

edited

Loading

scottinet Jun 5, 2019 •

edited

Loading

scottinet Jun 12, 2019 •

edited

Loading