Skip to content

Commit

Permalink
Altered BaseController to no longer always store current uri in sessi…
Browse files Browse the repository at this point in the history 
…on for redirection after login or logout
  • Loading branch information
rotimi committed Feb 21, 2025
1 parent b38dd90 commit 7b992e2
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 34 deletions.
7 changes: 2 additions & 5 deletions src/controllers/BaseController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public function setLogger(\Psr\Log\LoggerInterface $nu_logger): self {
* Will be used in actionLogin() to construct the url to redirect to upon successful login,
* if $_SESSION[self::SESSN_PARAM_LOGIN_REDIRECT] is not set.
*/
protected string $login_success_redirect_action = 'login-status';
protected string $login_success_redirect_action = 'index';

/**
* @psalm-suppress PossiblyUnusedMethod
Expand Down Expand Up @@ -241,8 +241,7 @@ public function __construct(
$this->action_name_from_uri = $uri_path_parts[1];
}
}

$this->storeCurrentUrlForLoginRedirection();

$this->updateSelectedLanguage();
}

Expand Down Expand Up @@ -1022,8 +1021,6 @@ public function storeCurrentUrlForLoginRedirection(): self {
'logout', 'action-logout', 'actionlogout', 'action_logout'
]
)
|| strtolower($this->request->getHeaderLine('X-Requested-With')) === strtolower('XMLHttpRequest') //ajax request
|| ( isset($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower((string) $_SERVER['HTTP_X_REQUESTED_WITH']) === 'xmlhttprequest' ) //ajax request
) { return $this; }

// Use the uri to grab the query string & the fragment part
Expand Down
70 changes: 42 additions & 28 deletions tests/BaseControllerTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,24 +48,9 @@ public function testThat_storeCurrentUrlForLoginRedirection_WorksAsExpected2() {
self::assertSame($controller, $controller->storeCurrentUrlForLoginRedirection());
self::assertArrayNotHasKey(BaseController::SESSN_PARAM_LOGIN_REDIRECT, $_SESSION);
}

//////////////////////////////////////////
$controller2 = new BaseController(
$psr11Container,
'', '',
$req->withHeader('X-Requested-With', 'XMLHttpRequest'),
$resp
);
self::assertSame($controller2, $controller2->storeCurrentUrlForLoginRedirection());
self::assertArrayNotHasKey(BaseController::SESSN_PARAM_LOGIN_REDIRECT, $_SESSION);

//////////////////////////////////////////
$_SERVER['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest';
$controller3 = new BaseController($psr11Container, 'da-controller', 'da-action', $req, $resp);

self::assertSame($controller3, $controller3->storeCurrentUrlForLoginRedirection());
self::assertArrayNotHasKey(BaseController::SESSN_PARAM_LOGIN_REDIRECT, $_SESSION);
unset($_SERVER['HTTP_X_REQUESTED_WITH']);

// Now that we don't have a login route or ajax request
// the method should store the current url in session
Expand Down Expand Up @@ -207,12 +192,12 @@ public function testThat_getLoginSuccessRedirectAction_WorksAsExpected() {
$controller = new BaseController(
$psr11Container, 'base-controller', '', $req, $resp
);
self::assertEquals('login-status', $controller->getLoginSuccessRedirectAction());
self::assertEquals('index', $controller->getLoginSuccessRedirectAction());

$controller2 = new \SMVCTools\Tests\TestObjects\ChildController(
$psr11Container, 'child-controller', 'da-action', $req, $resp
);
self::assertEquals('login-status2', $controller2->getLoginSuccessRedirectAction());
self::assertEquals('login-status', $controller2->getLoginSuccessRedirectAction());
}

public function testThat_getLoginSuccessRedirectController_WorksAsExpected() {
Expand Down Expand Up @@ -950,14 +935,15 @@ public function testThat_actionLogin_WithRequestPostMethod_WorksAsExpected4() {
// Scenario: Valid Username & Password lead to a successful login and
// user will be redirected.
//
// Response object containing a redirect uri (which is the uri stored in
// session when the controller was created) is returned instead of a
// Login form
// Response object containing a redirect uri (which is a uri containing
// $controller->getLoginSuccessRedirectController() as controller and
// $controller->getLoginSuccessRedirectAction() as action) is returned
// instead of a Login form
////////////////////////////////////////////////////////////////////////
$_POST['username'] = 'admin';
$_POST['password'] = 'admin';
$actionLoginResult = $controller->actionLogin();
$expectedRedirectPath = "/";
$expectedRedirectPath = $controller->makeLink("{$controller->getLoginSuccessRedirectController()}/{$controller->getLoginSuccessRedirectAction()}");

// Response Object with a redirect uri should not be returned in this scenario
self::assertInstanceOf(\Psr\Http\Message\ResponseInterface::class, $actionLoginResult);
Expand Down Expand Up @@ -1042,8 +1028,7 @@ public function testThat_doLogin_WorksAsExpected() {
////////////////////////////////////////////////////////////////////////

$success_redirect_path = '/random-path';
$expected_redirect_path =
$_SESSION[\SMVCTools\Tests\TestObjects\ControllerWithPublicDoLogin::SESSN_PARAM_LOGIN_REDIRECT];
$expected_redirect_path = '/random-path';
$credentials = [ 'username'=> 'admin', 'password'=> 'admin', ];

//reset the logger first so that only log messages related to the next
Expand All @@ -1055,8 +1040,7 @@ public function testThat_doLogin_WorksAsExpected() {
);

////////////////////////////////////////////////////////////////////////
// $success_redirect_path should have the value stored in
// $_SESSION[\SMVCTools\Tests\TestObjects\ControllerWithPublicDoLogin::SESSN_PARAM_LOGIN_REDIRECT]
// $success_redirect_path should not have changed
////////////////////////////////////////////////////////////////////////
self::assertEquals(
$expected_redirect_path,
Expand Down Expand Up @@ -1096,6 +1080,36 @@ public function testThat_doLogin_WorksAsExpected() {
////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////

$success_redirect_pathX = '/random-path';
// Line below will trigger the current uri to be stored in session
$controller->getResponseObjForLoginRedirectionIfNotLoggedIn();
$expected_redirect_pathX = $_SESSION[\SMVCTools\Tests\TestObjects\ControllerWithPublicDoLogin::SESSN_PARAM_LOGIN_REDIRECT];
$credentialsX = [ 'username'=> 'admin', 'password'=> 'admin', ];

//reset the logger first so that only log messages related to the next
//call of doLogin are present in the log object.
$controller->getContainerItem(ContainerKeys::LOGGER)->reset();

$resultX = $controller->doLoginPublic(
$controller->getVespulaAuthObject(), $credentialsX, $success_redirect_pathX
);

////////////////////////////////////////////////////////////////////////
// $success_redirect_path should have changed to the value stored
// in $_SESSION[\SMVCTools\Tests\TestObjects\ControllerWithPublicDoLogin::SESSN_PARAM_LOGIN_REDIRECT]
////////////////////////////////////////////////////////////////////////
self::assertEquals(
$expected_redirect_pathX,
$success_redirect_pathX
);
self::assertNotEquals(
'/random-path',
$success_redirect_pathX
);

////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////
// Try logging in again, this time $success_redirect_path should not
// be changed because $_SESSION[\SMVCTools\Tests\TestObjects\ControllerWithPublicDoLogin::SESSN_PARAM_LOGIN_REDIRECT]
Expand All @@ -1104,11 +1118,11 @@ public function testThat_doLogin_WorksAsExpected() {
$success_redirect_path2 = '/random-path';
$original_success_redirect_path = $success_redirect_path2;
$result2 = $controller->doLoginPublic(
$controller->getVespulaAuthObject(), $credentials, $success_redirect_path
$controller->getVespulaAuthObject(), $credentials, $success_redirect_path2
);

////////////////////////////////////////////////////////////////////////
// $success_redirect_path should not have been changed by doLogin
// $success_redirect_path2 should not have been changed by doLogin
////////////////////////////////////////////////////////////////////////
self::assertEquals(
$original_success_redirect_path,
Expand Down Expand Up @@ -1538,7 +1552,7 @@ public function testThat_actionLogout_WorksAsExpected() {
$controller5 = new BaseController(
$psr11Container, 'da-shizzle-for-rizzle-controller', '', $req, $resp
);

$controller5->storeCurrentUrlForLoginRedirection();
$actionResult5 = $controller5->actionLogout(false);
self::assertInstanceOf(\Psr\Http\Message\ResponseInterface::class, $actionResult5);
self::assertEquals(302, $actionResult5->getStatusCode());
Expand Down
2 changes: 1 addition & 1 deletion tests/fake-smvc-app-root/src/controllers/ChildController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class ChildController extends \SlimMvcTools\Controllers\BaseController {

protected string $login_success_redirect_controller = 'child-controller';

protected string $login_success_redirect_action = 'login-status2';
protected string $login_success_redirect_action = 'login-status';

public bool $is_logged_in = false;

Expand Down

0 comments on commit 7b992e2

Please sign in to comment.