gsadmin/gitbook
1
0
Fork 0
mirror of https://github.com/GitbookIO/gitbook.git synced 2026-09-16 23:55:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Upgrade Argos (#296)

Browse Source 
* Upgrade Argos

* Wait for cookie dialog, avoid fullPage if not needed

* Fix E2E

* Cookies dialog
This commit is contained in:
Greg Bergé
2024-03-18 15:30:45 +01:00
committed by GitHub
parent cc4a86cc23
commit 3c96bf84b5
4 changed files with 62 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bun.lockb
BIN
View File
Binary file not shown.
e2e/pages.spec.ts
+60 -3
View File
@@ -4,7 +4,7 @@ import {
CustomizationLocale,
CustomizationSettings,
} from '@gitbook/api';
import { test, Page } from '@playwright/test';
import { test, expect, Page } from '@playwright/test';
import jwt from 'jsonwebtoken';
import rison from 'rison';
@@ -14,6 +14,7 @@ interface Test {
name: string;
url: string;
run?: (page: Page) => Promise<unknown>;
fullPage?: false;
}
interface TestsCase {
@@ -29,6 +30,14 @@ const allLocales: CustomizationLocale[] = [
CustomizationLocale.Zh,
];
async function waitForCookiesDialog(page: Page) {
const dialog = page.getByRole('dialog', { name: 'Cookies' });
const accept = dialog.getByRole('button', { name: 'Accept' });
const reject = dialog.getByRole('button', { name: 'Reject' });
await expect(accept).toBeVisible();
await expect(reject).toBeVisible();
}
const testCases: TestsCase[] = [
{
name: 'GitBook',
@@ -37,24 +46,32 @@ const testCases: TestsCase[] = [
{
name: 'Home',
url: '',
run: waitForCookiesDialog,
},
{
name: 'Search',
url: '?q=',
fullPage: false,
},
{
name: 'Search Results',
url: '?q=gitbook',
run: (page) => page.waitForSelector('[data-test="search-results"]'),
run: async (page) => {
await page.waitForSelector('[data-test="search-results"]');
},
fullPage: false,
},
{
name: 'AI Search',
url: '?q=What+is+GitBook%3F&ask=true',
run: (page) => page.waitForSelector('[data-test="search-ask-answer"]'),
run: async (page) => {
await page.waitForSelector('[data-test="search-ask-answer"]');
},
},
{
name: 'Not found',
url: 'content-not-found',
run: waitForCookiesDialog,
},
],
},
@@ -65,6 +82,7 @@ const testCases: TestsCase[] = [
{
name: 'Landing page',
url: '',
run: waitForCookiesDialog,
},
],
},
@@ -75,6 +93,7 @@ const testCases: TestsCase[] = [
{
name: 'Home',
url: '',
run: waitForCookiesDialog,
},
],
},
@@ -85,6 +104,7 @@ const testCases: TestsCase[] = [
{
name: 'Home',
url: '',
run: waitForCookiesDialog,
},
],
},
@@ -95,6 +115,7 @@ const testCases: TestsCase[] = [
{
name: 'Revision',
url: '~/revisions/S55pwsEr5UVoroaOiWnP',
run: waitForCookiesDialog,
},
],
},
@@ -115,58 +136,72 @@ const testCases: TestsCase[] = [
{
name: 'Text',
url: 'text-page',
run: waitForCookiesDialog,
},
{
name: 'Long text',
url: 'text-page/long-text',
run: waitForCookiesDialog,
},
{
name: 'Images',
url: 'blocks/block-images',
run: waitForCookiesDialog,
},
{
name: 'Inline Images',
url: 'blocks/inline-images',
run: waitForCookiesDialog,
},
{
name: 'Tabs',
url: 'blocks/tabs',
run: waitForCookiesDialog,
},
{
name: 'Hints',
url: 'blocks/hints',
run: waitForCookiesDialog,
},
{
name: 'Integration Blocks',
url: 'blocks/integrations',
run: waitForCookiesDialog,
},
{
name: 'Tables',
url: 'blocks/tables',
run: waitForCookiesDialog,
},
{
name: 'Expandables',
url: 'blocks/expandables',
run: waitForCookiesDialog,
},
{
name: 'API Blocks',
url: 'blocks/api-blocks',
run: waitForCookiesDialog,
},
{
name: 'Headings',
url: 'blocks/headings',
run: waitForCookiesDialog,
},
{
name: 'Marks',
url: 'blocks/marks',
run: waitForCookiesDialog,
},
{
name: 'Emojis',
url: 'blocks/emojis',
run: waitForCookiesDialog,
},
{
name: 'Links',
url: 'blocks/links',
run: waitForCookiesDialog,
},
{
name: 'Lists',
@@ -186,6 +221,7 @@ const testCases: TestsCase[] = [
links: [],
},
}),
run: waitForCookiesDialog,
},
],
},
@@ -196,10 +232,16 @@ const testCases: TestsCase[] = [
{
name: 'Valid link',
url: 'Fc6mMII9FKgnwm7qqynx/',
run: waitForCookiesDialog,
},
{
name: 'Invalid link',
url: 'invalid/',
run: async (page) => {
await expect(
page.getByText('Authentication missing to access this content'),
).toBeVisible();
},
},
],
},
@@ -222,6 +264,7 @@ const testCases: TestsCase[] = [
);
return `first?jwt_token=${token}`;
})(),
run: waitForCookiesDialog,
},
{
name: 'Second',
@@ -238,6 +281,7 @@ const testCases: TestsCase[] = [
);
return `second?jwt_token=${token}`;
})(),
run: waitForCookiesDialog,
},
],
},
@@ -260,6 +304,7 @@ const testCases: TestsCase[] = [
);
return `?jwt_token=${token}`;
})(),
run: waitForCookiesDialog,
},
{
name: 'Primary (Space A)',
@@ -276,6 +321,7 @@ const testCases: TestsCase[] = [
);
return `v/spacea?jwt_token=${token}`;
})(),
run: waitForCookiesDialog,
},
{
name: 'Space B',
@@ -292,6 +338,7 @@ const testCases: TestsCase[] = [
);
return `v/spaceb?jwt_token=${token}`;
})(),
run: waitForCookiesDialog,
},
{
name: 'Space C',
@@ -308,6 +355,7 @@ const testCases: TestsCase[] = [
);
return `v/spacec?jwt_token=${token}`;
})(),
run: waitForCookiesDialog,
},
],
},
@@ -330,6 +378,7 @@ const testCases: TestsCase[] = [
);
return `?jwt_token=${token}`;
})(),
run: waitForCookiesDialog,
},
{
name: 'First',
@@ -346,6 +395,7 @@ const testCases: TestsCase[] = [
);
return `first?jwt_token=${token}`;
})(),
run: waitForCookiesDialog,
},
{
name: 'Custom page',
@@ -362,6 +412,7 @@ const testCases: TestsCase[] = [
);
return `custom-page?jwt_token=${token}`;
})(),
run: waitForCookiesDialog,
},
{
name: 'Inner page',
@@ -378,6 +429,7 @@ const testCases: TestsCase[] = [
);
return `custom-page/inner-page?jwt_token=${token}`;
})(),
run: waitForCookiesDialog,
},
],
},
@@ -392,6 +444,10 @@ const testCases: TestsCase[] = [
inherit: false,
},
}),
run: async (page) => {
const dialog = page.getByTestId('cookies-dialog');
await expect(dialog).toBeVisible();
},
})),
},
];
@@ -414,6 +470,7 @@ for (const testCase of testCases) {
display: none !important;
}
`,
fullPage: testEntry.fullPage,
});
});
}
package.json
+1 -2
View File
@@ -62,8 +62,7 @@
"url-join": "^5.0.0"
},
"devDependencies": {
"@argos-ci/cli": "^1.0.4",
"@argos-ci/playwright": "^1.9.3",
"@argos-ci/playwright": "^2.0.0",
"@cloudflare/next-on-pages": "^1.9.0",
"@cloudflare/workers-types": "^4.20231218.0",
"@playwright/test": "^1.42.1",
src/components/Cookies/CookiesToast.tsx
+1
View File
@@ -37,6 +37,7 @@ export function CookiesToast(props: { privacyPolicy?: string }) {
return (
<div
role="dialog"
data-testid="cookies-dialog"
aria-modal="true"
aria-label={tString(language, 'cookies_title')}
aria-describedby={describedById}