-
Notifications
You must be signed in to change notification settings - Fork 808
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
CRM: Fix companies API endpoint param mapping #41508
base: trunk
Are you sure you want to change the base?
Conversation
Thank you for your PR! When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:
This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖 The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available. Follow this PR Review Process:
Still unsure? Reach out in #jetpack-developers for guidance! |
Code Coverage SummaryCoverage changed in 1 file.
|
The param mapping for the
companies
endpoint was incorrect. This PR corrects the mapping so it does what it says it does, and does a direct DAL call.There's a slight chance that this would affect end users that are using less common endpoint params, but the fact that no one reported the issue with params not doing what they were saying means it's likely no one noticed.
I also did some linting in the first commit.
Proposed changes:
When working through
PhanParamTooMany
instances (#41263) I noticed one instance in CRM that required more investigation.The
companies
endpoint made a call tozeroBS_getCompanies
with 18 params, whereas said function only has 12 params. Looking through the commit history, it seems the call was actually copied fromzeroBS_getCustomers()
(which had 18 params at the time but now has 19), and params were never adjusted.This illustrates it best:
true
$perPage
$page
$withInvoices
$withQuotes
$searchPhrase
$withTransactions
false
false
''
''
false
false
false
'ID'
'DESC'
false
$isAssigned
Most of the params were passed through as defaults or not used, so they weren't passed through in the DAL call. I did not expose
sort
to the end user at this point, but it's available for easy implementation down the road.Other information:
Jetpack product discussion
Does this pull request change what data or activity we track or use?
Testing instructions:
Make sure the endpoint works as expected.