BridgeJSLink: remove cleanup hooks

Author: kateinoigakukun

Plugins/BridgeJS/Sources/BridgeJSLink/BridgeJSLink.swift

@@ -921,14 +921,12 @@ public struct BridgeJSLink {
             for structDef in allStructs {
                 let structPrinter = CodeFragmentPrinter()
                 let structScope = JSGlueVariableScope(intrinsicRegistry: intrinsicRegistry)
-                let structCleanup = CodeFragmentPrinter()
                 let fragment = IntrinsicJSFragment.structHelper(structDefinition: structDef, allStructs: allStructs)
                 _ = try fragment.printCode(
                     [structDef.name],
                     IntrinsicJSFragment.PrintCodeContext(
                         scope: structScope,
-                        printer: structPrinter,
-                        cleanupCode: structCleanup
+                        printer: structPrinter
                     )
                 )
                 bodyPrinter.write(lines: structPrinter.lines)
@@ -940,14 +938,12 @@ public struct BridgeJSLink {
             for enumDef in allAssocEnums {
                 let enumPrinter = CodeFragmentPrinter()
                 let enumScope = JSGlueVariableScope(intrinsicRegistry: intrinsicRegistry)
-                let enumCleanup = CodeFragmentPrinter()
                 let fragment = IntrinsicJSFragment.associatedValueEnumHelperFactory(enumDefinition: enumDef)
                 _ = try fragment.printCode(
                     [enumDef.valuesName],
                     IntrinsicJSFragment.PrintCodeContext(
                         scope: enumScope,
-                        printer: enumPrinter,
-                        cleanupCode: enumCleanup
+                        printer: enumPrinter
                     )
                 )
                 bodyPrinter.write(lines: enumPrinter.lines)
@@ -1192,7 +1188,6 @@ public struct BridgeJSLink {
 
     class ExportedThunkBuilder {
         var body: CodeFragmentPrinter
-        var cleanupCode: CodeFragmentPrinter
         var parameterForwardings: [String] = []
         let effects: Effects
         let scope: JSGlueVariableScope
@@ -1202,11 +1197,9 @@ public struct BridgeJSLink {
             self.effects = effects
             self.scope = JSGlueVariableScope(intrinsicRegistry: intrinsicRegistry)
             self.body = CodeFragmentPrinter()
-            self.cleanupCode = CodeFragmentPrinter()
             self.context = IntrinsicJSFragment.PrintCodeContext(
                 scope: scope,
                 printer: body,
-                cleanupCode: cleanupCode,
                 hasDirectAccessToSwiftClass: hasDirectAccessToSwiftClass
             )
         }
@@ -1280,7 +1273,6 @@ public struct BridgeJSLink {
         /// Renders the thunk body (body code, cleanup, exception handling, and optional return) into a printer.
         func renderFunctionBody(into printer: CodeFragmentPrinter, returnExpr: String?) {
             printer.write(contentsOf: body)
-            printer.write(contentsOf: cleanupCode)
             printer.write(lines: checkExceptionLines())
             if let returnExpr = returnExpr {
                 printer.write("return \(returnExpr);")
@@ -1506,8 +1498,7 @@ public struct BridgeJSLink {
         let printer = CodeFragmentPrinter()
         let context = IntrinsicJSFragment.PrintCodeContext(
             scope: scope,
-            printer: printer,
-            cleanupCode: CodeFragmentPrinter()
+            printer: printer
         )
         let enumValuesName = enumDefinition.valuesName
 
@@ -2092,7 +2083,6 @@ extension BridgeJSLink {
     class ImportedThunkBuilder {
         let body: CodeFragmentPrinter
         let scope: JSGlueVariableScope
-        let cleanupCode: CodeFragmentPrinter
         let context: BridgeContext
         var parameterNames: [String] = []
         var parameterForwardings: [String] = []
@@ -2101,12 +2091,10 @@ extension BridgeJSLink {
         init(context: BridgeContext = .importTS, intrinsicRegistry: JSIntrinsicRegistry) {
             self.body = CodeFragmentPrinter()
             self.scope = JSGlueVariableScope(intrinsicRegistry: intrinsicRegistry)
-            self.cleanupCode = CodeFragmentPrinter()
             self.context = context
             self.printContext = IntrinsicJSFragment.PrintCodeContext(
                 scope: scope,
-                printer: body,
-                cleanupCode: cleanupCode
+                printer: body
             )
         }
 
@@ -2645,7 +2633,6 @@ extension BridgeJSLink {
                 getterPrinter.write("get \(property.name)() {")
                 getterPrinter.indent {
                     getterPrinter.write(contentsOf: getterThunkBuilder.body)
-                    getterPrinter.write(contentsOf: getterThunkBuilder.cleanupCode)
                     getterPrinter.write(lines: getterThunkBuilder.checkExceptionLines())
                     if let returnExpr = getterReturnExpr {
                         getterPrinter.write("return \(returnExpr);")
@@ -2673,7 +2660,6 @@ extension BridgeJSLink {
                     setterPrinter.write("set \(property.name)(value) {")
                     setterPrinter.indent {
                         setterPrinter.write(contentsOf: setterThunkBuilder.body)
-                        setterPrinter.write(contentsOf: setterThunkBuilder.cleanupCode)
                         setterPrinter.write(lines: setterThunkBuilder.checkExceptionLines())
                     }
                     setterPrinter.write("},")

Plugins/BridgeJS/Sources/BridgeJSLink/JSGlueGen.swift

@@ -145,8 +145,6 @@ struct IntrinsicJSFragment: Sendable {
         var scope: JSGlueVariableScope
         /// The printer to print the main fragment code.
         var printer: CodeFragmentPrinter
-        /// The printer to print the code that is expected to be executed at the end of the caller of the fragment.
-        var cleanupCode: CodeFragmentPrinter
         /// Whether the fragment has direct access to the SwiftHeapObject classes.
         /// If false, the fragment needs to use `_exports["<class name>"]` to access the class.
         var hasDirectAccessToSwiftClass: Bool = true
@@ -236,7 +234,7 @@ struct IntrinsicJSFragment: Sendable {
     static let stringLowerParameter = IntrinsicJSFragment(
         parameters: ["value"],
         printCode: { arguments, context in
-            let (scope, printer, cleanupCode) = (context.scope, context.printer, context.cleanupCode)
+            let (scope, printer) = (context.scope, context.printer)
             let argument = arguments[0]
             let bytesLabel = scope.variable("\(argument)Bytes")
             let bytesIdLabel = scope.variable("\(argument)Id")
@@ -248,7 +246,7 @@ struct IntrinsicJSFragment: Sendable {
     static let stringLiftReturn = IntrinsicJSFragment(
         parameters: [],
         printCode: { arguments, context in
-            let (scope, printer, cleanupCode) = (context.scope, context.printer, context.cleanupCode)
+            let (scope, printer) = (context.scope, context.printer)
             let resultLabel = scope.variable("ret")
             printer.write("const \(resultLabel) = \(JSGlueVariableScope.reservedStorageToReturnString);")
             printer.write("\(JSGlueVariableScope.reservedStorageToReturnString) = undefined;")
@@ -258,7 +256,7 @@ struct IntrinsicJSFragment: Sendable {
     static let stringLiftParameter = IntrinsicJSFragment(
         parameters: ["objectId"],
         printCode: { arguments, context in
-            let (scope, printer, cleanupCode) = (context.scope, context.printer, context.cleanupCode)
+            let (scope, printer) = (context.scope, context.printer)
             let objectId = arguments[0]
             let objectLabel = scope.variable("\(objectId)Object")
             // TODO: Implement "take" operation
@@ -270,7 +268,7 @@ struct IntrinsicJSFragment: Sendable {
     static let stringLowerReturn = IntrinsicJSFragment(
         parameters: ["value"],
         printCode: { arguments, context in
-            let (scope, printer, cleanupCode) = (context.scope, context.printer, context.cleanupCode)
+            let (scope, printer) = (context.scope, context.printer)
             printer.write(
                 "\(JSGlueVariableScope.reservedStorageToReturnBytes) = \(JSGlueVariableScope.reservedTextEncoder).encode(\(arguments[0]));"
             )
@@ -287,7 +285,7 @@ struct IntrinsicJSFragment: Sendable {
     static let jsObjectLiftReturn = IntrinsicJSFragment(
         parameters: ["retId"],
         printCode: { arguments, context in
-            let (scope, printer, cleanupCode) = (context.scope, context.printer, context.cleanupCode)
+            let (scope, printer) = (context.scope, context.printer)
             // TODO: Implement "take" operation
             let resultLabel = scope.variable("ret")
             let retId = arguments[0]
@@ -299,7 +297,7 @@ struct IntrinsicJSFragment: Sendable {
     static let jsObjectLiftRetainedObjectId = IntrinsicJSFragment(
         parameters: ["objectId"],
         printCode: { arguments, context in
-            let (scope, printer, cleanupCode) = (context.scope, context.printer, context.cleanupCode)
+            let (scope, printer) = (context.scope, context.printer)
             let resultLabel = scope.variable("value")
             let objectId = arguments[0]
             printer.write(
@@ -444,7 +442,7 @@ struct IntrinsicJSFragment: Sendable {
     static let jsValueLower = IntrinsicJSFragment(
         parameters: ["value"],
         printCode: { arguments, context in
-            let (scope, printer, cleanupCode) = (context.scope, context.printer, context.cleanupCode)
+            let (scope, printer) = (context.scope, context.printer)
             let value = arguments[0]
             let kindVar = scope.variable("\(value)Kind")
             let payload1Var = scope.variable("\(value)Payload1")
@@ -570,7 +568,7 @@ struct IntrinsicJSFragment: Sendable {
     static let jsValueLift = IntrinsicJSFragment(
         parameters: [],
         printCode: { _, context in
-            let (scope, printer, cleanupCode) = (context.scope, context.printer, context.cleanupCode)
+            let (scope, printer) = (context.scope, context.printer)
             let payload2 = scope.variable("jsValuePayload2")
             let payload1 = scope.variable("jsValuePayload1")
             let kind = scope.variable("jsValueKind")
@@ -588,7 +586,7 @@ struct IntrinsicJSFragment: Sendable {
     static let jsValueLiftParameter = IntrinsicJSFragment(
         parameters: ["kind", "payload1", "payload2"],
         printCode: { arguments, context in
-            let (scope, printer, cleanupCode) = (context.scope, context.printer, context.cleanupCode)
+            let (scope, printer) = (context.scope, context.printer)
             let resultVar = scope.variable("jsValue")
             registerJSValueHelpers(scope: scope)
             printer.write(
@@ -1128,16 +1126,7 @@ struct IntrinsicJSFragment: Sendable {
                     printer.write("if (\(isSomeVar)) {")
                     try printer.indent {
                         let arrayLowerFragment = try arrayLower(elementType: elementType)
-                        let arrayCleanup = CodeFragmentPrinter()
-                        let _ = try arrayLowerFragment.printCode(
-                            [value],
-                            context.with(\.cleanupCode, arrayCleanup)
-                        )
-                        if !arrayCleanup.lines.isEmpty {
-                            for line in arrayCleanup.lines {
-                                printer.write(line)
-                            }
-                        }
+                        let _ = try arrayLowerFragment.printCode([value], context)
                     }
                     printer.write("}")
                     scope.emitPushI32Parameter("\(isSomeVar) ? 1 : 0", printer: printer)
@@ -1176,11 +1165,10 @@ struct IntrinsicJSFragment: Sendable {
                 case .associatedValueEnum(let fullName):
                     let base = fullName.components(separatedBy: ".").last ?? fullName
                     let caseIdVar = scope.variable("caseId")
-                    let cleanupVar = scope.variable("cleanup")
                     printer.write("if (\(isSomeVar)) {")
                     printer.indent {
                         printer.write(
-                            "const { caseId: \(caseIdVar), cleanup: \(cleanupVar) } = \(JSGlueVariableScope.reservedEnumHelpers).\(base).lower(\(value));"
+                            "const { caseId: \(caseIdVar) } = \(JSGlueVariableScope.reservedEnumHelpers).\(base).lower(\(value));"
                         )
                         printer.write("return \(caseIdVar);")
                     }
@@ -1529,9 +1517,8 @@ struct IntrinsicJSFragment: Sendable {
                 let (scope, printer) = (context.scope, context.printer)
                 let value = arguments[0]
                 let caseIdVar = scope.variable("caseId")
-                let cleanupVar = scope.variable("cleanup")
                 printer.write(
-                    "const { caseId: \(caseIdVar), cleanup: \(cleanupVar) } = \(JSGlueVariableScope.reservedEnumHelpers).\(base).lower(\(value));"
+                    "const { caseId: \(caseIdVar) } = \(JSGlueVariableScope.reservedEnumHelpers).\(base).lower(\(value));"
                 )
                 printer.write("return \(caseIdVar);")
                 return []
@@ -1593,15 +1580,10 @@ struct IntrinsicJSFragment: Sendable {
                         for enumCase in enumDefinition.cases {
                             let caseName = enumCase.name.capitalizedFirstLetter
                             let caseScope = scope.makeChildScope()
-                            let caseCleanup = CodeFragmentPrinter()
-                            caseCleanup.indent()
                             let fragment = IntrinsicJSFragment.associatedValuePushPayload(enumCase: enumCase)
                             _ = try fragment.printCode(
                                 ["value", enumName, caseName],
-                                context.with(\.scope, caseScope).with(\.printer, lowerPrinter).with(
-                                    \.cleanupCode,
-                                    caseCleanup
-                                )
+                                context.with(\.scope, caseScope).with(\.printer, lowerPrinter)
                             )
                         }
 
@@ -1627,15 +1609,11 @@ struct IntrinsicJSFragment: Sendable {
                         for enumCase in enumDefinition.cases {
                             let caseName = enumCase.name.capitalizedFirstLetter
                             let caseScope = scope.makeChildScope()
-                            let caseCleanup = CodeFragmentPrinter()
 
                             let fragment = IntrinsicJSFragment.associatedValuePopPayload(enumCase: enumCase)
                             _ = try fragment.printCode(
                                 [enumName, caseName],
-                                context.with(\.scope, caseScope).with(\.printer, liftPrinter).with(
-                                    \.cleanupCode,
-                                    caseCleanup
-                                )
+                                context.with(\.scope, caseScope).with(\.printer, liftPrinter)
                             )
                         }
 
@@ -2012,12 +1990,9 @@ struct IntrinsicJSFragment: Sendable {
         return IntrinsicJSFragment(
             parameters: ["value"],
             printCode: { arguments, context in
-                let (scope, printer) = (context.scope, context.printer)
+                let printer = context.printer
                 let value = arguments[0]
-                let cleanupVar = scope.variable("cleanup")
-                printer.write(
-                    "const { cleanup: \(cleanupVar) } = \(JSGlueVariableScope.reservedStructHelpers).\(base).lower(\(value));"
-                )
+                printer.write("\(JSGlueVariableScope.reservedStructHelpers).\(base).lower(\(value));")
                 return []
             }
         )
@@ -2027,12 +2002,9 @@ struct IntrinsicJSFragment: Sendable {
         return IntrinsicJSFragment(
             parameters: ["value"],
             printCode: { arguments, context in
-                let (scope, printer) = (context.scope, context.printer)
+                let printer = context.printer
                 let value = arguments[0]
-                let cleanupVar = scope.variable("cleanup")
-                printer.write(
-                    "const { cleanup: \(cleanupVar) } = \(JSGlueVariableScope.reservedStructHelpers).\(structBase).lower(\(value));"
-                )
+                printer.write("\(JSGlueVariableScope.reservedStructHelpers).\(structBase).lower(\(value));")
                 return []
             }
         )
@@ -2614,22 +2586,10 @@ struct IntrinsicJSFragment: Sendable {
 
                 let presenceExpr = kind.presenceCheck(value: value)
                 printer.write("const \(isSomeVar) = \(presenceExpr) ? 1 : 0;")
-                // Cleanup is written inside the if block so retained id is in scope
-                let localCleanupWriter = CodeFragmentPrinter()
                 printer.write("if (\(isSomeVar)) {")
                 try printer.indent {
                     let innerFragment = try stackLowerFragment(elementType: wrappedType)
-                    let _ = try innerFragment.printCode(
-                        [value],
-                        context.with(\.cleanupCode, localCleanupWriter)
-                    )
-                    let localCleanupLines = localCleanupWriter.lines.filter {
-                        !$0.trimmingCharacters(in: .whitespaces).isEmpty
-                    }
-                    if !localCleanupLines.isEmpty {
-                        let localCleanupCode = localCleanupLines.joined(separator: " ")
-                        printer.write("arrayCleanups.push(() => { \(localCleanupCode) });")
-                    }
+                    let _ = try innerFragment.printCode([value], context)
                 }
                 printer.write("} else {")
                 printer.indent {

Plugins/BridgeJS/Tests/BridgeJSToolTests/__Snapshots__/BridgeJSLinkTests/ImportedTypeInExportedInterface.js

@@ -330,7 +330,7 @@ export async function createInstantiator(options, swift) {
                     return arrayResult;
                 },
                 roundtripFooContainer: function bjs_roundtripFooContainer(container) {
-                    const { cleanup: cleanup } = structHelpers.FooContainer.lower(container);
+                    structHelpers.FooContainer.lower(container);
                     instance.exports.bjs_roundtripFooContainer();
                     const structValue = structHelpers.FooContainer.lift();
                     return structValue;

Plugins/BridgeJS/Tests/BridgeJSToolTests/__Snapshots__/BridgeJSLinkTests/Protocol.js

@@ -346,7 +346,7 @@ export async function createInstantiator(options, swift) {
             TestModule["bjs_MyViewControllerDelegate_result_get"] = function bjs_MyViewControllerDelegate_result_get(self) {
                 try {
                     let ret = swift.memory.getObject(self).result;
-                    const { caseId: caseId, cleanup: cleanup } = enumHelpers.Result.lower(ret);
+                    const { caseId: caseId } = enumHelpers.Result.lower(ret);
                     return caseId;
                 } catch (error) {
                     setException(error);
@@ -365,7 +365,7 @@ export async function createInstantiator(options, swift) {
                     let ret = swift.memory.getObject(self).optionalResult;
                     const isSome = ret != null;
                     if (isSome) {
-                        const { caseId: caseId, cleanup: cleanup } = enumHelpers.Result.lower(ret);
+                        const { caseId: caseId } = enumHelpers.Result.lower(ret);
                         return caseId;
                     } else {
                         return -1;
@@ -545,7 +545,7 @@ export async function createInstantiator(options, swift) {
             TestModule["bjs_MyViewControllerDelegate_getResult"] = function bjs_MyViewControllerDelegate_getResult(self) {
                 try {
                     let ret = swift.memory.getObject(self).getResult();
-                    const { caseId: caseId, cleanup: cleanup } = enumHelpers.Result.lower(ret);
+                    const { caseId: caseId } = enumHelpers.Result.lower(ret);
                     return caseId;
                 } catch (error) {
                     setException(error);