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

Improve type-safety for the total routes. #19

Merged
merged 8 commits into from
Nov 9, 2024
Merged

Improve type-safety for the total routes. #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
480fab8
Improve type-safety for the total routes.
arturaz Jun 20, 2024
7bd05a8
Extra .gitignore files for files that are generated when using Metals.
arturaz Jun 24, 2024
62d0752
Restructure the code as requested in https://github.com/raquo/Waypoin…
arturaz Jun 24, 2024
69a06df
Remove the `RouteBuilder`, as requested.
arturaz Aug 13, 2024
238706e
Separate `Route.static` and `Route.staticTotal`
arturaz Aug 13, 2024
6b3e117
Merge remote-tracking branch 'upstream/master'
arturaz Aug 15, 2024
4f6f4b6
Make `Route.staticTotal` fully type-safe.
arturaz Aug 15, 2024
547f990
`Route.staticTotal` tests
arturaz Aug 16, 2024
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
5 changes: 5 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,8 @@ js/yarn.lock
.DS_Store

/.bsp

/.metals
# This is autogenerated
metals.sbt
.bloop
62 changes: 49 additions & 13 deletions js/src/test/scala/com/raquo/waypoint/BasePathSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,41 +33,47 @@ class BasePathSpec extends UnitSpec {

describe(s"basePath = `$basePath`") {

val homeRoute: Route[HomePage.type, Unit] = Route.static(
val homeRoute: Route.Partial[HomePage.type, Unit] = Route.static(
HomePage,
pattern = root / endOfSegments,
basePath = basePath
)

val libraryRoute: Route[LibraryPage, Int] = Route(
val homeRouteTotal: Route.Total[HomePage.type, Unit] = Route.staticTotal(
HomePage,
pattern = root / endOfSegments,
basePath = basePath
)

val libraryRoute: Route.Total[LibraryPage, Int] = Route(
encode = _.libraryId,
decode = arg => LibraryPage(libraryId = arg),
pattern = root / "app" / "library" / segment[Int] / endOfSegments,
basePath = basePath
)

val textRoute: Route[TextPage, String] = Route(
val textRoute: Route.Total[TextPage, String] = Route(
encode = _.text,
decode = arg => TextPage(text = arg),
pattern = root / "app" / "test" / segment[String] / endOfSegments,
basePath = basePath
)

val noteRoute: Route[NotePage, (Int, Int)] = Route(
val noteRoute: Route.Total[NotePage, (Int, Int)] = Route(
encode = page => (page.libraryId, page.noteId),
decode = args => NotePage(libraryId = args._1, noteId = args._2, scrollPosition = 0),
pattern = root / "app" / "library" / segment[Int] / "note" / segment[Int] / endOfSegments,
basePath = basePath
)

val searchRoute: Route[SearchPage, String] = Route.onlyQuery(
val searchRoute: Route.Total[SearchPage, String] = Route.onlyQuery(
encode = page => page.query,
decode = arg => SearchPage(arg),
pattern = (root / "search" / endOfSegments) ? param[String]("query"),
basePath = basePath
)

val bigLegalRoute: Route[BigLegalPage, FragmentPatternArgs[String, Unit, String]] = Route.withFragment(
val bigLegalRoute: Route.Total[BigLegalPage, FragmentPatternArgs[String, Unit, String]] = Route.withFragment(
encode = page => FragmentPatternArgs(path = page.page, (), fragment = page.section),
decode = args => BigLegalPage(page = args.path, section = args.fragment),
pattern = (root / "legal" / segment[String] / endOfSegments) withFragment fragment[String],
Expand Down Expand Up @@ -137,6 +143,7 @@ class BasePathSpec extends UnitSpec {
textRoute,
noteRoute,
homeRoute,
homeRouteTotal,
searchRoute,
bigLegalRoute,
bigNumRoute,
Expand All @@ -156,13 +163,18 @@ class BasePathSpec extends UnitSpec {
)

it("segment routes - parse urls - match") {
if (basePath.nonEmpty) {
expectPageRelative(homeRoute, origin, s"$basePath", Some(HomePage))
} else {
// (basePath + url) must be a relative URL, so if basePath is empty, url can't also be empty, it must start with `/`
expectPageRelativeFailure(homeRoute, origin, s"$basePath")
def testHomeRoute(homeRoute: Route[HomePage.type, Unit]) = {
if (basePath.nonEmpty) {
expectPageRelative(homeRoute, origin, s"$basePath", Some(HomePage))
} else {
// (basePath + url) must be a relative URL, so if basePath is empty, url can't also be empty, it must start with `/`
expectPageRelativeFailure(homeRoute, origin, s"$basePath")
}
expectPageRelative(homeRoute, origin, s"$basePath/", Some(HomePage))
}
expectPageRelative(homeRoute, origin, s"$basePath/", Some(HomePage))

testHomeRoute(homeRoute)
testHomeRoute(homeRouteTotal)

expectPageRelative(libraryRoute, origin, s"$basePath/app/library/1234", Some(LibraryPage(libraryId = 1234)))
expectPageRelative(libraryRoute, origin, s"$basePath/app/library/100?hello=world", Some(LibraryPage(libraryId = 100)))
Expand Down Expand Up @@ -190,12 +202,14 @@ class BasePathSpec extends UnitSpec {

expectPageRelative(libraryRoute, origin, "/app/library/1234", if (basePath.isEmpty) Some(LibraryPage(1234)) else None)

{
def testHomeRoute(homeRoute: Route[HomePage.type, Unit]) = {
if (Utils.basePathHasEmptyFragment(basePath)) {
val basePathWithoutFragment = Utils.basePathWithoutFragment(basePath)
expectPageRelative(homeRoute, origin, s"$basePathWithoutFragment", Some(HomePage))
}
}
testHomeRoute(homeRoute)
testHomeRoute(homeRouteTotal)

// @TODO[API] I mean... these are not absolute urls...
expectPageAbsoluteFailure(libraryRoute, origin, "//app/library/1234")
Expand Down Expand Up @@ -260,6 +274,28 @@ class BasePathSpec extends UnitSpec {
urlForPage(DocsPage(NumPage(0))) shouldBe Some(s"$basePath/docs/zero/0")
urlForPage(DocsPage(NumPage(50))) shouldBe None
}

it("should not compile with non-singleton type for a staticTotal route") {
assertTypeError(
"""|Route.staticTotal(
| LegalPage("tos"),
| pattern = root / endOfSegments,
| basePath = "basePath"
|)
|""".stripMargin
)
}

it("should not compile with non-singleton type ascription for a staticTotal route") {
assertTypeError(
"""|Route.staticTotal[AppPage](
| HomePage,
| pattern = root / endOfSegments,
| basePath = "basePath"
|)
|""".stripMargin
)
}
}
}
}
Expand Down
16 changes: 8 additions & 8 deletions js/src/test/scala/com/raquo/waypoint/DynamicRouteSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,49 +18,49 @@ class DynamicRouteSpec extends UnitSpec {

val origin = "http://example.com"

val libraryRoute: Route[LibraryPage, Int] = Route(
val libraryRoute: Route.Total[LibraryPage, Int] = Route(
encode = _.libraryId,
decode = arg => LibraryPage(libraryId = arg),
pattern = root / "app" / "library" / segment[Int] / endOfSegments
)

val textRoute: Route[TextPage, String] = Route(
val textRoute: Route.Total[TextPage, String] = Route(
encode = _.text,
decode = arg => TextPage(text = arg),
pattern = root / "app" / "test" / segment[String] / endOfSegments
)

val noteRoute: Route[NotePage, (Int, Int)] = Route(
val noteRoute: Route.Total[NotePage, (Int, Int)] = Route(
encode = page => (page.libraryId, page.noteId),
decode = args => NotePage(libraryId = args._1, noteId = args._2, scrollPosition = 0),
pattern = root / "app" / "library" / segment[Int] / "note" / segment[Int] / endOfSegments
)

val searchRoute: Route[SearchPage, String] = Route.onlyQuery(
val searchRoute: Route.Total[SearchPage, String] = Route.onlyQuery(
encode = page => page.query,
decode = arg => SearchPage(arg),
pattern = (root / "search" / endOfSegments) ? param[String]("query")
)

val workspaceSearchRoute: Route[WorkspaceSearchPage, PatternArgs[String, String]] = Route.withQuery(
val workspaceSearchRoute: Route.Total[WorkspaceSearchPage, PatternArgs[String, String]] = Route.withQuery(
encode = page => PatternArgs(page.workspaceId, page.query),
decode = args => WorkspaceSearchPage(workspaceId = args.path, query = args.params),
pattern = (root / "workspace" / segment[String] / endOfSegments) ? param[String]("query")
)

val legalRoute: Route[LegalPage, String] = Route.onlyFragment(
val legalRoute: Route.Total[LegalPage, String] = Route.onlyFragment(
encode = page => page.section,
decode = arg => LegalPage(arg),
pattern = (root / "legal" / endOfSegments) withFragment fragment[String]
)

val bigLegalRoute: Route[BigLegalPage, FragmentPatternArgs[String, Unit, String]] = Route.withFragment(
val bigLegalRoute: Route.Total[BigLegalPage, FragmentPatternArgs[String, Unit, String]] = Route.withFragment(
encode = page => FragmentPatternArgs(path = page.page, (), fragment = page.section),
decode = args => BigLegalPage(page = args.path, section = args.fragment),
pattern = (root / "legal" / segment[String] / endOfSegments) withFragment fragment[String]
)

val hugeLegalRoute: Route[HugeLegalPage, FragmentPatternArgs[String, Int, String]] = Route.withQueryAndFragment(
val hugeLegalRoute: Route.Total[HugeLegalPage, FragmentPatternArgs[String, Int, String]] = Route.withQueryAndFragment(
encode = page => FragmentPatternArgs(path = page.page, query = page.version, fragment = page.section),
decode = args => HugeLegalPage(page = args.path, version = args.query, section = args.fragment),
pattern = (root / "legal" / segment[String] / endOfSegments) ? param[Int]("version") withFragment fragment[String]
Expand Down
Loading
Loading