1
0
Fork 0

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

View File

@ -23,7 +23,15 @@ uncompressed.
In deno: In deno:
```typescript ```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 ## Use

View File

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

View File

@ -3,7 +3,15 @@
In deno: In deno:
```typescript ```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 ## Use

View File

@ -1,8 +1,9 @@
import { import {
describe,
expect, expect,
it, it,
mock, 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"; import { Serializer } from "./serializer.ts";
class TestSerializerObj1 { class TestSerializerObj1 {
@ -62,6 +63,7 @@ function checkReversability(
return loaded; return loaded;
} }
describe(Serializer, () => {
it("serializes simple objects", () => { it("serializes simple objects", () => {
var obj = { var obj = {
"a": 5, "a": 5,
@ -97,6 +99,11 @@ it("restores objects constructed from class", () => {
expect(loaded).toBeInstanceOf(TestSerializerObj1); expect(loaded).toBeInstanceOf(TestSerializerObj1);
}); });
it("serializes reference to class type", () => {
let loaded = checkReversability(TestSerializerObj1);
expect(loaded).toBe(TestSerializerObj1);
});
it("stores one version of the same object", () => { it("stores one version of the same object", () => {
var a = new TestSerializerObj1(8); var a = new TestSerializerObj1(8);
var b = new TestSerializerObj1(8); var b = new TestSerializerObj1(8);
@ -157,7 +164,7 @@ it("ignores functions", () => {
let data = serializer.serialize({ obj: new TestSerializerObj2() }); let data = serializer.serialize({ obj: new TestSerializerObj2() });
let loaded = serializer.unserialize(data); let loaded = serializer.unserialize(data);
let expected = <any> new TestSerializerObj2(); let expected: any = new TestSerializerObj2();
expected.a = undefined; expected.a = undefined;
expected.b[0] = undefined; expected.b[0] = undefined;
expect(loaded).toEqual({ obj: expected }); expect(loaded).toEqual({ obj: expected });
@ -204,3 +211,4 @@ it("uses namespace alias to protect from property mangling", () => {
expect(serializer1.unserialize(dumped1)).toEqual(data); expect(serializer1.unserialize(dumped1)).toEqual(data);
expect(serializer2.unserialize(dumped2)).toEqual(data); expect(serializer2.unserialize(dumped2)).toEqual(data);
}); });
});

View File

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