Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Align search API with search page #656

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Align search API with search page #656

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
36d2ead
fix search api
adpi2 Feb 16, 2021
ab6f480
Add search page data in search api result
adpi2 Feb 16, 2021
041c971
Add defaultArtifact field in search API
adpi2 Feb 16, 2021
4d564b0
Add paging info in search API
adpi2 Feb 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 48 additions & 18 deletions server/src/main/scala/ch.epfl.scala.index.server/routes/api/SearchApi.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,16 @@ object SearchApi {
case class Project(
organization: String,
repository: String,
logo: Option[String] = None,
artifacts: List[String] = Nil
logo: Option[String],
stars: Option[Int],
forks: Option[Int],
contributorCount: Option[Int],
topics: Set[String],
artifacts: List[String],
scalaVersion: List[String],
scalaJsVersion: List[String],
scalaNativeVersion: List[String],
sbtVersion: List[String]
)

case class ReleaseOptions(
Expand Down Expand Up @@ -91,7 +99,8 @@ class SearchApi(
val routes: Route =
pathPrefix("api") {
cors() {
path("search") {
// deprecated endpoint replaced by api/search endpoint
path("search-old") {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we instead keep this one and introduce a new endpoint api/search/v2, to not break existing users?

get {
parameters(
(
Expand Down Expand Up @@ -125,17 +134,6 @@ class SearchApi(
sbtVersion
)

def convert(project: Project): SearchApi.Project = {
import project._
val artifacts0 = if (cli) cliArtifacts.toList else artifacts
SearchApi.Project(
organization,
repository,
project.github.flatMap(_.logo.map(_.target)),
artifacts0
)
}

scalaTarget match {
case Some(_) =>
val searchParams = SearchParams(
Expand All @@ -147,7 +145,7 @@ class SearchApi(
)
val result = dataRepository
.findProjects(searchParams)
.map(page => page.items.map(p => convert(p)))
.map(page => page.items.map(convertProject(cli)))
complete(OK, result)

case None =>
Expand All @@ -158,6 +156,19 @@ class SearchApi(
}
}
} ~
path("search") {
get {
optionalSession(refreshable, usingCookies) { userId =>
val user = session.getUser(userId)
searchParams(user) { params =>
val result = dataRepository
.findProjects(params)
.map(page => page.items.map(convertProject(params.cli)))
complete(result)
}
}
}
} ~
path("project") {
get {
parameters(
Expand Down Expand Up @@ -201,16 +212,35 @@ class SearchApi(
optionalSession(refreshable, usingCookies) { userId =>
val user = session.getUser(userId)
searchParams(user) { params =>
complete {
autocomplete(params)
}
val autoCompletion = autocomplete(params)
complete(autoCompletion)
}
}
}
}
}
}

private def convertProject(
cli: Boolean
)(project: Project): SearchApi.Project = {
val artifacts = if (cli) project.cliArtifacts.toList else project.artifacts
SearchApi.Project(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also include defaultArtifact since search API under the hood redirects to it anyway.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added the defaultArtifact field coming from the Project data class. You can try it here.

This field is not set automatically, it is set manually by the library maintainer. So it can be empty or completely nonsense.

project.organization,
project.repository,
project.github.flatMap(_.logo.map(_.target)),
project.github.flatMap(_.stars),
project.github.flatMap(_.forks),
project.github.map(_.contributorCount),
project.github.map(_.topics).getOrElse(Set.empty),
project.artifacts,
project.scalaVersion,
project.sbtVersion,
project.scalaJsVersion,
project.scalaNativeVersion
)
}

private def getReleaseOptions(
projectRef: Project.Reference,
scalaTarget: Option[ScalaTarget],
Expand Down
14 changes: 10 additions & 4 deletions server/src/main/scala/ch.epfl.scala.index.server/routes/package.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,33 @@ package object routes {
(
"q" ? "*",
"page".as[Int] ? 1,
"total".as[Int] ? SearchParams.resultsPerPage,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we also include information about available pages? Currently one needs to call next page until the response is empty (but this is probably not in the scope of this PR).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added the currentPage and pageTotal fields: https://index-dev.scala-lang.org/api/search?q=*&scalaVersions=scala3&sort=stars&total=20&page=2

"sort".?,
"topics".as[String].*,
"targetTypes".as[String].*,
"scalaVersions".as[String].*,
"scalaJsVersions".as[String].*,
"scalaNativeVersions".as[String].*,
"sbtVersions".as[String].*,
"you".?,
"contributingSearch".as[Boolean] ? false
"contributingSearch".as[Boolean] ? false,
"cli".as[Boolean] ? false,
"you".?
)
).tmap {
case (
q,
page,
total,
sort,
topics,
targetTypes,
scalaVersions,
scalaJsVersions,
scalaNativeVersions,
sbtVersions,
you,
contributingSearch
contributingSearch,
cli,
you
) =>
val userRepos = you
.flatMap(_ => user.map(_.repos))
Expand All @@ -42,8 +46,10 @@ package object routes {
page,
sort,
userRepos,
total = total,
topics = topics.toList,
targetTypes = targetTypes.toList,
cli = cli,
scalaVersions = scalaVersions.toList,
scalaJsVersions = scalaJsVersions.toList,
scalaNativeVersions = scalaNativeVersions.toList,
Expand Down