fix(seo): normalize and safely encode wiki route slug to prevent double-encoding 404s
This commit is contained in:
1 parent
721118787a
commit
e34156b2d3
4 files changed
+291
-10
No files matched your search
@@ -0,0 +1,85 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { normalizeRouteSlug, safeEncodeSlug } from './slug';
|
||||
|
||||
describe('normalizeRouteSlug', () => {
|
||||
it('normalizes single-encoded Persian slug to plain decoded string', () => {
|
||||
// آغوز encoded once
|
||||
const input = '%D8%A2%D8%BA%D9%88%D8%B2';
|
||||
expect(normalizeRouteSlug(input)).toBe('آغوز');
|
||||
});
|
||||
|
||||
it('normalizes already-decoded Persian slug without changes', () => {
|
||||
const input = 'آغوز';
|
||||
expect(normalizeRouteSlug(input)).toBe('آغوز');
|
||||
});
|
||||
|
||||
it('normalizes Persian spaced slug', () => {
|
||||
// آب پنیر
|
||||
expect(normalizeRouteSlug('%D8%A2%D8%A8%20%D9%BE%D9%86%DB%8C%D8%B1')).toBe('آب پنیر');
|
||||
expect(normalizeRouteSlug('آب پنیر')).toBe('آب پنیر');
|
||||
});
|
||||
|
||||
it('handles ASCII slugs safely', () => {
|
||||
expect(normalizeRouteSlug('HACCP')).toBe('HACCP');
|
||||
expect(normalizeRouteSlug('IFS')).toBe('IFS');
|
||||
expect(normalizeRouteSlug('BARF')).toBe('BARF');
|
||||
});
|
||||
|
||||
it('handles slash in slug such as EPA/DHA without turning into multiple path segments or breaking', () => {
|
||||
expect(normalizeRouteSlug('EPA%2FDHA')).toBe('EPA/DHA');
|
||||
expect(normalizeRouteSlug('EPA/DHA')).toBe('EPA/DHA');
|
||||
});
|
||||
|
||||
it('handles double-encoded slug safely without double-decoding legit single %', () => {
|
||||
// If incoming slug was double-encoded: %25D8%25A2%25D8%25BA%25D9%2588%25D8%25B2
|
||||
expect(normalizeRouteSlug('%25D8%25A2%25D8%25BA%25D9%2588%25D8%25B2')).toBe('آغوز');
|
||||
});
|
||||
|
||||
it('handles malformed percent encoding gracefully without throwing URIError', () => {
|
||||
expect(normalizeRouteSlug('100%pure')).toBe('100%pure');
|
||||
expect(normalizeRouteSlug('%E0%A4%A')).toBe('%E0%A4%A');
|
||||
expect(normalizeRouteSlug('%')).toBe('%');
|
||||
expect(normalizeRouteSlug('test%8')).toBe('test%8');
|
||||
});
|
||||
|
||||
it('handles Ca:P ratio slug', () => {
|
||||
// نسبت Ca:P
|
||||
expect(normalizeRouteSlug('%D9%86%D8%B3%D8%A8%D8%AA%20Ca%3AP')).toBe('نسبت Ca:P');
|
||||
});
|
||||
});
|
||||
|
||||
describe('safeEncodeSlug', () => {
|
||||
it('encodes slug exactly once for API and URL consumption', () => {
|
||||
expect(safeEncodeSlug('آغوز')).toBe('%D8%A2%D8%BA%D9%88%D8%B2');
|
||||
expect(safeEncodeSlug('HACCP')).toBe('HACCP');
|
||||
expect(safeEncodeSlug('EPA/DHA')).toBe('EPA%2FDHA');
|
||||
});
|
||||
});
|
||||
|
||||
describe('Edge cases: legitimate single % not double-decoded', () => {
|
||||
it('preserves slug with 100% discount or pure keyword without destroying %', () => {
|
||||
// A slug that literally has "100%pure" (malformed percent)
|
||||
expect(normalizeRouteSlug('100%pure')).toBe('100%pure');
|
||||
// If someone literally passed 100%25pure (100%pure encoded)
|
||||
expect(normalizeRouteSlug('100%25pure')).toBe('100%pure');
|
||||
});
|
||||
|
||||
it('handles all sitemap sample slugs cleanly', () => {
|
||||
const samples = [
|
||||
'%D8%A2%D8%BA%D9%88%D8%B2',
|
||||
'%D8%A2%D8%A8%20%D9%BE%D9%86%DB%8C%D8%B1',
|
||||
'HACCP',
|
||||
'IFS',
|
||||
'BARF',
|
||||
'EPA%2FDHA',
|
||||
'%D9%86%D8%B3%D8%A8%D8%AA%20Ca%3AP',
|
||||
'%D8%A8%DB%8C%D9%88%D8%AA%DB%8C%D9%86',
|
||||
];
|
||||
for (const sample of samples) {
|
||||
const normalized = normalizeRouteSlug(sample);
|
||||
expect(normalized).toBeTruthy();
|
||||
const reencoded = safeEncodeSlug(normalized);
|
||||
expect(normalizeRouteSlug(reencoded)).toBe(normalized);
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,57 @@
|
||||
/**
|
||||
* Safe slug normalization and encoding for SEO routes.
|
||||
*
|
||||
* Handles:
|
||||
* - Single-encoded Persian/UTF-8 (%D8%A2%D8%BA%D9%88%D8%B2 -> آغوز)
|
||||
* - Double-encoded slugs (%25D8%25A2... -> آغوز)
|
||||
* - Raw Unicode (آغوز -> آغوز)
|
||||
* - Slugs with spaces or encoded spaces (آب پنیر / %D8%A2%D8%A8%20%D9%BE%D9%86%DB%8C%D8%B1)
|
||||
* - Slashes like EPA/DHA (EPA%2FDHA -> EPA/DHA)
|
||||
* - Malformed percent sequences without throwing URIError (e.g. 100%pure, %E0%A4%A)
|
||||
* - Safe single-encoding for outgoing API requests and canonical URLs.
|
||||
*/
|
||||
|
||||
function safeDecode(val: string): string {
|
||||
try {
|
||||
return decodeURIComponent(val);
|
||||
} catch {
|
||||
return val;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalizes an incoming route parameter slug to a clean, decoded UTF-8 string.
|
||||
* Decodes iteratively (up to 2 passes) if double-encoded, but does not alter strings
|
||||
* where percent is not a valid percent-encoding sequence.
|
||||
*/
|
||||
export function normalizeRouteSlug(rawSlug: string): string {
|
||||
if (!rawSlug) return '';
|
||||
|
||||
let current = String(rawSlug).trim();
|
||||
|
||||
// If input contains '%', attempt safe decoding
|
||||
if (current.includes('%')) {
|
||||
const decodedOnce = safeDecode(current);
|
||||
if (decodedOnce !== current) {
|
||||
// Check if it was double-encoded (e.g. %25D8... -> %D8... -> Persian)
|
||||
if (decodedOnce.includes('%')) {
|
||||
const decodedTwice = safeDecode(decodedOnce);
|
||||
// Only accept second decode if it produced a valid string that differs
|
||||
if (decodedTwice !== decodedOnce) {
|
||||
return decodedTwice;
|
||||
}
|
||||
}
|
||||
return decodedOnce;
|
||||
}
|
||||
}
|
||||
|
||||
return current;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encodes a normalized slug safely for outgoing HTTP query/path or canonical URL.
|
||||
*/
|
||||
export function safeEncodeSlug(slug: string): string {
|
||||
if (!slug) return '';
|
||||
return encodeURIComponent(slug);
|
||||
}
|
||||
Reference in new issue
Block a user