test: Prevent test timeout error by properly closing server

[dplewis]

Pull Request

• Report security issues confidentially.
• Any contribution is under this license.
• Link this pull request to an issue.

Issue

https://github.com/parse-community/Parse-SDK-JS/actions/runs/13735695802/job/38419094737?pr=2486

Error: Timeout - Async function did not complete within 20000ms (set by jasmine.DEFAULT_TIMEOUT_INTERVAL)

parseServer.handleShutdown calls liveQueryServer.server.close(). When initializing the server with startLiveQueryServer option liveQueryServer.server and parseServer.server are the same so we are calling server.close() twice. This maybe the cause of the issue. As we can see the tests still pass without getting an EADDRINUSE error because now we are calling close once.

See: #2487

Approach

• Remove unused route
• Cache distribution files for performance
• Remove multiple server close events.
• Improve shutdown tests
• Refactor handleShutdown
• Set REQUEST_ATTEMPT_LIMIT to 1 to check for network drops
• Remove afterAll since the tests end at this point we don't care about open connections as the server will shutdown anyway.

If the issue persists then we can try to close all the connections. server.close prevents new connections but keeps existing ones alive until they are closed. There is now a server.closeAllConnections() method introduced in Node v18.2.0. If all else fails we can look into parseServer.handleShutdown() internals.

[parse-github-assistant]

Thanks for opening this pull request!

• ❌ Please link an issue that describes the reason for this pull request, otherwise your pull request will be closed. Make sure to write it as Closes: #123 in the PR description, so I can recognize it.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (43cba58) to head (d93d21a).
Report is 20 commits behind head on alpha.

Additional details and impacted files

@@            Coverage Diff            @@
##             alpha     #2490   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           64        64           
  Lines         6268      6268           
  Branches      1468      1468           
=========================================
  Hits          6268      6268           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[dplewis]

@mtrezza The issue still occurred. https://github.com/parse-community/Parse-SDK-JS/actions/runs/13749596429/job/38448859505

This tells me that this issue is with parseServer.handleShutdown() stalling. I added logic to run handleShutdown in the background and listen to the close event. I also destroyed all the connections to ensure the event is emitted. afdeb2b

Destroy connections was removed in #2185. This didn't work because you have to destroy the connections after you call server.close() to prevent a race condition.

https://nodejs.org/api/net.html#event-close

Emitted when the server closes. If connections exist, this event is not emitted until all connections are ended.

If this fails again the offending line is in handleShutdown for the same reasons stated above
https://github.com/parse-community/parse-server/blob/4f55c3e9cfa31c6aca9c005ab21ff6193600ba89/src/ParseServer.js#L232

[dplewis]

@mtrezza Until parseServer.handleShutdown is fixed on the server I moved the shutdown logic here. This gives us better control of the shutdown process. This should be good to merge. I ran it 20 times locally and got no errors timeout errors.

[dplewis]

@mtrezza This is ready for review

[mtrezza]

@mtrezza Until parseServer.handleShutdown is fixed on the server I moved the shutdown logic here. This gives us better control of the shutdown process. This should be good to merge. I ran it 20 times locally and got no errors timeout errors.

Are you referring to parse-community/parse-server#9634? Since it has been merged, are there any changes needed here, e.g. can the shutdown logic be removed here - because you wrote "Until parseServer.handleShutdown is fixed..."?

[dplewis]

You can merge this now then we can change it whenever parse-community/parse-server#9634 gets merged (I hope it works) and the server update gets released. This should work fine as is.

[parseplatformorg]

🎉 This change has been released in version 6.1.0-alpha.3

[parseplatformorg]

🎉 This change has been released in version 6.1.0