/
ModulesService.php
426 lines (388 loc) · 14.6 KB
/
ModulesService.php
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
<?php
/**
* Copyright 2021 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* An API for fetching information about and controlling App Engine Modules.
*
*/
namespace Google\AppEngine\Api\Modules;
use Google\AppEngine\Runtime\ApiProxy;
use Google\AppEngine\Runtime\ApplicationError;
use google\appengine\GetDefaultVersionRequest;
use google\appengine\GetDefaultVersionResponse;
use google\appengine\GetHostnameRequest;
use google\appengine\GetHostnameResponse;
use google\appengine\GetModulesRequest;
use google\appengine\GetModulesResponse;
use google\appengine\GetNumInstancesRequest;
use google\appengine\GetNumInstancesResponse;
use google\appengine\GetVersionsRequest;
use google\appengine\GetVersionsResponse;
use google\appengine\ModulesServiceError\ErrorCode;
use google\appengine\SetNumInstancesRequest;
use google\appengine\SetNumInstancesResponse;
use google\appengine\StartModuleRequest;
use google\appengine\StartModuleResponse;
use google\appengine\StopModuleRequest;
use google\appengine\StopModuleResponse;
final class ModulesService {
private static function errorCodeToException($error) {
switch($error) {
case ErrorCode::INVALID_MODULE:
return new ModulesException('Invalid module.');
case ErrorCode::INVALID_VERSION:
return new ModulesException('Invalid version.');
case ErrorCode::INVALID_INSTANCES:
return new ModulesException('Invalid instances.');
case ErrorCode::TRANSIENT_ERROR:
return new TransientModulesException('Temporary error, please re-try');
case ErrorCode::UNEXPECTED_STATE:
return new InvalidModuleStateException('Module in an unexpected state');
default:
return new ModulesException('Error Code: ' . $error);
}
}
/**
* Gets the name of the currently running module.
*
* @return string The name of the current module. For example, if this is
* version "v1" of module "module5" for app "my-app", this function
* will return "module5".
*/
public static function getCurrentModuleName() {
return $_SERVER['CURRENT_MODULE_ID'];
}
/**
* Gets the version of the currently running module.
*
* @return string The name of the current module. For example, if this is
* version "v1" of module "module5" for app "my-app", this function
* will return "v1".
*/
public static function getCurrentVersionName() {
return explode('.', $_SERVER['CURRENT_VERSION_ID'])[0];
}
/**
* Gets the id of the currently running instance.
*
* @return string The name of the current module. For example, if this is
* instance 2 of version "v1" of module "module5" for app "my-app", this
* function will return "2". For automatically-scaled modules, this function
* will return a unique hex string for the instance (e.g.
* "00c61b117c7f7fd0ce9e1325a04b8f0df30deaaf").
*/
public static function getCurrentInstanceId() {
return $_SERVER['INSTANCE_ID'];
}
/**
* Gets an array of all the modules for the application.
*
* @return string[] An array of string containing the names of the modules
* associated with the application. The 'default' module will be included if
* it exists, as will the name of the module that is associated with the
* instance that calls this function.
*/
public static function getModules() {
$req = new GetModulesRequest();
$resp = new GetModulesResponse();
ApiProxy::makeSyncCall('modules', 'GetModules', $req, $resp);
return $resp->getModuleList();
}
/**
* Get an array of all versions associated with a module.
*
* @param string $module The name of the module to retrieve the versions for.
* If null then the versions for the current module will be retrieved.
*
* @return string[] An array of strings containing the names of versions
* associated with the module. The current version will also be included in
* this list.
*
* @throws \InvalidArgumentException If $module is not a string.
* @throws ModulesException If the given $module isn't valid.
* @throws TransientModulesException if there is an issue fetching the
* information.
*/
public static function getVersions($module = null) {
$req = new GetVersionsRequest();
$resp = new GetVersionsResponse();
if ($module !== null) {
if (!is_string($module)) {
throw new \InvalidArgumentException(
'$module must be a string. Actual type: ' . gettype($module));
}
$req->setModule($module);
}
try {
ApiProxy::makeSyncCall('modules', 'GetVersions', $req, $resp);
} catch (ApplicationError $e) {
throw errorCodeToException($e->getApplicationError());
}
return $resp->getVersionList();
}
/**
* Get the default version of a module.
*
* @param string $module The name of the module to retrieve the default
* versions for. If null then the default versions for the current module
* will be retrieved.
*
* @return string The default version of the module.
*
* @throws \InvalidArgumentException If $module is not a string.
* @throws ModulesException If the given $module is invalid or if no default
* version could be found.
*/
public static function getDefaultVersion($module = null) {
$req = new GetDefaultVersionRequest();
$resp = new GetDefaultVersionResponse();
if ($module !== null) {
if (!is_string($module)) {
throw new \InvalidArgumentException(
'$module must be a string. Actual type: ' . gettype($module));
}
$req->setModule($module);
}
try {
ApiProxy::makeSyncCall('modules', 'GetDefaultVersion', $req, $resp);
} catch (ApplicationError $e) {
throw errorCodeToException($e->getApplicationError());
}
return $resp->getVersion();
}
/**
* Get the number of instances set for a version of a module.
*
* This function does not work on automatically-scaled modules.
*
* @param string $module The name of the module to retrieve the count for. If
* null then the count for the current module will be retrieved.
*
* @param string $version The version of the module to retrieve the count for.
* If null then the count for the version of the current instance will be
* retrieved.
*
* @return integer The number of instances set for the current module
* version.
*
* @throws \InvalidArgumentException If $module or $version is not a string.
* @throws ModulesException if the given combination of $module and $version
* is invalid.
*/
public static function getNumInstances($module = null, $version = null) {
$req = new GetNumInstancesRequest();
$resp = new GetNumInstancesResponse();
if ($module !== null) {
if (!is_string($module)) {
throw new \InvalidArgumentException(
'$module must be a string. Actual type: ' . gettype($module));
}
$req->setModule($module);
}
if ($version !== null) {
if (!is_string($version)) {
throw new \InvalidArgumentException(
'$version must be a string. Actual type: ' . gettype($version));
}
$req->setVersion($version);
}
try {
ApiProxy::makeSyncCall('modules', 'GetNumInstances', $req, $resp);
} catch (ApplicationError $e) {
throw self::errorCodeToException($e->getApplicationError());
}
return (int) $resp->getInstances();
}
/**
* Set the number of instances for a version of a module.
*
* This function does not work on automatically-scaled modules.
*
* @param string $module The name of the module to set the instance count for.
* If null then the instance count for the current module will be set.
*
* @param string $version The version of the module to set the instance count
* for. If null then the count for the version of the current instance will
* be set.
*
* @throws \InvalidArgumentException If $instances is not an integer or if
* $module or $version is not a string.
* @throws ModulesException if the given combination of $module and $version
* is invalid.
* @throws TransientModulesException if there is an issue setting the
* instance count.
*/
public static function setNumInstances($instances,
$module = null,
$version = null) {
$req = new SetNumInstancesRequest();
$resp = new SetNumInstancesResponse();
if (!is_int($instances)) {
throw new \InvalidArgumentException(
'$instances must be an integer. Actual type: ' . gettype($instances));
}
$req->setInstances($instances);
if ($module !== null) {
if (!is_string($module)) {
throw new \InvalidArgumentException(
'$module must be a string. Actual type: ' . gettype($module));
}
$req->setModule($module);
}
if ($version !== null) {
if (!is_string($version)) {
throw new \InvalidArgumentException(
'$version must be a string. Actual type: ' . gettype($version));
}
$req->setVersion($version);
}
try {
ApiProxy::makeSyncCall('modules', 'SetNumInstances', $req, $resp);
} catch (ApplicationError $e) {
throw self::errorCodeToException($e->getApplicationError());
}
}
/**
* Starts all instances of the given version of a module.
* *
* @param string $module The name of the module to start.
*
* @param string $version The version of the module to start.
*
* @throws \InvalidArgumentException If $module or $version is not a string.
* @throws ModulesException if the given combination of $module and $version
* is invalid.
* @throws InvalidModuleStateException if the given $version is already
* started or cannot be started.
* @throws TransientModulesException if there is an issue starting the module
* version.
*/
public static function startVersion($module, $version) {
$req = new StartModuleRequest();
$resp = new StartModuleResponse();
if (!is_string($module)) {
throw new \InvalidArgumentException(
'$module must be a string. Actual type: ' . gettype($module));
}
$req->setModule($module);
if (!is_string($version)) {
throw new \InvalidArgumentException(
'$version must be a string. Actual type: ' . gettype($version));
}
$req->setVersion($version);
try {
ApiProxy::makeSyncCall('modules', 'StartModule', $req, $resp);
} catch (ApplicationError $e) {
throw self::errorCodeToException($e->getApplicationError());
}
}
/**
* Stops all instances of the given version of a module.
* *
* @param string $module The name of the module to stop. If null then the
* current module will be stopped.
*
* @param string $version The version of the module to stop. If null then the
* current version will be stopped.
*
* @throws \InvalidArgumentException If $module or $version is not a string.
* @throws ModulesException if the given combination of $module and $version
* instance is invalid.
* @throws InvalidModuleStateException if the given $version is already
* stopped or cannot be stopped.
* @throws TransientModulesException if there is an issue stopping the module
* version.
*/
public static function stopVersion($module = null, $version = null) {
$req = new StopModuleRequest();
$resp = new StopModuleResponse();
if ($module !== null) {
if (!is_string($module)) {
throw new \InvalidArgumentException(
'$module must be a string. Actual type: ' . gettype($module));
}
$req->setModule($module);
}
if ($version !== null) {
if (!is_string($version)) {
throw new \InvalidArgumentException(
'$version must be a string. Actual type: ' . gettype($version));
}
$req->setVersion($version);
}
try {
ApiProxy::makeSyncCall('modules', 'StopModule', $req, $resp);
} catch (ApplicationError $e) {
throw self::errorCodeToException($e->getApplicationError());
}
}
/**
* Returns the hostname to use when contacting a module.
* *
* @param string $module The name of the module whose hostname should be
* returned. If null then the hostname of the current module will be returned.
*
* @param string $version The version of the module whose hostname should be
* returned. If null then the hostname for the version of the current
* instance will be returned.
*
* @param string $instance The instance whose hostname should be returned. If
* null then the load balanced hostname for the module will be returned. If
* the module is not a fixed module then the instance parameter is ignored.
*
* @return string The valid canonical hostname that can be used to communicate
* with the given module/version/instance e.g.
* "0.version1.module5.myapp.appspot.com".
* @throws \InvalidArgumentException If $module or $version is not a string
* or if $instance is not a string or integer.
* @throws ModulesException if the given combination of $module and $instance
* is invalid.
*/
public static function getHostname($module = null,
$version = null,
$instance = null) {
$req = new GetHostnameRequest();
$resp = new GetHostnameResponse();
if ($module !== null) {
if (!is_string($module)) {
throw new \InvalidArgumentException(
'$module must be a string. Actual type: ' . gettype($module));
}
$req->setModule($module);
}
if ($version !== null) {
if (!is_string($version)) {
throw new \InvalidArgumentException(
'$version must be a string. Actual type: ' . gettype($version));
}
$req->setVersion($version);
}
if ($instance !== null) {
if (!is_int($instance) && !is_string($instance)) {
throw new \InvalidArgumentException(
'$instance must be an integer or string. Actual type: ' .
gettype($instance));
}
$req->setInstance((string) $instance);
}
try {
ApiProxy::makeSyncCall('modules', 'GetHostname', $req, $resp);
} catch (ApplicationError $e) {
throw self::errorCodeToException($e->getApplicationError());
}
return $resp->getHostname();
}
}