[flow][ide] Introduce code action to fix all invalid type cast issue

Reviewed By: gkz

Differential Revision: D86531982

fbshipit-source-id: 11f03d5fe2c9a4fceb43653ee5986c5733717d59

Author: SamChou19815

newtests/lsp/code-action/quickfix/ts_and_legacy_syntax/__snapshots__/quickfix-fix-all-colon-cast.json

@@ -0,0 +1,97 @@
+{
+  "method": "textDocument/codeAction",
+  "result": [
+    {
+      "title": "Convert all colon casts to `as` expressions",
+      "kind": "quickfix",
+      "diagnostics": [],
+      "edit": {
+        "changes": {
+          "<PLACEHOLDER_PROJECT_URL>/fix-all-colon-cast.js": [
+            {
+              "range": {
+                "start": {
+                  "line": 2,
+                  "character": 18
+                },
+                "end": {
+                  "line": 2,
+                  "character": 29
+                }
+              },
+              "newText": "1 as number"
+            },
+            {
+              "range": {
+                "start": {
+                  "line": 4,
+                  "character": 18
+                },
+                "end": {
+                  "line": 4,
+                  "character": 35
+                }
+              },
+              "newText": "\"hello\" as string"
+            },
+            {
+              "range": {
+                "start": {
+                  "line": 5,
+                  "character": 19
+                },
+                "end": {
+                  "line": 5,
+                  "character": 34
+                }
+              },
+              "newText": "true as boolean"
+            }
+          ]
+        }
+      },
+      "command": {
+        "title": "",
+        "command": "log:org.flow:<PLACEHOLDER_PROJECT_URL>",
+        "arguments": [
+          "textDocument/codeAction",
+          "convert_all_colon_cast",
+          "Convert all colon casts to `as` expressions"
+        ]
+      }
+    },
+    {
+      "title": "Convert to `as` expression `<expr> as <type>`",
+      "kind": "quickfix",
+      "diagnostics": [],
+      "edit": {
+        "changes": {
+          "<PLACEHOLDER_PROJECT_URL>/fix-all-colon-cast.js": [
+            {
+              "range": {
+                "start": {
+                  "line": 2,
+                  "character": 18
+                },
+                "end": {
+                  "line": 2,
+                  "character": 29
+                }
+              },
+              "newText": "1 as number"
+            }
+          ]
+        }
+      },
+      "command": {
+        "title": "",
+        "command": "log:org.flow:<PLACEHOLDER_PROJECT_URL>",
+        "arguments": [
+          "textDocument/codeAction",
+          "convert_colon_cast",
+          "Convert to `as` expression `<expr> as <type>`"
+        ]
+      }
+    }
+  ]
+}

newtests/lsp/code-action/quickfix/ts_and_legacy_syntax/__snapshots__/quickfix-old-flow-type-cast.json

@@ -1,6 +1,39 @@
 {
   "method": "textDocument/codeAction",
   "result": [
+    {
+      "title": "Convert all colon casts to `as` expressions",
+      "kind": "quickfix",
+      "diagnostics": [],
+      "edit": {
+        "changes": {
+          "<PLACEHOLDER_PROJECT_URL>/fix-colon-cast.js": [
+            {
+              "range": {
+                "start": {
+                  "line": 2,
+                  "character": 0
+                },
+                "end": {
+                  "line": 2,
+                  "character": 14
+                }
+              },
+              "newText": "\"foo\" as mixed"
+            }
+          ]
+        }
+      },
+      "command": {
+        "title": "",
+        "command": "log:org.flow:<PLACEHOLDER_PROJECT_URL>",
+        "arguments": [
+          "textDocument/codeAction",
+          "convert_all_colon_cast",
+          "Convert all colon casts to `as` expressions"
+        ]
+      }
+    },
     {
       "title": "Convert to `as` expression `<expr> as <type>`",
       "kind": "quickfix",

newtests/lsp/code-action/quickfix/ts_and_legacy_syntax/fix-all-colon-cast.js.ignored

@@ -0,0 +1,6 @@
+// @flow
+
+const x: number = (1: number);
+//                    ^
+const y: string = ("hello": string);
+const z: boolean = (true: boolean);

newtests/lsp/code-action/quickfix/ts_and_legacy_syntax/test.js

@@ -6,6 +6,7 @@
 import type {SuiteType} from '../../../../Tester';
 const path = require('path');
 const {suite, test} = require('../../../../Tester');
+const {generateSimpleTests} = require('../../test-utils');
 
 module.exports = (suite(
   ({
@@ -624,5 +625,20 @@ module.exports = (suite(
         ['textDocument/publishDiagnostics', ...lspIgnoreStatusAndCancellation],
       ),
     ]),
+    test(
+      'provide fix-all-in-file quickfix for colon casts',
+      generateSimpleTests(
+        'quickfix',
+        {
+          addFile,
+          lspIgnoreStatusAndCancellation,
+          lspStartAndConnect,
+          lspRequestAndWaitUntilResponse,
+        },
+        __dirname,
+        'fix-all-colon-cast.js',
+        'quickfix-fix-all-colon-cast',
+      ),
+    ).flowConfig('_flowconfig_casting_syntax'),
   ],
 ): SuiteType);

src/services/code_action/autofix_casting_syntax.ml

@@ -5,18 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  *)
 
-class mapper ~enabled_casting_syntax target_loc kind =
+class mapper target_loc kind =
   object (this)
     inherit Flow_ast_contains_mapper.mapper target_loc as super
 
     method private build_cast ?comments expression annot =
       let expression = super#expression expression in
       let annot = super#type_ annot in
-      let open Options.CastingSyntax in
-      match enabled_casting_syntax with
-      | As
-      | Both ->
-        Ast_builder.Expressions.as_expression ?comments expression annot
+      Ast_builder.Expressions.as_expression ?comments expression annot
 
     method! expression e =
       let open Flow_ast.Expression in
@@ -30,10 +26,39 @@ class mapper ~enabled_casting_syntax target_loc kind =
       | _ -> super#expression e
   end
 
-let convert_satisfies_expression ~enabled_casting_syntax ast loc =
-  let mapper = new mapper ~enabled_casting_syntax loc `SatisfiesExpression in
+let convert_satisfies_expression ast loc =
+  let mapper = new mapper loc `SatisfiesExpression in
   mapper#program ast
 
-let convert_colon_cast ~enabled_casting_syntax ast loc =
-  let mapper = new mapper ~enabled_casting_syntax loc `ColonCast in
+let convert_colon_cast ast loc =
+  let mapper = new mapper loc `ColonCast in
+  mapper#program ast
+
+class all_mapper kind =
+  object (this)
+    inherit [Loc.t] Flow_ast_mapper.mapper as super
+
+    method private build_cast ?comments expression annot =
+      let expression = super#expression expression in
+      let annot = super#type_ annot in
+      Ast_builder.Expressions.as_expression ?comments expression annot
+
+    method! expression e =
+      let open Flow_ast.Expression in
+      match e with
+      | (_, TypeCast { TypeCast.expression; annot = (_, annot); comments }) when kind = `ColonCast
+        ->
+        this#build_cast ?comments expression annot
+      | (_, TSSatisfies { TSSatisfies.expression; annot = (_, annot); comments })
+        when kind = `SatisfiesExpression ->
+        this#build_cast ?comments expression annot
+      | _ -> super#expression e
+  end
+
+let convert_all_colon_casts ast =
+  let mapper = new all_mapper `ColonCast in
+  mapper#program ast
+
+let convert_all_satisfies_expressions ast =
+  let mapper = new all_mapper `SatisfiesExpression in
   mapper#program ast

src/services/code_action/autofix_casting_syntax.mli

@@ -6,13 +6,17 @@
  *)
 
 val convert_satisfies_expression :
-  enabled_casting_syntax:Options.CastingSyntax.t ->
   (Loc.t, Loc.t) Flow_ast_mapper.Ast.Program.t ->
   Loc.t ->
   (Loc.t, Loc.t) Flow_ast_mapper.Ast.Program.t
 
 val convert_colon_cast :
-  enabled_casting_syntax:Options.CastingSyntax.t ->
   (Loc.t, Loc.t) Flow_ast_mapper.Ast.Program.t ->
   Loc.t ->
   (Loc.t, Loc.t) Flow_ast_mapper.Ast.Program.t
+
+val convert_all_colon_casts :
+  (Loc.t, Loc.t) Flow_ast_mapper.Ast.Program.t -> (Loc.t, Loc.t) Flow_ast_mapper.Ast.Program.t
+
+val convert_all_satisfies_expressions :
+  (Loc.t, Loc.t) Flow_ast_mapper.Ast.Program.t -> (Loc.t, Loc.t) Flow_ast_mapper.Ast.Program.t

src/services/code_action/code_action_service.ml

@@ -1063,9 +1063,7 @@ let ast_transforms_of_error
         {
           title;
           diagnostic_title = "convert_satisfies_expression";
-          transform =
-            untyped_ast_transform
-              (Autofix_casting_syntax.convert_satisfies_expression ~enabled_casting_syntax);
+          transform = untyped_ast_transform Autofix_casting_syntax.convert_satisfies_expression;
           target_loc = error_loc;
           confidence = WillFixErrorAndSafeForRunningOnSave;
         };
@@ -1116,7 +1114,7 @@ let ast_transforms_of_error
         {
           title;
           diagnostic_title;
-          transform = untyped_ast_transform (fix ~enabled_casting_syntax);
+          transform = untyped_ast_transform fix;
           target_loc = error_loc;
           confidence = WillFixErrorAndSafeForRunningOnSave;
         };
@@ -1607,6 +1605,52 @@ let ast_transforms_of_error
       | _ -> [])
     | _ -> [])
 
+let fix_all_in_file_code_actions ~options ~loc_of_aloc ~ast ~diagnostics ~errors ~loc uri =
+  (* Step 1: Check if there's an EInvalidTypeCastSyntax error at the requested location *)
+  let has_invalid_cast_at_loc =
+    Flow_error.ErrorSet.exists
+      (fun error ->
+        let error_message =
+          Flow_error.msg_of_error error |> Error_message.map_loc_of_error_message loc_of_aloc
+        in
+        match error_message with
+        | Error_message.EInvalidTypeCastSyntax _ ->
+          (match Error_message.loc_of_msg error_message with
+          | Some error_loc -> Loc.intersects error_loc loc
+          | None -> false)
+        | _ -> false)
+      errors
+  in
+  if not has_invalid_cast_at_loc then
+    []
+  else
+    (* Step 2: Generate code action using convert_all_colon_casts *)
+    let new_ast = Autofix_casting_syntax.convert_all_colon_casts ast in
+    if new_ast == ast then
+      []
+    else
+      let opts = layout_options options in
+      let edits =
+        Replacement_printer.mk_loc_patch_ast_differ ~opts (Flow_ast_differ.program ast new_ast)
+        |> flow_loc_patch_to_lsp_edits
+      in
+      let open Lsp in
+      [
+        CodeAction.Action
+          {
+            CodeAction.title = "Convert all colon casts to `as` expressions";
+            kind = CodeActionKind.quickfix;
+            diagnostics;
+            action =
+              CodeAction.BothEditThenCommand
+                ( WorkspaceEdit.{ changes = UriMap.singleton uri edits },
+                  mk_log_command
+                    ~title:"Convert all colon casts to `as` expressions"
+                    ~diagnostic_title:"convert_all_colon_cast"
+                );
+          };
+      ]
+
 let code_actions_of_errors
     ~options
     ~loc_of_aloc
@@ -1939,6 +1983,19 @@ let code_actions_at_loc
         uri
         loc
   in
+  let fix_all_in_file_actions =
+    if include_quick_fixes only then
+      fix_all_in_file_code_actions
+        ~options
+        ~loc_of_aloc
+        ~ast
+        ~diagnostics
+        ~errors:(Context.errors cx)
+        ~loc
+        uri
+    else
+      []
+  in
   let error_fixes =
     code_actions_of_errors
       ~options
@@ -2005,6 +2062,7 @@ let code_actions_at_loc
     parse_error_fixes
     @ autofix_exports_code_actions
     @ autofix_missing_local_annot_code_actions
+    @ fix_all_in_file_actions
     @ error_fixes
     @ scope_based_auto_import_fixes
     @ insert_inferred_render_type_code_actions