Merge pull request #998 from code-corps/888-modify-task-timestamps-for-github-sync

Modify Task timestamps for GitHub sync

Author: joshsmith

lib/code_corps/github/adapters/task.ex

@@ -1,7 +1,7 @@
 defmodule CodeCorps.GitHub.Adapters.Task do
   @moduledoc """
   Used to adapt a GitHub issue payload into attributes for creating or updating
-  a `CodeCorps.Task`.
+  a `CodeCorps.Task` and vice-versa.
   """
 
   alias CodeCorps.{
@@ -10,22 +10,34 @@ defmodule CodeCorps.GitHub.Adapters.Task do
   }
 
   @mapping [
+    {:created_at, ["created_at"]},
     {:github_issue_number, ["number"]},
     {:markdown, ["body"]},
+    {:modified_at, ["updated_at"]},
     {:status, ["state"]},
     {:title, ["title"]}
   ]
 
+  @doc ~S"""
+  Converts a GitHub issue payled into a set of attributes used to update or
+  create a `Task` record.
+  """
   @spec from_issue(map) :: map
   def from_issue(%{} = payload) do
     payload |> MapTransformer.transform(@mapping)
   end
 
+  @autogenerated_github_keys ~w(created_at number updated_at)
+
+  @doc ~S"""
+  Converts a `Task` into a set of attributes used to update or create an
+  associated GitHub issue
+  """
   @spec to_issue(Task.t) :: map
   def to_issue(%Task{} = task) do
     task
     |> Map.from_struct
     |> MapTransformer.transform_inverse(@mapping)
-    |> Map.delete("number")
+    |> Map.drop(@autogenerated_github_keys)
   end
 end

lib/code_corps/github/event/issues/changeset_builder.ex

@@ -16,7 +16,10 @@ defmodule CodeCorps.GitHub.Event.Issues.ChangesetBuilder do
   alias Ecto.Changeset
 
   @doc ~S"""
-  Constructs a changeset for syncing a task when processing an Issues webhook
+  Constructs a changeset for syncing a `Task` when processing an Issues or
+  IssueComment webhook.
+
+  The changeset can be used to create or update a `Task`
   """
   @spec build_changeset(Task.t, map, ProjectGithubRepo.t, User.t) :: Changeset.t
   def build_changeset(
@@ -31,6 +34,8 @@ defmodule CodeCorps.GitHub.Event.Issues.ChangesetBuilder do
     end
   end
 
+  @create_attrs ~w(created_at github_issue_number markdown modified_at status title)a
+  @spec create_changeset(Task.t, map, ProjectGithubRepo.t, User.t) :: Changeset.t
   defp create_changeset(
     %Task{} = task,
     %{} = issue_attrs,
@@ -41,8 +46,9 @@ defmodule CodeCorps.GitHub.Event.Issues.ChangesetBuilder do
       TaskList |> Repo.get_by(project_id: project_id, inbox: true)
 
     task
-    |> Changeset.change(TaskAdapter.from_issue(issue_attrs))
+    |> Changeset.cast(TaskAdapter.from_issue(issue_attrs), @create_attrs)
     |> MarkdownRendererService.render_markdown_to_html(:markdown, :body)
+    |> Changeset.put_change(:created_on, "github")
     |> Changeset.put_change(:github_repo_id, github_repo_id)
     |> Changeset.put_change(:project_id, project_id)
     |> Changeset.put_change(:task_list_id, task_list_id)
@@ -54,10 +60,13 @@ defmodule CodeCorps.GitHub.Event.Issues.ChangesetBuilder do
     |> Changeset.assoc_constraint(:user)
   end
 
-  defp update_changeset(%Task{} = task, issue_attrs) do
+  @update_attrs ~w(github_issue_number markdown modified_at status title)a
+  @spec update_changeset(Task.t, map) :: Changeset.t
+  defp update_changeset(%Task{} = task, %{} = issue_attrs) do
     task
-    |> Changeset.change(issue_attrs |> TaskAdapter.from_issue())
+    |> Changeset.cast(TaskAdapter.from_issue(issue_attrs), @update_attrs)
     |> MarkdownRendererService.render_markdown_to_html(:markdown, :body)
+    |> Changeset.put_change(:updated_on, "github")
     |> Changeset.validate_required([:project_id, :title, :user_id])
     |> Changeset.assoc_constraint(:github_repo)
     |> Changeset.assoc_constraint(:project)

lib/code_corps/model/task.ex

@@ -9,9 +9,13 @@ defmodule CodeCorps.Task do
   @type t :: %__MODULE__{}
 
   schema "tasks" do
-    field :closed_at, :utc_datetime
     field :body, :string
+    field :closed_at, :utc_datetime
+    field :created_at, :utc_datetime
+    field :created_from, :string, default: "code_corps"
     field :markdown, :string
+    field :modified_at, :utc_datetime
+    field :modified_from, :string, default: "code_corps"
     field :number, :integer, read_after_writes: true
     field :order, :integer
     field :status, :string, default: "open"
@@ -48,6 +52,7 @@ defmodule CodeCorps.Task do
     struct
     |> changeset(params)
     |> cast(params, [:project_id, :user_id, :github_repo_id])
+    |> set_created_and_modified_at()
     |> validate_required([:project_id, :user_id])
     |> assoc_constraint(:project)
     |> assoc_constraint(:user)
@@ -61,6 +66,7 @@ defmodule CodeCorps.Task do
     |> cast(params, [:status])
     |> validate_inclusion(:status, statuses())
     |> set_closed_at()
+    |> update_modified_at()
   end
 
   def apply_position(changeset) do
@@ -79,10 +85,21 @@ defmodule CodeCorps.Task do
     case changeset do
       %Changeset{valid?: true, changes: %{status: "closed"}} ->
         put_change(changeset, :closed_at, DateTime.utc_now)
-      %Changeset{valid?: true, changes: %{status: "open"}} ->  
+      %Changeset{valid?: true, changes: %{status: "open"}} ->
         put_change(changeset, :closed_at, nil)
       _ ->
         changeset
-    end    
+    end
+  end
+
+  defp set_created_and_modified_at(changeset) do
+    now = DateTime.utc_now
+    changeset
+    |> put_change(:created_at, now)
+    |> put_change(:modified_at, now)
+  end
+
+  defp update_modified_at(changeset) do
+    put_change(changeset, :modified_at, DateTime.utc_now)
   end
 end

lib/code_corps_web/views/task_view.ex

@@ -4,7 +4,10 @@ defmodule CodeCorpsWeb.TaskView do
   use CodeCorpsWeb, :view
   use JaSerializer.PhoenixView
 
-  attributes ~w(body markdown number status title order inserted_at updated_at)a
+  attributes ~w(
+    body created_at inserted_at markdown modified_at number order status title
+    updated_at
+  )a
 
   has_one :github_repo, serializer: CodeCorpsWeb.GithubRepoView
   has_one :project, serializer: CodeCorpsWeb.ProjectView

priv/repo/migrations/20170928234412_add_created_at_and_modified_at_to_tasks.exs

@@ -0,0 +1,12 @@
+defmodule CodeCorps.Repo.Migrations.AddCreatedAtAndModifiedAtToTasks do
+  use Ecto.Migration
+
+  def change do
+    alter table(:tasks) do
+      add :created_at, :utc_datetime
+      add :modified_at, :utc_datetime
+      add :created_from, :string, default: "code_corps"
+      add :modified_from, :string, default: "code_corps"
+    end
+  end
+end

priv/repo/structure.sql

@@ -1368,7 +1368,11 @@ CREATE TABLE tasks (
     "order" integer,
     github_issue_number integer,
     github_repo_id bigint,
-    closed_at timestamp without time zone
+    closed_at timestamp without time zone,
+    created_at timestamp without time zone,
+    modified_at timestamp without time zone,
+    created_from character varying(255) DEFAULT 'code_corps'::character varying,
+    modified_from character varying(255) DEFAULT 'code_corps'::character varying
 );
 
 
@@ -3036,5 +3040,5 @@ ALTER TABLE ONLY user_tasks
 -- PostgreSQL database dump complete
 --
 
-INSERT INTO "schema_migrations" (version) VALUES (20160723215749), (20160804000000), (20160804001111), (20160805132301), (20160805203929), (20160808143454), (20160809214736), (20160810124357), (20160815125009), (20160815143002), (20160816020347), (20160816034021), (20160817220118), (20160818000944), (20160818132546), (20160820113856), (20160820164905), (20160822002438), (20160822004056), (20160822011624), (20160822020401), (20160822044612), (20160830081224), (20160830224802), (20160911233738), (20160912002705), (20160912145957), (20160918003206), (20160928232404), (20161003185918), (20161019090945), (20161019110737), (20161020144622), (20161021131026), (20161031001615), (20161121005339), (20161121014050), (20161121043941), (20161121045709), (20161122015942), (20161123081114), (20161123150943), (20161124085742), (20161125200620), (20161126045705), (20161127054559), (20161205024856), (20161207112519), (20161209192504), (20161212005641), (20161214005935), (20161215052051), (20161216051447), (20161218005913), (20161219160401), (20161219163909), (20161220141753), (20161221085759), (20161226213600), (20161231063614), (20170102130055), (20170102181053), (20170104113708), (20170104212623), (20170104235423), (20170106013143), (20170115035159), (20170115230549), (20170121014100), (20170131234029), (20170201014901), (20170201025454), (20170201035458), (20170201183258), (20170220032224), (20170224233516), (20170226050552), (20170228085250), (20170308214128), (20170308220713), (20170308222552), (20170313130611), (20170318032449), (20170318082740), (20170324194827), (20170424215355), (20170501225441), (20170505224222), (20170526095401), (20170602000208), (20170622205732), (20170626231059), (20170628092119), (20170628213609), (20170629183404), (20170630140136), (20170706132431), (20170707213648), (20170711122252), (20170717092127), (20170725060612), (20170727052644), (20170731130121), (20170814131722), (20170913114958), (20170921014405), (20170925214512), (20170925230419), (20170926134646), (20170927100300);
+INSERT INTO "schema_migrations" (version) VALUES (20160723215749), (20160804000000), (20160804001111), (20160805132301), (20160805203929), (20160808143454), (20160809214736), (20160810124357), (20160815125009), (20160815143002), (20160816020347), (20160816034021), (20160817220118), (20160818000944), (20160818132546), (20160820113856), (20160820164905), (20160822002438), (20160822004056), (20160822011624), (20160822020401), (20160822044612), (20160830081224), (20160830224802), (20160911233738), (20160912002705), (20160912145957), (20160918003206), (20160928232404), (20161003185918), (20161019090945), (20161019110737), (20161020144622), (20161021131026), (20161031001615), (20161121005339), (20161121014050), (20161121043941), (20161121045709), (20161122015942), (20161123081114), (20161123150943), (20161124085742), (20161125200620), (20161126045705), (20161127054559), (20161205024856), (20161207112519), (20161209192504), (20161212005641), (20161214005935), (20161215052051), (20161216051447), (20161218005913), (20161219160401), (20161219163909), (20161220141753), (20161221085759), (20161226213600), (20161231063614), (20170102130055), (20170102181053), (20170104113708), (20170104212623), (20170104235423), (20170106013143), (20170115035159), (20170115230549), (20170121014100), (20170131234029), (20170201014901), (20170201025454), (20170201035458), (20170201183258), (20170220032224), (20170224233516), (20170226050552), (20170228085250), (20170308214128), (20170308220713), (20170308222552), (20170313130611), (20170318032449), (20170318082740), (20170324194827), (20170424215355), (20170501225441), (20170505224222), (20170526095401), (20170602000208), (20170622205732), (20170626231059), (20170628092119), (20170628213609), (20170629183404), (20170630140136), (20170706132431), (20170707213648), (20170711122252), (20170717092127), (20170725060612), (20170727052644), (20170731130121), (20170814131722), (20170913114958), (20170921014405), (20170925214512), (20170925230419), (20170926134646), (20170927100300), (20170928234412);
 

test/lib/code_corps/github/adapters/task_test.exs

@@ -12,9 +12,11 @@ defmodule CodeCorps.GitHub.Adapters.TaskTest do
       %{"issue" => payload} = load_event_fixture("issues_opened")
 
       assert Adapters.Task.from_issue(payload) == %{
+        created_at: payload["created_at"],
         github_issue_number: payload["number"],
-        title: payload["title"],
         markdown: payload["body"],
+        modified_at: payload["updated_at"],
+        title: payload["title"],
         status: payload["state"]
       }
     end
@@ -26,10 +28,12 @@ defmodule CodeCorps.GitHub.Adapters.TaskTest do
         %Task{number: 5, title: "Foo", markdown: "bar", status: "open"}
         |> Adapters.Task.to_issue
 
-      assert payload["title"] == "Foo"
       assert payload["body"] == "bar"
       assert payload["state"] == "open"
+      assert payload["title"] == "Foo"
+      refute payload["created_at"]
       refute payload["number"]
+      refute payload["updated_at"]
     end
   end
 end

test/lib/code_corps/github/event/issues/changeset_builder_test.exs

@@ -24,15 +24,21 @@ defmodule CodeCorps.GitHub.Event.Issues.ChangesetBuilderTest do
         task, payload, project_github_repo, user
       )
 
+      {:ok, created_at, _} = payload["issue"]["created_at"] |> DateTime.from_iso8601()
+      {:ok, updated_at, _} = payload["issue"]["updated_at"] |> DateTime.from_iso8601()
+
       # adapted fields
-      assert get_change(changeset, :name) == payload["issue"]["name"]
+      assert get_change(changeset, :created_at) == created_at
       assert get_change(changeset, :github_issue_number) == payload["issue"]["number"]
       assert get_change(changeset, :markdown) == payload["issue"]["body"]
+      assert get_change(changeset, :modified_at) == updated_at
+      assert get_change(changeset, :name) == payload["issue"]["name"]
       assert get_field(changeset, :status) == payload["issue"]["state"]
 
-      # html was rendered
+      # markdown was rendered into html
       assert get_change(changeset, :body) ==
-        Earmark.as_html!(payload["issue"]["body"], %Earmark.Options{code_class_prefix: "language-"})
+        payload["issue"]["body"]
+        |> Earmark.as_html!(%Earmark.Options{code_class_prefix: "language-"})
 
       # relationships are proper
       assert get_change(changeset, :github_repo_id) == project_github_repo.github_repo_id

test/lib/code_corps/model/task_test.exs

@@ -31,6 +31,23 @@ defmodule CodeCorps.TaskTest do
     end
   end
 
+  describe "create_changeset/2" do
+    test "sets created_at and modified_at to the same time" do
+      project = insert(:project)
+      task_list = insert(:task_list)
+      user = insert(:user)
+      changes = Map.merge(@valid_attrs, %{
+        project_id: project.id,
+        task_list_id: task_list.id,
+        user_id: user.id
+      })
+      changeset = Task.create_changeset(%Task{}, changes)
+      assert changeset.valid?
+      {:ok, %Task{created_at: created_at, modified_at: modified_at}} = Repo.insert(changeset)
+      assert created_at == modified_at
+    end
+  end
+
   describe "update_changeset/2" do
     test "only allows specific values for status" do
       changes = Map.put(@valid_attrs, :status, "nonexistent")

test/lib/code_corps_web/views/task_view_test.exs

@@ -14,8 +14,10 @@ defmodule CodeCorpsWeb.TaskViewTest do
       "data" => %{
         "attributes" => %{
           "body" => task.body,
+          "created-at" => task.created_at,
           "inserted-at" => task.inserted_at,
           "markdown" => task.markdown,
+          "modified-at" => task.modified_at,
           "number" => task.number,
           "order" => task.order,
           "status" => task.status,