Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: migrate jest-serializer to TypeScript #7841

Merged
merged 5 commits into from Feb 9, 2019
Merged

chore: migrate jest-serializer to TypeScript #7841

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
efaa54e
chore: migrate jest-serializer to TypeScript
thymikee Feb 8, 2019
5dccf17
update changelog
thymikee Feb 8, 2019
1051cd7
use global.d.ts
thymikee Feb 8, 2019
ead8597
Update packages/jest-serializer/src/index.ts
SimenB Feb 9, 2019
3123acf
Update index.ts
SimenB Feb 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/jest-serializer/package.json
View file
Open in desktop
Expand Up @@ -11,5 +11,6 @@
},
"license": "MIT",
"main": "build/index.js",
"types": "build/index.d.ts",
"gitHead": "634e5a54f46b2a62d1dc81a170562e6f4e55ad60"
}
5 changes: 5 additions & 0 deletions ...st-serializer/src/__tests__/index.test.js → ...st-serializer/src/__tests__/index.test.ts
View file
Open in desktop
Expand Up @@ -18,7 +18,9 @@ import serializer from '..';

const v8s = [
{
// @ts-ignore - Node 8+ only
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of disabling all those node 8 checks, you should mybe patch the node types.

declare namespace NodeJS {
  interface v8 {
    // ...
  }
}

Copy link
Collaborator Author

@thymikee thymikee Feb 8, 2019 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Added global.d.ts, hope it's ok? I'm new to TS :P

deserialize: v8.deserialize,
// @ts-ignore - Node 8+ only
serialize: v8.serialize,
},
{
Expand All @@ -34,6 +36,7 @@ const objs = [
{key1: 'foo', key2: 'bar', key3: {array: [null, {}]}},
{minusInf: -Infinity, nan: NaN, plusInf: +Infinity},
{date: new Date(1234567890), re: /foo/gi},
// @ts-ignore - testing NaN
{map: new Map([[NaN, 4], [undefined, 'm']]), set: new Set([undefined, NaN])},
{buf: Buffer.from([0, 255, 127])},
];
Expand All @@ -54,7 +57,9 @@ afterEach(() => {
v8s.forEach((mockV8, i) => {
describe('Using V8 implementation ' + i, () => {
beforeEach(() => {
// @ts-ignore - Node 8+ only
v8.serialize = mockV8.serialize;
// @ts-ignore - Node 8+ only
v8.deserialize = mockV8.deserialize;
});

Expand Down
58 changes: 24 additions & 34 deletions packages/jest-serializer/src/index.js → packages/jest-serializer/src/index.ts
View file
Open in desktop
Expand Up @@ -3,16 +3,14 @@
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow
*/

'use strict';
thymikee marked this conversation as resolved.
Show resolved Hide resolved

import fs from 'fs';
import v8 from 'v8';

import type {Path} from 'types/Config';
type Path = string;

// JSON and V8 serializers are both stable when it comes to compatibility. The
// current JSON specification is well defined in RFC 8259, and V8 ensures that
Expand All @@ -23,7 +21,7 @@ const JS_TYPE = '__$t__';
const JS_VALUE = '__$v__';
const JS_VF = '__$f__';

function replacer(key: string, value: any): any {
function replacer(_key: string, value: any): any {
// NaN cannot be in a switch statement, because NaN !== NaN.
if (Number.isNaN(value)) {
return {[JS_TYPE]: 'n'};
Expand All @@ -32,72 +30,58 @@ function replacer(key: string, value: any): any {
switch (value) {
case undefined:
return {[JS_TYPE]: 'u'};

case +Infinity:
return {[JS_TYPE]: '+'};

case -Infinity:
return {[JS_TYPE]: '-'};
}

switch (value && value.constructor) {
case Date:
return {[JS_TYPE]: 'd', [JS_VALUE]: value.getTime()};

case RegExp:
return {[JS_TYPE]: 'r', [JS_VALUE]: value.source, [JS_VF]: value.flags};

case Set:
return {[JS_TYPE]: 's', [JS_VALUE]: Array.from(value)};

case Map:
return {[JS_TYPE]: 'm', [JS_VALUE]: Array.from(value)};

case Buffer:
return {[JS_TYPE]: 'b', [JS_VALUE]: value.toString('latin1')};
}

return value;
}

function reviver(key: string, value: any): any {
function reviver(_key: string, value: any): any {
if (!value || (typeof value !== 'object' && !value.hasOwnProperty(JS_TYPE))) {
return value;
}

switch (value[JS_TYPE]) {
case 'u':
return undefined;

case 'n':
return NaN;

case '+':
return +Infinity;

case '-':
return -Infinity;

case 'd':
return new Date(value[JS_VALUE]);

case 'r':
return new RegExp(value[JS_VALUE], value[JS_VF]);

case 's':
return new Set(value[JS_VALUE]);

case 'm':
return new Map(value[JS_VALUE]);

case 'b':
return Buffer.from(value[JS_VALUE], 'latin1');
}

return value;
}

function jsonStringify(content) {
function jsonStringify(content: unknown) {
// Not pretty, but the ES JSON spec says that "toJSON" will be called before
// getting into your replacer, so we have to remove them beforehand. See
// https://www.ecma-international.org/ecma-262/#sec-serializejsonproperty
Expand All @@ -109,55 +93,61 @@ function jsonStringify(content) {
/* eslint-disable no-extend-native */

try {
// $FlowFixMe: intentional removal of "toJSON" property.
// @ts-ignore intentional removal of "toJSON" property.
Date.prototype.toJSON = undefined;
// $FlowFixMe: intentional removal of "toJSON" property.
// @ts-ignore intentional removal of "toJSON" property.
Buffer.prototype.toJSON = undefined;

return JSON.stringify(content, replacer);
} finally {
// $FlowFixMe: intentional assignment of "toJSON" property.
Date.prototype.toJSON = dateToJSON;
thymikee marked this conversation as resolved.
Show resolved Hide resolved
// $FlowFixMe: intentional assignment of "toJSON" property.
Buffer.prototype.toJSON = bufferToJSON;
}

/* eslint-enable no-extend-native */
}

function jsonParse(content) {
function jsonParse(content: string) {
return JSON.parse(content, reviver);
}

// In memory functions.

export function deserialize(buffer: Buffer): any {
// $FlowFixMe - Node 8+ only
// @ts-ignore - Node 8+ only
return v8.deserialize
? v8.deserialize(buffer)
? //
// @ts-ignore - Node 8+ only
v8.deserialize(buffer)
: jsonParse(buffer.toString('utf8'));
}

export function serialize(content: any): Buffer {
// $FlowFixMe - Node 8+ only
export function serialize(content: unknown): Buffer {
// @ts-ignore - Node 8+ only
return v8.serialize
? v8.serialize(content)
? //
// @ts-ignore - Node 8+ only
v8.serialize(content)
: Buffer.from(jsonStringify(content));
}

// Synchronous filesystem functions.

export function readFileSync(filePath: Path): any {
// $FlowFixMe - Node 8+ only
// @ts-ignore - Node 8+ only
return v8.deserialize
? v8.deserialize(fs.readFileSync(filePath))
? //
// @ts-ignore - Node 8+ only
v8.deserialize(fs.readFileSync(filePath))
: jsonParse(fs.readFileSync(filePath, 'utf8'));
}

export function writeFileSync(filePath: Path, content: any) {
// $FlowFixMe - Node 8+ only
// @ts-ignore - Node 8+ only
return v8.serialize
? fs.writeFileSync(filePath, v8.serialize(content))
? //
// @ts-ignore - Node 8+ only
fs.writeFileSync(filePath, v8.serialize(content))
: fs.writeFileSync(filePath, jsonStringify(content), 'utf8');
}

Expand Down
7 changes: 7 additions & 0 deletions packages/jest-serializer/tsconfig.json
View file
Open in desktop
@@ -0,0 +1,7 @@
{
"extends": "../../tsconfig.json",
"compilerOptions": {
"rootDir": "src",
"outDir": "build"
}
}