feat: Enable Parse.idempotency by default

[dplewis]

Pull Request

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

Issue

There isn't a well documented way to turn idempotency on, enabling it by default only requires configuration on the server side. This is how it is handled in other SDKs

parse-community/Parse-Swift#62
parse-community/Parse-SDK-iOS-OSX#1790
parse-community/Parse-SDK-Android#1190

Approach

• Remove check for POST / PUT request method as they are handled by servers
• Add requestId to every request by default

Tasks

• Add tests
• Add changes to documentation (guides, repository pages, code comments)

[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 (df6df7c) to head (6ac20ca).
Report is 1 commits behind head on alpha.

Additional details and impacted files

@@            Coverage Diff            @@
##             alpha     #2164   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           64        64           
  Lines         6364      6363    -1     
  Branches      1507      1509    +2     
=========================================
- Hits          6364      6363    -1     

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

[mtrezza]

• This would likely be a breaking change for the JS SDK, since it changes the request headers.
• What's the purpose of turning this on by default? Is that on be default in the other client SDKs?

[dplewis]

This should have been enabled from the beginning. This is the default behavior of the other SDKs as I mentioned in the OP.

I wouldn't consider this a breaking change as wouldn't cause any disruptions to the developers. Adding this request header by default is pretty much useless unless the feature is enabled on the server. If it’s enabled on the server already it’s likely enabled in the SDK

A breaking change would be removing the ability to turn it off.

[mtrezza]

I'm not sure it should be on by default. That's at least not what I had in mind when I designed the feature. It's costly on server side resources when it's enabled on the server and a minority of users is likely using it. Sending a UID by default from the client to the server without the server using it would not be good practice because that generates unnecessary costs.

It could be breaking considering that we change the request headers. An additional header may cause a request to be rejected on tightly configured firewalls. It's like changing a request HTTP method, that would also be a breaking change for the same reason.

[dplewis]

@mtrezza Im closing this as it works for me. From a client side cost side we should purge the other SDKs headers as well from the parse.com days. Can you add documentation so developers can enable this feature since designed it?

[mtrezza]

I agree that other client SDKs should also not send the idempotency header by default. For docs see here.