mirrors
/
flight-core
mirror of https://github.com/flightphp/core
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Lots of tweaks for middleware. Cleaned up old code.

Browse Source
pull/514/head
n0nag0n 1 year ago
parent f543d74bfe
commit c98d6ce7d4
7 changed files with 128 additions and 108 deletions
Show Stats Download Patch File Download Diff File

22
flight/Engine.php
Unescape View File

@ -35,7 +35,7 @@ use flight\net\Route;
* *
* Routing * Routing
* @method Route route(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a URL to a callback function with all applicable methods * @method Route route(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a URL to a callback function with all applicable methods
* @method void group(string $pattern, callable $callback) Groups a set of routes together under a common prefix. * @method void group(string $pattern, callable $callback, array $group_middlewares = []) Groups a set of routes together under a common prefix.
* @method Route post(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a POST URL to a callback function. * @method Route post(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a POST URL to a callback function.
* @method Route put(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a PUT URL to a callback function. * @method Route put(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a PUT URL to a callback function.
* @method Route patch(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a PATCH URL to a callback function. * @method Route patch(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a PATCH URL to a callback function.
@ -397,10 +397,7 @@ class Engine
} }
// It's assumed if you don't declare before, that it will be assumed as the before method // It's assumed if you don't declare before, that it will be assumed as the before method
$middleware_result = $this->dispatcher->execute( $middleware_result = $middleware_object($route->params);
$middleware_object,
$params
);
if ($middleware_result === false) { if ($middleware_result === false) {
$failed_middleware_check = true; $failed_middleware_check = true;
@ -430,10 +427,8 @@ class Engine
continue; continue;
} }
$middleware_result = $this->dispatcher->execute( $middleware_result = $middleware_object($route->params);
$middleware_object,
$params
);
if ($middleware_result === false) { if ($middleware_result === false) {
$failed_middleware_check = true; $failed_middleware_check = true;
break 2; break 2;
@ -528,12 +523,13 @@ class Engine
/** /**
* Routes a URL to a callback function. * Routes a URL to a callback function.
* *
* @param string $pattern URL pattern to match * @param string $pattern URL pattern to match
* @param callable $callback Callback function that includes the Router class as first parameter * @param callable $callback Callback function that includes the Router class as first parameter
* @param array<callable> $group_middlewares The middleware to be applied to the route
*/ */
public function _group(string $pattern, callable $callback): void public function _group(string $pattern, callable $callback, array $group_middlewares = []): void
{ {
$this->router()->group($pattern, $callback); $this->router()->group($pattern, $callback, $group_middlewares);
} }
/** /**

2
flight/Flight.php
Unescape View File

@ -25,7 +25,7 @@ use flight\net\Route;
* @method static void halt(int $code = 200, string $message = '') Stop the framework with an optional status code and message. * @method static void halt(int $code = 200, string $message = '') Stop the framework with an optional status code and message.
* *
* @method static Route route(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Maps a URL pattern to a callback with all applicable methods. * @method static Route route(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Maps a URL pattern to a callback with all applicable methods.
* @method static void group(string $pattern, callable $callback) Groups a set of routes together under a common prefix. * @method static void group(string $pattern, callable $callback, array $group_middlewares = []) Groups a set of routes together under a common prefix.
* @method static Route post(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a POST URL to a callback function. * @method static Route post(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a POST URL to a callback function.
* @method static Route put(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a PUT URL to a callback function. * @method static Route put(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a PUT URL to a callback function.
* @method static Route patch(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a PATCH URL to a callback function. * @method static Route patch(string $pattern, callable $callback, bool $pass_route = false, string $alias = '') Routes a PATCH URL to a callback function.

61
flight/core/Dispatcher.php
Unescape View File

@ -53,7 +53,8 @@ class Dispatcher
} }
// Run requested method // Run requested method
$output = self::execute($this->get($name), $params); $callback = $this->get($name);
$output = $callback(...$params);
// Run post-filters // Run post-filters
if (!empty($this->filters[$name]['after'])) { if (!empty($this->filters[$name]['after'])) {
@ -140,7 +141,7 @@ class Dispatcher
{ {
$args = [&$params, &$output]; $args = [&$params, &$output];
foreach ($filters as $callback) { foreach ($filters as $callback) {
$continue = self::execute($callback, $args); $continue = $callback(...$args);
if (false === $continue) { if (false === $continue) {
break; break;
} }
@ -178,27 +179,7 @@ class Dispatcher
*/ */
public static function callFunction($func, array &$params = []) public static function callFunction($func, array &$params = [])
{ {
// Call static method return call_user_func_array($func, $params);
if (\is_string($func) && false !== strpos($func, '::')) {
return \call_user_func_array($func, $params);
}
switch (\count($params)) {
case 0:
return $func();
case 1:
return $func($params[0]);
case 2:
return $func($params[0], $params[1]);
case 3:
return $func($params[0], $params[1], $params[2]);
case 4:
return $func($params[0], $params[1], $params[2], $params[3]);
case 5:
return $func($params[0], $params[1], $params[2], $params[3], $params[4]);
default:
return \call_user_func_array($func, $params);
}
} }
/** /**
@ -215,37 +196,9 @@ class Dispatcher
$instance = \is_object($class); $instance = \is_object($class);
switch (\count($params)) { return ($instance) ?
case 0: $class->$method(...$params) :
return ($instance) ? $class::$method();
$class->$method() :
$class::$method();
case 1:
return ($instance) ?
$class->$method($params[0]) :
$class::$method($params[0]);
case 2:
return ($instance) ?
$class->$method($params[0], $params[1]) :
$class::$method($params[0], $params[1]);
case 3:
return ($instance) ?
$class->$method($params[0], $params[1], $params[2]) :
$class::$method($params[0], $params[1], $params[2]);
// This will be refactored soon enough
// @codeCoverageIgnoreStart
case 4:
return ($instance) ?
$class->$method($params[0], $params[1], $params[2], $params[3]) :
$class::$method($params[0], $params[1], $params[2], $params[3]);
case 5:
return ($instance) ?
$class->$method($params[0], $params[1], $params[2], $params[3], $params[4]) :
$class::$method($params[0], $params[1], $params[2], $params[3], $params[4]);
default:
return \call_user_func_array($func, $params);
// @codeCoverageIgnoreEnd
}
} }
/** /**

25
flight/core/Loader.php
Unescape View File

@ -136,30 +136,7 @@ class Loader
return \call_user_func_array($class, $params); return \call_user_func_array($class, $params);
} }
switch (\count($params)) { return new $class(...$params);
case 0:
return new $class();
case 1:
return new $class($params[0]);
// @codeCoverageIgnoreStart
case 2:
return new $class($params[0], $params[1]);
case 3:
return new $class($params[0], $params[1], $params[2]);
case 4:
return new $class($params[0], $params[1], $params[2], $params[3]);
case 5:
return new $class($params[0], $params[1], $params[2], $params[3], $params[4]);
// @codeCoverageIgnoreEnd
default:
try {
$refClass = new ReflectionClass($class);
return $refClass->newInstanceArgs($params);
} catch (ReflectionException $e) {
throw new Exception("Cannot instantiate {$class}", 0, $e);
}
}
} }
/** /**

108
tests/EngineTest.php
Unescape View File

@ -276,7 +276,7 @@ class EngineTest extends PHPUnit\Framework\TestCase
public function testMiddlewareCallableFunction() { public function testMiddlewareCallableFunction() {
$engine = new Engine(); $engine = new Engine();
$engine->route('/path1/@id', function($id) { echo 'OK'.$id; }) $engine->route('/path1/@id', function($id) { echo 'OK'.$id; })
->addMiddleware(function($id) { echo 'before'.$id; }); ->addMiddleware(function($params) { echo 'before'.$params['id']; });
$engine->request()->url = '/path1/123'; $engine->request()->url = '/path1/123';
$engine->start(); $engine->start();
$this->expectOutputString('before123OK123'); $this->expectOutputString('before123OK123');
@ -291,7 +291,7 @@ class EngineTest extends PHPUnit\Framework\TestCase
} }
}; };
$engine->route('/path1/@id', function($id) { echo 'OK'.$id; }) $engine->route('/path1/@id', function($id) { echo 'OK'.$id; })
->addMiddleware(function($id) { echo 'before'.$id; return false; }); ->addMiddleware(function($params) { echo 'before'.$params['id']; return false; });
$engine->request()->url = '/path1/123'; $engine->request()->url = '/path1/123';
$engine->start(); $engine->start();
$this->expectOutputString('Forbiddenbefore123'); $this->expectOutputString('Forbiddenbefore123');
@ -300,8 +300,8 @@ class EngineTest extends PHPUnit\Framework\TestCase
public function testMiddlewareClassBefore() { public function testMiddlewareClassBefore() {
$middleware = new class { $middleware = new class {
public function before($id) { public function before($params) {
echo 'before'.$id; echo 'before'.$params['id'];
} }
}; };
$engine = new Engine(); $engine = new Engine();
@ -315,11 +315,11 @@ class EngineTest extends PHPUnit\Framework\TestCase
public function testMiddlewareClassBeforeAndAfter() { public function testMiddlewareClassBeforeAndAfter() {
$middleware = new class { $middleware = new class {
public function before($id) { public function before($params) {
echo 'before'.$id; echo 'before'.$params['id'];
} }
public function after($id) { public function after($params) {
echo 'after'.$id; echo 'after'.$params['id'];
} }
}; };
$engine = new Engine(); $engine = new Engine();
@ -333,8 +333,9 @@ class EngineTest extends PHPUnit\Framework\TestCase
public function testMiddlewareClassAfter() { public function testMiddlewareClassAfter() {
$middleware = new class { $middleware = new class {
public function after($id) { public function after($params) {
echo 'after'.$id;
echo 'after'.$params['id'];
} }
}; };
$engine = new Engine(); $engine = new Engine();
@ -345,4 +346,91 @@ class EngineTest extends PHPUnit\Framework\TestCase
$engine->start(); $engine->start();
$this->expectOutputString('OK123after123'); $this->expectOutputString('OK123after123');
} }
public function testMiddlewareClassAfterFailedCheck() {
$middleware = new class {
public function after($params) {
echo 'after'.$params['id'];
return false;
}
};
$engine = new class extends Engine {
public function _halt(int $code = 200, string $message = ''): void
{
$this->response()->status($code);
$this->response()->write($message);
}
};
$engine->route('/path1/@id', function($id) { echo 'OK'.$id; })
->addMiddleware($middleware);
$engine->request()->url = '/path1/123';
$engine->start();
$this->assertEquals(403, $engine->response()->status());
$this->expectOutputString('ForbiddenOK123after123');
}
public function testMiddlewareCallableFunctionMultiple() {
$engine = new Engine();
$engine->route('/path1/@id', function($id) { echo 'OK'.$id; })
->addMiddleware(function($params) { echo 'before1'.$params['id']; })
->addMiddleware(function($params) { echo 'before2'.$params['id']; });
$engine->request()->url = '/path1/123';
$engine->start();
$this->expectOutputString('before1123before2123OK123');
}
// Pay attention to the order on how the middleware is executed in this test.
public function testMiddlewareClassCallableRouteMultiple() {
$middleware = new class {
public function before($params) {
echo 'before'.$params['another_id'];
}
public function after($params) {
echo 'after'.$params['id'];
}
};
$middleware2 = new class {
public function before($params) {
echo 'before'.$params['id'];
}
public function after($params) {
echo 'after'.$params['id'].$params['another_id'];
}
};
$engine = new Engine();
$engine->route('/path1/@id/subpath1/@another_id', function() { echo 'OK'; })->addMiddleware([ $middleware, $middleware2 ]);
$engine->request()->url = '/path1/123/subpath1/456';
$engine->start();
$this->expectOutputString('before456before123OKafter123456after123');
}
public function testMiddlewareClassGroupRouteMultipleBooyah() {
$middleware = new class {
public function before($params) {
echo 'before'.$params['another_id'];
}
public function after($params) {
echo 'after'.$params['id'];
}
};
$middleware2 = new class {
public function before($params) {
echo 'before'.$params['id'];
}
public function after($params) {
echo 'after'.$params['id'].$params['another_id'];
}
};
$engine = new Engine();
$engine->group('/path1/@id', function($router) {
$router->map('/subpath1/@another_id', function() { echo 'OK'; });
$router->map('/@cool_id', function() { echo 'OK'; });
}, [ $middleware, $middleware2 ]);
$engine->request()->url = '/path1/123/subpath1/456';
$engine->start();
$this->expectOutputString('before456before123OKafter123456after123');
}
} }

6
tests/LoaderTest.php
Unescape View File

@ -138,12 +138,6 @@ class LoaderTest extends PHPUnit\Framework\TestCase
$this->assertEquals('Suzie', $TesterClass->param6); $this->assertEquals('Suzie', $TesterClass->param6);
} }
public function testNewInstance6ParamsBadClass() {
$this->expectException(Exception::class);
$this->expectExceptionMessage('Cannot instantiate BadClass');
$TesterClass = $this->loader->newInstance('BadClass', ['Bob','Fred', 'Joe', 'Jane', 'Sally', 'Suzie']);
}
public function testAddDirectoryAsArray() { public function testAddDirectoryAsArray() {
$loader = new class extends Loader { $loader = new class extends Loader {
public function getDirectories() { public function getDirectories() {

12
tests/RouterTest.php
Unescape View File

@ -298,6 +298,18 @@ class RouterTest extends PHPUnit\Framework\TestCase
$this->check(); $this->check();
} }
public function testRouteBeingReturned() {
$route = $this->router->map('/hi', function() {});
$route_in_router = $this->router->getRoutes()[0];
$this->assertSame($route, $route_in_router);
}
public function testRouteSetAlias() {
$route = $this->router->map('/hi', function() {});
$route->setAlias('hello');
$this->assertEquals('hello', $route->alias);
}
// Test splat // Test splat
public function testSplatWildcard() public function testSplatWildcard()
{ {

Write Preview
Loading…
Cancel
Save