migrator: add a flag to print incoming usrs to the API diff data store to facilitate testing. NFC (#8969)

Author: nkcsgexi

include/swift/IDE/APIDigesterData.h

@@ -254,6 +254,7 @@ struct APIDiffItemStore {
   ~APIDiffItemStore();
   ArrayRef<APIDiffItem*> getDiffItems(StringRef Key) const;
   ArrayRef<APIDiffItem*> getAllDiffItems() const;
+  void printIncomingUsr(bool print = true);
 
   /// Add a path of a JSON file dumped from swift-api-digester that contains
   /// API changes we care about. Calling this can be heavy since the procedure

include/swift/Migrator/MigratorOptions.h

@@ -28,6 +28,9 @@ struct MigratorOptions {
   /// compiler and applies them. This is generally for debugging.
   bool EnableMigratorFixits = true;
 
+  /// Whether to print each USR we query the api change data store about.
+  bool DumpUsr = false;
+
   /// If non-empty, print the last MigrationState's output text to the given
   /// file path.
   std::string EmitMigratedFilePath = "";

include/swift/Option/Options.td

@@ -434,6 +434,9 @@ def api_diff_data_file: Separate<["-"], "api-diff-data-file">,
   HelpText<"API migration data is from <path>">,
   MetaVarName<"<path>">;
 
+def dump_usr: Flag<["-"], "dump-usr">,
+  Flags<[FrontendOption, NoInteractiveOption]>,
+  HelpText<"Dump USR for each declaration reference">;
 // File types
 
 def parse_as_library : Flag<["-"], "parse-as-library">,

lib/Driver/ToolChains.cpp

@@ -300,6 +300,9 @@ ToolChain::constructInvocation(const CompileJobAction &job,
           Arguments.push_back("-api-diff-data-file");
           Arguments.push_back(DataPath->getValue());
         }
+        if (context.Args.hasArg(options::OPT_dump_usr)) {
+          Arguments.push_back("-dump-usr");
+        }
       }
     }
     break;

lib/Frontend/CompilerInvocation.cpp

@@ -1592,6 +1592,7 @@ bool ParseMigratorArgs(MigratorOptions &Opts, llvm::Triple &Triple,
   using namespace options;
 
   Opts.AddObjC |= Args.hasArg(OPT_warn_swift3_objc_inference);
+  Opts.DumpUsr = Args.hasArg(OPT_dump_usr);
 
   if (Args.hasArg(OPT_disable_migrator_fixits)) {
     Opts.EnableMigratorFixits = false;

lib/IDE/APIDigesterData.cpp

@@ -371,6 +371,7 @@ struct swift::ide::api::APIDiffItemStore::Implementation {
   llvm::BumpPtrAllocator Allocator;
 public:
   llvm::StringMap<std::vector<APIDiffItem*>> Data;
+  bool PrintUsr;
   std::vector<APIDiffItem*> AllItems;
   void addStorePath(StringRef FileName) {
     llvm::MemoryBuffer *pMemBuffer = nullptr;
@@ -400,7 +401,11 @@ struct swift::ide::api::APIDiffItemStore::Implementation {
 };
 
 ArrayRef<APIDiffItem*> swift::ide::api::APIDiffItemStore::
-getDiffItems(StringRef Key) const { return Impl.Data[Key]; }
+getDiffItems(StringRef Key) const {
+  if (Impl.PrintUsr)
+    llvm::outs() << Key;
+  return Impl.Data[Key];
+}
 
 ArrayRef<APIDiffItem*> swift::ide::api::APIDiffItemStore::
 getAllDiffItems() const { return Impl.AllItems; }
@@ -413,3 +418,7 @@ swift::ide::api::APIDiffItemStore::~APIDiffItemStore() { delete &Impl; }
 void swift::ide::api::APIDiffItemStore::addStorePath(StringRef Path) {
   Impl.addStorePath(Path);
 }
+
+void swift::ide::api::APIDiffItemStore::printIncomingUsr(bool print) {
+  Impl.PrintUsr = print;
+}

lib/Migrator/SyntacticMigratorPass.cpp

@@ -76,6 +76,7 @@ struct SyntacticMigratorPass::Implementation : public SourceEntityWalker {
     if (Opts.APIDigesterDataStorePath.empty())
       return;
     DiffStore.addStorePath(Opts.APIDigesterDataStorePath);
+    DiffStore.printIncomingUsr(Opts.DumpUsr);
     walk(SF);
   }
 

test/migrator/dump_usr.swift

@@ -0,0 +1,10 @@
+// REQUIRES: objc_interop
+// RUN: rm -rf %t && mkdir -p %t && %swift -update-code -primary-file %s -F %S/mock-sdk -api-diff-data-file %S/API.json -o %t/member.swift.remap -dump-usr | %FileCheck %s -check-prefix=USR
+
+import Bar
+
+func foo(_ b: BarForwardDeclaredClass) -> Int32 {
+  return barGlobalVariable
+}
+
+// USR: c:objc(cs)BarForwardDeclaredClasss:s5Int32Vc:@barGlobalVariable