Details

Reviewers

alex

Commits

rINP16753: Fixes INP-1750 - Support PHP Memcached extension for caching

Summary

Added memcached support.

Test Plan

Part 1 (general test on PHP5)

confirm, that Memcached service is installed and started on the server
restart Memcached service
re-install In-Portal and on "Step 11 - System Configuration" confirm, that option "Memcached (via "Memcache" extension)" is available choice for "Output Caching Engine" dropdown.
choose this option.
login to Administrative Console
go to Tools → System Tools section
confirm, that "Memory Cache" sub-section is visible

Part 2 (general test on PHP7)

confirm, that Memcached service is installed and started on the server
restart Memcached service
re-install In-Portal and on "Step 11 - System Configuration" confirm, that option "Memcached (via "Memcached" extension)" is available choice for "Output Caching Engine" dropdown.
choose this option.
login to Administrative Console
go to Tools → System Tools section
confirm, that "Memory Cache" sub-section is visible

NOTE: Perform following tests twice - once after Part 1 installation, and once after Part 2 installation.

Preparation for following tests

create /memcache_test.php file with following content:

<?php
<?php
$start = microtime(true);

define('FULL_PATH', realpath(dirname(__FILE__)));
include_once(FULL_PATH.'/core/kernel/startup.php');

$application =& kApplication::Instance();
$application->Init();

echo 'PHP ' . PHP_VERSION . '<br/><br/>';

switch ( $application->GetVar('step') ) {
    case 'delete':
        echo 'Deleting Infinite Key<br/>' . PHP_EOL;
        $application->deleteCache('infinite_key');

        echo 'Deleting Expiring Key<br/>' . PHP_EOL;
        $application->deleteCache('expiring_key');

        echo 'Deleting Infinite Added Key<br/>' . PHP_EOL;
        $application->deleteCache('infinite_added_key');

        echo 'Deleting Expiring Added Key<br/>' . PHP_EOL;
        $application->deleteCache('expiring_added_key');
        break;

    case 'set':
        $result = $application->setCache('infinite_key', 'infinite value');
        echo 'Setting Infinite Key: ';
        var_dump($result);

        $result = $application->setCache('expiring_key', 'expiring value', 30);
        echo 'Setting Expiring Key: ';
        var_dump($result);

        $result = $application->addCache('infinite_added_key', 'infinite added value');
        echo 'Adding Infinite Adding Key: ';
        var_dump($result);

        $result = $application->addCache('expiring_added_key', 'expiring added value', 30);
        echo 'Adding Expiring Adding Key: ';
        var_dump($result);
        break;

    default:
        echo 'Getting Infinite Key:' . PHP_EOL;
        var_dump($application->getCache('infinite_key'));

        echo 'Getting Expiring Key:' . PHP_EOL;
        var_dump($application->getCache('expiring_key'));

        echo 'Getting Infinite Added Key:' . PHP_EOL;
        var_dump($application->getCache('infinite_added_key'));

        echo 'Getting Expiring Added Key:' . PHP_EOL;
        var_dump($application->getCache('expiring_added_key'));
        break;
}

$end = microtime(true);

this is URL for showing: .../memcache_test.php?step=show
this is URL for setting: .../memcache_test.php?step=set
this is URL for deleting: .../memcache_test.php?step=delete

Part 3 (no cached value by default)

open showing URL couple of times
confirm, that output is similar to this:

PHP ...

Getting Infinite Key:

boolean false

Getting Expiring Key:

boolean false

Getting Infinite Added Key:

boolean false

Getting Expiring Added Key:

boolean false

Part 4 (value is persistent upon setting/adding)

open setting URL
confirm, that output is similar to this:

PHP ...

Setting Infinite Key:

boolean true

Setting Expiring Key:

boolean true

Adding Infinite Adding Key:

boolean true

Adding Expiring Adding Key:

boolean true

open setting URL
confirm, that output is similar to this:

PHP ...

Setting Infinite Key:

boolean true

Setting Expiring Key:

boolean true

Adding Infinite Adding Key:

boolean false

Adding Expiring Adding Key:

boolean false

open getting URL couple of times
confirm, that output is similar to this:

PHP ...

Getting Infinite Key:

string 'infinite value' (length=14)

Getting Expiring Key:

string 'expiring value' (length=14)

Getting Infinite Added Key:

string 'infinite added value' (length=20)

Getting Expiring Added Key:

string 'expiring added value' (length=20)

wait 35 seconds (because auto-expiration is set to 30 seconds)
open getting URL couple of times
confirm, that output is similar to this:

PHP ...

Getting Infinite Key:

string 'infinite value' (length=14)

Getting Expiring Key:

boolean false

Getting Infinite Added Key:

string 'infinite added value' (length=20)

Getting Expiring Added Key:

boolean false

open deleting URL
open showing URL couple of times
confirm, that output is similar to this:

PHP ...

Getting Infinite Key:

boolean false

Getting Expiring Key:

boolean false

Getting Infinite Added Key:

boolean false

Getting Expiring Added Key:

boolean false

Diff Detail

Repository

rINP In-Portal

Branch

/in-portal/branches/5.2.x

Lint

Lint Errors

Excuse: all lint issues fixing is not subject of this task

Severity	Location	Code	Message
Error	core/install/install_toolkit.php:972	PHPCS.E.CodingStandard.Arrays.Array.SpaceAfterKeyword	CodingStandard.Arrays.Array.SpaceAfterKeyword
Error	core/install/install_toolkit.php:972	PHPCS.E.Generic.PHP.LowerCaseKeyword.Found	Generic.PHP.LowerCaseKeyword.Found
Error	core/kernel/utility/cache.php:820	PHPCS.E.CodingStandard.Classes.ClassDeclaration.OpenBraceNewLine	CodingStandard.Classes.ClassDeclaration.OpenBraceNewLine
Error	core/kernel/utility/cache.php:820	PHPCS.E.CodingStandard.Classes.ClassDeclaration.SpaceBeforeKeyword	CodingStandard.Classes.ClassDeclaration.SpaceBeforeKeyword
Error	core/kernel/utility/cache.php:820	PHPCS.E.Generic.Files.OneClassPerFile.MultipleFound	Generic.Files.OneClassPerFile.MultipleFound
Error	core/kernel/utility/cache.php:825	PHPCS.E.CodingStandard.Commenting.DocComment.TagValueIndent	CodingStandard.Commenting.DocComment.TagValueIndent
Error	core/kernel/utility/cache.php:828	PHPCS.E.CodingStandard.NamingConventions.ValidVariableName.PublicHasUnderscore	CodingStandard.NamingConventions.ValidVariableName.PublicHasUnderscore
Error	core/kernel/utility/cache.php:931	PHPCS.E.CodingStandard.Classes.ClassDeclaration.SpaceBeforeCloseBrace	CodingStandard.Classes.ClassDeclaration.SpaceBeforeCloseBrace
Error	core/kernel/utility/cache.php:1083	PHPCS.E.CodingStandard.Classes.ClassDeclaration.SpaceBeforeCloseBrace	CodingStandard.Classes.ClassDeclaration.SpaceBeforeCloseBrace
Warning	core/kernel/utility/cache.php:826	PHPCS.W.Squiz.Commenting.VariableComment.TagNotAllowed	Squiz.Commenting.VariableComment.TagNotAllowed

Unit

No Unit Test Coverage

Build Status

Buildable 1176
Build 1176: arc lint + arc unit

Event Timeline

erik created this revision.Oct 30 2018, 10:59 AM

Herald added a reviewer: alex. · View Herald TranscriptOct 30 2018, 10:59 AM

alex added a project: Restricted Project.Nov 1 2018, 6:20 AM

Test plan requested updates:

cover auto-usage of Memcached on PHP 7+, when Memcache is configured to be used
cover usage of new caching backend (all public methods via corresponding kApplication facade methods (e.g. MemcachedCacheHandler::add maps to kApplication::addCache and so on)

I'm not able to test any further, because all data set to cache will auto-expire immediately.

core/install/install_toolkit.php
973–978	Please reformat to have one array element on one line.
core/kernel/utility/cache.php
106	Please replace version_compare(PHP_VERSION, '7.0.0', '>=') with PHP_VERSION_ID >= 70000 Works faster.
825	I doubt, that class name used in `Memcached` PHP extension matches class name used in `Memcache` PHP extension.
895	Please pass argument according to method signature: `Memcache::set( string $key , mixed $var [, int $flag [, int $expire ]] )` `Memcached::set( string $key , mixed $value [, int $expiration ] )` The value of `$expiration` parameter is ignored.
911	Please pass argument according to method signature: `Memcache::add( string $key , mixed $var [, int $flag [, int $expire ]] )` `Memcached::add( string $key , mixed $value [, int $expiration ] )` The value of `$expiration` parameter is ignored.

This revision now requires changes to proceed.Nov 1 2018, 6:38 AM

Made requested code fixes. TODO - test plan changes.

erik edited the test plan for this revision. (Show Details)Nov 7 2018, 4:59 AM

alex edited the test plan for this revision. (Show Details)Nov 7 2018, 7:11 AM

In D351#6952, @alex wrote:

Test plan requested updates:

cover auto-usage of Memcached on PHP 7+, when Memcache is configured to be used

cover usage of new caching backend (all public methods via corresponding kApplication facade methods (e.g. MemcachedCacheHandler::add maps to kApplication::addCache and so on)

I'm not able to test any further, because all data set to cache will auto-expire immediately.

2nd half of requested test plan updates weren't made.

This revision now requires changes to proceed.Nov 8 2018, 1:45 AM

erik requested review of this revision.Nov 8 2018, 4:25 AM

erik edited the test plan for this revision. (Show Details)

erik edited edge metadata.

Not reopening, but test plan have issues:

not tested, that data is actually persistent in Memcache (e.g. available on different page loads)
not tested, that data in Memcache expires at given moment of time

Fixed API difference causing a notice (and non-working cache), when attempting to get several keys at once using get method.

Removed test file.

alex edited the test plan for this revision. (Show Details)Nov 13 2018, 8:31 AM

alex accepted this revision.Nov 13 2018, 8:36 AM

This revision is now accepted and ready to land.Nov 13 2018, 8:36 AM

This change isn't a bug fix request, but a requirement change, that happened over time.

Please also update the test plan.

core/kernel/utility/cache.php
106–108	move the code, that creates cache handler object (with fallback to the fake cache handler) above this IF statement if cache handler isn't working (use the `isWorking` method) AND we're using `MemcacheCacheHandler` cache handler (you can do either `instanceof` on the object OR compare `$handler_class`), then use `MemcachedCacheHandler` With CentOS, it's possible to install both PHP extensions (Memcache & Memcached) on any PHP version (even 5.x one). Therefore the assumption of fact, that if it's PHP 7, then the Memcache module is 100% non-available isn't true anymore.

This revision now requires changes to proceed.Jan 15 2021, 8:56 AM

alex added inline comments.Feb 22 2023, 4:02 AM

core/kernel/utility/cache.php
106–108	Instead of changing the fallback solution do this: delete this fallback code in the "\kInstallToolkit::getWorkingCacheHandlers" method change the `$cache_handlers` array as follows: change `'Memcache' => 'Memcached',` into `'Memcache' => 'Memcached (via "Memcache" extension)',` before the above-changed array element add `'Memcached' => 'Memcached (via "Memcached" extension)',` update the test plan to include testing cache handler selection on an existing install via corresponding installation wizard step (no need to test re-install/upgrade for this)

alex added inline comments.Feb 22 2023, 4:07 AM

core/install/install_toolkit.php
974	Replace with 'Memcache' => 'Memcached (via "Memcache" extension)', .
975	Replace with 'Memcache' => 'Memcached (via "Memcached" extension)', .

erik edited the test plan for this revision. (Show Details)Feb 22 2023, 5:02 AM

Renoved fallback logic, updated test plan.

Harbormaster completed remote builds in B1176: Diff 1137.Feb 23 2023, 4:45 AM

alex requested changes to this revision.Mar 17 2023, 5:43 AM

alex added inline comments.

core/kernel/utility/cache.php
106–111	Please return this code. When I said `delete this fallback code` in my previous comment that was meant only to selected code of that inline comment, which was: if ( $handler_class == 'MemcacheCacheHandler' && PHP_VERSION_ID >= 70000 ) { $handler_class = 'MemcachedCacheHandler'; }
898	Please remove. No longer relevant.
914	Please remove. No longer relevant.
928	Please remove the `, 0`. According to Memcached server documentation this behavior is no longer supported.

This revision now requires changes to proceed.Mar 17 2023, 5:43 AM

alex added a child revision: D443: INP-1838 - Set expiration limit for life-time cached keys.Mar 17 2023, 7:18 AM

alex retitled this revision from INP-1750 Support PHP Memcached extension for caching to INP-1750 - Support PHP Memcached extension for caching.Mar 17 2023, 11:45 AM

alex mentioned this in D443: INP-1838 - Set expiration limit for life-time cached keys.Mar 20 2023, 3:41 AM

Done requested changes - returned fallback to FakeCacheHandler zero time parameterusage and comments.

Harbormaster completed remote builds in B1179: Diff 1140.Mar 20 2023, 6:28 AM

alex accepted this revision.Mar 21 2023, 3:50 AM

This revision is now accepted and ready to land.Mar 21 2023, 3:50 AM

This revision was landed with ongoing or failed builds.Mar 21 2023, 3:51 AM

Closed by commit rINP16753: Fixes INP-1750 - Support PHP Memcached extension for caching (authored by alex, committed by ). · Explain Why

This revision was automatically updated to reflect the committed changes.

			Path	Packages
M			core/install/install_toolkit.php (6 lines)
M			core/kernel/utility/cache.php (120 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	875	16632		Oct 30 2018, 10:59 AM	★	★
Diff 2	878	16632	Made requested code fixes. TODO - test plan changes.	Nov 5 2018, 4:55 AM	★	★
Diff 3	885	16633		Nov 13 2018, 8:01 AM	★	★
Diff 4	886	16633	Removed test file.	Nov 13 2018, 8:03 AM	★	★
Diff 5	1137	16694	Renoved fallback logic, updated test plan.	Feb 23 2023, 4:45 AM	★	★
Diff 6	1140	16694	Done requested changes - returned fallback to FakeCacheHandler zero time…	Mar 20 2023, 6:28 AM	★	★
Diff 7	1141	16752	rINP16753	Mar 21 2023, 3:51 AM	★	★

INP-1750 - Support PHP Memcached extension for caching
ClosedPublic
Actions

Details

Part 1 (general test on PHP5)

Part 2 (general test on PHP7)

Preparation for following tests

Part 3 (no cached value by default)

Part 4 (value is persistent upon setting/adding)

Diff Detail

Event Timeline

Revision Contents
Changeset List

Diff 1137

core/install/install_toolkit.php

core/kernel/utility/cache.php

INP-1750 - Support PHP Memcached extension for cachingClosedPublicActions

Details

Part 1 (general test on PHP5)

Part 2 (general test on PHP7)

Preparation for following tests

Part 3 (no cached value by default)

Part 4 (value is persistent upon setting/adding)

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 1137

core/install/install_toolkit.php

core/kernel/utility/cache.php

INP-1750 - Support PHP Memcached extension for caching
ClosedPublic
Actions

Revision Contents
Changeset List