dev/core#2779 - Specify row fields to fetch in Api4 OAuthSysToken.Refresh

[ufundo]

Overview

Fix for https://lab.civicrm.org/dev/core/-/issues/2779

Before

Api4 action implementation was broken by this update to underlying BasicBatchAction class interface https://lab.civicrm.org/dev/core/-/commit/29ab318b684a79f4cdedde2bf0417775d4be5523

After

Previous functionality restored

Technical Details

The required fields from the OAuthSysToken table for the batch action are now explicitly specified using getSelect() method. Previously it fetched all using a wildcard "*" but I don't think this is possible any more. If the method needed additional fields they would need to be added to the selectFields array

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[demeritcowboy]

Also if this stopped working in 5.40 then the base branch for this PR should be 5.41 (because that's the standard procedure for backporting to recent breakage). Sorry I forgot to mention that in the lab ticket. It might work to just change that in the PR settings here but it usually breaks it. I'll try it.

[demeritcowboy]

Yep that broke it.
You should be able to do this:

git fetch upstream 5.41      -- assuming you've used "upstream" for https://github.com/civicrm/civicrm-core.git
git reset --hard upstream/5.41
[ Then redo your changes. ]
git commit -a -m "implement-basicbatchaction-getselect"
git push -f

[ufundo]

Thanks @demeritcowboy . I think third-time-lucky I may have just managed that cleanly :)

[demeritcowboy]

Yep looks good - thanks!

[seamuslee001]

Merging based on @demeritcowboy 's review and @totten 's supportive comments in MM https://chat.civicrm.org/civicrm/pl/ie5d7s6is3dmfj5nycd81s6igo

[totten]

I agree this change is good and necessary to address the regression.

Just to note that the select-list is now smaller than it was before.

$ cv api4 OAuthSysToken.getFields -T +s name

+---------------------+
| name                |
+---------------------+
| id                  | yes
| client_id           | yes
| token_type          | yes
| access_token        | yes
| expires             | yes
| refresh_token       | yes
| raw                 | yes
| tag                 | no longer
| grant_type          | no longer
| scopes              | no longer
| resource_owner_name | no longer
| resource_owner      | no longer
| error               | no longer
| created_date        | no longer
| modified_date       | no longer
+---------------------+

(Annotations: "yes" - restored as part of the list; "no longer" - would've matched * but no longer matches the list)

AFAICS, this list does cover the most important fields for a typical refresh. I can't spot/think of any specific problems with the smaller list. Just noting the change in case there are edgey issues later or in case it triggers any thoughts.