Merge pull request #10156 from github/redsun82/swift-import-optional-module

Swift: make `ImportDecl:imported_module` optional

Author: redsun82

swift/codegen/schema.yml

@@ -312,7 +312,7 @@ IfConfigClause:
 ImportDecl:
   _extends: Decl
   is_exported: predicate
-  imported_module: ModuleDecl
+  imported_module: ModuleDecl?  # may be none in inactive #if clauses
   declarations: ValueDecl*
 
 MissingMemberDecl:

swift/extractor/visitors/DeclVisitor.cpp

@@ -253,7 +253,7 @@ codeql::ExtensionDecl DeclVisitor::translateExtensionDecl(const swift::Extension
 codeql::ImportDecl DeclVisitor::translateImportDecl(const swift::ImportDecl& decl) {
   auto entry = createEntry(decl);
   entry.is_exported = decl.isExported();
-  entry.imported_module = dispatcher_.fetchLabel(decl.getModule());
+  entry.imported_module = dispatcher_.fetchOptionalLabel(decl.getModule());
   entry.declarations = dispatcher_.fetchRepeatedLabels(decl.getDecls());
   return entry;
 }

swift/ql/lib/codeql/swift/generated/Raw.qll

@@ -609,7 +609,7 @@ module Raw {
 
     predicate isExported() { import_decl_is_exported(this) }
 
-    ModuleDecl getImportedModule() { import_decls(this, result) }
+    ModuleDecl getImportedModule() { import_decl_imported_modules(this, result) }
 
     ValueDecl getDeclaration(int index) { import_decl_declarations(this, index, result) }
   }

swift/ql/lib/codeql/swift/generated/decl/ImportDecl.qll

@@ -19,6 +19,8 @@ class ImportDeclBase extends Synth::TImportDecl, Decl {
 
   final ModuleDecl getImportedModule() { result = getImmediateImportedModule().resolve() }
 
+  final predicate hasImportedModule() { exists(getImportedModule()) }
+
   ValueDecl getImmediateDeclaration(int index) {
     result =
       Synth::convertValueDeclFromRaw(Synth::convertImportDeclToRaw(this)

swift/ql/lib/swift.dbscheme

@@ -709,15 +709,20 @@ if_config_clause_is_active(  //dir=decl
 );
 
 import_decls(  //dir=decl
-  unique int id: @import_decl,
-  int imported_module: @module_decl ref
+  unique int id: @import_decl
 );
 
 #keyset[id]
 import_decl_is_exported(  //dir=decl
   int id: @import_decl ref
 );
 
+#keyset[id]
+import_decl_imported_modules(  //dir=decl
+  int id: @import_decl ref,
+  int imported_module: @module_decl ref
+);
+
 #keyset[id, index]
 import_decl_declarations(  //dir=decl
   int id: @import_decl ref,

swift/ql/test/extractor-tests/generated/decl/ImportDecl/ImportDecl.expected

@@ -1,5 +1,6 @@
-| import.swift:1:1:1:8 | import ... | getModule: | file://:0:0:0:0 | import | isExported: | no | getImportedModule: | file://:0:0:0:0 | Swift |
-| import.swift:2:1:2:24 | import ... | getModule: | file://:0:0:0:0 | import | isExported: | no | getImportedModule: | file://:0:0:0:0 | Swift |
-| import.swift:3:12:3:32 | import ... | getModule: | file://:0:0:0:0 | import | isExported: | yes | getImportedModule: | file://:0:0:0:0 | Swift |
-| import.swift:4:1:4:19 | import ... | getModule: | file://:0:0:0:0 | import | isExported: | no | getImportedModule: | file://:0:0:0:0 | Swift |
-| import.swift:5:1:5:23 | import ... | getModule: | file://:0:0:0:0 | import | isExported: | no | getImportedModule: | file://:0:0:0:0 | Swift |
+| import.swift:1:1:1:8 | import ... | getModule: | file://:0:0:0:0 | import | isExported: | no |
+| import.swift:2:1:2:24 | import ... | getModule: | file://:0:0:0:0 | import | isExported: | no |
+| import.swift:3:12:3:32 | import ... | getModule: | file://:0:0:0:0 | import | isExported: | yes |
+| import.swift:4:1:4:19 | import ... | getModule: | file://:0:0:0:0 | import | isExported: | no |
+| import.swift:5:1:5:23 | import ... | getModule: | file://:0:0:0:0 | import | isExported: | no |
+| import.swift:7:1:7:8 | import ... | getModule: | file://:0:0:0:0 | import | isExported: | no |

swift/ql/test/extractor-tests/generated/decl/ImportDecl/ImportDecl.ql

@@ -2,12 +2,10 @@
 import codeql.swift.elements
 import TestUtils
 
-from ImportDecl x, ModuleDecl getModule, string isExported, ModuleDecl getImportedModule
+from ImportDecl x, ModuleDecl getModule, string isExported
 where
   toBeTested(x) and
   not x.isUnknown() and
   getModule = x.getModule() and
-  (if x.isExported() then isExported = "yes" else isExported = "no") and
-  getImportedModule = x.getImportedModule()
-select x, "getModule:", getModule, "isExported:", isExported, "getImportedModule:",
-  getImportedModule
+  if x.isExported() then isExported = "yes" else isExported = "no"
+select x, "getModule:", getModule, "isExported:", isExported

swift/ql/test/extractor-tests/generated/decl/ImportDecl/ImportDecl_getImportedModule.expected

@@ -0,0 +1,5 @@
+| import.swift:1:1:1:8 | import ... | file://:0:0:0:0 | Swift |
+| import.swift:2:1:2:24 | import ... | file://:0:0:0:0 | Swift |
+| import.swift:3:12:3:32 | import ... | file://:0:0:0:0 | Swift |
+| import.swift:4:1:4:19 | import ... | file://:0:0:0:0 | Swift |
+| import.swift:5:1:5:23 | import ... | file://:0:0:0:0 | Swift |

swift/ql/test/extractor-tests/generated/decl/ImportDecl/ImportDecl_getImportedModule.ql

@@ -0,0 +1,7 @@
+// generated by codegen/codegen.py
+import codeql.swift.elements
+import TestUtils
+
+from ImportDecl x
+where toBeTested(x) and not x.isUnknown()
+select x, x.getImportedModule()

swift/ql/test/extractor-tests/generated/decl/ImportDecl/import.swift

@@ -3,3 +3,6 @@ import typealias Swift.Int
 @_exported import struct Swift.Double
 import func Swift.print  // imports all overloads
 import protocol Swift.Hashable
+#if foo
+import Foo
+#endif