refactor(editor): use common schema to validate editor-fmt json

Author: mydearxym

lib/helper/converter/editor_to_html/validator/index.ex

@@ -10,14 +10,9 @@ defmodule Helper.Converter.EditorToHTML.Validator do
   # blocks with "mode" and "items" fields
   @complex_blocks ["list"]
 
-  @valid_list_mode ["checklist", "order_list", "unorder_list"]
-  @valid_list_label_type ["success", "done", "todo"]
-  @valid_list_indent [0, 1, 2, 3, 4]
-
-  def is_valid(map) when is_map(map) do
-    with true <- is_valid_editorjs_fmt(map) do
-      blocks = map["blocks"]
-
+  def is_valid(data) when is_map(data) do
+    with {:ok, _} <- validate_editor_fmt(data),
+         blocks <- Map.get(data, "blocks") do
       try do
         validate_blocks(blocks)
       rescue
@@ -30,15 +25,13 @@ defmodule Helper.Converter.EditorToHTML.Validator do
         e ->
           format_parse_error()
       end
-    else
-      false ->
-        {:error, "invalid editor json format"}
-
-      _ ->
-        {:error, "invalid editor json"}
     end
   end
 
+  defp validate_editor_fmt(data) do
+    validate_with("editor", Schema.get("editor"), data)
+  end
+
   defp validate_blocks([]), do: {:ok, :pass}
 
   defp validate_blocks(blocks) do
@@ -75,7 +68,7 @@ defmodule Helper.Converter.EditorToHTML.Validator do
   end
 
   defp validate_block(%{"type" => type}), do: raise("undown #{type} block")
-  defp validate_block(_), do: raise("undown block")
+  defp validate_block(e), do: raise("undown block: #{e}")
 
   # validate with given schema
   defp validate_with(block, schema, data) do

lib/helper/converter/editor_to_html/validator/schema.ex

@@ -9,6 +9,14 @@ defmodule Helper.Converter.EditorToHTML.Validator.Schema do
   @valid_list_label_type ["success", "done", "todo"]
   @valid_list_indent [0, 1, 2, 3, 4]
 
+  def get("editor") do
+    %{
+      "time" => [:number],
+      "version" => [:string],
+      "blocks" => [:list]
+    }
+  end
+
   def get("header") do
     %{
       "text" => [:string],

lib/helper/validate_by_schema.ex

@@ -8,7 +8,7 @@ defmodule Helper.ValidateBySchema do
   @doc """
   cast data by given schema
 
-  e.g:
+  ## example
   schema = %{
     checked: [:boolean],
     hideLabel: [:boolean],
@@ -22,28 +22,35 @@ defmodule Helper.ValidateBySchema do
   ValidateBySchema.cast(schema, data)
   """
   def cast(schema, data) do
-    schema_fields = Map.keys(schema)
-
-    errors_info =
-      Enum.reduce(schema_fields, [], fn field, acc ->
-        value = get_in(data, [field])
-        field_schema = get_in(schema, [field])
-
-        case match(field, value, field_schema) do
-          {:error, error} ->
-            acc ++ [error]
-
-          _ ->
-            acc
-        end
-      end)
+    errors_info = cast_errors(schema, data)
 
     case errors_info do
       [] -> {:ok, :pass}
       _ -> {:error, errors_info}
     end
   end
 
+  defp cast_errors(schema, data) do
+    schema_fields = Map.keys(schema)
+
+    Enum.reduce(schema_fields, [], fn field, acc ->
+      value = get_in(data, [field])
+      field_schema = get_in(schema, [field])
+
+      case match(field, value, field_schema) do
+        {:error, error} ->
+          acc ++ [error]
+
+        _ ->
+          acc
+      end
+    end)
+  end
+
+  # 这里试过用 macro 消除重复代码，但是不可行。
+  # macro 对于重复定义的 quote 只会覆盖掉，除非每个 quote 中定义的内容不一样
+  # 参考: https://elixirforum.com/t/define-multiple-modules-in-macro-only-last-one-gets-created/1654
+
   # boolean field
   defp match(field, nil, [:boolean, required: false]), do: done(field, nil)
 
@@ -66,7 +73,9 @@ defmodule Helper.ValidateBySchema do
   defp match(field, value, [:string, required: false]), do: error(field, value, :string)
   defp match(field, value, [:string]), do: error(field, value, :string)
 
-  # number field
+  defp match(field, nil, [:string, required: false]), do: done(field, nil)
+
+  # number
   defp match(field, nil, [:number, required: false]), do: done(field, nil)
 
   defp match(field, value, [:number, required: false]) when is_number(value) do
@@ -77,6 +86,18 @@ defmodule Helper.ValidateBySchema do
   defp match(field, value, [:number, required: false]), do: error(field, value, :number)
   defp match(field, value, [:number]), do: error(field, value, :number)
 
+  # list
+  defp match(field, nil, [:list, required: false]), do: done(field, nil)
+
+  defp match(field, value, [:list, required: false]) when is_list(value) do
+    done(field, value)
+  end
+
+  defp match(field, value, [:list]) when is_list(value), do: done(field, value)
+  defp match(field, value, [:list, required: false]), do: error(field, value, :list)
+  defp match(field, value, [:list]), do: error(field, value, :list)
+
+  # enum
   defp match(field, nil, enum: _, required: false), do: done(field, nil)
 
   defp match(field, value, enum: enum, required: false) do

test/helper/converter/editor_to_html_test/index_test.exs

@@ -41,7 +41,7 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML do
       assert {:ok, _} = Parser.to_html(editor_string)
     end
 
-    @tag :wip
+    @tag :wip2
     test "invalid editorjs json fmt should raise error" do
       editor_json = %{
         "invalid_time" => 1_567_250_876_713,
@@ -50,7 +50,29 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML do
       }
 
       {:ok, editor_string} = Jason.encode(editor_json)
-      assert {:error, "invalid editor json format"} = Parser.to_html(editor_string)
+      {:error, error} = Parser.to_html(editor_string)
+
+      assert error == [
+               %{block: "editor", field: "time", message: "should be: number", value: nil}
+             ]
+
+      editor_json = %{
+        "time" => "1_567_250_876_713",
+        "blocks" => [],
+        "version" => "2.15.0"
+      }
+
+      {:ok, editor_string} = Jason.encode(editor_json)
+      {:error, error} = Parser.to_html(editor_string)
+
+      assert error == [
+               %{
+                 block: "editor",
+                 field: "time",
+                 message: "should be: number",
+                 value: "1_567_250_876_713"
+               }
+             ]
 
       editor_json = %{
         "time" => 1_567_250_876_713,
@@ -60,7 +82,22 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML do
       }
 
       {:ok, editor_string} = Jason.encode(editor_json)
-      assert {:error, "invalid editor json format"} = Parser.to_html(editor_string)
+      {:error, error} = Parser.to_html(editor_string)
+
+      assert error == [
+               %{block: "editor", field: "blocks", message: "should be: list", value: "blocks"}
+             ]
+
+      editor_json = %{
+        "time" => 1_567_250_876_713,
+        "blocks" => [1, 2, 3],
+        "version" => "2.15.0"
+      }
+
+      {:ok, editor_string} = Jason.encode(editor_json)
+      {:error, error} = Parser.to_html(editor_string)
+
+      assert error == "undown block: 1"
     end
 
     test "real-world editor.js data should work" do

test/helper/converter/editor_to_html_test/list_test.exs

@@ -19,8 +19,8 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML.List do
             "items" => [
               %{
                 "checked" => true,
-                "hideLabel" => "invalid",
-                "indent" => 5,
+                "hideLabel" => false,
+                "indent" => 0,
                 "label" => "label",
                 "labelType" => "success",
                 "text" => "list item"
@@ -32,23 +32,11 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML.List do
       "version" => "2.15.0"
     }
     @tag :wip
-    test "invalid list data parse should raise error message" do
+    test "valid list parse should work" do
       {:ok, editor_string} = Jason.encode(@editor_json)
-      {:error, err_msg} = Parser.to_html(editor_string)
-
-      assert err_msg == [
-               %{
-                 block: "list(checklist)",
-                 field: "hideLabel",
-                 message: "should be: boolean",
-                 value: "invalid"
-               },
-               %{
-                 block: "list(checklist)",
-                 field: "indent",
-                 message: "should be: 0 | 1 | 2 | 3 | 4"
-               }
-             ]
+      # assert {:ok, converted} = Parser.to_html(editor_string)
+      {:ok, converted} = Parser.to_html(editor_string)
+      IO.inspect(converted, label: "list converted")
     end
 
     @editor_json %{
@@ -61,8 +49,8 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML.List do
             "items" => [
               %{
                 "checked" => true,
-                "hideLabel" => false,
-                "indent" => 0,
+                "hideLabel" => "invalid",
+                "indent" => 5,
                 "label" => "label",
                 "labelType" => "success",
                 "text" => "list item"
@@ -74,9 +62,23 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML.List do
       "version" => "2.15.0"
     }
     @tag :wip
-    test "valid list parse should work" do
+    test "invalid list data parse should raise error message" do
       {:ok, editor_string} = Jason.encode(@editor_json)
-      assert {:ok, _} = Parser.to_html(editor_string)
+      {:error, err_msg} = Parser.to_html(editor_string)
+
+      assert err_msg == [
+               %{
+                 block: "list(checklist)",
+                 field: "hideLabel",
+                 message: "should be: boolean",
+                 value: "invalid"
+               },
+               %{
+                 block: "list(checklist)",
+                 field: "indent",
+                 message: "should be: 0 | 1 | 2 | 3 | 4"
+               }
+             ]
     end
 
     @editor_json %{