-
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathvalidate.ts
More file actions
312 lines (299 loc) 路 8.36 KB
/
Copy pathvalidate.ts
File metadata and controls
312 lines (299 loc) 路 8.36 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
import * as fs from 'fs/promises';
import { join } from 'path';
import { Command, Flags } from '@oclif/core';
import chalk from 'chalk';
import { Listr, ListrTask } from 'listr2';
import { Browser } from 'playwright';
import {
crawlSiteForUrls,
createBrowser,
validateAnimationDuration,
validateAnimationStyles,
visitPage
} from '../browser.js';
import { getLocalUrl, isUrl, isValidUrl, n } from '../util.js';
import { loadConfig, type Config } from '../config.js';
interface Ctx {
config: Config;
browser?: Browser;
teardown?: () => Promise<void>;
urls: string[];
errors: Error[];
}
export default class Validate extends Command {
static summary = 'Validate a swup-powered site';
static description =
'Crawl your site and validate that all pages are accessible and render correctly';
static examples = [
`<%= config.bin %> <%= command.id %>`,
`<%= config.bin %> <%= command.id %> --url https://mysite.com/about`,
`<%= config.bin %> <%= command.id %> --crawl --url https://mysite.com`,
`<%= config.bin %> <%= command.id %> --tests containers,transition-duration`,
`<%= config.bin %> <%= command.id %> --asynchronous`
];
static flags = {
url: Flags.string({
char: 'u',
summary: 'URL',
description:
'Base URL to validate. Will validate this single URL only, unless --crawl is specified.',
required: false,
exclusive: ['sitemap']
}),
crawl: Flags.boolean({
char: 'c',
summary: 'Crawl site',
description:
'Crawl the site for all public URLs and validate all found pages. Requires the --url flag as a base URL.',
required: false
}),
limit: Flags.string({
char: 'l',
summary: 'Limit',
description:
'Limit the number of pages to validate when crawling or reading from a sitemap.',
required: false
}),
sitemap: Flags.string({
char: 's',
summary: 'Sitemap',
description:
'If no URL is passed, the local sitemap file will be scanned for public URLs. Accepts a local filepath or URL.',
required: false,
exclusive: ['url']
}),
tests: Flags.string({
char: 't',
summary: 'Tests',
description: 'Specify which tests to run when validating. Defaults to all.',
required: false,
options: ['all', 'containers', 'transition-duration', 'transition-styles'],
default: 'all'
}),
parallel: Flags.boolean({
char: 'p',
summary: 'Parallel',
description: 'Run all tests asynchronously. A lot faster, but might cause issues.',
required: false
}),
containers: Flags.string({
summary: 'Containers',
description: 'Selectors of containers to validate, separated by comma.',
required: false,
default: '#swup'
}),
animation: Flags.string({
summary: 'Animation selector',
description: 'Selector of elements that should be animated.',
required: false,
default: '[class*="transition-"]'
}),
styles: Flags.string({
summary: 'Expected styles',
description: 'CSS properties expected to change during animations, separated by comma.',
required: false,
default: 'opacity,transform'
})
};
async run(): Promise<void> {
const ctx: Ctx = {
config: await this.parseConfig(),
urls: [],
errors: []
};
const tasks: ListrTask<Ctx>[] = [
{
title: 'Set up',
task: async (ctx, task) => {
return task.newListr(() => [
{
title: 'Launch browser',
task: async (ctx) => {
const { browser, teardown } = await createBrowser();
ctx.browser = browser;
ctx.teardown = teardown;
}
}
]);
}
},
{
title: 'Compile pages',
task: async (ctx, task) => {
const { source, urls } = await this.getPageUrls(ctx);
ctx.urls = urls;
task.title = chalk`Found {blue ${urls.length} ${n(
urls.length,
'page'
)}} in {magenta ${source}}`;
}
},
{
title: 'Limit pages',
enabled: (ctx) => ctx.config.validate.limit > 0 && ctx.urls.length > ctx.config.validate.limit,
task: async (ctx, task) => {
ctx.urls = ctx.urls.slice(0, ctx.config.validate.limit);
task.title = chalk`Limit to {blue ${ctx.urls.length} ${n(ctx.urls.length, 'page')}}`;
}
},
{
title: 'Validate pages',
task: async (ctx, task) => {
return task.newListr(
ctx.urls.map((url, index) => ({
title: `Validating ${getLocalUrl(url)}`,
task: async (_, subtask) => {
try {
await this.validatePage(ctx, url);
subtask.title = chalk`{green Validated} ${getLocalUrl(url)}`;
} catch (error) {
ctx.errors.push(error as Error);
subtask.title = chalk`{red Failed} ${getLocalUrl(url)}`;
}
}
})),
{ exitOnError: false, concurrent: ctx.config.validate.parallel }
);
}
},
{
title: 'Report results',
task: async ({ errors, urls: { length: total } }, task) => {
if (errors.length) {
errors.forEach((error) => this.warn(error));
this.error(
chalk`{red.bold Validation failed} for {red ${errors.length}/${total}} ${n(
total,
'page'
)}`
);
} else {
task.title = chalk`{green.bold Validation passed} for {green ${total}/${total}} ${n(
total,
'page'
)}`;
}
}
},
{
title: 'Shut down',
task: async (ctx, task) =>
task.newListr(() => [
{
title: 'Closing browser',
task: async (ctx) => {
await ctx.teardown!();
ctx.teardown = undefined;
}
}
])
}
];
try {
await new Listr<Ctx>(tasks, { ctx }).run();
} catch (error) {
if (ctx.teardown) {
await ctx.teardown();
}
throw error;
}
}
async catch(error: Error) {
// this.error(error as Error)
throw error;
}
async parseConfig(): Promise<Config> {
const { flags } = await this.parse(Validate);
const overrides = {
swup: {
animationSelector: flags.animationSelector,
containers: flags.containers.split(',').map((style) => style.trim())
},
validate: {
url: flags.url,
crawl: flags.crawl,
sitemap: flags.sitemap,
limit: Number(flags.limit),
asynchronous: flags.asynchronous,
tests: flags.tests
.split(',')
.map((style) => style.trim())
.filter((test) => test && test !== 'all'),
styles: flags.styles.split(',').map((style) => style.trim())
}
};
return await loadConfig(overrides);
}
async getPageUrls(ctx: Ctx): Promise<{ urls: string[]; source: string }> {
const { url, crawl, sitemap } = ctx.config.validate;
let urls: string[] = [];
let source = '';
if (url) {
if (!isValidUrl(url)) {
throw new Error(
`Invalid URL: ${url}. Make sure you include the protocol and hostname.`
);
}
if (crawl) {
source = 'crawled site';
urls = await crawlSiteForUrls(url);
} else {
source = 'url argument';
urls = [url];
}
} else if (sitemap) {
source = 'parsed sitemap';
urls = await this.getPageUrlsFromSitemap(ctx);
} else {
throw new Error('You must specify either a url or a sitemap to validate.');
}
urls = [...new Set(urls)];
return { urls, source };
}
async getPageUrlsFromSitemap(ctx: Ctx): Promise<string[]> {
const { sitemap } = ctx.config.validate;
let contents;
if (isUrl(sitemap)) {
try {
contents = await fetch(sitemap).then((res) => res.text());
} catch (error) {
throw new Error(`Error fetching sitemap: ${error}`);
}
} else {
try {
contents = await fs.readFile(join(process.cwd(), sitemap), 'utf8');
} catch (error) {
throw new Error(`Error reading sitemap: ${error}`);
}
}
// return (JSON.parse(parser.toJson(sitemap)).urlset.url.map(i => i.loc))
return [];
}
async validatePage(ctx: Ctx, url: string): Promise<void> {
const { tests, styles } = ctx.config.validate;
const { animationSelector } = ctx.config.swup;
const { browser } = ctx;
const page = await visitPage(browser!, url);
const allChecks = {
'transition-duration': () => validateAnimationDuration(page, animationSelector),
'transition-styles': () => validateAnimationStyles(page, animationSelector, styles)
};
const checks = Object.entries(allChecks).filter(
([test]) => !tests.length || tests.includes(test)
);
if (!checks.length) {
throw new Error(
`No valid tests specified. Available tests: ${Object.keys(allChecks).join(', ')}`
);
}
for (const [, test] of checks) {
try {
await test();
} catch (error) {
throw new Error(
chalk`Validation {red failed} for {magenta ${getLocalUrl(url)}}: ${error}`
);
}
}
}
}