13b8399d0c
As part of the tests run in the CircleCI `aio_monitoring` job, we need to retrieve `sitemap.xml` from the site under test. Previously, the URL used to retrieve that contained a double-slash (`//`). At some point, Firebase (which is used for hosting the site) stopped normalizing double-slashes to a single slash, causing the test to fail. This commit fixes the problem by ensuring that the constructed URLs do not contain double-slashes. PR Close #25641
87 lines
3.0 KiB
TypeScript
87 lines
3.0 KiB
TypeScript
import { resolve as resolvePath } from 'canonical-path';
|
|
import { load as loadJson } from 'cjson';
|
|
import { readFileSync } from 'fs';
|
|
import { get as httpGet } from 'http';
|
|
import { get as httpsGet } from 'https';
|
|
|
|
import { processNavigationUrls } from '../../../../packages/service-worker/config/src/generator';
|
|
import { FirebaseRedirector, FirebaseRedirectConfig } from '../../../tools/firebase-test-utils/FirebaseRedirector';
|
|
|
|
|
|
const AIO_DIR = resolvePath(__dirname, '../../..');
|
|
|
|
export function getRedirector() {
|
|
return new FirebaseRedirector(loadRedirects());
|
|
}
|
|
|
|
export function getSwNavigationUrlChecker() {
|
|
const config = loadJson(`${AIO_DIR}/ngsw-config.json`);
|
|
const navigationUrlSpecs = processNavigationUrls('', config.navigationUrls);
|
|
|
|
const includePatterns = navigationUrlSpecs
|
|
.filter(spec => spec.positive)
|
|
.map(spec => new RegExp(spec.regex));
|
|
const excludePatterns = navigationUrlSpecs
|
|
.filter(spec => !spec.positive)
|
|
.map(spec => new RegExp(spec.regex));
|
|
|
|
return (url: string) =>
|
|
includePatterns.some(regex => regex.test(url))
|
|
&& !excludePatterns.some(regex => regex.test(url));
|
|
}
|
|
|
|
export function loadRedirects(): FirebaseRedirectConfig[] {
|
|
const pathToFirebaseJSON = `${AIO_DIR}/firebase.json`;
|
|
const contents = loadJson(pathToFirebaseJSON);
|
|
return contents.hosting.redirects;
|
|
}
|
|
|
|
export function loadLegacyUrls() {
|
|
const pathToLegacyUrls = `${__dirname}/URLS_TO_REDIRECT.txt`;
|
|
const urls = readFileSync(pathToLegacyUrls, 'utf8').split('\n').map(line => line.split('\t'));
|
|
return urls;
|
|
}
|
|
|
|
export function loadLocalSitemapUrls() {
|
|
const pathToSiteMap = `${AIO_DIR}/src/generated/sitemap.xml`;
|
|
const xml = readFileSync(pathToSiteMap, 'utf8');
|
|
return extractSitemapUrls(xml);
|
|
}
|
|
|
|
export async function loadRemoteSitemapUrls(host: string) {
|
|
host = host.replace(/\/$/, '');
|
|
const urlToSiteMap = `${host}/generated/sitemap.xml`;
|
|
const get = /^https:/.test(host) ? httpsGet : httpGet;
|
|
|
|
const xml = await new Promise<string>((resolve, reject) => {
|
|
let responseText = '';
|
|
get(urlToSiteMap, res => res
|
|
.on('data', chunk => responseText += chunk)
|
|
.on('end', () => resolve(responseText))
|
|
.on('error', reject));
|
|
});
|
|
|
|
return extractSitemapUrls(xml);
|
|
}
|
|
|
|
// Private functions
|
|
function extractSitemapUrls(xml: string) {
|
|
// Currently, all sitemaps use `angular.io` as host in URLs (which is fine since we only use the
|
|
// sitemap in `angular.io`). See also `aio/src/extra-files/*/robots.txt`.
|
|
const host = 'https://angular.io';
|
|
const urls: string[] = [];
|
|
|
|
xml.replace(/<loc>([^<]+)<\/loc>/g, (_, loc) => urls.push(loc.replace(host, '')) as any);
|
|
|
|
// Ensure none of the URLs contains the scheme/host.
|
|
// (That would mean that the URL contains a different than expected host, which can in turn lead
|
|
// to tests passing while they shouldn't).
|
|
urls.forEach(url => {
|
|
if (url.includes('://')) {
|
|
throw new Error(`Sitemap URL (${url}) contains unexpected host. Expected: ${host}`);
|
|
}
|
|
});
|
|
|
|
return urls;
|
|
}
|