Skip to content

feat: add client socket ID to LiveQuery ws_disconnect, ws_connect , connect and subscribe event #7999

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

Open
wants to merge 8 commits into
base: alpha
Choose a base branch
from
Open

feat: add client socket ID to LiveQuery ws_disconnect, ws_connect , connect and subscribe event #7999

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
52e79f9
add clientId on ws_disconnect
May 11, 2022
4b5cede
lint
krtooch May 12, 2022
76a0ccf
change client => clientId
krtooch May 12, 2022
20445b8
Merge branch 'alpha' into addlcientid
mtrezza May 12, 2022
e704343
add test and clientId
May 16, 2022
bc8691e
Merge branch 'addlcientid' of github.com:krtooch/parse-server into ad…
May 16, 2022
87c021f
remove fit
May 16, 2022
deeff1f
remove await
May 16, 2022
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
39 changes: 37 additions & 2 deletions spec/ParseLiveQuery.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,48 @@ describe('ParseLiveQuery', function () {
requestedUser.setUsername('username');
requestedUser.setPassword('password');
Parse.Cloud.onLiveQueryEvent(req => {
const { event, sessionToken } = req;
const {
event,
clientId,
clients,
installationId,
sessionToken,
subscriptions,
useMasterKey,
} = req;
if (event === 'ws_disconnect') {
Parse.Cloud._removeAllHooks();
expect(sessionToken).toBeDefined();
expect(clientId).toBeDefined();
Copy link
Member

@dblythy dblythy May 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For completeness can we add tests for the other keys in req (e.g req.masterKey)

expect(clients).toBeDefined();
expect(installationId).toBeDefined();
expect(sessionToken).toBe(requestedUser.getSessionToken());
expect(useMasterKey).toBeDefined();
done();
}
if (event === 'ws_connect') {
expect(clients).toBeDefined();
expect(subscriptions).toBeDefined();
}
if (event === 'connect') {
expect(client).toBeDefined();
expect(clientId).toBeDefined();
expect(event).toBeDefined();
expect(clients).toBeDefined();
expect(subscriptions).toBeDefined();
expect(sessionToken).toBeDefined();
expect(useMasterKey).toBeDefined();
expect(installationId).toBeDefined();
}
if (event === 'subscribe') {
Copy link
Member

@mtrezza mtrezza May 17, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you split this up into individual tests for each event? Bulk tests have shown to be more difficult to maintain, also the test description would not be accurate anymore: "access user on onLiveQueryEvent disconnect".

expect(client).toBeDefined();
expect(clientId).toBeDefined();
expect(event).toBeDefined();
expect(clients).toBeDefined();
expect(subscriptions).toBeDefined();
expect(sessionToken).toBeDefined();
expect(useMasterKey).toBeDefined();
expect(installationId).toBeDefined();
}
});
await requestedUser.signUp();
const query = new Parse.Query(TestObject);
Expand Down
3 changes: 3 additions & 0 deletions src/LiveQuery/ParseLiveQueryServer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,7 @@ class ParseLiveQueryServer {
if (!this.clients.has(clientId)) {
runLiveQueryEventHandlers({
event: 'ws_disconnect_error',
clientId,
clients: this.clients.size,
subscriptions: this.subscriptions.size,
error: `Unable to find client ${clientId}`,
Expand Down Expand Up @@ -445,6 +446,7 @@ class ParseLiveQueryServer {
logger.verbose('Current subscriptions %d', this.subscriptions.size);
runLiveQueryEventHandlers({
event: 'ws_disconnect',
clientId,
clients: this.clients.size,
subscriptions: this.subscriptions.size,
useMasterKey: client.hasMasterKey,
Expand Down Expand Up @@ -805,6 +807,7 @@ class ParseLiveQueryServer {
logger.verbose('Current client number: %d', this.clients.size);
runLiveQueryEventHandlers({
client,
clientId: parseWebsocket.clientId,
event: 'subscribe',
clients: this.clients.size,
subscriptions: this.subscriptions.size,
Expand Down