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
|
<?php
namespace AmpProject;
/**
* Queries https://cdn.ampproject.org/rtv/metadata for the latest AMP runtime version. Uses a stale-while-revalidate
* caching strategy to avoid refreshing the version.
*
* More details: https://cdn.ampproject.org/rtv/metadata returns the following metadata:
*
* <pre>
* {
* "ampRuntimeVersion": "CURRENT_PROD",
* "ampCssUrl": "https://cdn.ampproject.org/rtv/CURRENT_PROD/v0.css",
* "canaryPercentage": "0.1",
* "diversions": [
* "CURRENT_OPTIN",
* "CURRENT_1%",
* "CURRENT_CONTROL"
* ]
* }
* </pre>
*
* where:
*
* <ul>
* <li> CURRENT_OPTIN: is when you go to https://cdn.ampproject.org/experiments.html and toggle "dev-channel". It's
* the earliest possible time to get new code.</li>
* <li> CURRENT_1%: 1% is the same code as opt-in that we're now comfortable releasing to 1% of the population.</li>
* <li> CURRENT_CONTROL is the same thing as production, but with a different URL. This is to compare experiments
* against, since prod's immutable caching would affect metrics.</li>
* </ul>
*
* @package ampproject/common
*/
final class RuntimeVersion
{
/**
* Option to retrieve the latest canary version data instead of the production version data.
*
* @var string
*/
const OPTION_CANARY = 'canary';
/**
* Endpoint to query for retrieving the runtime version data.
*/
const RUNTIME_METADATA_ENDPOINT = 'https://cdn.ampproject.org/rtv/metadata';
/**
* Transport to use for remote requests.
*
* @var RemoteGetRequest
*/
private $remoteRequest;
/**
* Instantiate a RuntimeVersion object.
*
* @param RemoteGetRequest $remoteRequest Transport to use for remote requests.
*/
public function __construct(RemoteGetRequest $remoteRequest)
{
$this->remoteRequest = $remoteRequest;
}
/**
* Returns the version of the current AMP runtime release.
*
* Pass [ canary => true ] to get the latest canary version.
*
* @param array $options Optional. Associative array of options.
* @return string Version string of the AMP runtime.
*/
public function currentVersion($options = [])
{
$response = $this->remoteRequest->get(self::RUNTIME_METADATA_ENDPOINT);
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode >= 300) {
return '0';
}
$metadata = json_decode($response->getBody());
$version = (! empty($options['canary']))
? $metadata->diversions[0]
: $metadata->ampRuntimeVersion;
return $this->padVersionString($version);
}
/**
* Pad the version string to the required length.
*
* @param string $version Version string to pad.
* @return string Padded version string.
*/
private function padVersionString($version)
{
return str_pad($version, 15, 0);
}
}
|