Provide a 'symbolLocation' thrift method

Summary:
The most common reason people are using Glass in ad hoc ways is to find symbol locations (i.e. a mixture of search or our symbol id builders + describe().

describe() is still more than we need for this, and I keep forgetting we have 'resolveSymbolRange()'.

So make it clearer by calling it `symbolLocaton` and then I'll go through and fix a ton of the clients to use this much cheaper method. Then expose it to the main clients properly and refactor clients of describe()

Reviewed By: simonmar

Differential Revision: D59952037

fbshipit-source-id: ef7b4678995056a37d2bebda666418075c2d6381

glean/glass/Glean/Glass/Handler.hs

@@ -22,14 +22,16 @@ module Glean.Glass.Handler
   , findReferenceRanges
 
   -- * working with symbol ids
-  , resolveSymbolRange
+  , symbolLocation
   , describeSymbol
 
   -- * searching by string
   , searchSymbol
 
   -- ** by relationship
   , searchRelated
+
+  -- ** a large report of all information we know about a symbol
   , searchRelatedNeighborhood
 
   ) where
@@ -214,13 +216,13 @@ findReferenceRanges [email protected]{..} sym opts@RequestOptions{..} =
 
 
 -- | Resolve a symbol identifier to its range-based location in the latest db
-resolveSymbolRange
+symbolLocation
   :: Glass.Env
   -> SymbolId
   -> RequestOptions
   -> IO LocationRange
-resolveSymbolRange env@Glass.Env{..} sym opts = do
-  withSymbol "resolveSymbolRange" env opts sym
+symbolLocation env@Glass.Env{..} sym opts = do
+  withSymbol "symbolLocation" env opts sym
     $ \gleanDBs _dbInfo (repo, lang, toks) ->
       findSymbolLocationRange env GleanBackend{..} repo lang toks
 

glean/glass/Glean/Glass/Main.hs

@@ -186,11 +186,9 @@ glassHandler env0 cmd =
   FindReferences r opts -> Handler.findReferences env r opts
   FindReferenceRanges r opts -> Handler.findReferenceRanges env r opts
 
-  -- Resolving symbol information
-  ResolveSymbolRange r opts -> Handler.resolveSymbolRange env r opts
-
   -- Symbol info
   DescribeSymbol r opts -> Handler.describeSymbol env r opts
+  SymbolLocation r opts -> Handler.symbolLocation env r opts
 
   -- Search for symbols
   -- by string

glean/glass/Glean/Glass/Tracing.hs

@@ -83,8 +83,8 @@ glassTraceEvent (GlassTraceWithId tid (TraceCommand cmd)) = case cmd of
     ( "FindReferences", tid, json $ toEncoding r)
   Glass.FindReferenceRanges r opts ->
     ("FindReferenceRanges", tid, json $ toEncoding r)
-  Glass.ResolveSymbolRange r opts ->
-    ("ResolveSymbolRange", tid, json $ toEncoding r)
+  Glass.SymbolLocation r opts ->
+    ("SymbolLocation", tid, json $ toEncoding r)
   Glass.DescribeSymbol r opts ->
     ("DescribeSymbol", tid, json $ toEncoding r)
   Glass.SearchSymbol r opts ->

glean/glass/if/glass.thrift

@@ -751,14 +751,14 @@ service GlassService extends fb303.FacebookService {
     2: RequestOptions options,
   ) throws (1: ServerException e, 2: GlassException g);
 
-  // Resolve a symbol id to its definition location range
-  LocationRange resolveSymbolRange(
+  // Return details about a symbol, such as its location or type signature
+  SymbolDescription describeSymbol(
     1: SymbolId symbol,
     2: RequestOptions options,
   ) throws (1: ServerException e, 2: GlassException g);
 
-  // Return details about a symbol, such as its location or type signature
-  SymbolDescription describeSymbol(
+  // Return just the symbol's location as efficiently as possible
+  LocationRange symbolLocation(
     1: SymbolId symbol,
     2: RequestOptions options,
   ) throws (1: ServerException e, 2: GlassException g);

glean/glass/test/regression/lib/Glean/Glass/Regression/Snapshot.hs

@@ -193,8 +193,8 @@ evalQuery glassEnv qFile Query{..} oFile = case action of
     (Glass.findReferences glassEnv)
   "findReferenceRanges" -> withSymbolId oFile args
     (Glass.findReferenceRanges glassEnv)
-  "resolveSymbolRange" -> withSymbolId oFile args
-    (Glass.resolveSymbolRange glassEnv)
+  "symbolLocation" -> withSymbolId oFile args
+    (Glass.symbolLocation glassEnv)
   "describeSymbol" -> withSymbolId oFile args
     (Glass.describeSymbol glassEnv)
   "searchSymbol" ->  withObjectArgs qFile oFile args

glean/glass/test/regression/lib/Glean/Glass/Regression/Tests.hs

@@ -14,7 +14,7 @@ module Glean.Glass.Regression.Tests (
   testDescribeSymbolHasAnnotations,
   testDescribeSymbolHasVisibility,
   testSearchRelated,
-  testResolveSymbol,
+  testSymbolLocation,
 ) where
 
 import Data.Default
@@ -54,15 +54,15 @@ testDocumentSymbolListX path get =
         (not (null (documentSymbolListXResult_references res)) &&
          not (null (documentSymbolListXResult_definitions res)))
 
-testResolveSymbol :: SymbolId -> Path -> Getter -> Test
-testResolveSymbol sym@(SymbolId name) path get =
+testSymbolLocation :: SymbolId -> Path -> Getter -> Test
+testSymbolLocation sym@(SymbolId name) path get =
   TestLabel (Text.unpack name) $ TestCase $ do
     (backend, _repo) <- get
     withTestEnv backend $ \env -> do
-      LocationRange{..} <- resolveSymbolRange env sym def
-      assertEqual "resolveSymbol Path matches" locationRange_filepath path
+      LocationRange{..} <- symbolLocation env sym def
+      assertEqual "symbolLocation Path matches" locationRange_filepath path
 
--- | Test that both describeSymbol and resolveSymbol for a SymbolId
+-- | Test that both describeSymbol and symbolLocation for a SymbolId
 -- find the symbol in a given Path.
 testDescribeSymbolMatchesPath
   :: SymbolId -> Path -> Getter -> Test
@@ -74,8 +74,8 @@ testDescribeSymbolMatchesPath sym@(SymbolId name) path get =
       assertEqual "describeSymbol Path matches"
         (symbolPath_filepath symbolDescription_location)
         path
-      LocationRange{..} <- resolveSymbolRange env sym def
-      assertEqual "resolveSymbol Path matches" locationRange_filepath path
+      LocationRange{..} <- symbolLocation env sym def
+      assertEqual "symbolLocation Path matches" locationRange_filepath path
 
 -- | Test that both describeSymbol has expected comment
 testDescribeSymbolComments

glean/glass/test/regression/tests/buck/resolveSymbolRange_target.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/buck/t/buck_project/PATH/./foo"

glean/glass/test/regression/tests/buck/resolveSymbol_def.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/buck/d/buck_project/my_defs.bzl/some_library"

glean/glass/test/regression/tests/buck/resolveSymbol_file.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/buck/f/buck_project/toto.c"

glean/glass/test/regression/tests/buck/resolveSymbol_target.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/buck/t/buck_project/PATH/./foo"

glean/glass/test/regression/tests/cpp/resolveSymbol.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//h"

glean/glass/test/regression/tests/cpp/resolveSymbolRange.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//h"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_Nothing.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//maybe/Nothing"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_Nothing_ctor.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//maybe/Nothing/.c/maybe::Nothing::_secret"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_Nothing_ctor_decl.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//maybe/Nothing/.ctor//.decl"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_Nothing_nothing_decl.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//maybe/nothing/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_Nothing_secret.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//maybe/Nothing/_secret"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_Nothing_secret_decl.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//maybe/Nothing/_secret/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_S.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/S/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_T.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/bar/T/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_bar.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/bar/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_f.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/f/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_foo_foo.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/foo"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_local_i.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//h/i/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbolRange_local_ns.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/fooFn/fooI/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbol_S.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/S/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbol_T.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/bar/T/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbol_bar.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/bar/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbol_enum_class_global.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//GlobalClass"

glean/glass/test/regression/tests/cpp/resolveSymbol_enum_global.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//Global"

glean/glass/test/regression/tests/cpp/resolveSymbol_f.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/f/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbol_foo.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/.decl"

glean/glass/test/regression/tests/cpp/resolveSymbol_foo_foo.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//foo/foo"

glean/glass/test/regression/tests/cpp/resolveSymbol_namespace_baz.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//baz"

glean/glass/test/regression/tests/cpp/resolveSymbol_namespace_struct.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//baz/U"

glean/glass/test/regression/tests/cpp/resolveSymbol_namespace_struct_enum.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//baz/U/InU"

glean/glass/test/regression/tests/cpp/resolveSymbol_namespace_struct_enum_field.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//baz/U/InU/UA"

glean/glass/test/regression/tests/cpp/resolveSymbol_namespace_struct_enumclass_field.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/cpp//baz/U/InUClass/UCA"

glean/glass/test/regression/tests/flow/resolveSymbol.query

@@ -1,4 +1,4 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/js/imports/C"
 
 

glean/glass/test/regression/tests/flow/resolveSymbolRange.query

@@ -1,4 +1,4 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/js/imports/C"
 
 

glean/glass/test/regression/tests/hack/resolveSymbol.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/php/Position"

glean/glass/test/regression/tests/hack/resolveSymbolRange.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/php/Position"

glean/glass/test/regression/tests/java-lsif/resolveSymbolRange.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/java/lsif/com/glean/app/App%23getMessage%28%29"

glean/glass/test/regression/tests/python/resolveSymbol.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/py/all.py/all"

glean/glass/test/regression/tests/python/resolveSymbolRange.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/py/all.py/all"

glean/glass/test/regression/tests/thrift/describe_field.query

@@ -1,2 +1,2 @@
-action: resolveSymbolRange
+action: symbolLocation
 args: "test/thrift/lib.thrift/Attribute/aBool"

glean/glass/tools/Glean/Glass/Test/DemoClient.hs

@@ -46,7 +46,7 @@ data Command
   = List RepoName Path
   | Describe SymbolId
   | FindRefs SymbolId
-  | Resolve SymbolId
+  | FindLocation SymbolId
   | Search RepoName Text
 
 options :: ParserInfo Options
@@ -79,7 +79,7 @@ options = info (helper <*> parser) (fullDesc <>
             ]
           )
         ) <>
-        command "resolve" (info resolveCommand
+        command "location" (info locationCommand
           (progDesc $ unlines
             ["Find the definition location of a symbol"
             ]
@@ -101,7 +101,7 @@ options = info (helper <*> parser) (fullDesc <>
     listCommand = cmd readListRepoPath (metavar "REPO/PATH")
     describeCommand = cmd (Describe <$> readSymbol) symbolHelp
     findRefsCommand = cmd (FindRefs <$> readSymbol) symbolHelp
-    resolveCommand = cmd (Resolve <$> readSymbol) symbolHelp
+    locationCommand = cmd (FindLocation <$> readSymbol) symbolHelp
     searchCommand = cmd readSearch searchHelp
 
 readService :: ReadM Service
@@ -163,7 +163,7 @@ main = Glean.withOptions options $ \Options{..} ->
         List repo path -> runListSymbols repo path
         Describe sym -> runDescribe sym
         FindRefs sym -> runFindRefs sym
-        Resolve sym -> runResolve sym
+        FindLocation sym -> runLocation sym
         Search repo str -> runSearch repo str
     mapM_ Text.putStrLn res
 
@@ -198,9 +198,9 @@ runSearch repoName strName = do
         def -- kinds
         def -- default search options
 
-runResolve :: Protocol p => SymbolId -> GlassM p [Text]
-runResolve sym = do
-  range <- resolveSymbolRange sym def
+runLocation :: Protocol p => SymbolId -> GlassM p [Text]
+runLocation sym = do
+  range <- symbolLocation sym def
   return [pprLocationRange range]
 
 runFindRefs :: Protocol p => SymbolId -> GlassM p [Text]

glean/glass/tools/Glean/Glass/Test/Symbol.hs

@@ -84,10 +84,10 @@ main =
 
     case cfgCmd of
       FindLocation -> do
-        let resolveLocation :: SymbolId -> IO LocationRange
-            resolveLocation r =
-              Handle.resolveSymbolRange env r (def :: RequestOptions)
-        forM_ syms $ Text.putStrLn <=< testResolveSymbol resolveLocation
+        let symbolLocation :: SymbolId -> IO LocationRange
+            symbolLocation r =
+              Handle.symbolLocation env r (def :: RequestOptions)
+        forM_ syms $ Text.putStrLn <=< testSymbolLocation symbolLocation
 
       FindReferences -> do
         let findReferences :: SymbolId -> IO [LocationRange]
@@ -121,11 +121,11 @@ testFindReferences handler symbol@(SymbolId name) = do
 
     return $ title : body
 
-testResolveSymbol
+testSymbolLocation
   :: (SymbolId -> IO LocationRange)
   -> SymbolId
   -> IO Text
-testResolveSymbol handler symbol@(SymbolId name) = do
+testSymbolLocation handler symbol@(SymbolId name) = do
   handle (\(ServerException e) -> return ("FAIL " <> e)) $ do
     res <- runTest handler symbol
     return $ Text.concat