Skip to content
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.

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

Perform occurrence POST write async #1037

Merged
merged 1 commit into from Aug 1, 2022

Conversation

waltjones
Copy link
Contributor

Description of the change

There are concerns that when sending an occurrence, the write of the POST request payload can be blocked, blocking the caller. This is specifically about the request write not completing, not about any delay or timeout related to the response, which is already async.

While the http response completes async, the request is performed on the caller's thread. There are concerns that the caller could be blocked in some cases.

This PR uses a zero setTimeout to get off the caller's tick before making the request. This PR also updates all tests that relied on the request being synchronous. (Typically tests that inspect the request.)

Notes:
This PR adheres to this project's es5 syntax.

The execution is kept synchronous until the payload is fully constructed. Making these paths async would cause an undesired change in behavior where objects such as custom data would change value before being evaluated for the payload.

If the subsequent network write blocks the event loop, that may still lead to a perf impact, but that is outside the scope of this PR.

Type of change

  • Bug fix (non-breaking change that fixes an issue)

Related issues

Fixes: https://app.shortcut.com/rollbar/story/112245
Fixes: #1036

Development

  • Lint rules pass locally
  • The code changed/added as part of this pull request has been covered with tests
  • All tests related to the changed code pass in development

Code review

  • This pull request has a descriptive title and information useful to a reviewer. There may be a screenshot or screencast attached
  • "Ready for review" label attached to the PR and reviewers assigned
  • Issue from task tracker has a link to this pull request
  • Changes have been reviewed by at least one other engineer

Copy link
Contributor

@mudetroit mudetroit left a comment

Choose a reason for hiding this comment

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

Yeah what you are doing here makes sense to me. As per my note, watch out for any flakiness on those setTimeouts with the tests, but that may take time to expose itself.


var body = JSON.parse(server.requests[0].requestBody);
setTimeout(function() {
Copy link
Contributor

Choose a reason for hiding this comment

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

Comment
This strategy should work find 99% of the time, just watch out for flakiness. I don't think that there is a guarantee on execution order based on the length of the timeout

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True, there's no guarantee.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wrapped Rollbar Node SDK running into timeout issues
2 participants