Skip to content

make cache purge environment aware #267

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.

Sign up for GitHub

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

Merged
jacobbednarz merged 5 commits into from
Dec 17, 2024
Merged

make cache purge environment aware #267

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9fca1b3
make cache purge environment aware
Dec 17, 2024
73b49cd
Update tests/Endpoints/ZoneCacheTest.php
jafowler Dec 17, 2024
2dceed9
remove extra trailing comma
jacobbednarz Dec 17, 2024
0a78ed0
supress phpmd for zone cache functions
Dec 17, 2024
06412c0
fix phpmd annotation
jacobbednarz Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions src/Endpoints/Zones.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?php

/**
* Created by PhpStorm.
* User: junade
Expand Down Expand Up @@ -217,8 +218,15 @@ public function setCachingLevel(string $zoneID, string $level = 'aggressive'): b
* @param string $zoneID
* @return bool
*/
public function cachePurgeEverything(string $zoneID): bool
public function cachePurgeEverything(string $zoneID, bool $includeEnvironments = false): bool
{
if ($includeEnvironments) {
$env = $this->adapter->get("zones/$zoneID/environments");
$envs = json_decode($env->getBody(), true);
foreach ($envs["result"]["environments"] as $env) {
$this->adapter->post("zones/$zoneID/environments/{$env["ref"]}/purge_cache", ['purge_everything' => true]);
}
}
$user = $this->adapter->post('zones/' . $zoneID . '/purge_cache', ['purge_everything' => true]);

$this->body = json_decode($user->getBody());
Expand All @@ -230,7 +238,7 @@ public function cachePurgeEverything(string $zoneID): bool
return false;
}

public function cachePurge(string $zoneID, array $files = null, array $tags = null, array $hosts = null): bool
public function cachePurge(string $zoneID, array $files = null, array $tags = null, array $hosts = null, bool $includeEnvironments = false): bool
{
if ($files === null && $tags === null && $hosts === null) {
throw new EndpointException('No files, tags or hosts to purge.');
Expand All @@ -249,6 +257,14 @@ public function cachePurge(string $zoneID, array $files = null, array $tags = nu
$options['hosts'] = $hosts;
}

if ($includeEnvironments) {
$env = $this->adapter->get("zones/$zoneID/environments");
$envs = json_decode($env->getBody(), true);
foreach ($envs["result"]["environments"] as $env) {
$this->adapter->post("zones/$zoneID/environments/{$env["ref"]}/purge_cache", $options);
}
}

$user = $this->adapter->post('zones/' . $zoneID . '/purge_cache', $options);

$this->body = json_decode($user->getBody());
Expand Down
109 changes: 106 additions & 3 deletions tests/Endpoints/ZoneCacheTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,10 @@ public function testCachePurge()
->method('post')
->with(
$this->equalTo('zones/c2547eb745079dac9320b638f5e225cf483cc5cfdda41/purge_cache'),
$this->equalTo(['files' => [
'https://example.com/file.jpg',
]
$this->equalTo([
'files' => [
'https://example.com/file.jpg',
]
])
);

Expand All @@ -75,4 +76,106 @@ public function testCachePurge()
$this->assertTrue($result);
$this->assertEquals('023e105f4ecef8ad9ca31a8372d0c353', $zones->getBody()->result->id);
}

public function testCachePurgeIncludingEnvironments()
{
$envResp = $this->getPsr7JsonResponseForFixture('Endpoints/getEnvironments.json');
$cacheResp = $this->getPsr7JsonResponseForFixture('Endpoints/cachePurge.json');
$mock = $this->getMockBuilder(\Cloudflare\API\Adapter\Adapter::class)->getMock();

$mock->expects($this->once())
->method('get')
->willReturn($envResp)
->with(
$this->equalTo('zones/c2547eb745079dac9320b638f5e225cf483cc5cfdda41/environments'),
);

$mock->expects($this->exactly(4))
->method('post')
->willReturn($cacheResp)
->withConsecutive(
[
$this->equalTo('zones/c2547eb745079dac9320b638f5e225cf483cc5cfdda41/environments/first/purge_cache'),
$this->equalTo([
'files' => [
'https://example.com/file.jpg',
]
])
],
[
$this->equalTo('zones/c2547eb745079dac9320b638f5e225cf483cc5cfdda41/environments/second/purge_cache'),
$this->equalTo([
'files' => [
'https://example.com/file.jpg',
]
])
],
[
$this->equalTo('zones/c2547eb745079dac9320b638f5e225cf483cc5cfdda41/environments/third/purge_cache'),
$this->equalTo([
'files' => [
'https://example.com/file.jpg',
]
])
],
[
$this->equalTo('zones/c2547eb745079dac9320b638f5e225cf483cc5cfdda41/purge_cache'),
$this->equalTo([
'files' => [
'https://example.com/file.jpg',
]
])
]
);

$zones = new \Cloudflare\API\Endpoints\Zones($mock);
$result = $zones->cachePurge('c2547eb745079dac9320b638f5e225cf483cc5cfdda41', [
'https://example.com/file.jpg',
], null, null, true);

$this->assertTrue($result);
$this->assertEquals('023e105f4ecef8ad9ca31a8372d0c353', $zones->getBody()->result->id);
}

public function testCachePurgeEverythingIncludingEnvironments()
{
$envResp = $this->getPsr7JsonResponseForFixture('Endpoints/getEnvironments.json');
$cacheResp = $this->getPsr7JsonResponseForFixture('Endpoints/cachePurgeEverything.json');
$mock = $this->getMockBuilder(\Cloudflare\API\Adapter\Adapter::class)->getMock();

$mock->expects($this->once())
->method('get')
->willReturn($envResp)
->with(
$this->equalTo('zones/c2547eb745079dac9320b638f5e225cf483cc5cfdda41/environments'),
);

$mock->expects($this->exactly(4))
->method('post')
->willReturn($cacheResp)
->withConsecutive(
[
$this->equalTo('zones/c2547eb745079dac9320b638f5e225cf483cc5cfdda41/environments/first/purge_cache'),
$this->equalTo(['purge_everything' => true])
],
[
$this->equalTo('zones/c2547eb745079dac9320b638f5e225cf483cc5cfdda41/environments/second/purge_cache'),
$this->equalTo(['purge_everything' => true])
],
[
$this->equalTo('zones/c2547eb745079dac9320b638f5e225cf483cc5cfdda41/environments/third/purge_cache'),
$this->equalTo(['purge_everything' => true])
],
[
$this->equalTo('zones/c2547eb745079dac9320b638f5e225cf483cc5cfdda41/purge_cache'),
$this->equalTo(['purge_everything' => true])
]
);

$zones = new \Cloudflare\API\Endpoints\Zones($mock);
$result = $zones->cachePurgeEverything('c2547eb745079dac9320b638f5e225cf483cc5cfdda41', true);

$this->assertTrue($result);
$this->assertEquals('023e105f4ecef8ad9ca31a8372d0c353', $zones->getBody()->result->id);
}
}
40 changes: 40 additions & 0 deletions tests/Fixtures/Endpoints/getEnvironments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"result": {
"environments": [
{
"name": "Production",
"ref": "first",
"version": 0,
"expression": "expression_1",
"locked_on_deployment": false,
"position": {
"before": "second"
}
},
{
"name": "Staging",
"ref": "second",
"version": 0,
"expression": "expression_2",
"locked_on_deployment": false,
"position": {
"before": "third",
"after": "first"
}
},
{
"name": "Development",
"ref": "third",
"version": 0,
"expression": "expression_3",
"locked_on_deployment": false,
"position": {
"after": "second"
}
}
]
},
"success": true,
"errors": [],
"messages": []
}
Loading