feat(authors): db query socials by author

Author: rafaeldelboni

src/codes/clj/docs/backend/adapters/db/postgres.clj

@@ -77,9 +77,9 @@
        (filter #(= (:type %) "see-also"))
        (map db->see-also)))
 
-(defn db->social
+(defn db->socials
   {:malli/schema [:=> [:cat [:sequential schemas.db/Row]]
-                  [:maybe schemas.model.social/Social]]}
+                  [:maybe [:sequential schemas.model.social/Social]]]}
   [db-rows]
   (->> db-rows
        (group-by :definition-id)
@@ -90,5 +90,10 @@
                 {:social/definition-id definition-id
                  :social/notes notes
                  :social/examples examples
-                 :social/see-alsos see-alsos})))
-       first))
+                 :social/see-alsos see-alsos})))))
+
+(defn db->social-definition
+  {:malli/schema [:=> [:cat [:sequential schemas.db/Row]]
+                  [:maybe schemas.model.social/Social]]}
+  [db-rows]
+  (first (db->socials db-rows)))

src/codes/clj/docs/backend/db/postgres.clj

@@ -5,41 +5,14 @@
             [honey.sql :as sql]
             [honey.sql.helpers :as sql.helpers]
             [next.jdbc :as jdbc]
-            [parenthesin.components.db.jdbc-hikari :as components.database]))
+            [parenthesin.components.db.jdbc-hikari :as components.database]
+            [taoensso.encore :as enc]))
 
 (defn ^:private execute!
   {:malli/schema [:=> [:cat schemas.types/DatabaseComponent :any] :any]}
   [db sql-params]
   (components.database/execute db sql-params jdbc/unqualified-snake-kebab-opts))
 
-(defn upsert-author
-  {:malli/schema [:=> [:cat schemas.model.social/NewAuthor schemas.types/DatabaseComponent]
-                  schemas.model.social/Author]}
-  [transaction db]
-  (->> (-> (sql.helpers/insert-into :author)
-           (sql.helpers/values [transaction])
-           (sql.helpers/upsert (-> (sql.helpers/on-conflict :login :account_source)
-                                   (sql.helpers/do-update-set :avatar_url)))
-           (sql.helpers/returning :*)
-           sql/format)
-       (execute! db)
-       first
-       adapters/db->author))
-
-(defn get-author
-  {:malli/schema [:=> [:cat :string schemas.model.social/account-source schemas.types/DatabaseComponent]
-                  [:maybe schemas.model.social/Author]]}
-  [login source db]
-  (when-let [author (->> (-> (sql.helpers/select :*)
-                             (sql.helpers/from :author)
-                             (sql.helpers/where :and
-                                                [:= :login login]
-                                                [:= :account_source source])
-                             sql/format)
-                         (execute! db)
-                         first)]
-    (adapters/db->author author)))
-
 (defn insert-see-also
   {:malli/schema [:=> [:cat schemas.model.social/NewSeeAlso schemas.types/DatabaseComponent]
                   schemas.model.social/SeeAlso]}
@@ -259,6 +232,51 @@
        first
        adapters/db->note))
 
+(defn upsert-author
+  {:malli/schema [:=> [:cat schemas.model.social/NewAuthor schemas.types/DatabaseComponent]
+                  schemas.model.social/Author]}
+  [transaction db]
+  (->> (-> (sql.helpers/insert-into :author)
+           (sql.helpers/values [transaction])
+           (sql.helpers/upsert (-> (sql.helpers/on-conflict :login :account_source)
+                                   (sql.helpers/do-update-set :avatar_url)))
+           (sql.helpers/returning :*)
+           sql/format)
+       (execute! db)
+       first
+       adapters/db->author))
+
+(defn get-author
+  {:malli/schema [:=> [:cat :string schemas.model.social/account-source schemas.types/DatabaseComponent]
+                  [:maybe schemas.model.social/Author+Socials]]}
+  [login source db]
+  (when-let [author (->> (-> (sql.helpers/select :*)
+                             (sql.helpers/from :author)
+                             (sql.helpers/where :and
+                                                [:= :login login]
+                                                [:= :account_source source])
+                             sql/format)
+                         (execute! db)
+                         first)]
+    (let [author-id (:author-id author)
+          socials (->> (-> (sql.helpers/union-all
+                            (-> get-note-query
+                                (sql.helpers/where [:= :note/author-id author-id]))
+
+                            (-> get-example-query
+                                (sql.helpers/where [:= :example-edit/author-id author-id]))
+
+                            (-> get-see-also-query
+                                (sql.helpers/where [:= :see-also/author-id author-id])))
+                           sql/format)
+                       (execute! db)
+                       adapters/db->socials
+                       seq)]
+
+      (enc/assoc-some
+       (adapters/db->author author)
+       :author/socials socials))))
+
 (defn get-by-definition
   {:malli/schema [:=> [:cat :string schemas.types/DatabaseComponent]
                   [:maybe schemas.model.social/Social]]}
@@ -274,4 +292,4 @@
                 (sql.helpers/where [:= :see-also/definition-id definition-id])))
            sql/format)
        (execute! db)
-       adapters/db->social))
+       adapters/db->social-definition))

src/codes/clj/docs/backend/schemas/model/social.clj

@@ -110,3 +110,6 @@
    [:social/notes [:sequential Note]]
    [:social/examples [:sequential Example]]
    [:social/see-alsos [:sequential SeeAlso]]])
+
+(def Author+Socials
+  (mu/assoc Author [:author/socials {:optional true}] [:sequential Social]))

test/integration/codes/clj/docs/backend/db/postgres_test.clj

@@ -26,9 +26,31 @@
    :cleanup util/stop-system!
    :fail-fast? true}
 
-  [database (state-flow.api/get-state :database)]
-
-  (util.db.postgres/upsert-author "delboni" "github")
+  [database (state-flow.api/get-state :database)
+
+  ; prepare db authors
+   author-1 (util.db.postgres/upsert-author "delboni" "github")
+   author-2 (util.db.postgres/upsert-author "not-delboni" "github")
+
+  ; prepare socials
+   see-also-1 (util.db.postgres/create-see-also {:see-also/author-id (:author/author-id author-1)
+                                                 :see-also/definition-id "clojure.core/disj"
+                                                 :see-also/definition-id-to "clojure.core/dissoc"})
+   _see-also-2 (util.db.postgres/create-see-also {:see-also/author-id (:author/author-id author-2)
+                                                  :see-also/definition-id "clojure.core/disj"
+                                                  :see-also/definition-id-to "clojure.core/dissoc2"})
+   note-1 (util.db.postgres/create-note {:note/author-id (:author/author-id author-1)
+                                         :note/definition-id "clojure.core/disj"
+                                         :note/body "author 1 note about this function."})
+   _note-2 (util.db.postgres/create-note {:note/author-id (:author/author-id author-2)
+                                          :note/definition-id "clojure.core/disj"
+                                          :note/body "author 2 note about this function."})
+   example-1 (util.db.postgres/create-example {:example/author-id (:author/author-id author-1)
+                                               :example/definition-id "clojure.core/disj"
+                                               :example/body "author 1 example about this function."})
+   _example-2 (util.db.postgres/create-example {:example/author-id (:author/author-id author-2)
+                                                :example/definition-id "clojure.core/disj"
+                                                :example/body "author 2 example about this function."})]
 
   (flow "upsert author with new url"
     (state/invoke
@@ -42,7 +64,13 @@
              :author/login "delboni"
              :author/account-source "github"
              :author/avatar-url "https://my.pic.com/me2.jpg"
-             :author/created-at inst?}
+             :author/created-at inst?
+             :author/socials [{:social/definition-id "clojure.core/disj"
+                               :social/notes [note-1]
+                               :social/examples [(dissoc example-1
+                                                         :example/author-id)]
+                               :social/see-alsos [see-also-1]}]}
+
             (db/get-author "delboni" "github" database))))
 
 (defflow see-also-db-test

test/integration/codes/clj/docs/backend/social_test.clj

@@ -324,6 +324,16 @@
                   (state-flow.server/request! {:method :get
                                                :uri (str "/api/social/example/" example-id)})))
 
+        (flow "should return author"
+          (match? {:status 200
+                   :body {:author-id string?
+                          :login "delboni",
+                          :account-source "github",
+                          :avatar-url "https://my.pic/me.jpg",
+                          :created-at string?}}
+                  (state-flow.server/request! {:method :get
+                                               :uri    "/api/social/author/delboni/github"})))
+
         (flow "delete example revision part 1"
           (state-flow.server/request! {:method :delete
                                        :headers {"authorization" (str "Bearer " token)}

test/unit/codes/clj/docs/backend/adapters/db/postgres_test.clj

@@ -200,4 +200,59 @@
                                                                 :avatar-url "https://my.pic.com/me.jpg"
                                                                 :created-at
                                                                 #inst "2020-10-23T00:00:00.000-00:00"}}]}
-                (adapters/db->social db-rows)))))
+                (adapters/db->social-definition db-rows)))))
+
+(deftest db->author-social-test
+  (testing "should map and get author social data for multiple definitions"
+    (is (match? [#:social{:definition-id "clojure.core/disj"
+                          :notes [#:note{:note-id #uuid "d9564b50-98f8-4c04-a668-bd24c1241e34"
+                                         :definition-id "clojure.core/disj"
+                                         :body "my note about this function."
+                                         :created-at #inst "2020-10-23T00:00:00.000-00:00"
+                                         :author
+                                         #:author{:author-id
+                                                  #uuid "387863e6-e32b-4d4b-8ec5-8cf4dab7e048"
+                                                  :login "delboni"
+                                                  :account-source "github"
+                                                  :avatar-url "https://my.pic.com/me.jpg"
+                                                  :created-at
+                                                  #inst "2020-10-23T00:00:00.000-00:00"}}]
+                          :examples []
+                          :see-alsos []}
+                 #:social{:definition-id "clojure.core/disj2"
+                          :notes [#:note{:note-id #uuid "d9564b50-98f8-4c04-a668-bd24c1241e34"
+                                         :definition-id "clojure.core/disj2"
+                                         :body "my note about this function 2."
+                                         :created-at #inst "2020-10-23T00:00:00.000-00:00"
+                                         :author
+                                         #:author{:author-id
+                                                  #uuid "387863e6-e32b-4d4b-8ec5-8cf4dab7e048"
+                                                  :login "delboni"
+                                                  :account-source "github"
+                                                  :avatar-url "https://my.pic.com/me.jpg"
+                                                  :created-at
+                                                  #inst "2020-10-23T00:00:00.000-00:00"}}]
+                          :examples []
+                          :see-alsos []}]
+                (adapters/db->socials [{:account-source "github"
+                                       :avatar-url "https://my.pic.com/me.jpg"
+                                       :type "note"
+                                       :created #inst "2020-10-23T00:00:00.000-00:00"
+                                       :login "delboni"
+                                       :id #uuid "d9564b50-98f8-4c04-a668-bd24c1241e34"
+                                       :author-id #uuid "387863e6-e32b-4d4b-8ec5-8cf4dab7e048"
+                                       :body "my note about this function."
+                                       :created-at #inst "2020-10-23T00:00:00.000-00:00"
+                                       :definition-id "clojure.core/disj"}
+                                      {:account-source "github"
+                                       :avatar-url "https://my.pic.com/me.jpg"
+                                       :type "note"
+                                       :created #inst "2020-10-23T00:00:00.000-00:00"
+                                       :login "delboni"
+                                       :id #uuid "d9564b50-98f8-4c04-a668-bd24c1241e34"
+                                       :author-id #uuid "387863e6-e32b-4d4b-8ec5-8cf4dab7e048"
+                                       :body "my note about this function 2."
+                                       :created-at #inst "2020-10-23T00:00:00.000-00:00"
+                                       :definition-id "clojure.core/disj2"}])))))
+
+