rest.exe client: error codes

Author: derhuerst

lib/errors.js

@@ -52,7 +52,7 @@ const byErrorCode = Object.assign(Object.create(null), {
 	H390: {
 		isClient: true,
 		code: INVALID_REQUEST,
-		message: 'journeys search: departure/arrival station replaced',
+		message: 'journeys search: origin/destination replaced',
 		statusCode: 400
 	},
 	H410: {
@@ -101,7 +101,7 @@ const byErrorCode = Object.assign(Object.create(null), {
 	H895: {
 		isClient: true,
 		code: INVALID_REQUEST,
-		message: 'journeys search: departure & arrival are too near',
+		message: 'journeys search: origin & destination are too near',
 		statusCode: 400
 	},
 	H899: {
@@ -145,19 +145,19 @@ const byErrorCode = Object.assign(Object.create(null), {
 	H9260: {
 		isClient: true,
 		code: INVALID_REQUEST,
-		message: 'journeys search: unknown departure station',
+		message: 'journeys search: unknown origin',
 		statusCode: 400
 	},
 	H9280: {
 		isClient: true,
 		code: INVALID_REQUEST,
-		message: 'journeys search: unknown intermediate station',
+		message: 'journeys search: unknown change/via station',
 		statusCode: 400
 	},
 	H9300: {
 		isClient: true,
 		code: INVALID_REQUEST,
-		message: 'journeys search: unknown arrival station',
+		message: 'journeys search: unknown destination',
 		statusCode: 400
 	},
 	H9320: {
@@ -175,7 +175,7 @@ const byErrorCode = Object.assign(Object.create(null), {
 	H9380: {
 		isClient: true,
 		code: INVALID_REQUEST,
-		message: 'journeys search: departure/arrival/intermediate station defined more than once',
+		message: 'journeys search: origin/destination/via defined more than once',
 		statusCode: 400
 	},
 	SQ001: {

rest-exe-errors.js

@@ -0,0 +1,124 @@
+'use strict'
+
+const ACCESS_DENIED = 'ACCESS_DENIED'
+const INVALID_REQUEST = 'INVALID_REQUEST'
+const NOT_FOUND = 'NOT_FOUND'
+const SERVER_ERROR = 'SERVER_ERROR'
+
+const invalidReq = {
+	isClient: true,
+	code: INVALID_REQUEST,
+	statusCode: 400
+}
+const serverError = {
+	isClient: false,
+	code: SERVER_ERROR,
+	statusCode: 500
+}
+
+// HAFAS ReST API documentation 1.23.30 (06.06.2019)
+const byErrorCode = Object.assign(Object.create(null), {
+	API_AUTH: {
+		isClient: true,
+		code: ACCESS_DENIED,
+		message: 'invalid or missing authentication data',
+		statusCode: 401
+	},
+	API_QUOTA: {
+		isClient: true,
+		code: ACCESS_DENIED,
+		message: 'quota exceeded for API key',
+		statusCode: 429
+	},
+	API_PARAM: {
+		...invalidReq,
+		message: 'parameter missing or invalid' // todo: use HAFAS message
+	},
+	API_FORMAT: {
+		...invalidReq,
+		message: 'requested response format not supported',
+		statusCode: 406
+	},
+	SVC_PARAM: {
+		...invalidReq,
+		message: 'parameter missing or invalid' // todo: use HAFAS message
+	},
+	SVC_LOC: {
+		...invalidReq,
+		message: 'location missing or invalid'
+	},
+	SVC_LOC_ARR: {
+		...invalidReq,
+		message: 'destination location missing or invalid'
+	},
+	SVC_LOC_DEP: {
+		...invalidReq,
+		message: 'origin location missing or invalid'
+	},
+	SVC_LOC_VIA: {
+		...invalidReq,
+		message: 'change/via location missing or invalid'
+	},
+	SVC_LOC_EQUAL: {
+		...invalidReq,
+		message: 'origin & destination locations are equal'
+	},
+	SVC_LOC_NEAR: {
+		...invalidReq,
+		message: 'origin & destination are too near'
+	},
+	SVC_DATATIME: {
+		...invalidReq,
+		message: 'date/time missing or invalid'
+	},
+	SVC_DATATIME_PERIOD: {
+		...invalidReq,
+		message: 'date/time not in the timetable data or not allowed'
+	},
+	SVC_PROD: {
+		...invalidReq,
+		message: 'products fields missing or invalid'
+	},
+	SVC_CTX: {
+		...invalidReq,
+		message: 'context invalid'
+	},
+	SVC_FAILED_SEARCH: {
+		...serverError,
+		message: 'search unsuccessful'
+	},
+	SVC_NO_RESULT: {
+		...invalidReq,
+		message: 'no results found',
+		statusCode: 404
+	},
+	SVC_NO_MATCH: {
+		...invalidReq,
+		message: 'no match found',
+		statusCode: 404
+	},
+	INT_ERR: {
+		...serverError,
+		message: 'internal error'
+	},
+	SOT_AT_DEST: {
+		...invalidReq,
+		message: 'trip already arrived'
+	},
+	SOT_BEFORE_START: {
+		...invalidReq,
+		message: 'trip hasn\'t started yet'
+	},
+	SOT_CANCELLED: {
+		...invalidReq,
+		message: 'trip is cancelled'
+	}
+})
+
+module.exports = {
+	ACCESS_DENIED,
+	INVALID_REQUEST,
+	NOT_FOUND,
+	SERVER_ERROR,
+	byErrorCode
+}

rest-exe.js

@@ -7,6 +7,7 @@ const Promise = require('pinkie-promise')
 const {fetch} = require('fetch-ponyfill')({Promise})
 const {stringify} = require('qs')
 const {parse: parseContentType} = require('content-type')
+const {byErrorCode} = require('./rest-exe-errors')
 const findInTree = require('./lib/find-in-tree')
 const parseWhen = require('./parse-rest/when')
 const parsePolyline = require('./parse-rest/polyline')
@@ -46,16 +47,25 @@ const request = async (method, query = {}) => {
 	}
 	const res = await fetch(url, fetchCfg)
 
-	const {type: cType} = parseContentType(res.headers.get('content-type'))
+	const cTypeHeader = res.headers.get('content-type')
+	const {type: cType} = cTypeHeader ? parseContentType(cTypeHeader) : {}
 	const asJSON = cType === 'application/json'
 	const body = asJSON ? await res.json() : await res.text()
+	if (DEBUG) console.error(asJSON ? JSON.stringify(body) : body)
 
 	if (!res.ok) {
 		// todo: parse HTML error messages
 		let err = new Error(res.statusText)
 		if (asJSON) {
-			err = new Error(body.errorText)
-			err.code = body.errorCode
+			const {errorCode, errorText} = body
+			if (errorCode && byErrorCode[errorCode]) {
+				Object.assign(err, byErrorCode[errorCode])
+				err.hafasErrorCode = errorCode
+				if (errorText) err.hafasErrorMessage = errorText
+			} else {
+				err = new Error(errorText)
+				err.code = errorCode
+			}
 		} else if (body) err = new Error(body)
 
 		err.statusCode = res.status
@@ -69,8 +79,6 @@ const request = async (method, query = {}) => {
 	// todo: sometimes it returns a body without any data
 	// e.g. `location.nearbystops` with an invalid `type`
 
-	if (DEBUG) console.error(asJSON ? JSON.stringify(body) : body)
-
 	unwrapNested(body, '**.ServiceDays[0]', 'serviceDays')
 	unwrapNested(body, '**.LegList.Leg', 'legs')
 	unwrapNested(body, '**.Notes.Note', 'notes')