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

CRM: Fix companies API endpoint param mapping #41508

Open
wants to merge 6 commits into
base: trunk
Choose a base branch
from

Conversation

tbradsha
Copy link
Contributor

@tbradsha tbradsha commented Feb 3, 2025

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 to zeroBS_getCompanies with 18 params, whereas said function only has 12 params. Looking through the commit history, it seems the call was actually copied from zeroBS_getCustomers() (which had 18 params at the time but now has 19), and params were never adjusted.

This illustrates it best:

Call Position Endpoint call zeroBS_getCompanies zeroBS_getCustomers
1 true $withFullDetails $withFullDetails
2 $perPage $perPage $perPage
3 $page $page $page
4 $withInvoices $searchPhrase $withInvoices
5 $withQuotes $argsOverride $withQuotes
6 $searchPhrase $withInvoices $searchPhrase
7 $withTransactions $withQuotes $withTransactions
8 false $withTransactions $argsOverride
9 false $inCountry $companyID
10 '' $ownedByID $hasTagIDs
11 '' $withStatus $inArr
12 false $inArr $withTags
13 false (No parameter) $withAssigned
14 false (No parameter) $withLastLog
15 'ID' (No parameter) $sortByField
16 'DESC' (No parameter) $sortOrder
17 false (No parameter) $quickFilters
18 $isAssigned (No parameter) $ownedByID

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:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

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.

@tbradsha tbradsha self-assigned this Feb 3, 2025
@github-actions github-actions bot added [CRM] API [Plugin] CRM Issues about the Jetpack CRM plugin labels Feb 3, 2025
Copy link
Contributor

github-actions bot commented Feb 3, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

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:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Feb 3, 2025
Copy link
Contributor

github-actions bot commented Feb 3, 2025

Code Coverage Summary

Coverage changed in 1 file.

File Coverage Δ% Δ Uncovered
projects/plugins/crm/api/companies.php 0/43 (0.00%) 0.00% 11 💔

Full summary · PHP report

@tbradsha tbradsha added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Bug When a feature is broken and / or not performing as intended and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[CRM] API [Plugin] CRM Issues about the Jetpack CRM plugin [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant