Skip to content

feat: LDP-2540: Drupal logout helper function (D10.3+) #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 24, 2024
Merged

feat: LDP-2540: Drupal logout helper function (D10.3+) #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
38c1eaa
feat: LDP-2540: Adds helper for Drupal logout
junkuncz Jul 3, 2024
2481b5c
refact: LDP-2540: Rename method
junkuncz Jul 3, 2024
78d3d48
refact: LDP-2540: Change/move logout helper
junkuncz Jul 23, 2024
821a7a9
feat: LDP-2540: Add check that we are logged out, directly in ILogOut().
rmuit Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions tests/helpers/test-methods.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ export function IShouldNotBeLoggedIn(page): Promise<void>;

export function ILogInAs([page, username]): Promise<void>;

export function ILogOut([page, base_url]): Promise<void>;

export function theCacheHitExists([page, response]): Promise<void>;

export function theHeaderContains([response, headerValue, shouldContain, ...headers]): Promise<void>;
Expand Down
19 changes: 16 additions & 3 deletions tests/helpers/test-methods.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,25 @@ module.exports = {
},
ILogInAs: async ([page, username]) => {
await page.goto('/user/login');
await page.fill('input[name="name"]', username);
await page.fill('input[name="pass"]', process.env.APP_SECRET);
await page.click('input[value="Log in"]', process.env.APP_SECRET);
await expect(page.locator('form.user-login-form')).toBeVisible;
await page.locator('input[name="name"]').fill(username);
await page.locator('input[name="pass"]').fill(process.env.APP_SECRET);
await page.locator('input[value="Log in"]').click();
Copy link
Contributor

@rmuit rmuit Jul 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not strictly related to the Drupal Logout, but this seemed a good time to do some refactoring of ILogInAs.

The extra expect() doesn't really add anything, because if we are already logged in, the fill() would also fail.
It's just that the expect() likely generates a better error message.
(Also, I felt I needed to do something, while removing the first line from all the following constructions in the tests:

    await helpers.IShouldNotBeLoggedIn(page);
    await helpers.ILogInAs([page, 'dru_editor']);

)

// Then make sure login worked.
await expect(page.locator('body.user-logged-in').first()).toHaveCount(1);
},
ILogOut: async ([page, base_url]) => {
// Go to the confirm form URL directly, instead of /user/logout: it saves a
// redirect and supports the destination parameter.
// Possible optimization: get the URL including token from the "logout"
// menu item; visiting that URL is faster because it doesn't need the extra
// "Log out" click.
await page.goto(`${base_url}/user/logout/confirm?destination=/user/login`);
await page.locator('input[value="Log out"]').click();
// Verify logout worked, on the immediate destination page. (The default
// home page does not have an indicator? So use the login page for that.)
await expect(page.locator('form.user-login-form')).toBeVisible;
},
theCacheHitExists: async ([page, response]) => {
expect(await response.headerValue('X-Drupal-Cache') == 'HIT' ||
await response.headerValue('X-Drupal-Dynamic-Cache') == 'HIT' ||
Expand Down