Compatibility with scala-js #38

jdesiloniz · 2016-10-28T16:33:09Z

OK, this is a rather lengthy one...

This PR contains code to make github4s compatible with scala-js projects. The process of doing so implies modifications in the overall structure of the project. The changes comprises the following:

The main project github4s is now a cross-project composed of three different modules github4s which holds the shared code between both the JVM and the JS sides (most of the code is there), github4sJVM which contains an implementation of the http-requests-handling code more or less similar with the one we had before (compatible with Task, Eval, Id...); and github4sJS which contains an alternative implementation of that code, but working with Futures and a HTTP client compatible with scala-js (roshttp).
In order for github4s to be compatible with applications working under the JVM, developers just need to mixin the ImplicitsJVM trait to their code, so our implicit instances for Id, Task, Eval... and the scalaj http clients are available for github4s.
The process is more or less similar for applications working under scala-js. In this case, users should mixin the ImplicitsJS trait to their code; but also a valid implicit execution context (i.e.: import scala.concurrent.ExecutionContext.Implicits.global). In this case, github4s is limited to be use with Future and the roshttp client.
So far, tut doesn't seem to be compatible with scala-js code, as well as scoverage. Both have been limited access to the JS code for the moment.

Fixes #10

Could you please review, @juanpedromoreno @raulraja? Thanks!

…s into g4s-10-support-for-scalajs

… yet

juanpedromoreno

This is completely awesome!!

However, I've requested some changes before merging. Besides that, I'd suggest a different LGTM from @raulraja or @rafaparadela since there are some commits with my name :P (sbt stuff)

juanpedromoreno · 2016-10-29T08:53:14Z

github4s/js/src/main/scala/github4s/HttpRequestBuilderExtensionJS.scala

+
+  import monix.execution.Scheduler.Implicits.global
+
+  def userAgent = {


Could be this method a val?

juanpedromoreno · 2016-10-29T08:55:59Z

build.sbt

  .enablePlugins(AutomateHeaderPlugin)
+
+lazy val testSettings = Seq(
+  fork in Test := false


Can this fork in Test := false be moved to sharedJsSettings? In this way, the github4s module can be defined simply with

lazy val github4sJS = github4s.js

juanpedromoreno · 2016-10-29T08:57:21Z

build.sbt

+  fork in Test := false
+)
+
+addCommandAlias("testAllCoverable", ";docs/test;scalaz/test;github4sJVM/test")


Should testAll alias include the github4sJS/test sbt command as well?

I did it that way because I was under the impression that scoverage wasn't compatible with scala-js, which was the case until this: scoverage/scalac-scoverage-plugin#118. Do you know which version of the sbt-scoverage plugin are we using on sbt-catalyst-extras? (I haven't been able to find it). I'm not really familiar on how it works... Maybe we need to update it for the JS tests to be coverable?

OK, I switched to using a higher version of the sbt-scoverage plugin and proved to be compatible with ScalaJS, so I removed the extra command and all the tests go through the coverage process.

juanpedromoreno · 2016-10-29T09:03:10Z

github4s/jvm/src/main/scala/github4s/HttpRequestBuilderExtensionJVM.scala

+      decode[A](r.body).fold(
+        e ⇒ Either.left(JsonParsingException(e.getMessage, r.body)),
+        result ⇒ Either.right(GHResult(result, r.code, toLowerCase(r.headers)))
+      )


Does this TODO comment make sense?

Ermmm... nope! https://media.giphy.com/media/CdwvDXD6bqCcw/giphy.gif

juanpedromoreno · 2016-10-29T09:16:16Z

github4s/js/src/main/scala/github4s/HttpRequestBuilderExtensionJS.scala

+          .withHeaders(rb.authHeader.toList: _*)
+          .withHeaders(rb.headers.toList: _*)
+
+        (rb.data match {


Just giving here my personal preferences for the following piece of code ;) :

rb .data .map(d => request.send(CirceJSONBody(d))) .getOrElse(request.send()) .map(toEntity[A]) .recoverWith { case e => Future.successful(Either.left(UnexpectedException(e.getMessage))) }

Elegant! Totally changing it to this!

juanpedromoreno · 2016-10-29T09:17:51Z

github4s/js/src/main/scala/github4s/HttpRequestBuilderExtensionJS.scala

+
+  def toEntity[A](response: SimpleHttpResponse)(implicit D: Decoder[A]): GHResponse[A] =
+    response match {
+      case r if r.statusCode < 400 ⇒


Status codes should be placed in single place, we prefer to do not have literals along the code when possible.

Maybe we could move somewhere here: github4s.HttpClient.HttpStatus, together with github4s.HttpClient.HttpVerb.

Does it make sense?

juanpedromoreno · 2016-10-29T09:26:30Z

version.sbt

@@ -1 +1 @@
-version in ThisBuild := "0.8.2-SNAPSHOT"
+version in ThisBuild := "0.8.3-SNAPSHOT"


This file shouldn't be edited manually, it's being modified automatically when releasing the new version.

codecov-io · 2016-11-02T09:19:26Z

Current coverage is 86.37% (diff: 88.03%)

Merging #38 into master will decrease coverage by 0.21%

@@             master        #38   diff @@
==========================================
  Files            16         21     +5   
  Lines           261        301    +40   
  Methods         259        299    +40   
  Messages          0          0          
  Branches          2          2          
==========================================
+ Hits            226        260    +34   
- Misses           35         41     +6   
  Partials          0          0

Powered by Codecov. Last update 3d82dcf...fcaf13c

jdesiloniz · 2016-11-02T09:23:03Z

@raulraja @rafaparadela I performed the changes requested by @juanpedromoreno. If you have the chance, could you take a look at this (i.e.: there are changes introduced by both JP and me); or is this safe to merge already? Thanks!

…ests

juanpedromoreno · 2016-11-02T14:47:16Z

LGTM!

raulraja

LGTM, but would like to see the recommendation addressed before merging.

raulraja · 2016-11-02T14:52:56Z

docs/src/main/tut/docs.md

+In order for github4s to work in both JVM and scala-js environments, you'll need to place different implicits in your scope:
+
+```tut:silent
+object JVMProgram extends github4s.ImplicitsJVM {


we should provide objects for implicits imports such as github4s.jvm.implicits._ beside traits for aggregation. In most use cases folks are going to want an import not aggregating a trait.

…ts - Gists in tests are not publico

jdesiloniz · 2016-11-02T15:59:08Z

@raulraja I Implemented objects for easier use of implicits in both the JS/JVM projects. As soon as the build passes OK I'll merge this branch to master. Thanks!

raulraja · 2016-11-02T16:12:40Z

👍

juanpedromoreno and others added 15 commits October 23, 2016 20:20

Moves the code to the different modules. WIP

a922b56

Merge branch 'master' into g4s-10-support-for-scalajs

aed4702

Merge branch 'master' into g4s-10-support-for-scalajs

34cbe91

WIP

042ef1c

Merge branch 'g4s-10-support-for-scalajs' of github.com:47deg/github4…

2e3a545

…s into g4s-10-support-for-scalajs

Still WIP - solves major problems with implicits

ef4298e

Still WIP - solves major problems with implicits

3d266d3

WIP - fixed problems with implicits

311661b

WIP - Fixed compilation issues in tests for JVM

586586a

WIP - tests compiling/passing

c9515eb

Fixed publishing to local - Switched to latest version of ROSHTTP

af091aa

Added user-agent header to requests from the JS side

0a84652

Fixed issues with tests both in JVM and JS sides

683cda3

Excluding JS side from scoverage, as it's not compatible with ScalaJS…

b2b09f2

… yet

Fixing issues with tut docs

7040a3c

juanpedromoreno requested changes Oct 29, 2016

View reviewed changes

Fixing changes from PRs

8ba724e

Updating docs to reflect the use of GitHub access tokens to perform t…

fcaf13c

…ests

juanpedromoreno approved these changes Nov 2, 2016

View reviewed changes

raulraja approved these changes Nov 2, 2016

View reviewed changes

Added objects for easier implicit handling for both JVM and JS projec…

544652b

…ts - Gists in tests are not publico

jdesiloniz merged commit a714e61 into master Nov 2, 2016

jdesiloniz deleted the g4s-10-support-for-scalajs branch November 2, 2016 16:12


		import monix.execution.Scheduler.Implicits.global

		def userAgent = {

		@@ -1 +1 @@
		version in ThisBuild := "0.8.2-SNAPSHOT" No newline at end of file
		version in ThisBuild := "0.8.3-SNAPSHOT" No newline at end of file

Compatibility with scala-js #38

Compatibility with scala-js #38

Uh oh!

Conversation

jdesiloniz commented Oct 28, 2016 • edited by juanpedromoreno Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

juanpedromoreno left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jdesiloniz Oct 30, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov-io commented Nov 2, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Current coverage is 86.37% (diff: 88.03%)

Uh oh!

jdesiloniz commented Nov 2, 2016

Uh oh!

juanpedromoreno commented Nov 2, 2016

Uh oh!

raulraja left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jdesiloniz commented Nov 2, 2016

Uh oh!

raulraja commented Nov 2, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jdesiloniz commented Oct 28, 2016 •

edited by juanpedromoreno

Loading

jdesiloniz Oct 30, 2016 •

edited

Loading

codecov-io commented Nov 2, 2016 •

edited

Loading