multiple API on same server

[clysss]

Hello,
I've 4 API xxApi.php on same server, each using a different controler.
In each, I use :
include api.include.php
everything go well until I made from :
aaApi an curl call to bbAPI
in this case there is a mismatch on the routes :
[25-Sep-2024 08:34:05 UTC] {routeList: [[{},"_list"],[{},"create"],[{},"read"],[{},"update"],[{},"delete"],[{},"increment"],[{},"_list"],[{},"read"],[{},"openapi"],[{},"ping"],[{},"createVendor"],[{},"getItem"],[{},"setItem"]],
routeId: 12,
routeInUse: [{},"setItem"]}
[25-Sep-2024 08:34:09 UTC] PHP Warning: Undefined array key 12 in ..........\phpCrudApi\go\api.include.php on line 8038
[25-Sep-2024 08:34:09 UTC] {routeList: [[{},"_list"],[{},"create"],[{},"read"],[{},"update"],[{},"delete"],[{},"increment"],[{},"_list"],[{},"read"],[{},"openapi"],[{},"ping"],[{},"setItem"]],
routeId: 12,
routeInUse: null}

if I add a debug breakpoint and wait few seconds, the reply is OK
[25-Sep-2024 08:34:20 UTC] {routeList: [[{},"_list"],[{},"create"],[{},"read"],[{},"update"],[{},"delete"],[{},"increment"],[{},"_list"],[{},"read"],[{},"openapi"],[{},"ping"],[{},"createVendor"],[{},"getItem"],[{},"setItem"]],
routeId: 12,
routeInUse: [{},"setItem"]}
[25-Sep-2024 08:34:31 UTC] {routeList: [[{},"_list"],[{},"create"],[{},"read"],[{},"update"],[{},"delete"],[{},"increment"],[{},"_list"],[{},"read"],[{},"openapi"],[{},"ping"],[{},"setItem"]],
routeId: 10,
routeInUse: [{},"setItem"]}

Finaly, I found a solution that seems really weird to me :
I made a copy of api.include.php to XXapi.include.php and each XXapi.php now include "his" XXapi.include.php
with this, everything is OK. Do you have an idea why the routelist seems shared from a 2 different API call ?
(i've test on 2 different PHP server, one on windows, one on Linux/prod environnemnt OVH)

[clysss]

in the previous msg rootId is [$routeNumbers[0]]

perhaps i've an idea where it comes from...
in line 8034 of api.include
8034 :
$routeNumbers = $this->getRouteNumbers($request);
if (count($routeNumbers) == 0) {
return $this->responder->error(ErrorCode::ROUTE_NOT_FOUND, $request->getUri()->getPath());
}
try {
$response = call_user_func($this->routeHandlers[$routeNumbers[0]], $request);

and in :
7998 :
private function getRouteNumbers(ServerRequestInterface $request): array
{
$method = strtoupper($request->getMethod());
$path = array();
$segment = $method;
for ($i = 1; strlen($segment) > 0; $i++) {
array_push($path, $segment);
$segment = RequestUtils::getPathSegment($request, $i);
}
return $this->routes->match($path);
}

so the issue seems to come from this->routes
in
class SimpleRouter implements Router
{
[...]
public function __construct(string $basePath, Responder $responder, Cache $cache, int $ttl)
{
7933 : $this->routes = $this->loadPathTree();

and in
7956 : private function loadPathTree(): PathTree
{
$data = $this->cache->get('PathTree');
finaly SimpleRouter is called in : class Api implements RequestHandlerInterface
public function __construct(Config $config)

php-crud-api/api.include.php

Line 12311 in 8ac4561

$prefix = sprintf('phpcrudapi-%s-', substr(md5(__FILE__), 0, 8));

        $prefix = sprintf('phpcrudapi-%s-', substr(md5(__FILE__), 0, 8));
       $cache = CacheFactory::create($config->getCacheType(), $prefix, $config->getCachePath());
        $reflection = new ReflectionService($db, $cache, $config->getCacheTime());
        $responder = new JsonResponder($config->getJsonOptions(), $config->getDebug());
        $router = new SimpleRouter($config->getBasePath(), $responder, $cache, $config->getCacheTime());

[clysss]

conclusion : the issue comes from line 12311 :
$prefix = sprintf('phpcrudapi-%s-', substr(md5(__FILE__), 0, 8));
where __FILE__ constant returns full path and name of the PHP file that's being executed. If used inside an include, the name of the included file is returned.
So, if it's the same included api.include.php for all different xApi.php, the prefix is the same... and it bugs !

and so, #624 (comment) is not totaly usable with this bug..!!

Propositions for resolution :

• use the CachePath (to be defined in $config in xApi.php) to store in a different directory each [not so easy, as having different tmp path can be tricky on basic hebergement]
• add a CachePrefix in the config file (and modify line 12290 and CacheFactory::create)
• modify line 12289 and change __FILE__ to something else .... for example basename($_SERVER["PHP_SELF"], ".php");?
  (there is another FILE_ use in detectBasePath

        private function detectBasePath(): string
        {
            if (isset($_SERVER['REQUEST_URI'])) {
                $fullPath = urldecode(explode('?', $_SERVER['REQUEST_URI'])[0]);
                if (isset($_SERVER['PATH_INFO'])) {
                    $path = $_SERVER['PATH_INFO'];
                    if (substr($fullPath, -1 * strlen($path)) == $path) {
                        return substr($fullPath, 0, -1 * strlen($path));
                    }
                }
                $path = '/' . basename(__FILE__);
                if (substr($fullPath, -1 * strlen($path)) == $path) {
                    return $fullPath;
                }
            }
            return '/';
        }

Please give me your opinion that I can make a proposal :)

[mevdschee]

Thank you for your extensive report.

So, if it's the same included api.include.php for all different xApi.php, the prefix is the same... and it bugs !

That is something I overlooked.

Please give me your opinion that I can make a proposal :)

I'm not sure which one is the best. I think the "add a CachePrefix in the config file" is the best, holding the 'phpcrudapi' string from the 'phpcrudapi-%s-' string from the sprintf you mentioned.

A PR would be appreciated!

[clysss]

just one question before trying to update it :
what is the interest using FILE instead of $_SERVER["PHP_SELF"] ?
cf https://www.php.net/manual/en/reserved.variables.server.php
is it for executing not on a php web server ?

edit:
ah yes, PHP_SELF is crap because of easy injection
so, why not $_SERVER['SCRIPT_NAME'] ? (as perhaps $_SERVER['REQUEST_URI'] is not perfect because of rewritings?)

[mevdschee]

so, why not $_SERVER['SCRIPT_NAME'] ?

There are many fcgi implementations. I'm not sure they all set that variable.

[clysss]

after rereading all the code, the easiest option seems to change only src/Tqdev/PhpCrudApi/Api.php

if (isset($_SERVER['SCRIPT_NAME'])) 
        $prefix = sprintf('phpcrudapi-%s-', substr(md5($_SERVER['SCRIPT_NAME']), 0, 8));
else
        $prefix = sprintf('phpcrudapi-%s-', substr(md5(__FILE__), 0, 8));

the adventage of option with cachePrefix is that we can reread more easily cachedata (as knowing wich MD5 is the good one is not easy)... but who needs ?! do you see other advantages ?
The disadvantages are that it needs to make more modifications in src/Tqdev/PhpCrudApi/Config/Config.php and needs also not to forget to define it in each api call (in my case, I've at least 6 api running in //) -- and forget to do it can handle very hard debugging...

[mevdschee]

Lets think of other things that your 6 implementations differ in.. how about md5 of the entire json encoded config as a cache key?

[clysss]

Hmmm very very clever:) you're a genius! Le mar. 1 oct. 2024, 23:32, Maurits van der Schee ***@***.***> a écrit :

…

Lets think of other things that your 6 implementations differ in.. how about md5 of the entire json encoded config as a cache key? — Reply to this email directly, view it on GitHub <#1044 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ANKVWKQ5TGCUJP6MD7GQ7Q3ZZMIHXAVCNFSM6AAAAABO2Q45EWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGOBXGEYTGOJSHE> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[clysss]

pull request

[mevdschee]

I merged and released. Your PR contained a syntax error: a closing bracket after $config->getUID(). I corrected that.

See: v2.14.29: Support multiple installs

https://github.com/mevdschee/php-crud-api/releases/tag/v2.14.29