Skip to content

Fix instances for message fields in message constructor #70

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

Merged
timostamm merged 2 commits into from
May 3, 2022
Merged

Fix instances for message fields in message constructor #70

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
aafde2d
Add a test case
timostamm May 3, 2022
58e5b06
Fix
timostamm May 3, 2022
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
28 changes: 28 additions & 0 deletions packages/protobuf-test/src/constructor.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,34 @@ import {
import { TestAllTypesProto3 as JS_TestAllTypesProto3 } from "./gen/js/google/protobuf/test_messages_proto3_pb.js";
import { testMT } from "./helpers.js";

describe("constructor takes message partial for message field", function () {
testMT(
{ ts: TS_TestAllTypesProto3, js: JS_TestAllTypesProto3 },
(messageType) => {
const m = new messageType({
recursiveMessage: {
optionalInt32: 123,
},
});
expect(m.recursiveMessage?.optionalInt32).toBe(123);
}
);
});

describe("constructor takes message instance for message field", function () {
testMT(
{ ts: TS_TestAllTypesProto3, js: JS_TestAllTypesProto3 },
(messageType) => {
const m = new messageType({
recursiveMessage: new messageType({
optionalInt32: 123,
}),
});
expect(m.recursiveMessage?.optionalInt32).toBe(123);
}
);
});

describe("constructor takes partial message for oneof field", function () {
testMT(
{ ts: TS_TestAllTypesProto3, js: JS_TestAllTypesProto3 },
Expand Down
2 changes: 1 addition & 1 deletion packages/protobuf/src/private/util-common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ export function makeUtilCommon(): Omit<Util, "newFieldList" | "initFields"> {
if (mt.fieldWrapper) {
t[localName] = val;
} else {
t[localName] = val instanceof mt ? mt : new mt(val);
t[localName] = val instanceof mt ? val : new mt(val);
Copy link
Member Author

@timostamm timostamm May 3, 2022

Choose a reason for hiding this comment

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

This code runs when you call new MyMessage(data). We're walking through the metadata (message fields) here, and pick values from the data. If the value for a message field is already an instance of the expected message type, we can use it as is. But instead of doing that, we do something silly and use the message type.

Copy link
Member

@paul-sachs paul-sachs May 3, 2022

Choose a reason for hiding this comment

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

Lol, yeah having it set to mt IS very weird. Definitely explains some other weird behaviour i was seeing.

}
}
break;
Expand Down