fix: interrupted WebSocket connection not closed by LiveQuery server #8012

pash2048 · 2022-05-24T15:06:53Z

New Pull Request Checklist

I am not disclosing a vulnerability.
I am creating this PR in reference to an issue.

Issue Description

parse live query WebSocket server not closing broken connection!

Related issue: #8010

Approach

I add a property to ws object (isAlive) and make isAlive false on ping message and make that true if got pong message.
If I didn't get a pong message on the next sending ping message, terminaing connection and clear interval

TODOs before merging

I don't have any idea how to write a test for this, I need help to complete this

Add tests
Add changes to documentation (guides, repository pages, in-code descriptions)
Add security check
Add new Parse Error codes to Parse JS SDK
A changelog entry is created automatically using the pull request title (do not manually add a changelog entry)

parse-github-assistant · 2022-05-24T15:07:03Z

Thanks for opening this pull request!

🎉 We are excited about your hands-on contribution!

mtrezza · 2022-05-24T20:37:51Z

Could you please add a test to ensure the functionality you expect?

pash2048 · 2022-05-25T06:46:53Z

Dear @mtrezza as I said I don't know how to write a test to ensure the functionality.
for example, creating a web Socket client in test and don't answer ping messages then expecting the server may close the connection is a good idea?
I need help complete with this step.

mtrezza · 2022-05-25T17:01:23Z

@parse-community/server Any web socket experts who could give a hint?

dblythy · 2022-05-25T21:40:34Z

Maybe something along these lines?

pash2048 · 2022-05-28T08:35:48Z

@dblythy, @mtrezza thanks for the help.
I wrote a test to ensure the functionality worked without defects

mtrezza · 2022-05-28T08:57:19Z

Could you take a look at the failing CI? I think you still have fit enabled for your new test.

pash2048 · 2022-05-28T09:07:00Z

@mtrezza sorry, I fix it

spec/ParseWebSocketServer.spec.js

codecov · 2022-05-28T09:17:16Z

Codecov Report

Merging #8012 (a1e38d6) into alpha (468e987) will increase coverage by 0.30%.
The diff coverage is 83.33%.

@@            Coverage Diff             @@
##            alpha    #8012      +/-   ##
==========================================
+ Coverage   93.82%   94.12%   +0.30%     
==========================================
  Files         182      182              
  Lines       13634    13639       +5     
==========================================
+ Hits        12792    12838      +46     
+ Misses        842      801      -41

Impacted Files	Coverage Δ
src/LiveQuery/ParseWebSocketServer.js	`91.42% <83.33%> (-1.91%)`	⬇️
src/ParseServerRESTController.js	`96.96% <0.00%> (-1.52%)`	⬇️
src/Adapters/Cache/RedisCacheAdapter.js	`87.71% <0.00%> (+75.43%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 468e987...a1e38d6. Read the comment docs.

spec/ParseWebSocketServer.spec.js

src/LiveQuery/ParseWebSocketServer.js

mtrezza

Looks good! Is this ready for merge? Waiting for CI to pass.

pash2048 · 2022-06-01T16:26:18Z

Dear @mtrezza how can I follow up merging status?

mtrezza · 2022-06-02T19:37:34Z

This is ready for merge, but it's currently on hold as we are preparing this month's releases.

mtrezza · 2022-06-04T14:39:27Z

@dblythy have all your remarks been addressed? Then I'd merge.

dblythy

LGTM

# [5.3.0-alpha.15](5.3.0-alpha.14...5.3.0-alpha.15) (2022-06-05) ### Bug Fixes * interrupted WebSocket connection not closed by LiveQuery server ([#8012](#8012)) ([2d5221e](2d5221e))

parseplatformorg · 2022-06-05T14:10:02Z

🎉 This change has been released in version 5.3.0-alpha.15

# [5.3.0-beta.1](5.2.1...5.3.0-beta.1) (2022-06-17) ### Bug Fixes * afterSave trigger removes pointer in Parse object ([#7913](#7913)) ([47d796e](47d796e)) * auto-release process may fail if optional back-merging task fails ([#8051](#8051)) ([cf925e7](cf925e7)) * custom database options are not passed to MongoDB GridFS ([#7911](#7911)) ([b1e5565](b1e5565)) * depreciate allowClientClassCreation defaulting to true ([#7925](#7925)) ([38ed96a](38ed96a)) * errors in GraphQL do not show the original error but a general `Unexpected Error` ([#8045](#8045)) ([0d81887](0d81887)) * interrupted WebSocket connection not closed by LiveQuery server ([#8012](#8012)) ([2d5221e](2d5221e)) * live query role cache does not clear when a user is added to a role ([#8026](#8026)) ([199dfc1](199dfc1)) * peer dependency mismatch for GraphQL dependencies ([#7934](#7934)) ([0a6faa8](0a6faa8)) * return correct response when revert is used in beforeSave ([#7839](#7839)) ([19900fc](19900fc)) * security upgrade @parse/fs-files-adapter from 1.2.1 to 1.2.2 ([#7948](#7948)) ([3a70fda](3a70fda)) * security upgrade moment from 2.29.1 to 2.29.2 ([#7931](#7931)) ([731c550](731c550)) * security upgrade parse push adapter from 4.1.0 to 4.1.2 ([#7893](#7893)) ([93667b4](93667b4)) * websocket connection of LiveQuery interrupts frequently ([#8048](#8048)) ([03caae1](03caae1)) ### Features * add MongoDB 5.1 compatibility ([#7682](#7682)) ([022a856](022a856)) * add MongoDB 5.2 support ([#7894](#7894)) ([5bfa716](5bfa716)) * add support for Node 17 and 18 ([#7896](#7896)) ([3e9f292](3e9f292)) * align file trigger syntax with class trigger; use the new syntax `Parse.Cloud.beforeSave(Parse.File, (request) => {})`, the old syntax `Parse.Cloud.beforeSaveFile((request) => {})` has been deprecated ([#7966](#7966)) ([c6dcad8](c6dcad8)) * replace GraphQL Apollo with GraphQL Yoga ([#7967](#7967)) ([1aa2204](1aa2204)) * selectively enable / disable default authentication adapters ([#7953](#7953)) ([c1e808f](c1e808f)) * upgrade mongodb from 4.4.1 to 4.5.0 ([#7991](#7991)) ([e692b5d](e692b5d)) ### Performance Improvements * reduce database operations when using the constant parameter in Cloud Function validation ([#7892](#7892)) ([041197f](041197f))

parseplatformorg · 2022-06-17T12:39:40Z

🎉 This change has been released in version 5.3.0-beta.1

# [5.3.0](5.2.8...5.3.0) (2022-10-29) ### Bug Fixes * afterSave trigger removes pointer in Parse object ([#7913](#7913)) ([47d796e](47d796e)) * authentication adapter app ID validation may be circumvented; this fixes a vulnerability that affects configurations which allow users to authenticate using the Parse Server authentication adapter for *Facebook* or *Spotify* and where the server-side authentication adapter configuration `appIds` is set as a string (e.g. `abc`) instead of an array of strings (e.g. `["abc"]`) ([GHSA-r657-33vp-gp22](GHSA-r657-33vp-gp22)) [skip release] ([#8188](#8188)) ([1a2b1b9](1a2b1b9)) * auto-release process may fail if optional back-merging task fails ([#8051](#8051)) ([cf925e7](cf925e7)) * brute force guessing of user sensitive data via search patterns (GHSA-2m6g-crv8-p3c6) ([#8145](#8145)) [skip release] ([f0db4ca](f0db4ca)) * certificate in Apple Game Center auth adapter not validated [skip release] ([#8055](#8055)) ([4c2aa63](4c2aa63)) * custom database options are not passed to MongoDB GridFS ([#7911](#7911)) ([b1e5565](b1e5565)) * depreciate allowClientClassCreation defaulting to true ([#7925](#7925)) ([38ed96a](38ed96a)) * errors in GraphQL do not show the original error but a general `Unexpected Error` ([#8045](#8045)) ([0d81887](0d81887)) * interrupted WebSocket connection not closed by LiveQuery server ([#8012](#8012)) ([2d5221e](2d5221e)) * invalid file request not properly handled [skip release] ([#8061](#8061)) ([1a04a34](1a04a34)) * live query role cache does not clear when a user is added to a role ([#8026](#8026)) ([199dfc1](199dfc1)) * peer dependency mismatch for GraphQL dependencies ([#7934](#7934)) ([0a6faa8](0a6faa8)) * protected fields exposed via LiveQuery (GHSA-crrq-vr9j-fxxh) [skip release] ([#8075](#8075)) ([636d16e](636d16e)) * return correct response when revert is used in beforeSave ([#7839](#7839)) ([19900fc](19900fc)) * security upgrade @parse/fs-files-adapter from 1.2.1 to 1.2.2 ([#7948](#7948)) ([3a70fda](3a70fda)) * security upgrade moment from 2.29.1 to 2.29.2 ([#7931](#7931)) ([731c550](731c550)) * security upgrade parse push adapter from 4.1.0 to 4.1.2 ([#7893](#7893)) ([93667b4](93667b4)) * server crashes when receiving file download request with invalid byte range; this fixes a security vulnerability that allows an attacker to impact the availability of the server instance; the fix improves parsing of the range parameter to properly handle invalid range requests ([GHSA-h423-w6qv-2wj3](GHSA-h423-w6qv-2wj3)) [skip release] ([#8237](#8237)) ([4c1befa](4c1befa)) * session object properties can be updated by foreign user; this fixes a security vulnerability in which a foreign user can write to the session object of another user if the session object ID is known; the fix prevents writing to foreign session objects ([GHSA-6w4q-23cf-j9jp](GHSA-6w4q-23cf-j9jp)) [skip release] ([#8181](#8181)) ([83cdc89](83cdc89)) * websocket connection of LiveQuery interrupts frequently ([#8048](#8048)) ([03caae1](03caae1)) ### Features * add MongoDB 5.1 compatibility ([#7682](#7682)) ([022a856](022a856)) * add MongoDB 5.2 support ([#7894](#7894)) ([5bfa716](5bfa716)) * add support for Node 17 and 18 ([#7896](#7896)) ([3e9f292](3e9f292)) * align file trigger syntax with class trigger; use the new syntax `Parse.Cloud.beforeSave(Parse.File, (request) => {})`, the old syntax `Parse.Cloud.beforeSaveFile((request) => {})` has been deprecated ([#7966](#7966)) ([c6dcad8](c6dcad8)) * replace GraphQL Apollo with GraphQL Yoga ([#7967](#7967)) ([1aa2204](1aa2204)) * selectively enable / disable default authentication adapters ([#7953](#7953)) ([c1e808f](c1e808f)) * upgrade mongodb from 4.4.1 to 4.5.0 ([#7991](#7991)) ([e692b5d](e692b5d)) ### Performance Improvements * reduce database operations when using the constant parameter in Cloud Function validation ([#7892](#7892)) ([041197f](041197f))

parseplatformorg · 2022-10-29T19:15:20Z

🎉 This change has been released in version 5.3.0

close broken webSocket connection in LiveQuery server

0f939e5

mtrezza linked an issue May 24, 2022 that may be closed by this pull request

websocket broken connection not handled in live query server #8010

Closed

4 tasks

Merge branch 'alpha' into close-liveQuery-websocket-broken-connection

fe40cce

write test for handle broken connection

c429efb

Merge branch 'alpha' into close-liveQuery-websocket-broken-connection

6f22350

mtrezza changed the title ~~fix: close broken WebSocket connection in LiveQuery server~~ fix: interrupted WebSocket connection not closed by LiveQuery server May 28, 2022

change all fit to it

307a684

mtrezza requested changes May 28, 2022

View reviewed changes

spec/ParseWebSocketServer.spec.js Outdated Show resolved Hide resolved

change test function name to closes interrupted connection

7154fd8

dblythy suggested changes May 28, 2022

View reviewed changes

spec/ParseWebSocketServer.spec.js Outdated Show resolved Hide resolved

change test function to async

5134864

mtrezza requested a review from a team May 28, 2022 13:56

Merge branch 'alpha' into close-liveQuery-websocket-broken-connection

6dbfa22

mtrezza requested changes May 28, 2022

View reviewed changes

spec/ParseWebSocketServer.spec.js Outdated Show resolved Hide resolved

src/LiveQuery/ParseWebSocketServer.js Outdated Show resolved Hide resolved

pash2048 added 2 commits May 29, 2022 16:27

delete useless comments

5090390

change isAlive variable name to waitingForPong

2aa616c

mtrezza requested changes May 29, 2022

View reviewed changes

src/LiveQuery/ParseWebSocketServer.js Outdated Show resolved Hide resolved

invert waitingForPong logic

15e3ce3

mtrezza approved these changes May 29, 2022

View reviewed changes

Merge branch 'alpha' into close-liveQuery-websocket-broken-connection

7d98151

mtrezza requested a review from dblythy May 29, 2022 18:25

Merge branch 'alpha' into close-liveQuery-websocket-broken-connection

077f87e

mtrezza added 3 commits June 3, 2022 14:43

Merge branch 'alpha' into close-liveQuery-websocket-broken-connection

de8aaf4

Merge branch 'alpha' into close-liveQuery-websocket-broken-connection

08d162f

Merge branch 'alpha' into close-liveQuery-websocket-broken-connection

a1e38d6

dblythy approved these changes Jun 5, 2022

View reviewed changes

mtrezza approved these changes Jun 5, 2022

View reviewed changes

mtrezza merged commit 2d5221e into parse-community:alpha Jun 5, 2022

parseplatformorg added the state:released-alpha Released as alpha version label Jun 5, 2022

This was referenced Jun 16, 2022

LiveQuery connection interrupts frequently #8047

Closed

fix: websocket connection of LiveQuery interrupts frequently #8048

Merged

parseplatformorg added the state:released-beta Released as beta version label Jun 17, 2022

parseplatformorg added the state:released Released as stable version label Oct 29, 2022

Uh oh!

fix: interrupted WebSocket connection not closed by LiveQuery server #8012

fix: interrupted WebSocket connection not closed by LiveQuery server #8012

Uh oh!

Conversation

pash2048 commented May 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Pull Request Checklist

Issue Description

Approach

TODOs before merging

Uh oh!

parse-github-assistant bot commented May 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Thanks for opening this pull request!

Uh oh!

mtrezza commented May 24, 2022

Uh oh!

pash2048 commented May 25, 2022

Uh oh!

mtrezza commented May 25, 2022

Uh oh!

dblythy commented May 25, 2022

Uh oh!

pash2048 commented May 28, 2022

Uh oh!

mtrezza commented May 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pash2048 commented May 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

codecov bot commented May 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mtrezza left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pash2048 commented Jun 1, 2022

Uh oh!

mtrezza commented Jun 2, 2022

Uh oh!

mtrezza commented Jun 4, 2022

Uh oh!

dblythy left a comment

Choose a reason for hiding this comment

Uh oh!

parseplatformorg commented Jun 5, 2022

Uh oh!

parseplatformorg commented Jun 17, 2022

Uh oh!

parseplatformorg commented Oct 29, 2022

Uh oh!

Uh oh!

pash2048 commented May 24, 2022 •

edited

Loading

parse-github-assistant bot commented May 24, 2022 •

edited

Loading

mtrezza commented May 28, 2022 •

edited

Loading

pash2048 commented May 28, 2022 •

edited

Loading

codecov bot commented May 28, 2022 •

edited

Loading

mtrezza left a comment •

edited

Loading