@rxreact/jest-helpers
Version:
Helpers for using Jest to test RxJS observables
173 lines (165 loc) • 7.93 kB
JavaScript
import { shareReplay } from 'rxjs/operators';
/*! *****************************************************************************
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at http://www.apache.org/licenses/LICENSE-2.0
THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
MERCHANTABLITY OR NON-INFRINGEMENT.
See the Apache Version 2.0 License for specific language governing permissions
and limitations under the License.
***************************************************************************** */
function __awaiter(thisArg, _arguments, P, generator) {
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
}
function __generator(thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "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 (_) 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 };
}
}
function ok(data) {
return {
ok: true,
data: data
};
}
function err(message) {
return {
ok: false,
message: message
};
}
function isOk(result) {
return result.ok;
}
/**
* Subscribe to the given signal,
* so you can use `expect(signal$).toEmit()` on it later.
* @param o$ - the observable to watch
* @returns a hot observable to test against
*/
var watchSignal = function (o$) {
// Share so the signal records all values emitted.
var hot$ = o$.pipe(shareReplay());
// Subscribe to the signal so it starts emitting.
var subscription = hot$.subscribe();
// Clean up after the test is finished.
afterEach(function () {
subscription.unsubscribe();
});
// Return the hot signal for testing.
return hot$;
};
var resolveObservable = function (o) {
return new Promise(function (resolve) {
var timeout = setTimeout(function () { return resolve(err("timeout")); }, 100);
o.subscribe(function (value) {
clearTimeout(timeout);
resolve(ok(value));
});
});
};
var resolveObservableOnValue = function (utils, o, expected) {
return new Promise(function (resolve) {
var timeout = setTimeout(function () { return resolve(err("timeout")); }, 100);
o.subscribe(function (value) {
if (utils.equals(value, expected)) {
clearTimeout(timeout);
resolve(ok(value));
}
});
});
};
/** Test that an observable did (or did not) emit anything */
var toEmit = function toEmit(o) {
return __awaiter(this, void 0, void 0, function () {
var result, pass, message;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, resolveObservable(o)];
case 1:
result = _a.sent();
pass = isOk(result);
message = isOk(result)
? function () {
// This error message will show if `pass === true`,
// but the user called `.not.toEmit()`
return _this.utils.matcherHint("toEmit") + "\n\n" +
"Expected signal not to emit\n" +
("Received: " + _this.utils.printReceived(result.data));
}
: function () {
// This error message will show if `pass === false`,
// and the user called `.toEmit()`
return _this.utils.matcherHint("toEmit") + "\n\n" +
"Expected signal to emit\n" +
"Signal did not emit";
};
return [2 /*return*/, { pass: pass, message: message }];
}
});
});
};
/** Test that an observable did (or did not) emit a specific value */
var toEmitValue = function toEmitValue(o, expected) {
return __awaiter(this, void 0, void 0, function () {
var result, actual, pass, message;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, resolveObservableOnValue(this, o, expected)];
case 1:
result = _a.sent();
pass = false;
message = "";
if (isOk(result)) {
actual = result.data;
pass = this.equals(result.data, expected);
message =
this.utils.matcherHint("toEmit") + "\n\n" +
("Expected signal not to emit " + this.utils.printReceived(expected) + "\n") +
("Received: " + this.utils.printReceived(actual));
}
else {
message =
this.utils.matcherHint("toEmit") + "\n\n" +
("Expected: " + this.utils.printExpected(expected) + "\n") +
"Signal did not emit the expected value";
}
return [2 /*return*/, { actual: actual, pass: pass, message: function () { return message; } }];
}
});
});
};
expect.extend({ toEmit: toEmit, toEmitValue: toEmitValue });
export { watchSignal };
//# sourceMappingURL=jest-helpers.es5.js.map