typescript
/
serializer
1
0
Fork 0
Code Releases 3 Activity

Allow to serialize reference to a constructor in the namespace

This commit is contained in:
Michaël Lemaire 2021-08-15 19:11:32 +02:00
parent 9e0d1d623e
commit 95b3cf9fcc
5 changed files with 189 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -23,7 +23,15 @@ uncompressed.
In deno:
```typescript
import { Serializer } from "https://code.thunderk.net/typescript/serializer/raw/branch/master/mod.ts";
import { Serializer } from "https://js.thunderk.net/serializer/mod.ts";
```
In browser:
```html
<script type="module">
import { Serializer } from "https://js.thunderk.net/serializer/mod.js";
</script>
```
## Use

2
TODO.md
View File

@ -1 +1,3 @@
# TODO
- Add protocol version, to handle breaking changes

10
doc/usage.md
View File

@ -3,7 +3,15 @@
In deno:
```typescript
import { Serializer } from "https://code.thunderk.net/typescript/serializer/raw/branch/master/mod.ts";
import { Serializer } from "https://js.thunderk.net/serializer/mod.ts";
```
In browser:
```html
<script type="module">
import { Serializer } from "https://js.thunderk.net/serializer/mod.js";
</script>
```
## Use

46
serializer.test.ts
View File

@ -1,8 +1,9 @@
import {
describe,
expect,
it,
mock,
} from "https://code.thunderk.net/typescript/devtools/raw/1.2.2/testing.ts";
} from "https://code.thunderk.net/typescript/devtools/raw/1.3.0/testing.ts";
import { Serializer } from "./serializer.ts";
class TestSerializerObj1 {
@ -62,7 +63,8 @@ function checkReversability(
return loaded;
}
it("serializes simple objects", () => {
describe(Serializer, () => {
it("serializes simple objects", () => {
var obj = {
"a": 5,
"b": null,
@ -81,9 +83,9 @@ it("serializes simple objects", () => {
checkReversability(new Set(["a", new Set([1, "b"])]));
checkReversability(new Map([["a", new Map([[1, "test"]])]]));
});
});
it("restores objects constructed from class", () => {
it("restores objects constructed from class", () => {
let loaded = checkReversability(new TestSerializerObj1(5));
expect(loaded.a).toBe(5);
expect(loaded).toBeInstanceOf(TestSerializerObj1);
@ -95,9 +97,14 @@ it("restores objects constructed from class", () => {
loaded = checkReversability(new TestSerializerObj1(5), TEST_NS_RENAME);
expect(loaded.a).toBe(5);
expect(loaded).toBeInstanceOf(TestSerializerObj1);
});
});
it("stores one version of the same object", () => {
it("serializes reference to class type", () => {
let loaded = checkReversability(TestSerializerObj1);
expect(loaded).toBe(TestSerializerObj1);
});
it("stores one version of the same object", () => {
var a = new TestSerializerObj1(8);
var b = new TestSerializerObj1(8);
var c = {
@ -110,9 +117,9 @@ it("stores one version of the same object", () => {
expect(loaded.t).toBe(loaded.r);
expect(loaded.s[1]).toBe(loaded.r);
expect(loaded.u).not.toBe(loaded.r);
});
});
it("handles circular references", () => {
it("handles circular references", () => {
var a: any = { b: {} };
a.b.c = a;
@ -124,9 +131,9 @@ it("handles circular references", () => {
expect(loaded.b.c).toBe(loaded);
expect(loaded.b.c.b).toBe(loaded.b);
});
});
});
it("ignores some classes", () => {
it("ignores some classes", () => {
let serializer = new Serializer(TEST_NS);
serializer.addIgnoredClass("TestSerializerObj1");
@ -150,20 +157,20 @@ it("ignores some classes", () => {
loaded = serializer.unserialize(data);
expect(loaded).toEqual({ a: 5, b: undefined });
});
});
it("ignores functions", () => {
it("ignores functions", () => {
let serializer = new Serializer(TEST_NS);
let data = serializer.serialize({ obj: new TestSerializerObj2() });
let loaded = serializer.unserialize(data);
let expected = <any> new TestSerializerObj2();
let expected: any = new TestSerializerObj2();
expected.a = undefined;
expected.b[0] = undefined;
expect(loaded).toEqual({ obj: expected });
});
});
it("calls specific postUnserialize", () => {
it("calls specific postUnserialize", () => {
let serializer = new Serializer(TEST_NS);
let data = serializer.serialize({ obj: new TestSerializerObj3() });
let loaded = serializer.unserialize(data);
@ -171,9 +178,9 @@ it("calls specific postUnserialize", () => {
let expected = new TestSerializerObj3();
expected.a = [1, 2, 3];
expect(loaded).toEqual({ obj: expected });
});
});
it("handles missing classes", () => {
it("handles missing classes", () => {
mock(console, "error", undefined, (mock_error) => {
let serializer = new Serializer(TEST_NS);
let data = serializer.serialize({ obj: new TestSerializerObj4() });
@ -184,9 +191,9 @@ it("handles missing classes", () => {
"TestSerializerObj4",
);
});
});
});
it("uses namespace alias to protect from property mangling", () => {
it("uses namespace alias to protect from property mangling", () => {
const data = {
a: new TestSerializerObj1(1),
b: new TestSerializerObj1(2),
@ -203,4 +210,5 @@ it("uses namespace alias to protect from property mangling", () => {
expect(serializer1.unserialize(dumped1)).toEqual(data);
expect(serializer2.unserialize(dumped2)).toEqual(data);
});
});

42
serializer.ts
View File

@ -41,18 +41,32 @@ export class Serializer {
// Collect objects
var objects: Object[] = [];
var stats: any = {};
function add(value: any): void {
if (objects.indexOf(value) < 0) {
objects.push(value);
}
}
crawl(obj, (value) => {
if (isObject(value)) {
var vtype = classname(value);
if (vtype != "" && this.ignored.indexOf(vtype) < 0) {
stats[vtype] = (stats[vtype] || 0) + 1;
if (objects.indexOf(value) < 0) {
objects.push(value);
}
add(value);
return value;
} else {
return STOP_CRAWLING;
}
} else if (typeof value == "function") {
const found = Object.entries(this.namespace).find(([_, cons]) =>
cons === value
);
if (found && this.ignored.indexOf(found[0]) < 0) {
// Keep references to constructors in the namespace
add(value);
}
return STOP_CRAWLING;
} else {
return value;
}
@ -63,7 +77,8 @@ export class Serializer {
var fobjects = objects.map((value) => this.encodeObject(value));
return JSON.stringify(fobjects, (key, value) => {
if (
key != "$f" && isObject(value) && !value.hasOwnProperty("$c") &&
key != "$f" && (isObject(value) || typeof value == "function") &&
!value.hasOwnProperty("$c") &&
!value.hasOwnProperty("$i")
) {
return { $i: objects.indexOf(value) };
@ -132,6 +147,10 @@ export class Serializer {
$c: ctype,
$f: Array.from(obj),
};
} else if (typeof obj == "function") {
return {
$c: obj.name,
};
} else {
return {
$c: this.namespace_rev[ctype] || ctype,
@ -149,8 +168,10 @@ export class Serializer {
return new Set(objdata.$f);
} else if (ctype == "Map") {
return new Map(objdata.$f);
} else {
} else if (objdata.$f) {
return Object.assign(this.constructObject(ctype), objdata.$f);
} else {
return this.namespace[ctype];
}
}
}
@ -159,7 +180,8 @@ export class Serializer {
* Check if the argument is an instance of a class
*/
function isObject(value: any): boolean {
return value instanceof Object && !Array.isArray(value);
return typeof value == "object" && value instanceof Object &&
!Array.isArray(value);
}
/**
@ -174,7 +196,7 @@ function crawl(
callback: (item: any) => any,
replace = false,
memo: any[] = [],
) {
): any {
if (isObject(obj)) {
if (memo.indexOf(obj) >= 0) {
return obj;
@ -183,11 +205,11 @@ function crawl(
}
}
if (obj !== undefined && obj !== null && typeof obj != "function") {
if (obj !== undefined && obj !== null) {
const result = callback(obj);
if (result === STOP_CRAWLING) {
return;
return undefined;
}
if (Array.isArray(obj)) {
@ -244,5 +266,5 @@ function crawl(
* Get the class name of an object.
*/
function classname(obj: Object): string {
return (<any> obj.constructor).name;
return obj.constructor.name;
}