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

Improve from Binary/Json/Partial performance by roughly 30% #582

Merged
merged 2 commits into from
Dec 4, 2023
Merged

Improve from Binary/Json/Partial performance by roughly 30% #582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf93e81
Improve from Binary/Json/Partial performance by roughly 30%
jcready Sep 13, 2023
ac3172b
Add comment explaining the reasoning for the ternary
jcready Dec 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 39 additions & 36 deletions packages/plugin/src/message-type-extensions/create.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,14 @@ export class Create implements CustomMethodGenerator {
source,
descriptor,

// const message = { boolField: false, ... };
this.makeMessageVariable(source, descriptor),
// const message = globalThis.Object.create(this.messagePrototype);
this.makeMessageVariable(),

// Object.defineProperty(message, MESSAGE_TYPE, {enumerable: false, value: this});
this.makeDefineMessageTypeSymbolProperty(source),
// message.boolField = false;
// message.repeatedField = [];
// message.mapField = {};
// ...
...this.makeMessagePropertyAssignments(source, descriptor),

// if (value !== undefined)
// reflectionMergePartial<ScalarValuesMessage>(message, value, this);
Expand Down Expand Up @@ -73,52 +76,52 @@ export class Create implements CustomMethodGenerator {
}


makeMessageVariable(source: TypescriptFile, descriptor: DescriptorProto) {
let messageType = this.interpreter.getMessageType(descriptor);
let defaultMessage = messageType.create();
makeMessageVariable() {
return ts.createVariableStatement(
undefined,
ts.createVariableDeclarationList(
[ts.createVariableDeclaration(
ts.createIdentifier("message"),
undefined,
typescriptLiteralFromValue(defaultMessage)
ts.createCall(
ts.createPropertyAccess(
ts.createPropertyAccess(
ts.createIdentifier("globalThis"),
ts.createIdentifier("Object")
),
ts.createIdentifier("create")
),
undefined,
[
ts.createNonNullExpression(
ts.createPropertyAccess(
ts.createThis(),
ts.createIdentifier("messagePrototype")
)
)
]
)
)],
ts.NodeFlags.Const
)
);
}


makeDefineMessageTypeSymbolProperty(source: TypescriptFile) {
const MESSAGE_TYPE = this.imports.name(source, 'MESSAGE_TYPE', this.options.runtimeImportPath);

return ts.createExpressionStatement(ts.createCall(
ts.createPropertyAccess(
ts.createPropertyAccess(
ts.createIdentifier("globalThis"),
ts.createIdentifier("Object")
),
ts.createIdentifier("defineProperty")
),
undefined,
[
ts.createIdentifier("message"),
ts.createIdentifier(MESSAGE_TYPE),
ts.createObjectLiteral(
[
ts.createPropertyAssignment(
ts.createIdentifier("enumerable"),
ts.createFalse()
),
ts.createPropertyAssignment(
ts.createIdentifier("value"),
ts.createThis()
)
],
false
makeMessagePropertyAssignments(source: TypescriptFile, descriptor: DescriptorProto) {
let messageType = this.interpreter.getMessageType(descriptor);
let defaultMessage = messageType.create();
return Object.entries(defaultMessage).map(([key, value]): ts.ExpressionStatement => (
ts.createExpressionStatement(
ts.createBinary(
ts.createPropertyAccess(
ts.createIdentifier("message"),
ts.createIdentifier(key)
),
ts.createToken(ts.SyntaxKind.EqualsToken),
typescriptLiteralFromValue(value)
)
]
)
));
}

Expand Down
6 changes: 6 additions & 0 deletions packages/runtime/src/message-type-contract.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ export interface IMessageType<T extends object> extends MessageInfo {
*/
readonly options: { [extensionName: string]: JsonValue };

/**
* Contains the prototype for messages returned by create() which
* includes the `MESSAGE_TYPE` symbol pointing back to `this`.
*/
readonly messagePrototype?: Readonly<{}>;


/**
* Create a new message with default values.
Expand Down
7 changes: 7 additions & 0 deletions packages/runtime/src/message-type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type {IMessageType, PartialMessage} from "./message-type-contract";
import {MESSAGE_TYPE} from "./message-type-contract";
import type {FieldInfo, PartialFieldInfo} from "./reflection-info";
import {normalizeFieldInfo} from "./reflection-info";
import {ReflectionTypeCheck} from "./reflection-type-check";
Expand Down Expand Up @@ -49,6 +50,11 @@ export class MessageType<T extends object> implements IMessageType<T> {
*/
readonly options: JsonOptionsMap;

/**
* Contains the prototype for messages returned by create() which
* includes the `MESSAGE_TYPE` symbol pointing back to `this`.
*/
readonly messagePrototype: Readonly<{}> | undefined;

protected readonly defaultCheckDepth = 16;
protected readonly refTypeCheck: ReflectionTypeCheck;
Expand All @@ -61,6 +67,7 @@ export class MessageType<T extends object> implements IMessageType<T> {
this.typeName = name;
this.fields = fields.map(normalizeFieldInfo);
this.options = options ?? {};
this.messagePrototype = Object.defineProperty({}, MESSAGE_TYPE, { value: this });
this.refTypeCheck = new ReflectionTypeCheck(this);
this.refJsonReader = new ReflectionJsonReader(this);
this.refJsonWriter = new ReflectionJsonWriter(this);
Expand Down
15 changes: 13 additions & 2 deletions packages/runtime/src/reflection-create.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,19 @@ import {MESSAGE_TYPE} from './message-type-contract';
* information.
*/
export function reflectionCreate<T extends object>(type: IMessageType<T>): T {
const msg: UnknownMessage = {};
Object.defineProperty(msg, MESSAGE_TYPE, {enumerable: false, value: type});
/**
* This ternary can be removed in the next major version.
* The `Object.create()` code path utilizes a new `messagePrototype`
* property on the `IMessageType` which has this same `MESSAGE_TYPE`
* non-enumerable property on it. Doing it this way means that we only
* pay the cost of `Object.defineProperty()` once per `IMessageType`
* class of once per "instance". The falsy code path is only provided
* for backwards compatibility in cases where the runtime library is
* updated without also updating the generated code.
*/
const msg: UnknownMessage = type.messagePrototype
? Object.create(type.messagePrototype)
: Object.defineProperty({}, MESSAGE_TYPE, {value: type});
Comment on lines +21 to +23
Copy link
Owner

Choose a reason for hiding this comment

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

Can you add a comment here explaining that Object.create is used to avoid calling the expensive Object.defineProperty for every new instance?
We should also explain that the second code path is only there for BC, so we know that we can remove it with a major version release.

for (let field of type.fields) {
let name = field.localName;
if (field.opt)
Expand Down