[Feature]: Allow multiple distinct url prefixes to act as "early routes"

[calvinalkan]

Thanks for taking the time to fill out this feature request!"

• I have searched the issue tracker for similar requests

Which @snicco/* package(s) are relevant/related of the feature request?

http-routing-bundle

Description

Currently, the HttpKernelRunner class takes a single "api" prefix to determine if a route should be loaded early.

 private function isApiRequest(ServerRequestInterface $request): bool
    {
        return $this->api_prefix && Str::startsWith($request->getUri()->getPath(), $this->api_prefix);
   }

It would be good to allow multiple distinct prefixes from acting as "API" routes that should be loaded early in the WP loading process.

I.E.

• /my-plugin/rest-api
• /my-plugin/pages

Proposed solution

Change the constructor arguments of HttpKernelRunner to accept string|string[]

/**
 * @param non-empty-string|non-empty-string[]|null $api_prefix
*/
public function __construct(
        HttpKernel $http_kernel,
        ServerRequestCreator $request_creator,
        EventDispatcherInterface $event_dispatcher,
        ResponseEmitter $emitter,
        StreamFactoryInterface $stream_factory,
        ? $api_prefix
    ) {
        $this->http_kernel = $http_kernel;
        $this->request_creator = $request_creator;
        $this->event_dispatcher = $event_dispatcher;
        $this->emitter = $emitter;
        $this->stream_factory = $stream_factory;

        if (null !== $api_prefix) {
            $api_prefix = '/' . ltrim($api_prefix, '/');
        }

        $this->api_prefix = $api_prefix;
}

Alternatives

Currently the above is only possible by structuring URLs like so:

• /my-plugin/EARLY/rest-api
• /my-plugin/EARLY/pages

(EARLY is some shared "sub" prefix that is currently needed")

[calvinalkan]

To clarify,

What we want to achieve here is that:

/my-plugin/rest-api/*
/my-plugin/pages/*

can be loaded early as API-routes

while /my-plugin/shared/*

can be loaded late.

This is currently not possible.

[snicco-bot]

🎉 This issue has been resolved in version 1.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀