-
Notifications
You must be signed in to change notification settings - Fork 68
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Derive http endpoints from hints (#41)
* Derive HttpEndpoint from Hint instead of relying on subtyping This derives the HttpEndpoint instance associated to an Endpoint, by searching smithy.api.Http in the the Endpoint's hints, and compiling the found data to the correct interface, by means of Schematic. The rationale is the following : 1. allow for dynamically instantiated service to have HttpService without any bespoke processing. 2. open the door for splitting the http package away from the core module Also : * AlsRemove uri-specific methods from core package object * Fix URIEncoderDecoder to actually do uri encoding Co-authored-by: Jakub Kozłowski <kubukoz@gmail.com>
- Loading branch information
Showing
19 changed files
with
418 additions
and
192 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /* | ||
| * Copyright 2021 Disney Streaming | ||
| * | ||
| * Licensed under the Tomorrow Open Source Technology License, Version 1.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://disneystreaming.github.io/TOST-1.0.txt | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package smithy4s.http.internals | ||
|
|
||
| import smithy4s.internals.Hinted | ||
|
|
||
| trait PathEncode[A] { self => | ||
| def encode(sb: StringBuilder, a: A): Unit | ||
| def encodeGreedy(sb: StringBuilder, a: A): Unit | ||
|
|
||
| def contramap[B](from: B => A): PathEncode[B] = new PathEncode[B] { | ||
| def encode(sb: StringBuilder, b: B): Unit = self.encode(sb, from(b)) | ||
|
|
||
| def encodeGreedy(sb: StringBuilder, b: B): Unit = | ||
| self.encodeGreedy(sb, from(b)) | ||
| } | ||
| } | ||
|
|
||
| object PathEncode { | ||
|
|
||
| type MaybePathEncode[A] = Option[PathEncode[A]] | ||
| type Make[A] = Hinted[MaybePathEncode, A] | ||
|
|
||
| object Make { | ||
| def from[A](f: A => String): Make[A] = Hinted.static[MaybePathEncode, A] { | ||
| Some { | ||
| raw(f) | ||
| } | ||
| } | ||
|
|
||
| def raw[A](f: A => String): PathEncode[A] = { | ||
| new PathEncode[A] { | ||
| def encode(sb: StringBuilder, a: A): Unit = { | ||
| val _ = sb.append(URIEncoderDecoder.encode(f(a))) | ||
| } | ||
| def encodeGreedy(sb: StringBuilder, a: A): Unit = { | ||
| f(a).split('/').foreach { | ||
| case s if s.isEmpty() => () | ||
| case s => sb.append('/').append(URIEncoderDecoder.encode(s)) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| def fromToString[A]: Make[A] = from(_.toString) | ||
|
|
||
| def noop[A]: Make[A] = Hinted.static[MaybePathEncode, A](None) | ||
| } | ||
|
|
||
| } |
136 changes: 136 additions & 0 deletions
136
modules/core/src/smithy4s/http/internals/SchematicPathEncoder.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| /* | ||
| * Copyright 2021 Disney Streaming | ||
| * | ||
| * Licensed under the Tomorrow Open Source Technology License, Version 1.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://disneystreaming.github.io/TOST-1.0.txt | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package smithy4s | ||
| package http.internals | ||
|
|
||
| import smithy.api.TimestampFormat | ||
| import schematic.Field | ||
| import smithy4s.internals.Hinted | ||
| import smithy.api.Http | ||
| import smithy4s.http.PathSegment | ||
| import smithy4s.http.PathSegment.StaticSegment | ||
| import smithy4s.http.PathSegment.LabelSegment | ||
| import smithy4s.http.PathSegment.GreedySegment | ||
|
|
||
| object SchematicPathEncoder | ||
| extends Schematic[PathEncode.Make] | ||
| with StubSchematic[PathEncode.Make] { | ||
|
|
||
| def default[A]: PathEncode.Make[A] = PathEncode.Make.noop | ||
| override def withHints[A]( | ||
| fa: PathEncode.Make[A], | ||
| hints: smithy4s.Hints | ||
| ): PathEncode.Make[A] = | ||
| fa.addHints(hints) | ||
|
|
||
| override def bijection[A, B]( | ||
| f: PathEncode.Make[A], | ||
| to: A => B, | ||
| from: B => A | ||
| ): PathEncode.Make[B] = | ||
| Hinted[PathEncode.MaybePathEncode, B]( | ||
| f.hints, | ||
| make = hints => f.make(hints).map(_.contramap(from)) | ||
| ) | ||
|
|
||
| override val bigdecimal: PathEncode.Make[BigDecimal] = | ||
| PathEncode.Make.fromToString | ||
| override val bigint: PathEncode.Make[BigInt] = PathEncode.Make.fromToString | ||
| override val double: PathEncode.Make[Double] = PathEncode.Make.fromToString | ||
| override val int: PathEncode.Make[Int] = PathEncode.Make.fromToString | ||
| override val float: PathEncode.Make[Float] = PathEncode.Make.fromToString | ||
| override val short: PathEncode.Make[Short] = PathEncode.Make.fromToString | ||
| override val long: PathEncode.Make[Long] = PathEncode.Make.fromToString | ||
| override val string: PathEncode.Make[String] = PathEncode.Make.fromToString | ||
| override val uuid: PathEncode.Make[java.util.UUID] = | ||
| PathEncode.Make.fromToString | ||
| override val boolean: PathEncode.Make[Boolean] = PathEncode.Make.fromToString | ||
|
|
||
| override val timestamp: PathEncode.Make[Timestamp] = | ||
| Hinted[PathEncode.MaybePathEncode].from { hints => | ||
| val fmt = hints.get(TimestampFormat).getOrElse(TimestampFormat.DATE_TIME) | ||
|
|
||
| Some(PathEncode.Make.raw(_.format(fmt))) | ||
| } | ||
|
|
||
| override val unit: PathEncode.Make[Unit] = | ||
| genericStruct(Vector.empty)(_ => ()) | ||
|
|
||
| override def genericStruct[S](fields: Vector[Field[PathEncode.Make, S, _]])( | ||
| const: Vector[Any] => S | ||
| ): PathEncode.Make[S] = { | ||
| type Writer = (StringBuilder, S) => Unit | ||
|
|
||
| def toPathEncoder[A]( | ||
| field: Field[PathEncode.Make, S, A], | ||
| greedy: Boolean | ||
| ): Option[Writer] = { | ||
| field.fold(new Field.Folder[PathEncode.Make, S, Option[Writer]] { | ||
| def onRequired[AA]( | ||
| label: String, | ||
| instance: PathEncode.Make[AA], | ||
| get: S => AA | ||
| ): Option[Writer] = | ||
| if (greedy) | ||
| instance.get.map(encoder => | ||
| (sb, s) => encoder.encodeGreedy(sb, get(s)) | ||
| ) | ||
| else | ||
| instance.get.map(encoder => (sb, s) => encoder.encode(sb, get(s))) | ||
| def onOptional[AA]( | ||
| label: String, | ||
| instance: PathEncode.Make[AA], | ||
| get: S => Option[AA] | ||
| ): Option[Writer] = None | ||
| }) | ||
| } | ||
|
|
||
| def compile1(path: PathSegment): Option[Writer] = path match { | ||
| case StaticSegment(value) => | ||
| Some((sb, _) => { val _ = sb.append(value) }) | ||
| case LabelSegment(value) => | ||
| fields | ||
| .find(_.label == value) | ||
| .flatMap(field => toPathEncoder(field, greedy = false)) | ||
| case GreedySegment(value) => | ||
| fields | ||
| .find(_.label == value) | ||
| .flatMap(field => toPathEncoder(field, greedy = true)) | ||
| } | ||
|
|
||
| def compilePath(path: Vector[PathSegment]): Option[Vector[Writer]] = | ||
| path.traverse(compile1(_)) | ||
|
|
||
| Hinted[PathEncode.MaybePathEncode].onHintOpt[Http, S] { maybeHttpHint => | ||
| for { | ||
| httpHint <- maybeHttpHint | ||
| path <- pathSegments(httpHint.uri.value) | ||
| writers <- compilePath(path) | ||
| } yield new PathEncode[S] { | ||
| def encode(sb: StringBuilder, s: S): Unit = { | ||
| var first = true | ||
| writers.foreach { w => | ||
| if (first) { w.apply(sb, s); first = false } | ||
| else w.apply(sb.append('/'), s) | ||
| } | ||
| } | ||
|
|
||
| def encodeGreedy(sb: StringBuilder, s: S) = () | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.