feat(radar-thread): basic workflow (#415)

* chore(radar): add migration tables

* chore(radar): setup basic model & test react macros

* chore(radar): fix used value

* chore(radar): fix macro

* chore(radar): use article_react_mutations

* chore(radar): use article_react_mutations

* chore(radar): add tests

* chore(radar): missing radar model

* chore(radar): fix test

Author: mydearxym

config/config.exs

@@ -69,15 +69,16 @@ config :groupher_server, :article,
   min_length: 10,
   max_length: 20_000,
   # NOTE: do not change unless you know what you are doing
-  threads: [:post, :job, :repo, :blog, :works],
+  threads: [:post, :job, :repo, :blog, :works, :radar],
   # in this period, paged articles will sort front if non-article-author commented
   # 在此时间段内，一旦有非文章作者的用户评论，该文章就会排到前面
   active_period_days: %{
     post: 10,
     job: 10,
     repo: 10,
     blog: 10,
-    works: 10
+    works: 10,
+    radar: 10
   },
 
   # NOTE: if you want to add/remove emotion, just edit the list below

lib/groupher_server/cms/models/radar.ex

@@ -0,0 +1,48 @@
+defmodule GroupherServer.CMS.Model.Radar do
+  @moduledoc false
+  alias __MODULE__
+
+  use Ecto.Schema
+  use Accessible
+
+  import Ecto.Changeset
+  import GroupherServer.CMS.Helper.Macros
+
+  alias GroupherServer.CMS
+  alias CMS.Model.Embeds
+
+  @timestamps_opts [type: :utc_datetime_usec]
+
+  @required_fields ~w(title digest)a
+  @article_cast_fields general_article_cast_fields()
+  @optional_fields @article_cast_fields
+
+  @type t :: %Radar{}
+  schema "cms_radars" do
+    article_tags_field(:radar)
+    article_communities_field(:radar)
+    general_article_fields(:radar)
+  end
+
+  @doc false
+  def changeset(%Radar{} = radar, attrs) do
+    radar
+    |> cast(attrs, @optional_fields ++ @required_fields)
+    |> validate_required(@required_fields)
+    |> cast_embed(:meta, required: false, with: &Embeds.ArticleMeta.changeset/2)
+    |> generl_changeset
+  end
+
+  @doc false
+  def update_changeset(%Radar{} = radar, attrs) do
+    radar
+    |> cast(attrs, @optional_fields ++ @required_fields)
+    |> generl_changeset
+  end
+
+  defp generl_changeset(changeset) do
+    changeset
+    |> validate_length(:title, min: 3, max: 50)
+    |> cast_embed(:emotions, with: &Embeds.ArticleEmotion.changeset/2)
+  end
+end

lib/groupher_server/cms/models/radar_document.ex

@@ -0,0 +1,47 @@
+defmodule GroupherServer.CMS.Model.RadarDocument do
+  @moduledoc """
+  mainly for full-text search
+  """
+  alias __MODULE__
+
+  use Ecto.Schema
+  use Accessible
+
+  import Ecto.Changeset
+  import Helper.Utils, only: [get_config: 2]
+
+  alias GroupherServer.CMS
+  alias CMS.Model.Radar
+
+  @timestamps_opts [type: :utc_datetime_usec]
+
+  @max_body_length get_config(:article, :max_length)
+  @min_body_length get_config(:article, :min_length)
+
+  @required_fields ~w(body body_html radar_id)a
+  @optional_fields []
+
+  @type t :: %RadarDocument{}
+  schema "radar_documents" do
+    belongs_to(:radar, Radar, foreign_key: :radar_id)
+
+    field(:body, :string)
+    field(:body_html, :string)
+    field(:toc, :map)
+  end
+
+  @doc false
+  def changeset(%RadarDocument{} = radar, attrs) do
+    radar
+    |> cast(attrs, @optional_fields ++ @required_fields)
+    |> validate_required(@required_fields)
+    |> validate_length(:body, min: @min_body_length, max: @max_body_length)
+  end
+
+  @doc false
+  def update_changeset(%RadarDocument{} = radar, attrs) do
+    radar
+    |> cast(attrs, @optional_fields ++ @required_fields)
+    |> validate_length(:body, min: @min_body_length, max: @max_body_length)
+  end
+end

lib/groupher_server_web/schema/Helper/mutations.ex

@@ -2,22 +2,42 @@ defmodule GroupherServerWeb.Schema.Helper.Mutations do
   @moduledoc """
   general mutations used for articles
 
+  can not dedefine private macros, see:
+  https://github.com/elixir-lang/elixir/issues/3887
+
   e.g:
   in schema/cms/mutation/post.ex
 
   add following:
-  article_upvote_mutation(:post)
-
-  post will have two mutation endpoint:
-
-  upvote_post
-  unto_emotion_post
+    article_react_mutations(:post, [:upvote, :pin, :mark_delete, :delete, :emotion, :report, :sink, :lock_comment])
+
+  it will expand as
+    article_upvote_mutation(:radar)
+    article_pin_mutation(:radar)
+    article_mark_delete_mutation(:radar)
+    article_delete_mutation(:radar)
+    article_emotion_mutation(:radar)
+    article_report_mutation(:radar)
+    article_sink_mutation(:radar)
+    article_lock_comment_mutation(:radar)
 
   same for the job/repo .. article thread
   """
   alias GroupherServerWeb.Middleware, as: M
   alias GroupherServerWeb.Resolvers, as: R
 
+  @doc """
+  add basic mutation reactions to article
+  """
+  defmacro article_react_mutations(thread, reactions) do
+    reactions
+    |> Enum.map(
+      &quote do
+        unquote(:"article_#{&1}_mutation")(unquote(thread))
+      end
+    )
+  end
+
   @doc """
   upvote mutation for article
 

lib/groupher_server_web/schema/cms/cms_metrics.ex

@@ -199,13 +199,19 @@ defmodule GroupherServerWeb.Schema.CMS.Metrics do
   end
 
   @desc "works_filter doc"
-  # TODO:
   input_object :paged_works_filter do
     pagination_args()
     article_filter_fields()
     field(:sort, :sort_enum)
   end
 
+  @desc "radar_filter doc"
+  input_object :paged_radars_filter do
+    pagination_args()
+    article_filter_fields()
+    field(:sort, :sort_enum)
+  end
+
   @desc "article_filter doc"
   input_object :paged_repos_filter do
     @desc "limit of records (default 20), if first > 30, only return 30 at most"

lib/groupher_server_web/schema/cms/cms_types.ex

@@ -105,6 +105,18 @@ defmodule GroupherServerWeb.Schema.CMS.Types do
     timestamp_fields(:article)
   end
 
+  object :radar do
+    interface(:article)
+
+    general_article_fields()
+    comments_fields()
+
+    field(:length, :integer)
+    field(:link_addr, :string)
+
+    timestamp_fields(:article)
+  end
+
   object :repo do
     interface(:article)
 

lib/groupher_server_web/schema/cms/mutations/blog.ex

@@ -43,15 +43,15 @@ defmodule GroupherServerWeb.Schema.CMS.Mutations.Blog do
       resolve(&R.CMS.update_article/3)
     end
 
-    #############
-    article_upvote_mutation(:blog)
-    article_pin_mutation(:blog)
-    article_mark_delete_mutation(:blog)
-    article_delete_mutation(:blog)
-    article_emotion_mutation(:blog)
-    article_report_mutation(:blog)
-    article_sink_mutation(:blog)
-    article_lock_comment_mutation(:blog)
-    #############
+    article_react_mutations(:blog, [
+      :upvote,
+      :pin,
+      :mark_delete,
+      :delete,
+      :emotion,
+      :report,
+      :sink,
+      :lock_comment
+    ])
   end
 end

lib/groupher_server_web/schema/cms/mutations/job.ex

@@ -53,15 +53,15 @@ defmodule GroupherServerWeb.Schema.CMS.Mutations.Job do
       resolve(&R.CMS.update_article/3)
     end
 
-    #############
-    article_upvote_mutation(:job)
-    article_pin_mutation(:job)
-    article_mark_delete_mutation(:job)
-    article_delete_mutation(:job)
-    article_emotion_mutation(:job)
-    article_report_mutation(:job)
-    article_sink_mutation(:job)
-    article_lock_comment_mutation(:job)
-    #############
+    article_react_mutations(:job, [
+      :upvote,
+      :pin,
+      :mark_delete,
+      :delete,
+      :emotion,
+      :report,
+      :sink,
+      :lock_comment
+    ])
   end
 end

lib/groupher_server_web/schema/cms/mutations/post.ex

@@ -43,15 +43,15 @@ defmodule GroupherServerWeb.Schema.CMS.Mutations.Post do
       resolve(&R.CMS.update_article/3)
     end
 
-    #############
-    article_upvote_mutation(:post)
-    article_pin_mutation(:post)
-    article_mark_delete_mutation(:post)
-    article_delete_mutation(:post)
-    article_emotion_mutation(:post)
-    article_report_mutation(:post)
-    article_sink_mutation(:post)
-    article_lock_comment_mutation(:post)
-    #############
+    article_react_mutations(:post, [
+      :upvote,
+      :pin,
+      :mark_delete,
+      :delete,
+      :emotion,
+      :report,
+      :sink,
+      :lock_comment
+    ])
   end
 end

lib/groupher_server_web/schema/cms/mutations/radar.ex

@@ -0,0 +1,52 @@
+defmodule GroupherServerWeb.Schema.CMS.Mutations.Radar do
+  @moduledoc """
+  CMS mutations for radar
+  """
+  use Helper.GqlSchemaSuite
+  import GroupherServerWeb.Schema.Helper.Mutations
+
+  object :cms_radar_mutations do
+    @desc "create a radar"
+    field :create_radar, :radar do
+      arg(:title, non_null(:string))
+      arg(:body, non_null(:string))
+      arg(:digest, non_null(:string))
+      arg(:community_id, non_null(:id))
+      arg(:thread, :thread, default_value: :radar)
+      arg(:article_tags, list_of(:id))
+
+      middleware(M.Authorize, :login)
+      middleware(M.PublishThrottle)
+      resolve(&R.CMS.create_article/3)
+      middleware(M.Statistics.MakeContribute, for: [:user, :community])
+    end
+
+    @desc "update a cms/radar"
+    field :update_radar, :radar do
+      arg(:id, non_null(:id))
+      arg(:title, :string)
+      arg(:body, :string)
+      arg(:digest, :string)
+
+      arg(:article_tags, list_of(:id))
+      # ...
+
+      middleware(M.Authorize, :login)
+      middleware(M.PassportLoader, source: :radar)
+      middleware(M.Passport, claim: "owner;cms->c?->radar.edit")
+
+      resolve(&R.CMS.update_article/3)
+    end
+
+    article_react_mutations(:radar, [
+      :upvote,
+      :pin,
+      :mark_delete,
+      :delete,
+      :emotion,
+      :report,
+      :sink,
+      :lock_comment
+    ])
+  end
+end