[swiftsrc2cpg] Fixed instanceOf checks (#5688)

max-leuthaeuser · web-flow · commit f76444dd23e7 · 2025-10-28T10:26:28.000+01:00
diff --git a/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstCreator.scala b/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstCreator.scala
@@ -44,7 +44,6 @@ class AstCreator(
   protected val dynamicInstanceTypeStack = new Stack[String]
   protected val localAstParentStack      = new Stack[NewBlock]()
   protected val scopeLocalUniqueNames    = mutable.HashMap.empty[String, Int]
-  protected val seenAliasTypes           = mutable.HashSet.empty[NewTypeDecl]
 
   protected lazy val definedSymbols: Map[String, String] = {
     config.defines.map {
diff --git a/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstCreatorHelper.scala b/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstCreatorHelper.scala
@@ -76,6 +76,7 @@ object AstCreatorHelper {
       case ""                   => Defines.Any
       case t if t.contains("?") => Defines.Any
       // Map builtin types
+      case "Any"        => Defines.Any
       case "String"     => Defines.String
       case "Character"  => Defines.Character
       case "Int"        => Defines.Int
@@ -283,7 +284,7 @@ trait AstCreatorHelper(implicit withSchemaValidation: ValidationMode) { this: As
     typeNameInfoForNode(node, name)
   }
 
-  protected def nameForTypeSyntax(node: TypeSyntax): String = {
+  private def nameForTypeSyntax(node: TypeSyntax): String = {
     val name = node match {
       case _: ArrayTypeSyntax                       => "array-type"
       case a: AttributedTypeSyntax                  => nameForTypeSyntax(a.baseType)
@@ -307,6 +308,29 @@ trait AstCreatorHelper(implicit withSchemaValidation: ValidationMode) { this: As
     scopeLocalUniqueName(cleanType(name))
   }
 
+  protected def simpleTypeNameForTypeSyntax(node: TypeSyntax): String = {
+    node match {
+      case _: ArrayTypeSyntax                       => Defines.Array
+      case a: AttributedTypeSyntax                  => simpleTypeNameForTypeSyntax(a.baseType)
+      case _: ClassRestrictionTypeSyntax            => Defines.Class
+      case _: CompositionTypeSyntax                 => scopeLocalUniqueName("composition-type")
+      case _: DictionaryTypeSyntax                  => Defines.Dictionary
+      case _: FunctionTypeSyntax                    => Defines.Function
+      case id: IdentifierTypeSyntax                 => scopeLocalUniqueName(cleanType(code(id.name)))
+      case w: ImplicitlyUnwrappedOptionalTypeSyntax => simpleTypeNameForTypeSyntax(w.wrappedType)
+      case m: MemberTypeSyntax                      => scopeLocalUniqueName(cleanType(code(m)))
+      case m: MetatypeTypeSyntax                    => simpleTypeNameForTypeSyntax(m.baseType)
+      case _: MissingTypeSyntax                     => scopeLocalUniqueName("missing-type")
+      case n: NamedOpaqueReturnTypeSyntax           => simpleTypeNameForTypeSyntax(n.`type`)
+      case o: OptionalTypeSyntax                    => simpleTypeNameForTypeSyntax(o.wrappedType)
+      case p: PackElementTypeSyntax                 => simpleTypeNameForTypeSyntax(p.pack)
+      case p: PackExpansionTypeSyntax               => simpleTypeNameForTypeSyntax(p.repetitionPattern)
+      case s: SomeOrAnyTypeSyntax                   => simpleTypeNameForTypeSyntax(s.constraint)
+      case s: SuppressedTypeSyntax                  => simpleTypeNameForTypeSyntax(s.`type`)
+      case _: TupleTypeSyntax                       => Defines.Tuple
+    }
+  }
+
   protected def typeNameInfoForTypeSyntax(node: TypeSyntax): TypeInfo = {
     val name = nameForTypeSyntax(node)
     typeNameInfoForNode(node, name)
diff --git a/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstForDeclSyntaxCreator.scala b/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstForDeclSyntaxCreator.scala
@@ -48,7 +48,6 @@ trait AstForDeclSyntaxCreator(implicit withSchemaValidation: ValidationMode) {
       astParentFullName,
       alias = aliasName
     )
-    seenAliasTypes.add(typeDeclNode_)
 
     attributes.foreach { ast =>
       Ast.storeInDiffGraph(ast, diffGraph)
@@ -328,7 +327,6 @@ trait AstForDeclSyntaxCreator(implicit withSchemaValidation: ValidationMode) {
       astParentFullName,
       inherits = inherits
     )
-    seenAliasTypes.add(typeDeclNode_)
 
     attributes.foreach { ast =>
       Ast.storeInDiffGraph(ast, diffGraph)
@@ -472,7 +470,6 @@ trait AstForDeclSyntaxCreator(implicit withSchemaValidation: ValidationMode) {
       astParentFullName,
       inherits = inherits
     )
-    seenAliasTypes.add(typeDeclNode_)
 
     attributes.foreach { ast =>
       Ast.storeInDiffGraph(ast, diffGraph)
@@ -856,7 +853,6 @@ trait AstForDeclSyntaxCreator(implicit withSchemaValidation: ValidationMode) {
       astParentFullName,
       alias = Option(aliasName)
     )
-    seenAliasTypes.add(typeDeclNode_)
 
     attributes.foreach { ast =>
       Ast.storeInDiffGraph(ast, diffGraph)
diff --git a/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstForExprSyntaxCreator.scala b/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstForExprSyntaxCreator.scala
@@ -380,15 +380,17 @@ trait AstForExprSyntaxCreator(implicit withSchemaValidation: ValidationMode) {
   }
 
   private def astForIsExprSyntax(node: IsExprSyntax): Ast = {
+    val op     = Operators.instanceOf
     val lhsAst = astForNode(node.expression)
-    val rhsAst = astForNode(node.`type`)
 
-    val op  = Operators.instanceOf
-    val tpe = fullnameProvider.typeFullname(node).getOrElse(Defines.Any)
+    val tpeNode = node.`type`
+    val tpe     = simpleTypeNameForTypeSyntax(tpeNode)
     registerType(tpe)
-    val callNode_ = createStaticCallNode(node, code(node), op, op, tpe)
 
-    val argAsts = List(lhsAst, rhsAst)
+    val callNode_    = createStaticCallNode(node, code(node), op, op, Defines.Bool)
+    val typeRefNode_ = typeRefNode(node, code(tpeNode), tpe)
+
+    val argAsts = List(lhsAst, Ast(typeRefNode_))
     callAst(callNode_, argAsts)
   }
 
diff --git a/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstForPatternSyntaxCreator.scala b/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstForPatternSyntaxCreator.scala
@@ -1,10 +1,10 @@
 package io.joern.swiftsrc2cpg.astcreation
 
 import io.joern.swiftsrc2cpg.parser.SwiftNodeSyntax.*
-import io.joern.x2cpg.{Ast, ValidationMode}
 import io.joern.x2cpg.datastructures.VariableScopeManager
 import io.joern.x2cpg.frontendspecific.swiftsrc2cpg.Defines
-import io.shiftleft.codepropertygraph.generated.{DispatchTypes, EdgeTypes, Operators}
+import io.joern.x2cpg.{Ast, ValidationMode}
+import io.shiftleft.codepropertygraph.generated.{EdgeTypes, Operators}
 
 import scala.annotation.{tailrec, unused}
 
@@ -20,16 +20,17 @@ trait AstForPatternSyntaxCreator(implicit withSchemaValidation: ValidationMode)
   }
 
   private def astForIsTypePatternSyntax(node: IsTypePatternSyntax): Ast = {
-    val op      = Operators.instanceOf
+    val op = Operators.instanceOf
+
     val tpeNode = node.`type`
-    val tpeCode = code(tpeNode)
-    val tpe     = nameForTypeSyntax(tpeNode)
+    val tpe     = simpleTypeNameForTypeSyntax(tpeNode)
     registerType(tpe)
 
-    val callNode_    = createStaticCallNode(node, code(node), op, op, tpe)
-    val typeRefNode_ = typeRefNode(node, tpeCode, tpe)
-    val arg          = Ast(typeRefNode_)
-    callAst(callNode_, List(arg))
+    val callNode_    = createStaticCallNode(node, code(node), op, op, Defines.Bool)
+    val typeRefNode_ = typeRefNode(node, code(tpeNode), tpe)
+
+    val argAsts = List(Ast(typeRefNode_))
+    callAst(callNode_, argAsts)
   }
 
   private def astForMissingPatternSyntax(@unused node: MissingPatternSyntax): Ast = Ast()
diff --git a/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstForTypeSyntaxCreator.scala b/joern-cli/frontends/swiftsrc2cpg/src/main/scala/io/joern/swiftsrc2cpg/astcreation/AstForTypeSyntaxCreator.scala
@@ -18,7 +18,6 @@ trait AstForTypeSyntaxCreator(implicit withSchemaValidation: ValidationMode) {
     val typeDeclNode_ =
       typeDeclNode(node, typeName, typeFullName, parserResult.filename, code(node), astParentType, astParentFullName)
 
-    seenAliasTypes.add(typeDeclNode_)
     diffGraph.addEdge(methodAstParentStack.head, typeDeclNode_, EdgeTypes.AST)
     typeDeclNode_
   }
diff --git a/joern-cli/frontends/swiftsrc2cpg/src/test/scala/io/joern/swiftsrc2cpg/passes/ast/InstanceOfTests.scala b/joern-cli/frontends/swiftsrc2cpg/src/test/scala/io/joern/swiftsrc2cpg/passes/ast/InstanceOfTests.scala
@@ -0,0 +1,42 @@
+package io.joern.swiftsrc2cpg.passes.ast
+
+import io.joern.swiftsrc2cpg.testfixtures.SwiftCompilerSrc2CpgSuite
+import io.joern.x2cpg.frontendspecific.swiftsrc2cpg.Defines
+import io.shiftleft.codepropertygraph.generated.*
+import io.shiftleft.codepropertygraph.generated.nodes.*
+import io.shiftleft.semanticcpg.language.*
+
+class InstanceOfTests extends SwiftCompilerSrc2CpgSuite {
+
+  "InstanceOfTests" should {
+    "have correct structure for instanceOf checks" in {
+      val cpg = code("""
+          |func main(x: Int) -> Int {
+          |  if x is [[String: Any]] {
+          |    return 2
+          |  }
+          |  return 1
+          |}""".stripMargin)
+      inside(cpg.call.nameExact(Operators.instanceOf).argument.l) { case List(x: Identifier, typeRef: TypeRef) =>
+        x.typeFullName shouldBe Defines.Int
+        typeRef.typeFullName shouldBe "Swift.Array"
+      }
+    }
+
+    "have correct structure for instanceOf checks with compiler support" in {
+      val cpg = codeWithSwiftSetup("""
+          |func main(x: Int) -> Int {
+          |  if x is [[String: Any]] {
+          |    return 2
+          |  }
+          |  return 1
+          |}""".stripMargin)
+      inside(cpg.call.nameExact(Operators.instanceOf).argument.l) { case List(x: Identifier, typeRef: TypeRef) =>
+        x.typeFullName shouldBe Defines.Int
+        // Sadly, swiftc does not offer any information about the actual (deep) type of the RSH of the check
+        typeRef.typeFullName shouldBe "Swift.Array"
+      }
+    }
+  }
+
+}
diff --git a/joern-cli/frontends/x2cpg/src/main/scala/io/joern/x2cpg/frontendspecific/swiftsrc2cpg/Defines.scala b/joern-cli/frontends/x2cpg/src/main/scala/io/joern/x2cpg/frontendspecific/swiftsrc2cpg/Defines.scala
@@ -16,7 +16,9 @@ object Defines {
   val Double: String                 = "Swift.Double"
   val Bool: String                   = "Swift.Bool"
   val Function: String               = "Swift.Function"
+  val Tuple: String                  = "Swift.Tuple"
   val Array: String                  = "Swift.Array"
+  val Class: String                  = "Swift.Class"
   val Dictionary: String             = "Swift.Dictionary"
   val Nil: String                    = "Swift.Nil"
   val Iterator: String               = "Swift.Iterator"
@@ -27,7 +29,23 @@ object Defines {
   val GlobalNamespace: String        = NamespaceTraversal.globalNamespaceName
 
   val SwiftTypes: List[String] =
-    List(Any, Nil, Character, String, Int, Float, Double, Bool, Function, Array, Dictionary, Iterator, Void)
+    List(
+      Any,
+      Nil,
+      Character,
+      String,
+      Int,
+      Float,
+      Double,
+      Bool,
+      Tuple,
+      Function,
+      Class,
+      Array,
+      Dictionary,
+      Iterator,
+      Void
+    )
 
   val PostfixOperatorMap: Map[String, String] = Map(
     "++"  -> Operators.postIncrement,

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,6 @@ trait AstForTypeSyntaxCreator(implicit withSchemaValidation: ValidationMode) {`
`18`	`18`	`val typeDeclNode_ =`
`19`	`19`	`typeDeclNode(node, typeName, typeFullName, parserResult.filename, code(node), astParentType, astParentFullName)`
`20`	`20`
`21`		`- seenAliasTypes.add(typeDeclNode_)`
`22`	`21`	`diffGraph.addEdge(methodAstParentStack.head, typeDeclNode_, EdgeTypes.AST)`
`23`	`22`	`typeDeclNode_`
`24`	`23`	`}`