php-api-sdk/tests/Integration/CacheTest.php at 5d17eb8a9128eb4a40c21db927a2680e8b675a12 · programmatordev/php-api-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<?php

namespace ProgrammatorDev\Api\Test\Integration;

use Nyholm\Psr7\Response;
use ProgrammatorDev\Api\Test\Fixture\JsonApi;
use ProgrammatorDev\Api\Test\Fixture\FakeApi;
use ProgrammatorDev\Api\Test\Support\AbstractTestCase;
use Symfony\Component\Cache\Adapter\ArrayAdapter;

class CacheTest extends AbstractTestCase
{
    public function testSdkUserCanConfigureCache(): void
    {
        $client = $this->mockClient(new Response(
            headers: ['Cache-Control' => 'max-age=60'],
            body: '{"id":1}'
        ));

        $api = new JsonApi($client);
        $api
            ->setup()->cache(new ArrayAdapter())
            ->defaultTtl(60);

        $first = $api->raw()->fetch();
        $second = $api->raw()->fetch();

        $this->assertSame(['id' => 1], $first->data());
        $this->assertSame(['id' => 1], $second->data());
        $this->assertCount(1, $client->getRequests());
    }

    public function testEndpointCanOverrideCacheConfiguration(): void
    {
        $client = $this->mockClient(new Response(body: '{"id":1,"name":"John"}'));
        $api = new FakeApi($client);
        $api->setup()->cache(new ArrayAdapter())->methods(['GET']);

        $first = $api->users()->createWithEndpointCache(['name' => 'John']);
        $second = $api->users()->createWithEndpointCache(['name' => 'John']);

        $this->assertSame(['id' => 1, 'name' => 'John'], $first->data());
        $this->assertSame(['id' => 1, 'name' => 'John'], $second->data());
        $this->assertCount(1, $client->getRequests());
    }

    public function testResourceCacheOverrideWinsOverEndpointCacheDefault(): void
    {
        $client = $this->mockClient(
            new Response(body: '{"id":1,"name":"John"}'),
            new Response(body: '{"id":2,"name":"Jane"}')
        );
        $api = new FakeApi($client);
        $api->setup()->cache(new ArrayAdapter())->methods(['GET']);

        $first = $api
            ->users()
            ->withCache(fn($cache) => $cache->methods(['GET']))
            ->createWithEndpointCache(['name' => 'John']);

        $second = $api
            ->users()
            ->withCache(fn($cache) => $cache->methods(['GET']))
            ->createWithEndpointCache(['name' => 'John']);

        $this->assertSame(['id' => 1, 'name' => 'John'], $first->data());
        $this->assertSame(['id' => 2, 'name' => 'Jane'], $second->data());
        $this->assertCount(2, $client->getRequests());
    }

    public function testEndpointCacheOverridesAreAppliedInFluentOrder(): void
    {
        $client = $this->mockClient(
            new Response(body: '{"id":1,"name":"John"}'),
            new Response(body: '{"id":2,"name":"Jane"}')
        );
        $api = new FakeApi($client);
        $api->setup()->cache(new ArrayAdapter())->methods(['GET']);

        $first = $api->users()->createWithChainedEndpointCache(['name' => 'John']);
        $second = $api->users()->createWithChainedEndpointCache(['name' => 'John']);

        $this->assertSame(['id' => 1, 'name' => 'John'], $first->data());
        $this->assertSame(['id' => 2, 'name' => 'Jane'], $second->data());
        $this->assertCount(2, $client->getRequests());
    }

    public function testResourceCacheOverrideRequiresGlobalCacheConfiguration(): void
    {
        $this->expectException(\RuntimeException::class);
        $this->expectExceptionMessage('Endpoint cache overrides require API-level cache configuration.');

        $client = $this->mockClient(new Response(body: '{"id":1,"name":"John"}'));
        $api = new FakeApi($client);

        $api
            ->users()
            ->withCache(fn($cache) => $cache->defaultTtl(60))
            ->find(1);
    }

    public function testCachedResponsesUseCurrentResourceConfig(): void
    {
        $client = $this->mockClient(new Response(
            headers: ['Cache-Control' => 'max-age=60'],
            body: '{"id":1,"name":"John"}'
        ));
        $api = new FakeApi($client);
        $api->setup()->cache(new ArrayAdapter())->defaultTtl(60);

        $utc = $api
            ->users()
            ->withConfig(['timezone' => 'UTC'])
            ->find(1);

        $lisbon = $api
            ->users()
            ->withConfig(['timezone' => 'Europe/Lisbon'])
            ->find(1);

        $this->assertSame('UTC', $utc->getTimezone());
        $this->assertSame('Europe/Lisbon', $lisbon->getTimezone());
        $this->assertCount(1, $client->getRequests());
    }

    public function testResourceConfigAndCacheOverridesComposeInEitherOrder(): void
    {
        $client = $this->mockClient(
            new Response(body: '{"id":1,"name":"John"}'),
            new Response(body: '{"id":2,"name":"Jane"}')
        );
        $api = new FakeApi($client);
        $api->setup()->cache(new ArrayAdapter())->methods(['GET']);

        $first = $api
            ->users()
            ->withConfig(['timezone' => 'Europe/Lisbon'])
            ->withCache(fn($cache) => $cache->methods([]))
            ->find(1);

        $second = $api
            ->users()
            ->withCache(fn($cache) => $cache->methods([]))
            ->withConfig(['timezone' => 'Europe/Lisbon'])
            ->find(2);

        $this->assertSame('Europe/Lisbon', $first->getTimezone());
        $this->assertSame('Europe/Lisbon', $second->getTimezone());
        $this->assertCount(2, $client->getRequests());
    }
}