無邪気に ssh-add -K したら、 WARNING が出てることに気づいた。
WARNING: The -K and -A flags are deprecated and have been replaced
by the --apple-use-keychain and --apple-load-keychain
flags, respectively. To suppress this warning, set the
environment variable APPLE_SSH_ADD_BEHAVIOR as described in
the ssh-add(1) manual page.
メッセージの通りだけれど、 -K は deprecated になったようだ。
代わりに --apple-use-keychain を使えば OK 。
以前 Validation をカスタムしやすくする方法を書いた。
Validation は bootstrap.php で差し替えればいいんだけれど、じゃあ自前で呼ばない Table の Validator を差し替えるにはどうしたらいいのか。
Table クラスでの既定のバリデーションは、 validationDefault() で行われる。
インターフェースとしては Validator を引数で受け取る形になっており、ここを差し替えたい。
<?php public function validationDefault(Validator $validator) { $validator ->requirePresence('title', 'create') ->notEmpty('title'); ... return $validator; }
Table クラスの initialize で、 _validatorClass を差し替えてあげればよさそう。
<?php public function initialize(array $config): void { $this->_validatorClass = MyValidator::class;; }
ドキュメントにもちゃんと書いてあった。
https://book.cakephp.org/4/en/orm/validation.html#default-validator-class
横断的に差し替えたいとなったら、基底クラス用意するのがいいのかなー。
PHP8.1 未満の環境における CakePHP の FrozenDate は、 UTC でない Timezone を使った場合に、日付差分が正しく取れないケースがある。
FrozenTime を使うようにするか、 PHP8.1 以降にバージョンを上げると解決する。
※タイトルでは PHP7 としているけど、 8.0 でもだめなはず。
環境は PHP7.4 , CakePHP は 4.2.8 で試す。
たとえば 2021年1月1日から3月1日までの差分を求めるとする。
期待値は当然 2 だ。
$ php -v
PHP 7.4.24 (cli) (built: Sep 23 2021 22:49:50) ( NTS )
Copyright (c) The PHP Group
Zend Engine v3.4.0, Copyright (c) Zend Technologies
with Zend OPcache v7.4.24, Copyright (c), by Zend Technologies
with Xdebug v2.9.8, Copyright (c) 2002-2020, by Derick Rethans
$ bin/cake version
4.2.8
以前からあった diffInMonths は TimeZone の問題を抱えていたが、diffInMonthsIgnoreTimezone が提供されるようになったことで、期待通りの結果が得られるようになった。
<?php use Cake\I18n\FrozenTime; // UTC 以外にする date_default_timezone_set('Asia/Tokyo'); $from = FrozenTime::create(2021, 1, 1); $to = FrozenTime::create(2021, 3, 1); // UTC 以外だと 1 が返ってきてしまうのでだめ $result1 = $from->diffInMonths($to); // 期待通り！ $result2 = $from->diffInMonthsIgnoreTimezone($to);
ところが FrozenDate を使うと、どうにも 1 が返ってきてしまう。
<?php use Cake\I18n\FrozenDate; // UTC 以外にする date_default_timezone_set('Asia/Tokyo'); $from = FrozenDate::create(2021, 1, 1); $to = FrozenDate::create(2021, 3, 1); // IgnoreTimezone しても 1 が返ってきてしまう！ $result = $from->diffInMonthsIgnoreTimezone($to);
前述の Issue にコメントされているのだが、どうやらそもそも DateTime::diff に問題があったようで、バグ報告されている。
このバグは既に対応済で、 PHP8.1 のリリースに含まれている。
環境は PHP8.1 , CakePHP は 4.3.2 で試す。
$ php -v PHP 8.1.0 (cli) (built: Nov 30 2021 06:10:58) (NTS) Copyright (c) The PHP Group Zend Engine v4.1.0, Copyright (c) Zend Technologies $ bin/cake version 4.3.2
この環境で試すと、期待通りの結果が得られる。
（コードは同じもの）
<?php use Cake\I18n\FrozenDate; // UTC 以外にする date_default_timezone_set('Asia/Tokyo'); $from = FrozenDate::create(2021, 1, 1); $to = FrozenDate::create(2021, 3, 1); // 無事 2 が返ってくるようになった $result = $from->diffInMonthsIgnoreTimezone($to);
今回の検証にあたって、以前作った Cake 用の Docker Image に PHP8.1 版を追加しておいたので、よかったら使ってみてください。
dateInMonths の罠については↓らへんの記事が参考になった。
Mock はできるだけ使いたくない派なんだけれど、外部API利用時なんかはどうしても必要になる時がある。
Controller の場合はやりようがあるが、 Command はちょっと迷った。
CakePHP の Command で使うようなときに Mock をするには DI を使うのがよさそう。
Controller の場合は \Cake\TestSuite\IntegrationTestTrait::controllerSpy という用途にあったメソッドが提供されている。
https://api.cakephp.org/4.2/trait-Cake.TestSuite.IntegrationTestTrait.html#controllerSpy()
また、 Controller.initialize のように、初期化時のフックイベントが元から用意されているので、そこに差し込むようなことも可能。
https://book.cakephp.org/4/en/controllers.html#event-list
Command 用には \Cake\TestSuite\ConsoleIntegrationTestTrait が用意されているものの、 controllerSpy に相当するようなメソッドは用意されていないようだ。
Command 関連のイベントには Console.buildCommands が用意されているが、これはどちらかというとコマンドの名前変更等が目的なようで、このイベント内でどうにかするにはかなり無理がありそう（イベントが発火されるのも、Command のインスタンス生成前）。
自前で差し込み用のイベントを作成することも考えたが、テストのためだけに新しいイベントを作成するのは躊躇われる。
そういった理由から DI がよさそうと判断した。DI 自体は CakePHP の中ではまだ実験的な位置づけらしいので、大きな変更や使えなくなったりする可能性はあると思う。
まず Command のコンストラクタで、 Mock したいクラスを受け取るようにする。 受け取った引数をメンバ変数に格納する
<?php class HelloCommand extends Command { public $externalApiService; public function __construct(ExternalApiService $externalApiService) { parent::__construct(); $this->externalApiService = $externalApiService; } public function execute(Arguments $args, ConsoleIo $io) { // モックしたい処理 $this->externalApiService->doSomething(); } }
\App\Application::services で、 DI コンテナに登録しておく。
Command の場合は次のようになる。
<?php public function services(ContainerInterface $container): void { parent::services($container); $container ->add(HelloCommand::class) ->addArgument(ExternalApiService::class); }
ここまでで DI されるようになったので、テストで Mock に差し替えてみる。
差し替えには \Cake\TestSuite\ContainerStubTrait::mockService を使う。
ConsoleIntegrationTestTrait は ContainerStubTrait を実装しているので、別途 use する必要はない。
<?php class HelloCommandTest extends TestCase { public function testExecute(): void { // モックに差し替える $this->mockService(ExternalApiService::class, function () { $mock = $this->createPartialMock(ExternalApiService::class, ['doSomething']); $mock->expects($this->atLeastOnce())->method('doSomething'); return $mock; }); $this->exec('hello'); $this->assertExitCode(CommandInterface::CODE_SUCCESS); } }
CakePHP3 の AuthComponent は非推奨になり、 CakePHP4 では AuthenticationComponent を使うことになる。
認証スキップのやり方が変わったのでメモしておく。
\Cake\Controller\Component\AuthComponent::allow を使えば良い。
Controller の initialize で、認証不要のアクションを指定してあげればいい。
<?php public function initialize(): void { parent::initialize(); $this->loadComponent('Auth'); // index アクションは認証不要 $this->Auth->allow('index'); }
\Authentication\Controller\Component\AuthenticationComponent::allowUnauthenticated を使う。
AuthComponent では複数アクション指定の場合は配列、単独の場合は文字列で指定できたが、 AuthenticationComponent の場合は必ず配列で指定する必要がある。
<?php public function initialize(): void { parent::initialize(); $this->loadComponent('Authentication.Authentication'); // 必ず配列で指定する $this->Authentication->allowUnauthenticated(['index']); }
Cake3 (AuthComponent) の場合は、 allow の引数を指定しないことで全アクションを対象にできた。
<?php public function initialize(): void { parent::initialize(); $this->loadComponent('Auth'); // Controller 内すべてのアクションで認証不要になる $this->Auth->allow(); }
ただし Cake4 (AuthenticationComponent) では設定でチェックを無効化する形になる。
<?php public function initialize(): void { parent::initialize(); $this->loadComponent('Authentication.Authentication', [ // requireIdentity で無効化する 'requireIdentity' => false, ]); }
実際に AuthenticationComponent を利用する際は AppController など基底クラスで load することになると思うので、各コントローラで設定を切り替えてやればよい。
<?php public function initialize(): void { parent::initialize(); // 認証不要 $this->Authentication->setConfig('requireIdentity', false); }
↓みたいなメッセージが出て死んじゃうことがある。
PHP Fatal error: Out of memory (allocated 39845888) (tried to allocate 512000 bytes)...
Fatal error : Allowed memory size of 2147483648 bytes exhausted (tried to allocate 80 bytes) in ・・・
memory_get_usage や memory_get_peak_usage を使うと、使用しているメモリを調べられる。
real_usage を引数で指定することにより、確保しているメモリか実際に使っているメモリか判別できる。
echo "memory_get_usage: " . memory_get_usage() / (1024 * 1024) . "MB"; echo "memory_get_peak_usage: " . memory_get_peak_usage() / (1024 * 1024) . "MB";
getrusage というのもあるらしい
php のメモリ上限は設定ファイルで定義されているので、値を変更することで上限を引き上げられる。
-1 にすると上限がなくなる（必要なら使えるだけ使う）。
$ php -i | grep memory_limit memory_limit => 128M => 128M
php.ini を修正してあげればOK
; Maximum amount of memory a script may consume ; http://php.net/memory-limit ; memory_limit = 128M memory_limit = 256M
ini_set で memory_limit を変更することによって、プログラムからメモリ上限を引き上げることができる。
// 取得
$memory_limit = ini_get('memory_limit');
// 設定
ini_set('memory_limit', '1G');
メモリリークをしているような処理はないのに、まるでメモリリークをしているような現象に遭遇することがある。
そういう場合は gc_collect_cycles で解決するかもしれない。
gc_collect_cycles();
PHPの循環参照の検出はルートが満杯になると動作するが、その件数が1万件に固定されている。
そのため、「件数は少ないがメモリ消費量が大きい」状態になると、GC が動くより先にメモリ上限に達してしまうことがある（と理解している）。
なので、手動で実行すると問題が解消することがあった。
GCの呼び出しを完全に手動制御する gc_enable や gc_disable といった API もあるが、パフォーマンス上の止むにやまない問題がある場合を除き、あえて使うリスクを犯す必要はないと思う（ gc_enable でも gc_collect_cycles は使える）。
AWS の ECS タスクで PHP プログラムを実行したところ、 ECS 側のメモリ制限に引っかかって OOM になる事象が発生した。
memory_get_peak_usage で取得したメモリ使用量上は問題はなさそうに見えたのだが、プロセスが実際に使用するメモリはまた別のようだ。
なので、 memory_get_peak_usage だけを元にプロセス自体のメモリ制限をカツカツにしないほうがよい。
