How to fake requests with OAuth2?

[thursdaydan]

Hi, just started using saloon and loving it. It's an excellent package and we are building all of our API integrations with it for a nice standardised developer experience.

I'm just starting to explore the testing side of it and have a question around OAuth2, I've not seen any discussion of this in here or the docs and wondered if someone could tell me where I'm going wrong please.

This is my basic test at the moment:

public function can_create_invoice(): void
{
    Saloon::fake([
        CreateInvoiceRequest::class => MockResponse::fixture('xero/create-invoice')
    ]);

    $xero = new XeroAuthConnector;

     $request = new CreateInvoiceRequest([
        'Type' => null,
        'Contact' => ['ContactID' => null],
        'LineItems' => null,
        'Date' => null,
        'DueDate' => null,
        'Reference' => null,
        'Status' => null,
    ]);

    $response = $xero->send($request);

    dd($response->status(), $response->body());
}

Running the above results in the following error:

InvalidArgumentException: The given value is not an OAuthAuthenticator instance.
/var/www/html/vendor/saloonphp/laravel-plugin/src/Casts/OAuthAuthenticatorCast.php:37
/var/www/html/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Concerns/HasAttributes.php:1136
/var/www/html/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Concerns/HasAttributes.php:976
/var/www/html/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:519
/var/www/html/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:613
/var/www/html/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Builder.php:1535
/var/www/html/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Builder.php:1020
/var/www/html/vendor/laravel/framework/src/Illuminate/Support/Traits/ForwardsCalls.php:23
/var/www/html/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:2334
/var/www/html/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php:2346
/var/www/html/tests/TestCase.php:70
/var/www/html/tests/TestCase.php:35
/var/www/html/tests/TestCase.php:29
/var/www/html/tests/Feature/Api/Integrations/Xero/InvoicesTest.php:29

Here is how I'm handling the authentication, based from the spotify example repo:

public function xero(): XeroApiConnector
{
    $authorisation = $this->accountIntegration->auth;

    if ($authorisation->hasExpired()) {
        try {
            $authorisation = XeroAuthConnector::make()->refreshAccessToken($authorisation);
        } catch (\ReflectionException|OAuthConfigValidationException|\Throwable $e) {
            Log::error($e->getMessage());
        }

        $this->accountIntegration->auth = $authorisation;
        $this->accountIntegration->save();
    }

    return XeroApiConnector::make()->authenticate($authorisation);
}

[Sammyjo20]

Hey @thursdaydan thank you for the kind words! ❤️

I wonder if this is because the $authorisation = $this->accountIntegration->auth; line isn't returning an authenticator at this stage because in your tests, it's not in the database?

Let me know if there's something wrong with the cast with null values and I can take a look.

You can "fake" the OAuth2 process just like you are with the current mock client - you can fake the underlying OAuth2 requests:

Listed here: https://github.com/saloonphp/saloon/tree/v3/src/Http/OAuth2

Although faking OAuth2 can be tricky because in a test suite, there's no browser to open to initiate the OAuth2 process. It's been something I've been thinking about for a while. Let me know if you have any ideas on this.