@hello.nrfcloud.com/proto
Version:
Documents the communication protocol between the hello.nrfcloud.com backend and the web application
424 lines (423 loc) • 17.2 kB
JavaScript
function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
try {
var info = gen[key](arg);
var value = info.value;
} catch (error) {
reject(error);
return;
}
if (info.done) {
resolve(value);
} else {
Promise.resolve(value).then(_next, _throw);
}
}
function _async_to_generator(fn) {
return function() {
var self = this, args = arguments;
return new Promise(function(resolve, reject) {
var gen = fn.apply(self, args);
function _next(value) {
asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
}
function _throw(err) {
asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
}
_next(undefined);
});
};
}
function _ts_generator(thisArg, body) {
var f, y, t, _ = {
label: 0,
sent: function() {
if (t[0] & 1) throw t[1];
return t[1];
},
trys: [],
ops: []
}, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() {
return this;
}), g;
function verb(n) {
return function(v) {
return step([
n,
v
]);
};
}
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while(g && (g = 0, op[0] && (_ = 0)), _)try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [
op[0] & 2,
t.value
];
switch(op[0]){
case 0:
case 1:
t = op;
break;
case 4:
_.label++;
return {
value: op[1],
done: false
};
case 5:
_.label++;
y = op[1];
op = [
0
];
continue;
case 7:
op = _.ops.pop();
_.trys.pop();
continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
_ = 0;
continue;
}
if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
_.label = op[1];
break;
}
if (op[0] === 6 && _.label < t[1]) {
_.label = t[1];
t = op;
break;
}
if (t && _.label < t[2]) {
_.label = t[2];
_.ops.push(op);
break;
}
if (t[2]) _.ops.pop();
_.trys.pop();
continue;
}
op = body.call(thisArg, _);
} catch (e) {
op = [
6,
e
];
y = 0;
} finally{
f = t = 0;
}
if (op[0] & 5) throw op[1];
return {
value: op[0] ? op[1] : void 0,
done: true
};
}
}
import { Type } from '@sinclair/typebox';
import nock from 'nock';
import assert from 'node:assert/strict';
import { describe, it } from 'node:test';
import { Context } from './Context.js';
import { typedFetch } from './typedFetch.js';
void describe('typedFetch()', function() {
void it('should validate a response', function() {
return _async_to_generator(function() {
var response, scope, getData, res;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
response = JSON.stringify({
success: true
});
scope = nock('https://api.example.com').get('/data').reply(200, response, {
'content-type': 'application/json; charset=utf-8',
'content-length': "".concat(response.length)
});
getData = typedFetch({
responseBodySchema: Type.Object({
success: Type.Boolean()
})
});
return [
4,
getData(new URL('https://api.example.com/data'))
];
case 1:
res = _state.sent();
assert.equal(scope.isDone(), true);
assert.equal('error' in res, false);
assert.deepEqual('result' in res && res.result, {
success: true
});
return [
2
];
}
});
})();
});
void it('should fail if the response fails', function() {
return _async_to_generator(function() {
var scope, getData, res;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
scope = nock('https://api.example.com').get('/data').reply(404, 'Not found', {
'content-type': 'application/text; charset=utf-8',
'content-length': "9"
});
getData = typedFetch({
responseBodySchema: Type.Object({
success: Type.Boolean()
})
});
return [
4,
getData(new URL('https://api.example.com/data'))
];
case 1:
res = _state.sent();
assert.equal(scope.isDone(), true);
assertProblem({
res: res,
expectedTitle: 'Request failed (404)',
expectedErrorDetailBody: 'Not found'
});
return [
2
];
}
});
})();
});
void it('should fail if a JSON response is invalid', function() {
return _async_to_generator(function() {
var response, scope, getData, res;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
response = JSON.stringify({
invalid: 'data'
});
scope = nock('https://api.example.com').get('/data').reply(200, response, {
'content-type': 'application/json; charset=utf-8',
'content-length': "".concat(response.length)
});
getData = typedFetch({
responseBodySchema: Type.Object({
success: Type.Boolean()
})
});
return [
4,
getData(new URL('https://api.example.com/data'))
];
case 1:
res = _state.sent();
assert.equal(scope.isDone(), true);
assertProblem({
res: res,
expectedTitle: 'Response body validation failed',
expectedErrorDetailBody: {
invalid: 'data'
},
requireErrorsArray: true
});
return [
2
];
}
});
})();
});
void it('should fail if a non-JSON response is invalid', function() {
return _async_to_generator(function() {
var response, scope, getData, res;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
response = 'foo';
scope = nock('https://api.example.com').get('/data').reply(200, response, {
'content-type': 'application/text; charset=utf-8',
'content-length': "".concat(response.length)
});
getData = typedFetch({
responseBodySchema: Type.Literal('bar')
});
return [
4,
getData(new URL('https://api.example.com/data'))
];
case 1:
res = _state.sent();
assert.equal(scope.isDone(), true);
assertProblem({
res: res,
expectedTitle: 'Response body validation failed',
expectedErrorDetailBody: response,
requireErrorsArray: true
});
return [
2
];
}
});
})();
});
void it('should fail if the request body validation fails', function() {
return _async_to_generator(function() {
var postData, res;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
postData = typedFetch({
requestBodySchema: Type.Object({
foo: Type.Literal('bar')
}),
responseBodySchema: Type.Object({
success: Type.Boolean()
})
});
return [
4,
postData(new URL('https://api.example.com/data'), {
bar: 'baz'
}, {
method: 'POST'
})
];
case 1:
res = _state.sent();
assertProblem({
res: res,
expectedTitle: 'Request body validation failed',
expectedErrorDetailBody: {
bar: 'baz'
},
requireErrorsArray: true
});
return [
2
];
}
});
})();
});
void it('should fail if fetch throws an error', function() {
return _async_to_generator(function() {
var postData, res;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
postData = typedFetch({
responseBodySchema: Type.Any(),
fetchImplementation: function() {
return _async_to_generator(function() {
return _ts_generator(this, function(_state) {
throw new Error('Network error');
});
})();
}
});
return [
4,
postData(new URL('https://api.example.com/data'))
];
case 1:
res = _state.sent();
assertProblem({
res: res,
expectedTitle: 'Network error'
});
return [
2
];
}
});
})();
});
void it('should parse a problem detail response', function() {
return _async_to_generator(function() {
var response, scope, getData, res;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
response = JSON.stringify({
'@context': 'https://github.com/hello-nrfcloud/proto/ProblemDetail',
title: 'Invalid fingerprint provided!',
detail: '29a.aaaaaa',
status: 400
});
scope = nock('https://api.example.com').get('/error').reply(400, response, {
'content-type': 'application/problem+json',
'content-length': "".concat(response.length)
});
getData = typedFetch({
responseBodySchema: Type.Any()
});
return [
4,
getData(new URL('https://api.example.com/error'))
];
case 1:
res = _state.sent();
assert.equal(scope.isDone(), true);
assert.equal('error' in res && res.error.title, 'Invalid fingerprint provided!');
assert.equal('error' in res && res.error.detail, '29a.aaaaaa');
assert.equal('error' in res && res.error.status, 400);
return [
2
];
}
});
})();
});
void it('should set the content-type header when a body is provided', function() {
return _async_to_generator(function() {
var scope, postData, res;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
scope = nock('https://api.example.com', {
reqheaders: {
'content-type': 'application/json; charset=utf-8'
}
}).post('/post').reply(200);
postData = typedFetch({
responseBodySchema: Type.Undefined()
});
return [
4,
postData(new URL('https://api.example.com/post'), {
foo: 'bar'
})
];
case 1:
res = _state.sent();
assert.equal(scope.isDone(), true);
assert.equal('error' in res, false);
assert.deepEqual('result' in res && res.result, undefined);
return [
2
];
}
});
})();
});
});
var assertProblem = function(param) {
var res = param.res, expectedTitle = param.expectedTitle, expectedErrorDetailBody = param.expectedErrorDetailBody, requireErrorsArray = param.requireErrorsArray;
assert.equal('error' in res, true, 'The request should have failed.');
var _res_error = res.error, context = _res_error['@context'], title = _res_error.title, detailJSON = _res_error.detail;
assert.equal(context, Context.problemDetail.toString());
assert.equal(title, expectedTitle);
if (expectedErrorDetailBody === undefined && detailJSON === undefined) return;
var detail = JSON.parse(detailJSON);
if (expectedErrorDetailBody !== undefined) assert.deepEqual(detail.body, expectedErrorDetailBody, 'The body should be included in the error detail.');
if (requireErrorsArray) assert.equal(Array.isArray(detail.errors), true, 'The errors should be included the error detail.');
};