Merge pull request #39 from unisoncomputing/cp/search-user-id

Add UserID to search results

Author: ChrisPenner

src/Share/Web/Share/Impl.hs

@@ -35,6 +35,7 @@ import Share.Utils.API
 import Share.Utils.Caching
 import Share.Utils.Logging qualified as Logging
 import Share.Utils.Servant.Cookies qualified as Cookies
+import Share.Utils.URI (URIParam (..))
 import Share.Web.App
 import Share.Web.Authentication qualified as AuthN
 import Share.Web.Authorization qualified as AuthZ
@@ -363,8 +364,8 @@ searchEndpoint (MaybeAuthedUserID callerUserId) (Query query) (fromMaybe (Limit
     pure (users, projects)
   let userResults =
         users
-          <&> \User {user_name, avatar_url, handle} ->
-            SearchResultUser handle user_name avatar_url
+          <&> \User {user_name = name, avatar_url = avatarUrl, handle, user_id = userId} ->
+            SearchResultUser (UserDisplayInfo {handle, name, avatarUrl = unpackURI <$> avatarUrl, userId})
   let projectResults =
         projects
           <&> \(Project {slug, summary, visibility}, ownerHandle) ->

src/Share/Web/Share/Types.hs

@@ -89,19 +89,19 @@ instance ToJSON DocResponse where
       ]
 
 data SearchResult
-  = -- | handle displayName avatarUrl
-    SearchResultUser UserHandle (Maybe Text) (Maybe URIParam)
+  = SearchResultUser UserDisplayInfo
   | -- | shorthand summary visibility
     SearchResultProject ProjectShortHand (Maybe Text) ProjectVisibility
   deriving (Show)
 
 instance ToJSON SearchResult where
   toJSON = \case
-    SearchResultUser handle name avatarUrl ->
+    SearchResultUser (UserDisplayInfo {handle, name, avatarUrl, userId}) ->
       Aeson.object
         [ "handle" .= fromId @UserHandle @Text handle,
           "name" .= name,
           "avatarUrl" .= avatarUrl,
+          "userId" .= userId,
           "tag" .= ("User" :: Text)
         ]
     SearchResultProject shorthand summary visibility ->
@@ -156,8 +156,7 @@ instance ToJSON UserDisplayInfo where
         "userId" Aeson..= userId
       ]
 
-data DefinitionNameSearchResult
-  = DefinitionNameSearchResult
+data DefinitionNameSearchResult = DefinitionNameSearchResult
   { token :: Name,
     tag :: TermOrTypeTag
   }
@@ -179,8 +178,7 @@ instance ToJSON DefinitionSearchResults where
       [ "results" .= results
       ]
 
-data DefinitionSearchResult
-  = DefinitionSearchResult
+data DefinitionSearchResult = DefinitionSearchResult
   { fqn :: Name,
     summary :: DefSync.TermOrTypeSummary,
     project :: ProjectShortHand,

transcripts/run-transcripts.zsh

@@ -2,6 +2,8 @@
 
 set -e
 
+unset UNISON_SYNC_VERSION
+
 while ! (  curl http://localhost:5424/health > /dev/null 2> /dev/null )  do \
     echo "Waiting for share server to come up, did you run 'make serve'?"; \
     sleep 1; \

transcripts/share-apis/code-browse/account.json

@@ -8,7 +8,11 @@
       "unison"
     ],
     "primaryEmail": "[email protected]",
-    "userId": "U-43efd5e7-139a-40b2-8a35-3f99b054dc84"
+    "userId": "U-<UUID>"
   },
-  "status": 200
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
 }

transcripts/share-apis/code-browse/codebase-browse.json

@@ -128,5 +128,9 @@
     "namespaceListingFQN": "names",
     "namespaceListingHash": "#77bp25t820hpn7t6andan3evac2o5gon8ulggl3kq2galktlbo10jkpub3rli3teop6h5ikgjhuirk87hf58g7cir4pk0ra6a9r5rro"
   },
-  "status": 200
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
 }

transcripts/share-apis/code-browse/codebase-definition-by-hash-constructor.json

@@ -71,5 +71,9 @@
       }
     }
   },
-  "status": 200
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
 }

transcripts/share-apis/code-browse/codebase-definition-by-hash-term.json

@@ -80,5 +80,9 @@
     },
     "typeDefinitions": {}
   },
-  "status": 200
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
 }

transcripts/share-apis/code-browse/codebase-definition-by-name-encoded.json

@@ -190,5 +190,9 @@
     },
     "typeDefinitions": {}
   },
-  "status": 200
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
 }

transcripts/share-apis/code-browse/codebase-definition-by-name-should-minimally-suffix-again.json

@@ -80,5 +80,9 @@
     },
     "typeDefinitions": {}
   },
-  "status": 200
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
 }

transcripts/share-apis/code-browse/codebase-definition-by-name-should-minimally-suffix.json

@@ -80,5 +80,9 @@
     },
     "typeDefinitions": {}
   },
-  "status": 200
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
 }