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

support content-type of application/json on AJAX requests #30678

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

MegaphoneJon
Copy link
Contributor

Overview

This is #29886, but I've addressed Coleman's concern by fixing the non-deprecated function as well.

I force-pushed my change and tried reopening that PR, but apparently you have to reopen before force-pushing or not at all.

Before

Can't submit JSON-formatted POST requests.

After

You can.

Technical Details

While I don't love the static variable, my profiling of Civi shows that we lose a ridiculous amount of time to serializing/deserializing data (including JSON), even though it uses internal functions. So we only decode the POST request once.

I didn't think this necessary on the deprecated function because it seems far less likely to get called multiple times (it retrieves all values, not just one) but I could be swayed to add it to both (or leave it off of both).

Copy link

civibot bot commented Jul 15, 2024

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers...

➡️ Online demo of this PR 🔗

@civibot civibot bot added the master label Jul 15, 2024
@MegaphoneJon
Copy link
Contributor Author

test this please

static $post = NULL;
if (!isset($post)) {
$rawPost = file_get_contents('php://input');
$post = json_decode($rawPost, TRUE) ?? [];
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this give reasonable performance? The input JSON is decoded every time a value is requested, instead of only once per request.

Copy link
Member

Choose a reason for hiding this comment

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

In practice, I don't think this is called very many times per request.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, I agree. Normally this is only called a couple of times, and json_decode is pretty fast.

However, this loop can become problematic. It will decode JSON again for every key in the request JSON. This quadratic complexity could be abused in a denial-of-service attack.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Sjord Shouldn't the static keyword on line 137 (static $post = NULL) prevent this from being decoded multiple times?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, you are right. Thanks for pointing that out. So it is decoded only once per request, I was mistaken about that.

@MegaphoneJon
Copy link
Contributor Author

test this please

I think the test fails are unrelated, hopefully this will provide some insight.

@MegaphoneJon
Copy link
Contributor Author

This is only failing on a test that looks like it's failing generally, api\v4\SearchDisplay\SearchRunTest.testRunWithTags.

@colemanw
Copy link
Member

That test was fixed already in master so a rebase would get rid of the failure. Or you can just ignore it.

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

Successfully merging this pull request may close these issues.

3 participants