Retire unused "comments" description field

Summary: This was replaced by pretty_comments some time ago, which has the same behavior and permits a pre-rendered comment string in markdown. Remove the field to save a few bytes in each symbol's description. For compatibility - `comments` == `location . pretty_comments` Reviewed By: simonmar Differential Revision: D59741472 fbshipit-source-id: 88fea0cda50024ff406ec189804fc02d9a67cb10
facebookincubator · Jul 18, 2024 · ba496e1 · ba496e1
1 parent ba67e39
commit ba496e1
Show file tree

Hide file tree

Showing 206 changed files with 5 additions and 2,166 deletions.
diff --git a/glean/glass/Glean/Glass/Describe.hs b/glean/glass/Glean/Glass/Describe.hs
@@ -102,9 +102,6 @@ describeEntity scmRevs ent SymbolResult{..} = do
   let symbolDescription_name = symbolResult_qname
   symbolDescription_annotations <- eThrow =<< getAnnotationsForEntity repo ent
   symbolDescription_pretty_comments <- eThrow =<< getCommentsForEntity repo ent
-  -- backwards compat until deprecated, we just make a copy
-  let symbolDescription_comments = map symbolComment_location
-        symbolDescription_pretty_comments
   (symbolDescription_visibility, symbolDescription_modifiers)
      <- eThrow =<< getInfoForEntity ent
   (symbolDescription_signature, symbolDescription_type_xrefs)

diff --git a/glean/glass/Glean/Glass/Handler.hs b/glean/glass/Glean/Glass/Handler.hs
@@ -265,9 +265,6 @@ combineDescriptions
 combineDescriptions y x =
   x { symbolDescription_annotations = symbolDescription_annotations x <>
         symbolDescription_annotations y -- <> Maybe [a]
-    , symbolDescription_comments = uniq $
-        symbolDescription_comments x <>
-        symbolDescription_comments y
     , symbolDescription_pretty_comments = uniq $
         symbolDescription_pretty_comments x <>
         symbolDescription_pretty_comments y

diff --git a/glean/glass/if/glass.thrift b/glean/glass/if/glass.thrift
@@ -405,7 +405,6 @@ struct SymbolDescription {
   3: QualifiedName name;
   4: optional SymbolKind kind;
   5: optional list<Annotation> annotations;
-  6: list<LocationRange> comments; // deprecated, use pretty_comments
   7: optional Visibility visibility;
   8: Revision repo_hash;
   9: Language language;

diff --git a/glean/glass/test/regression/lib/Glean/Glass/Regression/Tests.hs b/glean/glass/test/regression/lib/Glean/Glass/Regression/Tests.hs
@@ -88,10 +88,10 @@ testDescribeSymbolComments sym@(SymbolId name) (line, col) get =
       assertEqual "describeSymbol Comment start matches"
         [(fromIntegral line, fromIntegral col)] $
         zip
-          (range_lineBegin . locationRange_range
-            <$> symbolDescription_comments)
-          (range_columnBegin . locationRange_range
-            <$> symbolDescription_comments)
+          (range_lineBegin . locationRange_range . symbolComment_location
+            <$> symbolDescription_pretty_comments)
+          (range_columnBegin . locationRange_range . symbolComment_location
+            <$> symbolDescription_pretty_comments)
 
 -- | Test that describeSymbol has specific annotations
 testDescribeSymbolHasAnnotations

diff --git a/glean/glass/test/regression/tests/buck/describeSymbol.out b/glean/glass/test/regression/tests/buck/describeSymbol.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/buck/describeSymbol_definition.out b/glean/glass/test/regression/tests/buck/describeSymbol_definition.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/buck/describeSymbol_file.out b/glean/glass/test/regression/tests/buck/describeSymbol_file.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/callees_h.out b/glean/glass/test/regression/tests/cpp/callees_h.out
@@ -102,7 +102,6 @@
         "symbolDetails": {
             "test/cpp//foo/bar/g/.f//.decl": {
                 "annotations": [],
-                "comments": [],
                 "contains_relation": {
                     "firstChild": "nondeterministic",
                     "firstParent": "nondeterministic",
@@ -151,18 +150,6 @@
             },
             "test/cpp//foo/f/.f//.decl": {
                 "annotations": [],
-                "comments": [
-                    {
-                        "filepath": "test.cpp",
-                        "range": {
-                            "columnBegin": 1,
-                            "columnEnd": 4,
-                            "lineBegin": 18,
-                            "lineEnd": 20
-                        },
-                        "repository": "test"
-                    }
-                ],
                 "contains_relation": {
                     "firstChild": "nondeterministic",
                     "firstParent": "nondeterministic",
@@ -223,7 +210,6 @@
                 "type_xrefs": []
             },
             "test/cpp//foo/foo/.f/": {
-                "comments": [],
                 "contains_relation": {
                     "firstChild": "nondeterministic",
                     "firstParent": "nondeterministic",
@@ -275,7 +261,6 @@
             },
             "test/cpp//foo/foo/.f//.decl": {
                 "annotations": [],
-                "comments": [],
                 "contains_relation": {
                     "firstChild": "nondeterministic",
                     "firstParent": "nondeterministic",
@@ -326,18 +311,6 @@
                 "type_xrefs": []
             },
             "test/cpp//h": {
-                "comments": [
-                    {
-                        "filepath": "test.cpp",
-                        "range": {
-                            "columnBegin": 1,
-                            "columnEnd": 4,
-                            "lineBegin": 56,
-                            "lineEnd": 58
-                        },
-                        "repository": "test"
-                    }
-                ],
                 "contains_relation": {
                     "firstChild": "nondeterministic",
                     "firstParent": "nondeterministic",
@@ -401,18 +374,6 @@
                 "type_xrefs": []
             },
             "test/cpp//h/.f/int": {
-                "comments": [
-                    {
-                        "filepath": "test.cpp",
-                        "range": {
-                            "columnBegin": 1,
-                            "columnEnd": 4,
-                            "lineBegin": 56,
-                            "lineEnd": 58
-                        },
-                        "repository": "test"
-                    }
-                ],
                 "contains_relation": {
                     "firstChild": "nondeterministic",
                     "firstParent": "nondeterministic",
@@ -477,18 +438,6 @@
             },
             "test/cpp//h/.f/int/.decl": {
                 "annotations": [],
-                "comments": [
-                    {
-                        "filepath": "test.cpp",
-                        "range": {
-                            "columnBegin": 1,
-                            "columnEnd": 4,
-                            "lineBegin": 51,
-                            "lineEnd": 53
-                        },
-                        "repository": "test"
-                    }
-                ],
                 "contains_relation": {
                     "firstChild": "nondeterministic",
                     "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/callers_h.out b/glean/glass/test/regression/tests/cpp/callers_h.out
@@ -9,18 +9,6 @@
         ],
         "symbolDetails": {
             "test/cpp//h": {
-                "comments": [
-                    {
-                        "filepath": "test.cpp",
-                        "range": {
-                            "columnBegin": 1,
-                            "columnEnd": 4,
-                            "lineBegin": 56,
-                            "lineEnd": 58
-                        },
-                        "repository": "test"
-                    }
-                ],
                 "contains_relation": {
                     "firstChild": "nondeterministic",
                     "firstParent": "nondeterministic",
@@ -85,18 +73,6 @@
             },
             "test/cpp//h/.f/int/.decl": {
                 "annotations": [],
-                "comments": [
-                    {
-                        "filepath": "test.cpp",
-                        "range": {
-                            "columnBegin": 1,
-                            "columnEnd": 4,
-                            "lineBegin": 56,
-                            "lineEnd": 58
-                        },
-                        "repository": "test"
-                    }
-                ],
                 "contains_relation": {
                     "firstChild": "nondeterministic",
                     "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describeSymbol_S.out b/glean/glass/test/regression/tests/cpp/describeSymbol_S.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describeSymbol_T.out b/glean/glass/test/regression/tests/cpp/describeSymbol_T.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describeSymbol_bar.out b/glean/glass/test/regression/tests/cpp/describeSymbol_bar.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describeSymbol_defn_h.out b/glean/glass/test/regression/tests/cpp/describeSymbol_defn_h.out
@@ -1,18 +1,6 @@
 [
     "@generated",
     {
-        "comments": [
-            {
-                "filepath": "test.cpp",
-                "range": {
-                    "columnBegin": 1,
-                    "columnEnd": 4,
-                    "lineBegin": 56,
-                    "lineEnd": 58
-                },
-                "repository": "test"
-            }
-        ],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describeSymbol_f.out b/glean/glass/test/regression/tests/cpp/describeSymbol_f.out
@@ -2,18 +2,6 @@
     "@generated",
     {
         "annotations": [],
-        "comments": [
-            {
-                "filepath": "test.cpp",
-                "range": {
-                    "columnBegin": 1,
-                    "columnEnd": 4,
-                    "lineBegin": 18,
-                    "lineEnd": 20
-                },
-                "repository": "test"
-            }
-        ],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describeSymbol_local_i.out b/glean/glass/test/regression/tests/cpp/describeSymbol_local_i.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describeSymbol_local_ns.out b/glean/glass/test/regression/tests/cpp/describeSymbol_local_ns.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describeSymbol_namespace_foo.out b/glean/glass/test/regression/tests/cpp/describeSymbol_namespace_foo.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_param.out b/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_param.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature.out b/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature_empty.out b/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature_empty.out
@@ -2,18 +2,6 @@
     "@generated",
     {
         "annotations": [],
-        "comments": [
-            {
-                "filepath": "test.cpp",
-                "range": {
-                    "columnBegin": 5,
-                    "columnEnd": 8,
-                    "lineBegin": 117,
-                    "lineEnd": 119
-                },
-                "repository": "test"
-            }
-        ],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature_sig1.out b/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature_sig1.out
@@ -2,7 +2,6 @@
     "@generated",
     {
         "annotations": [],
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature_sig2.out b/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature_sig2.out
@@ -2,7 +2,6 @@
     "@generated",
     {
         "annotations": [],
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature_sig_nary.out b/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature_sig_nary.out
@@ -2,7 +2,6 @@
     "@generated",
     {
         "annotations": [],
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature_sig_nary_nested.out b/glean/glass/test/regression/tests/cpp/describe_symbol_ctor_signature_sig_nary_nested.out
@@ -2,7 +2,6 @@
     "@generated",
     {
         "annotations": [],
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_dtor.out b/glean/glass/test/regression/tests/cpp/describe_symbol_dtor.out
@@ -2,7 +2,6 @@
     "@generated",
     {
         "annotations": [],
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_enum_enumerator.out b/glean/glass/test/regression/tests/cpp/describe_symbol_enum_enumerator.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_fun.out b/glean/glass/test/regression/tests/cpp/describe_symbol_fun.out
@@ -2,7 +2,6 @@
     "@generated",
     {
         "annotations": [],
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_fun_2.out b/glean/glass/test/regression/tests/cpp/describe_symbol_fun_2.out
@@ -1,7 +1,6 @@
 [
     "@generated",
     {
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",

diff --git a/glean/glass/test/regression/tests/cpp/describe_symbol_fun_nary_1.out b/glean/glass/test/regression/tests/cpp/describe_symbol_fun_nary_1.out
@@ -2,7 +2,6 @@
     "@generated",
     {
         "annotations": [],
-        "comments": [],
         "contains_relation": {
             "firstChild": "nondeterministic",
             "firstParent": "nondeterministic",