From 866fde18d8ad3386f01d848625370f08b78bbbd3 Mon Sep 17 00:00:00 2001
From: Kevin Wooten <kevin@outfoxx.io>
Date: Thu, 14 Nov 2024 14:31:59 -0700
Subject: [PATCH] Fixes for hierarchies in Kotlin, Swift & Typescript

## All
Lookup inherited/inheriting by non-nullable type

## Swift
Use non-optional `AnyRef` type for `ifPresent` decoding

## Kotlin
Remove inherited properties from declared properties to support constraining properties in sub-types
---
 .../generator/common/ResolutionContext.kt     | 16 +--
 .../generator/kotlin/KotlinTypeRegistry.kt    |  4 +-
 .../generator/swift/SwiftTypeRegistry.kt      |  2 +-
 .../sunday/generator/utils/WebApiExts.kt      |  1 +
 .../generator/kotlin/RamlObjectTypesTest.kt   | 98 ++++++++++++++++++-
 .../generator/swift/RamlObjectTypesTest.kt    | 35 ++++++-
 .../typescript/RamlObjectTypesTest.kt         | 56 ++++++++++-
 .../tools/LocalTypeScriptCompiler.kt          |  9 ++
 .../types/obj-property-nullability.raml       | 23 +++++
 9 files changed, 224 insertions(+), 20 deletions(-)

diff --git a/generator/src/main/kotlin/io/outfoxx/sunday/generator/common/ResolutionContext.kt b/generator/src/main/kotlin/io/outfoxx/sunday/generator/common/ResolutionContext.kt
index b1c2908fc..2c4502b99 100644
--- a/generator/src/main/kotlin/io/outfoxx/sunday/generator/common/ResolutionContext.kt
+++ b/generator/src/main/kotlin/io/outfoxx/sunday/generator/common/ResolutionContext.kt
@@ -25,13 +25,7 @@ import amf.core.client.platform.model.domain.PropertyShape
 import amf.core.client.platform.model.domain.Shape
 import amf.core.internal.annotations.Aliases
 import amf.shapes.client.platform.model.domain.NodeShape
-import io.outfoxx.sunday.generator.utils.allUnits
-import io.outfoxx.sunday.generator.utils.annotations
-import io.outfoxx.sunday.generator.utils.declares
-import io.outfoxx.sunday.generator.utils.id
-import io.outfoxx.sunday.generator.utils.location
-import io.outfoxx.sunday.generator.utils.name
-import io.outfoxx.sunday.generator.utils.nonPatternProperties
+import io.outfoxx.sunday.generator.utils.*
 import scala.collection.JavaConverters
 
 interface ResolutionContext {
@@ -39,13 +33,13 @@ interface ResolutionContext {
   val unit: BaseUnit
   val shapeIndex: ShapeIndex
 
-  fun hasInherited(shape: Shape): Boolean = shapeIndex.hasInherited(shape)
+  fun hasInherited(shape: Shape): Boolean = shapeIndex.hasInherited(shape.nonNullableType)
 
-  fun hasNoInherited(shape: Shape): Boolean = shapeIndex.hasNoInherited(shape)
+  fun hasNoInherited(shape: Shape): Boolean = shapeIndex.hasNoInherited(shape.nonNullableType)
 
-  fun hasNoInheriting(shape: Shape): Boolean = shapeIndex.hasNoInheriting(shape)
+  fun hasNoInheriting(shape: Shape): Boolean = shapeIndex.hasNoInheriting(shape.nonNullableType)
 
-  fun findRootShape(shape: Shape): Shape = findSuperShapeOrNull(shape)?.let(this::findRootShape) ?: shape
+  fun findRootShape(shape: Shape): Shape = findSuperShapeOrNull(shape.nonNullableType)?.let(this::findRootShape) ?: shape
 
   fun findSuperShapeOrNull(shape: Shape): Shape? {
     val superShapeId = shapeIndex.findSuperShapeIdOrNull(shape) ?: return null
diff --git a/generator/src/main/kotlin/io/outfoxx/sunday/generator/kotlin/KotlinTypeRegistry.kt b/generator/src/main/kotlin/io/outfoxx/sunday/generator/kotlin/KotlinTypeRegistry.kt
index 99478de4e..7a6f3d69c 100644
--- a/generator/src/main/kotlin/io/outfoxx/sunday/generator/kotlin/KotlinTypeRegistry.kt
+++ b/generator/src/main/kotlin/io/outfoxx/sunday/generator/kotlin/KotlinTypeRegistry.kt
@@ -518,7 +518,7 @@ class KotlinTypeRegistry(
           resolveReferencedTypeName(itemsShape, context)
         }
         ?: ANY
-    
+
     val collectionType =
       if (shape.uniqueItems == true) {
         SET
@@ -612,7 +612,7 @@ class KotlinTypeRegistry(
     }
 
     var inheritedProperties = superShape?.let(context::findAllProperties) ?: emptyList()
-    var declaredProperties = context.findProperties(shape)
+    var declaredProperties = context.findProperties(shape).filter { dec -> dec.name !in inheritedProperties.map { it.name } }
 
     val inheritingTypes = context.findInheritingShapes(shape)
 
diff --git a/generator/src/main/kotlin/io/outfoxx/sunday/generator/swift/SwiftTypeRegistry.kt b/generator/src/main/kotlin/io/outfoxx/sunday/generator/swift/SwiftTypeRegistry.kt
index cedd84330..053b73ca4 100644
--- a/generator/src/main/kotlin/io/outfoxx/sunday/generator/swift/SwiftTypeRegistry.kt
+++ b/generator/src/main/kotlin/io/outfoxx/sunday/generator/swift/SwiftTypeRegistry.kt
@@ -933,7 +933,7 @@ class SwiftTypeRegistry(
       when {
         !isLeaf -> {
           propertyTypeName = if (isOptional) {
-            (propertyTypeName.makeNonOptional() as DeclaredTypeName).nestedType(ANY_REF_NAME).makeOptional()
+            (propertyTypeName.makeNonOptional() as DeclaredTypeName).nestedType(ANY_REF_NAME)
           } else {
             (propertyTypeName as DeclaredTypeName).nestedType(ANY_REF_NAME)
           }
diff --git a/generator/src/main/kotlin/io/outfoxx/sunday/generator/utils/WebApiExts.kt b/generator/src/main/kotlin/io/outfoxx/sunday/generator/utils/WebApiExts.kt
index 8248d9a6c..034b8e45a 100644
--- a/generator/src/main/kotlin/io/outfoxx/sunday/generator/utils/WebApiExts.kt
+++ b/generator/src/main/kotlin/io/outfoxx/sunday/generator/utils/WebApiExts.kt
@@ -326,6 +326,7 @@ val Shape.ifShape: Shape? get() = this.ifShape()
 val Shape.thenShape: Shape? get() = this.thenShape()
 val Shape.elseShape: Shape? get() = this.elseShape()
 val Shape.inlined: Boolean get() = this.annotations.inlinedElement()
+val Shape.nonNullableType: Shape get() = if (this is UnionShape) this.nullableType else this
 
 //
 val ShapeExtension.definedBy: PropertyShape get() = this.definedBy()
diff --git a/generator/src/test/kotlin/io/outfoxx/sunday/generator/kotlin/RamlObjectTypesTest.kt b/generator/src/test/kotlin/io/outfoxx/sunday/generator/kotlin/RamlObjectTypesTest.kt
index 8f71e330c..e6b679345 100644
--- a/generator/src/test/kotlin/io/outfoxx/sunday/generator/kotlin/RamlObjectTypesTest.kt
+++ b/generator/src/test/kotlin/io/outfoxx/sunday/generator/kotlin/RamlObjectTypesTest.kt
@@ -77,7 +77,8 @@ class RamlObjectTypesTest {
     val typeRegistryOptions = setOf<Option>()
     val typeRegistry = KotlinTypeRegistry("io.test", null, GenerationMode.Server, typeRegistryOptions)
 
-    val typeSpec = findType("io.test.Test", generateTypes(testUri, typeRegistry))
+    val types = generateTypes(testUri, typeRegistry)
+    val typeSpec = findType("io.test.Test", types)
 
     assertEquals(
       """
@@ -97,6 +98,34 @@ class RamlObjectTypesTest {
           .writeTo(this)
       },
     )
+
+
+    val typeSpec2 = findType("io.test.Test2", types)
+
+    assertEquals(
+      """
+        package io.test
+
+        import kotlin.Any
+        import kotlin.String
+        import kotlin.collections.Map
+
+        public interface Test2 {
+          public val optionalObject: Map<String, Any>?
+
+          public val nillableObject: Map<String, Any>?
+
+          public val optionalHierarchy: Parent?
+
+          public val nillableHierarchy: Parent?
+        }
+
+      """.trimIndent(),
+      buildString {
+        FileSpec.get("io.test", typeSpec2)
+          .writeTo(this)
+      },
+    )
   }
 
   @Test
@@ -106,7 +135,8 @@ class RamlObjectTypesTest {
 
     val typeRegistry = KotlinTypeRegistry("io.test", null, GenerationMode.Server, setOf(ImplementModel))
 
-    val typeSpec = findType("io.test.Test", generateTypes(testUri, typeRegistry))
+    val types = generateTypes(testUri, typeRegistry)
+    val typeSpec = findType("io.test.Test", types)
 
     assertEquals(
       """
@@ -155,6 +185,70 @@ class RamlObjectTypesTest {
           .writeTo(this)
       },
     )
+
+    val typeSpec2 = findType("io.test.Test2", types)
+
+    assertEquals(
+      """
+        package io.test
+
+        import kotlin.Any
+        import kotlin.Boolean
+        import kotlin.Int
+        import kotlin.String
+        import kotlin.collections.Map
+
+        public class Test2(
+          public val optionalObject: Map<String, Any>? = null,
+          public val nillableObject: Map<String, Any>?,
+          public val optionalHierarchy: Parent? = null,
+          public val nillableHierarchy: Parent?,
+        ) {
+          public fun copy(
+            optionalObject: Map<String, Any>? = null,
+            nillableObject: Map<String, Any>? = null,
+            optionalHierarchy: Parent? = null,
+            nillableHierarchy: Parent? = null,
+          ): Test2 = Test2(optionalObject ?: this.optionalObject, nillableObject ?: this.nillableObject,
+              optionalHierarchy ?: this.optionalHierarchy, nillableHierarchy ?: this.nillableHierarchy)
+
+          override fun hashCode(): Int {
+            var result = 1
+            result = 31 * result + (optionalObject?.hashCode() ?: 0)
+            result = 31 * result + (nillableObject?.hashCode() ?: 0)
+            result = 31 * result + (optionalHierarchy?.hashCode() ?: 0)
+            result = 31 * result + (nillableHierarchy?.hashCode() ?: 0)
+            return result
+          }
+
+          override fun equals(other: Any?): Boolean {
+            if (this === other) return true
+            if (javaClass != other?.javaClass) return false
+
+            other as Test2
+
+            if (optionalObject != other.optionalObject) return false
+            if (nillableObject != other.nillableObject) return false
+            if (optionalHierarchy != other.optionalHierarchy) return false
+            if (nillableHierarchy != other.nillableHierarchy) return false
+
+            return true
+          }
+
+          override fun toString(): String = ""${'"'}
+          |Test2(optionalObject='${"$"}optionalObject',
+          | nillableObject='${"$"}nillableObject',
+          | optionalHierarchy='${"$"}optionalHierarchy',
+          | nillableHierarchy='${"$"}nillableHierarchy')
+          ""${'"'}.trimMargin()
+        }
+
+      """.trimIndent(),
+      buildString {
+        FileSpec.get("io.test", typeSpec2)
+          .writeTo(this)
+      },
+    )
   }
 
   @Test
diff --git a/generator/src/test/kotlin/io/outfoxx/sunday/generator/swift/RamlObjectTypesTest.kt b/generator/src/test/kotlin/io/outfoxx/sunday/generator/swift/RamlObjectTypesTest.kt
index 9c96566d7..22d8125de 100644
--- a/generator/src/test/kotlin/io/outfoxx/sunday/generator/swift/RamlObjectTypesTest.kt
+++ b/generator/src/test/kotlin/io/outfoxx/sunday/generator/swift/RamlObjectTypesTest.kt
@@ -180,42 +180,71 @@ class RamlObjectTypesTest {
 
           public var optionalObject: [String : Any]?
           public var nillableObject: [String : Any]?
+          public var optionalHierarchy: Parent?
+          public var nillableHierarchy: Parent?
           public var debugDescription: String {
             return DescriptionBuilder(Test2.self)
                 .add(optionalObject, named: "optionalObject")
                 .add(nillableObject, named: "nillableObject")
+                .add(optionalHierarchy, named: "optionalHierarchy")
+                .add(nillableHierarchy, named: "nillableHierarchy")
                 .build()
           }
 
-          public init(optionalObject: [String : Any]? = nil, nillableObject: [String : Any]?) {
+          public init(
+            optionalObject: [String : Any]? = nil,
+            nillableObject: [String : Any]?,
+            optionalHierarchy: Parent? = nil,
+            nillableHierarchy: Parent?
+          ) {
             self.optionalObject = optionalObject
             self.nillableObject = nillableObject
+            self.optionalHierarchy = optionalHierarchy
+            self.nillableHierarchy = nillableHierarchy
           }
 
           public required init(from decoder: Decoder) throws {
             let container = try decoder.container(keyedBy: CodingKeys.self)
             self.optionalObject = try container.decodeIfPresent([String : AnyValue].self, forKey: .optionalObject)?.mapValues { ${'$'}0.unwrapped }
             self.nillableObject = try container.decodeIfPresent([String : AnyValue].self, forKey: .nillableObject)?.mapValues { ${'$'}0.unwrapped }
+            self.optionalHierarchy = try container.decodeIfPresent(Parent.AnyRef.self, forKey: .optionalHierarchy)?.value
+            self.nillableHierarchy = try container.decodeIfPresent(Parent.AnyRef.self, forKey: .nillableHierarchy)?.value
           }
 
           public func encode(to encoder: Encoder) throws {
             var container = encoder.container(keyedBy: CodingKeys.self)
             try container.encodeIfPresent(self.optionalObject?.mapValues { try AnyValue.wrapped(${'$'}0) }, forKey: .optionalObject)
             try container.encodeIfPresent(self.nillableObject?.mapValues { try AnyValue.wrapped(${'$'}0) }, forKey: .nillableObject)
+            try container.encodeIfPresent(self.optionalHierarchy, forKey: .optionalHierarchy)
+            try container.encodeIfPresent(self.nillableHierarchy, forKey: .nillableHierarchy)
           }
 
           public func withOptionalObject(optionalObject: [String : Any]?) -> Test2 {
-            return Test2(optionalObject: optionalObject, nillableObject: nillableObject)
+            return Test2(optionalObject: optionalObject, nillableObject: nillableObject,
+                optionalHierarchy: optionalHierarchy, nillableHierarchy: nillableHierarchy)
           }
 
           public func withNillableObject(nillableObject: [String : Any]?) -> Test2 {
-            return Test2(optionalObject: optionalObject, nillableObject: nillableObject)
+            return Test2(optionalObject: optionalObject, nillableObject: nillableObject,
+                optionalHierarchy: optionalHierarchy, nillableHierarchy: nillableHierarchy)
+          }
+
+          public func withOptionalHierarchy(optionalHierarchy: Parent?) -> Test2 {
+            return Test2(optionalObject: optionalObject, nillableObject: nillableObject,
+                optionalHierarchy: optionalHierarchy, nillableHierarchy: nillableHierarchy)
+          }
+
+          public func withNillableHierarchy(nillableHierarchy: Parent?) -> Test2 {
+            return Test2(optionalObject: optionalObject, nillableObject: nillableObject,
+                optionalHierarchy: optionalHierarchy, nillableHierarchy: nillableHierarchy)
           }
 
           fileprivate enum CodingKeys : String, CodingKey {
 
             case optionalObject = "optionalObject"
             case nillableObject = "nillableObject"
+            case optionalHierarchy = "optionalHierarchy"
+            case nillableHierarchy = "nillableHierarchy"
 
           }
 
diff --git a/generator/src/test/kotlin/io/outfoxx/sunday/generator/typescript/RamlObjectTypesTest.kt b/generator/src/test/kotlin/io/outfoxx/sunday/generator/typescript/RamlObjectTypesTest.kt
index 39195b7ad..39280239e 100644
--- a/generator/src/test/kotlin/io/outfoxx/sunday/generator/typescript/RamlObjectTypesTest.kt
+++ b/generator/src/test/kotlin/io/outfoxx/sunday/generator/typescript/RamlObjectTypesTest.kt
@@ -91,7 +91,8 @@ class RamlObjectTypesTest {
 
     val typeRegistry = TypeScriptTypeRegistry(setOf())
 
-    val typeModSpec = findTypeMod("Test@!test", generateTypes(testUri, typeRegistry, compiler))
+    val types = generateTypes(testUri, typeRegistry, compiler)
+    val typeModSpec = findTypeMod("Test@!test", types)
 
     assertEquals(
       """
@@ -131,6 +132,59 @@ class RamlObjectTypesTest {
           .writeTo(this)
       },
     )
+
+    val typeModSpec2 = findTypeMod("Test2@!test2", types)
+
+    assertEquals(
+      """
+        import {Parent} from './parent';
+
+
+        export interface Test2Spec {
+
+          optionalObject?: Record<string, unknown>;
+
+          nillableObject: Record<string, unknown> | null;
+
+          optionalHierarchy?: Parent;
+
+          nillableHierarchy: Parent | null;
+
+        }
+
+        export class Test2 implements Test2Spec {
+
+          optionalObject: Record<string, unknown> | undefined;
+
+          nillableObject: Record<string, unknown> | null;
+
+          optionalHierarchy: Parent | undefined;
+
+          nillableHierarchy: Parent | null;
+
+          constructor(init: Test2Spec) {
+            this.optionalObject = init.optionalObject;
+            this.nillableObject = init.nillableObject;
+            this.optionalHierarchy = init.optionalHierarchy;
+            this.nillableHierarchy = init.nillableHierarchy;
+          }
+
+          copy(changes: Partial<Test2Spec>): Test2 {
+            return new Test2(Object.assign({}, this, changes));
+          }
+
+          toString(): string {
+            return `Test2(optionalObject='${"$"}{this.optionalObject}', nillableObject='${"$"}{this.nillableObject}', optionalHierarchy='${"$"}{this.optionalHierarchy}', nillableHierarchy='${"$"}{this.nillableHierarchy}')`;
+          }
+
+        }
+
+      """.trimIndent(),
+      buildString {
+        FileSpec.get(typeModSpec2)
+          .writeTo(this)
+      },
+    )
   }
 
   @Test
diff --git a/generator/src/test/kotlin/io/outfoxx/sunday/generator/typescript/tools/LocalTypeScriptCompiler.kt b/generator/src/test/kotlin/io/outfoxx/sunday/generator/typescript/tools/LocalTypeScriptCompiler.kt
index 7e9f35da2..d76459680 100644
--- a/generator/src/test/kotlin/io/outfoxx/sunday/generator/typescript/tools/LocalTypeScriptCompiler.kt
+++ b/generator/src/test/kotlin/io/outfoxx/sunday/generator/typescript/tools/LocalTypeScriptCompiler.kt
@@ -16,16 +16,22 @@
 
 package io.outfoxx.sunday.generator.typescript.tools
 
+import io.outfoxx.sunday.generator.utils.ShellProcess
 import java.nio.file.Path
 
 class LocalTypeScriptCompiler(private val command: String, workDir: Path) : TypeScriptCompiler(workDir) {
 
+  val env = ShellProcess.loadExtraEnvironment()
+
   init {
 
     val buildPkg =
       ProcessBuilder()
         .directory(workDir.toFile())
         .command(command, "ci")
+        .apply {
+          environment().putAll(env)
+        }
         .redirectErrorStream(true)
         .start()
 
@@ -42,6 +48,9 @@ class LocalTypeScriptCompiler(private val command: String, workDir: Path) : Type
       ProcessBuilder()
         .directory(workDir.toFile())
         .command(command, "run", "build")
+        .apply {
+          environment().putAll(env)
+        }
         .redirectErrorStream(true)
         .start()
 
diff --git a/generator/src/test/resources/raml/type-gen/types/obj-property-nullability.raml b/generator/src/test/resources/raml/type-gen/types/obj-property-nullability.raml
index 671b36c0a..fd286584e 100644
--- a/generator/src/test/resources/raml/type-gen/types/obj-property-nullability.raml
+++ b/generator/src/test/resources/raml/type-gen/types/obj-property-nullability.raml
@@ -18,6 +18,29 @@ types:
     properties:
       optionalObject?: object
       nillableObject: object?
+      optionalHierarchy?: Parent
+      nillableHierarchy: Parent?
+
+  Parent:
+    type: object
+    discriminator: type
+    properties:
+      type: string
+      value: string
+
+  Child1:
+    type: Parent
+    discriminatorValue: child1
+    properties:
+      type: string
+      childValue: string
+
+  Child2:
+    type: Parent
+    discriminatorValue: child2
+    properties:
+      type: string
+      childValue: string
 
 /tests/{id}: