Extends filterUserField to pass the resource to all fieldGates (!112) · Merge requests · composer / laravel-api-controller · GitLab

GitLab now enforces expiry dates on tokens that originally had no set expiration date. Those tokens were given an expiration date of one year later. Please review your personal access tokens, project access tokens, and group access tokens to ensure you are aware of upcoming expirations. Administrators of GitLab can find more information on how to identify and mitigate interruption in our documentation.

Robert Sinton requested to merge feature/pass_resource_to_gates into master Apr 11, 2022

Background

Extends filterUserField to pass the resource to all fieldGates, to allow for context-dependent decisions.

Also documents the use of fieldGates, and adds some hints about using relationships in defaultFields and allowedFields.

Action Plan / Actions Taken

Extended filterUserField to pass the resource to all fieldGates, so that gates with context-dependent logic can be used.
Added documentation for gatedFields.
Added mentions of the need to reference related resources in $defaultFields and/or $allowedFields.

Added tests?

Yes, of course
No, and here's why: no test suite to fit them into!
I need help writing tests

Implications

None

Setup

Can be tested with feature/include_artworks_when_fetching_purchase in the Art Money API project.

How to test

Code review.
Review the new/updated tests carefully: are they correct, sufficient, and passing?
Use feature/include_artworks_when_fetching_purchase to test it. Play around with the gate definition to allow/deny access.
Try and break it!