Merge pull request #103 from sparksuite/bad-status-code-error

Bad status code error

Author: WesCossick

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "w3c-css-validator",
-	"version": "1.2.0",
+	"version": "1.2.1",
 	"description": "Easily validate CSS using W3C's public CSS validator service",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

src/retrieve-validation/bad-status-error.ts

@@ -0,0 +1,12 @@
+class BadStatusError extends Error {
+	statusCode: number;
+
+	constructor(message: string, statusCode: number) {
+		super(message);
+
+		this.statusCode = statusCode;
+		this.name = 'BadStatusError';
+	}
+}
+
+export default BadStatusError;

src/retrieve-validation/browser.test.ts

@@ -5,6 +5,7 @@
 //Imports
 import retrieveFromBrowser from './browser';
 import 'whatwg-fetch';
+import BadStatusError from './bad-status-error';
 
 // Tests
 describe('#retrieveFromBrowser()', () => {
@@ -41,6 +42,36 @@ describe('#retrieveFromBrowser()', () => {
 		).rejects.toThrow('The request took longer than 1ms');
 	});
 
+	it('Rejects status codes other than 200-300', async () => {
+		try {
+			await retrieveFromBrowser(
+				`https://jigsaw.w3.org/css-validator/validator?usermedium=all&warning=no&output=application/json&profile=css3`,
+				3000
+			);
+
+			throw new Error('This test should not proceed to this point');
+		} catch (error: unknown) {
+			expect(error).toBeInstanceOf(BadStatusError);
+
+			if (!(error instanceof BadStatusError)) {
+				return;
+			}
+
+			expect(error.statusCode).toBe(500);
+		}
+	});
+
+	it('Rejects long CSS requests with a hint', async () => {
+		await expect(
+			retrieveFromBrowser(
+				`https://jigsaw.w3.org/css-validator/validator?text=${encodeURIComponent(
+					'* { color: black }\n'.repeat(750)
+				)}&usermedium=all&warning=no&output=application/json&profile=css3`,
+				3000
+			)
+		).rejects.toThrow('This may be due to trying to validate too much CSS at once');
+	});
+
 	it('Rejects unexpected errors', async () => {
 		await expect(
 			retrieveFromBrowser(

src/retrieve-validation/browser.ts

@@ -1,5 +1,6 @@
 // Imports
 import { W3CCSSValidatorResponse } from '.';
+import BadStatusError from './bad-status-error';
 
 // Utility function for retrieving response from W3C CSS Validator in a browser environment
 const retrieveInBrowser = async (url: string, timeout: number): Promise<W3CCSSValidatorResponse['cssvalidation']> => {
@@ -16,11 +17,19 @@ const retrieveInBrowser = async (url: string, timeout: number): Promise<W3CCSSVa
 
 	try {
 		res = await fetch(url, { signal: controller.signal });
+
+		if (!res.ok) {
+			throw new BadStatusError(res.statusText, res.status);
+		}
 	} catch (err: unknown) {
 		if (err instanceof Error && err.name === 'AbortError') {
 			throw new Error(`The request took longer than ${timeout}ms`);
 		}
 
+		if (err instanceof TypeError) {
+			throw new TypeError(`${err.message} (This may be due to trying to validate too much CSS at once)`);
+		}
+
 		throw err;
 	}
 

src/retrieve-validation/node.test.ts

@@ -1,4 +1,5 @@
 //Imports
+import BadStatusError from './bad-status-error';
 import retrieveFromNode from './node';
 
 // Tests
@@ -36,6 +37,28 @@ describe('#retrieveFromNode()', () => {
 		).rejects.toThrow('The request took longer than 1ms');
 	});
 
+	it('Rejects status codes other than 200-300', async () => {
+		try {
+			await retrieveFromNode(
+				`https://jigsaw.w3.org/css-validator/validator?text=${encodeURIComponent(
+					'* { color: black }\n'.repeat(750)
+				)}&usermedium=all&warning=no&output=application/json&profile=css3`,
+				3000
+			);
+
+			throw new Error('This test should not proceed to this point');
+		} catch (error: unknown) {
+			expect(error).toBeInstanceOf(BadStatusError);
+
+			if (!(error instanceof BadStatusError)) {
+				return;
+			}
+
+			expect(error.message).toBe('Bad request (This may be due to trying to validate too much CSS at once)');
+			expect(error.statusCode).toBe(400);
+		}
+	});
+
 	it('Rejects unexpected errors', async () => {
 		await expect(
 			retrieveFromNode(

src/retrieve-validation/node.ts

@@ -1,6 +1,7 @@
 // Imports
 import * as https from 'https';
 import { W3CCSSValidatorResponse } from '.';
+import BadStatusError from './bad-status-error';
 
 // Utility function for retrieving response from W3C CSS Validator in a Node.js environment
 const retrieveInNode = async (url: string, timeout: number): Promise<W3CCSSValidatorResponse['cssvalidation']> => {
@@ -12,6 +13,18 @@ const retrieveInNode = async (url: string, timeout: number): Promise<W3CCSSValid
 				timeout,
 			},
 			(res) => {
+				if (typeof res.statusCode === 'number' && (res.statusCode < 200 || res.statusCode >= 300)) {
+					let message = res.statusMessage;
+
+					if (res.statusCode === 400) {
+						message = message
+							? `${message} (This may be due to trying to validate too much CSS at once)`
+							: 'This may be due to trying to validate too much CSS at once';
+					}
+
+					reject(new BadStatusError(message ?? '', res.statusCode));
+				}
+
 				let data = '';
 
 				res.on('data', (chunk) => {