Skip to content

BridgeJS: Fix optional String return handling in generated JS glue code #585

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
krodak merged 1 commit into from
Feb 5, 2026
+31 −56
Merged

BridgeJS: Fix optional String return handling in generated JS glue code #585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 4 additions & 16 deletions Plugins/BridgeJS/Sources/BridgeJSLink/JSGlueGen.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -994,19 +994,13 @@ struct IntrinsicJSFragment: Sendable {
"bjs[\"swift_js_return_optional_double\"](\(isSomeVar) ? 1 : 0, \(isSomeVar) ? \(value) : 0.0);"
)
case .string:
let bytesVar = scope.variable("bytes")
printer.write("if (\(isSomeVar)) {")
printer.indent {
printer.write(
"const \(bytesVar) = \(JSGlueVariableScope.reservedTextEncoder).encode(\(value));"
)
printer.write("bjs[\"swift_js_return_optional_string\"](1, \(bytesVar), \(bytesVar).length);")
printer.write("return \(bytesVar).length;")
printer.write("\(JSGlueVariableScope.reservedStorageToReturnString) = \(value);")
}
printer.write("} else {")
printer.indent {
printer.write("bjs[\"swift_js_return_optional_string\"](0, 0, 0);")
printer.write("return -1;")
printer.write("\(JSGlueVariableScope.reservedStorageToReturnString) = null;")
}
printer.write("}")
case .jsObject, .swiftProtocol:
Expand All @@ -1032,19 +1026,13 @@ struct IntrinsicJSFragment: Sendable {
case .rawValueEnum(_, let rawType):
switch rawType {
case .string:
let bytesVar = scope.variable("bytes")
printer.write("if (\(isSomeVar)) {")
printer.indent {
printer.write(
"const \(bytesVar) = \(JSGlueVariableScope.reservedTextEncoder).encode(\(value));"
)
printer.write(
"bjs[\"swift_js_return_optional_string\"](1, \(bytesVar), \(bytesVar).length);"
)
printer.write("\(JSGlueVariableScope.reservedStorageToReturnString) = \(value);")
}
printer.write("} else {")
printer.indent {
printer.write("bjs[\"swift_js_return_optional_string\"](0, 0, 0);")
printer.write("\(JSGlueVariableScope.reservedStorageToReturnString) = null;")
}
printer.write("}")
default:
Expand Down
28 changes: 8 additions & 20 deletions Plugins/BridgeJS/Tests/BridgeJSToolTests/__Snapshots__/BridgeJSLinkTests/Optionals.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,12 +238,9 @@ export async function createInstantiator(options, swift) {
let ret = swift.memory.getObject(self).stringOrNull;
const isSome = ret != null;
if (isSome) {
const bytes = textEncoder.encode(ret);
bjs["swift_js_return_optional_string"](1, bytes, bytes.length);
return bytes.length;
tmpRetString = ret;
} else {
bjs["swift_js_return_optional_string"](0, 0, 0);
return -1;
tmpRetString = null;
}
} catch (error) {
setException(error);
Expand All @@ -254,12 +251,9 @@ export async function createInstantiator(options, swift) {
let ret = swift.memory.getObject(self).stringOrUndefined;
const isSome = ret !== undefined;
if (isSome) {
const bytes = textEncoder.encode(ret);
bjs["swift_js_return_optional_string"](1, bytes, bytes.length);
return bytes.length;
tmpRetString = ret;
} else {
bjs["swift_js_return_optional_string"](0, 0, 0);
return -1;
tmpRetString = null;
}
} catch (error) {
setException(error);
Expand Down Expand Up @@ -395,12 +389,9 @@ export async function createInstantiator(options, swift) {
let ret = swift.memory.getObject(self).roundTripStringOrNull(valueIsSome ? obj : null);
const isSome = ret != null;
if (isSome) {
const bytes = textEncoder.encode(ret);
bjs["swift_js_return_optional_string"](1, bytes, bytes.length);
return bytes.length;
tmpRetString = ret;
} else {
bjs["swift_js_return_optional_string"](0, 0, 0);
return -1;
tmpRetString = null;
}
} catch (error) {
setException(error);
Expand All @@ -416,12 +407,9 @@ export async function createInstantiator(options, swift) {
let ret = swift.memory.getObject(self).roundTripStringOrUndefined(valueIsSome ? obj : undefined);
const isSome = ret !== undefined;
if (isSome) {
const bytes = textEncoder.encode(ret);
bjs["swift_js_return_optional_string"](1, bytes, bytes.length);
return bytes.length;
tmpRetString = ret;
} else {
bjs["swift_js_return_optional_string"](0, 0, 0);
return -1;
tmpRetString = null;
}
} catch (error) {
setException(error);
Expand Down
39 changes: 19 additions & 20 deletions Tests/BridgeJSRuntimeTests/OptionalSupportTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,25 @@ final class OptionalSupportTests: XCTestCase {
try runJsOptionalSupportTests()
}

// FIXME: Optional<String> return type on imported function is broken
// func testRoundTripOptionalStringNull() throws {
// try XCTAssertEqual(jsRoundTripOptionalStringNull("hello"), "hello")
// try XCTAssertNil(jsRoundTripOptionalStringNull(nil))
// }

// func testRoundTripOptionalStringUndefined() throws {
// let some = try jsRoundTripOptionalStringUndefined(.value("hi"))
// switch some {
// case .value(let value):
// XCTAssertEqual(value, "hi")
// case .undefined:
// XCTFail("Expected defined value")
// }

// let undefined = try jsRoundTripOptionalStringUndefined(.undefinedValue)
// if case .value = undefined {
// XCTFail("Expected undefined")
// }
// }
func testRoundTripOptionalStringNull() throws {
try XCTAssertEqual(jsRoundTripOptionalStringNull("hello"), "hello")
try XCTAssertNil(jsRoundTripOptionalStringNull(nil))
}

func testRoundTripOptionalStringUndefined() throws {
let some = try jsRoundTripOptionalStringUndefined(.value("hi"))
switch some {
case .value(let value):
XCTAssertEqual(value, "hi")
case .undefined:
XCTFail("Expected defined value")
}

let undefined = try jsRoundTripOptionalStringUndefined(.undefinedValue)
if case .value = undefined {
XCTFail("Expected undefined")
}
}

func testRoundTripOptionalNumberNull() throws {
try XCTAssertEqual(jsRoundTripOptionalNumberNull(42), 42)
Expand Down