🗄 🔧 Kotlin + Ktor

Question

🗄 🔧 Kotlin + Ktor

AndreasVolkmann opened this issue 7 years ago · comments

Andreas Volkmann commented 7 years ago

Progress / ToDo

🏁 Fork the starter repo & post the link in this issue
🎨 Create logo for repo & update issue status (@EricSimons)
🔨 Implement all of Conduit's functionality per the spec & API
👀 Move repo to main org & Peer review final codebase by admins/community (RFC)
🎉 Tag v1 release and officially list it on the README!

Current Status

Codebase in progress: dragneelfps/realworld-kotlin-ktor

Eric Simons · Answer 1 · Thu Sep 28 2017 07:36:26 GMT+0800 (China Standard Time)

@goreRatzete awesome man! Can't wait to see this!

Muhannad · Answer 2 · Mon Oct 02 2017 09:27:56 GMT+0800 (China Standard Time)

@goreRatzete is this project still active? I'm trying to get involved here. And unfortunately, there is no Issues tab in your Github forked project, which make it hard to discuss

Andreas Volkmann · Answer 3 · Mon Oct 02 2017 16:30:16 GMT+0800 (China Standard Time)

@Muhannad508 Hi there. Yes it is still alive. I had a smaller break but will continue working on it soon. I haven't created any issues since I was working alone so far. I can either tell you what needs to be done, or you can have a look yourself.
Also I have placed many TODOs in the code to show what is missing. If you go through the routes you can quickly find them.

2 things I am not 100% sure on yet:

Database access and design
Json serialization

Carlos Ballesteros Velasco · Answer 4 · Mon Jun 25 2018 23:50:25 GMT+0800 (China Standard Time)

I have implemented a realworld backend using ktor and MongoDB here: https://github.com/soywiz/realworld-kotlin

EDIT: @AndreasVolkmann did you finished it? Maybe we can merge efforts.

Andreas Volkmann · Answer 5 · Tue Jun 26 2018 00:07:35 GMT+0800 (China Standard Time)

@soywiz Hi there, no it's not finished. Mainly I am waiting for the optional auth feature before proceeding. I see you build it manually in your repo.

Is your's feature complete yet? Of course we can / should merge.
One thing that I would change in your setup is the use of Mongo.
I use an in-memory H2 DB which makes it lighter and easier to try out locally, because you do not have to install any db.

Carlos Ballesteros Velasco · Answer 6 · Tue Jun 26 2018 20:32:52 GMT+0800 (China Standard Time)

@AndreasVolkmann Nice. FYI: We have just released 0.9.3 that supports optional authentication.

Andreas Volkmann · Answer 7 · Wed Jun 27 2018 23:32:29 GMT+0800 (China Standard Time)

@soywiz Yeah I saw it 👍 Great job by the way.
Again, is you version feature complete yet?
I see no reason to maintain two separate repos.
We have a couple of options afaik:

Merge your code into my project
Deprecate my project and use yours from now on

Carlos Ballesteros Velasco · Answer 8 · Thu Jun 28 2018 05:10:28 GMT+0800 (China Standard Time)

My version is feature complete as far as I know, but it's a bit quick and dirty and needs reviewing and a bit polishing.

Using h2 to not have external dependencies is a good idea for people to use it, but I also think that using another readical different db engine like mongodb provides value to show another way of doing things.
I think that realworld won't require too much effort maintaining once it is done and people could contribute to the implementation.

My proposal would be to complete your version and publish it, and maybe, later, add a folder with another possible implementation using mongodb?

Anish Karandikar · Answer 9 · Wed Aug 22 2018 02:16:22 GMT+0800 (China Standard Time)

@AndreasVolkmann @soywiz did we settle on a final merged version of this repo? If so could we get this building on TravisCI. It really helps get rid of system dependent hacks and gets everyone on the same page. Thanks!

Carlos Ballesteros Velasco · Answer 10 · Wed Aug 22 2018 18:37:50 GMT+0800 (China Standard Time)

Nothing new from my side. But my proposal is still to finish the H2 version, and once it is published explore options.
@AndreasVolkmann I can help you finish your implementation if you don't have enough time, and if you are accepting PRs

Andreas Volkmann · Answer 11 · Sun Aug 26 2018 17:18:52 GMT+0800 (China Standard Time)

@anishkny @soywiz
I am on vacation at the moment and will be moving shortly afterwards, so not a lot of time on my hands. PRs are welcome.

Sourabh · Answer 12 · Tue Jun 18 2019 15:31:59 GMT+0800 (China Standard Time)

@AndreasVolkmann
Is this still alive? I am planning to build it from scratch for learning purposes.

Andreas Volkmann · Answer 13 · Wed Jun 19 2019 00:09:37 GMT+0800 (China Standard Time)

@dragneelfps please go ahead. I am not working on this anymore.

Sourabh · Answer 14 · Wed Jun 19 2019 02:36:34 GMT+0800 (China Standard Time)

Hi, I have started working on it.
https://github.com/dragneelfps/realworld-kotlin-ktor
@AndreasVolkmann can you update the top post status so that it reflect that I am working on it. It will be helpful for people reading this issue.

Sourabh · Answer 15 · Thu Jun 20 2019 20:24:45 GMT+0800 (China Standard Time)

I have completed the features as per the API spec. But there might be things that I overlooked so I'll do revisions if needed. Also, any PR is welcome.
I need to do documentation about the stuff the backend is built on, in the readme and some in code, though it mostly is self explanatory.
If someone can review my code, so we can move forward.

Sourabh · Answer 16 · Sun Jun 23 2019 17:03:14 GMT+0800 (China Standard Time)

Any update? Its out of wip

Anish Karandikar · Answer 17 · Sun Jun 23 2019 22:21:27 GMT+0800 (China Standard Time)

Could you run the API tests given in this repo (/api folder). Also could you add some CI service on your repo (eg TravisCI). Thanks!

Sourabh · Answer 18 · Sun Jun 23 2019 22:29:17 GMT+0800 (China Standard Time)

@anishkny ~~the tests in the postman collection mentions "celebs" but in the API spec there is not mention of that. Are both, API spec and postman updated? I followed the API spec in my code.~~
I ran the tests after fixing my code for failing tests. Following is the output:

[sourabh@sourabh-pc` api_tests]$ env APIURL=http://localhost:8080/api ./run-api-tests.sh > api-tests-output.txt
+++ dirname ./run-api-tests.sh
++ cd .
++ pwd
+ SCRIPTDIR=/home/sourabh/IdeaProjects/Realworld/api_tests
+ APIURL=http://localhost:8080/api
++ date +%s
+ USERNAME=u1561310429
+ EMAIL=u1561310429@mail.com
+ PASSWORD=password
+ npx newman run /home/sourabh/IdeaProjects/Realworld/api_tests/Conduit.postman_collection.json --delay-request 500 --global-var APIURL=http://localhost:8080/api --global-var USERNAME=u1561310429 --global-var EMAIL=u1561310429@mail.com --global-var PASSWORD=password
npx: installed 152 in 2.793s

newman

Conduit

❏ Auth
↳ Register
  POST http://localhost:8080/api/users [200 OK, 487B, 58ms]
  ✓  Response contains "user" property
  ✓  User has "email" property
  ✓  User has "username" property
  ✓  User has "bio" property
  ✓  User has "image" property
  ✓  User has "token" property

↳ Login
  POST http://localhost:8080/api/users/login [200 OK, 487B, 11ms]
  ✓  Response contains "user" property
  ✓  User has "email" property
  ✓  User has "username" property
  ✓  User has "bio" property
  ✓  User has "image" property
  ✓  User has "token" property

↳ Login and Remember Token
  POST http://localhost:8080/api/users/login [200 OK, 487B, 12ms]
  ✓  Response contains "user" property
  ✓  User has "email" property
  ✓  User has "username" property
  ✓  User has "bio" property
  ✓  User has "image" property
  ✓  User has "token" property
  ✓  Global variable "token" has been set

↳ Current User
  GET http://localhost:8080/api/user [200 OK, 346B, 9ms]
  ✓  Response contains "user" property
  ✓  User has "email" property
  ✓  User has "username" property
  ✓  User has "bio" property
  ✓  User has "image" property
  ✓  User has "token" property

↳ Update User
  PUT http://localhost:8080/api/user [200 OK, 487B, 15ms]
  ✓  Response contains "user" property
  ✓  User has "email" property
  ✓  User has "username" property
  ✓  User has "bio" property
  ✓  User has "image" property
  ✓  User has "token" property

❏ Articles
↳ All Articles
  GET http://localhost:8080/api/articles [200 OK, 247B, 7ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  articlesCount is 0 when feed is empty

↳ Articles by Author
  GET http://localhost:8080/api/articles?author=johnjacob [200 OK, 247B, 10ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  articlesCount is 0 when feed is empty

↳ Articles Favorited by Username
  GET http://localhost:8080/api/articles?favorited=jane [200 OK, 247B, 10ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  articlesCount is 0 when feed is empty

↳ Articles by Tag
  GET http://localhost:8080/api/articles?tag=dragons [200 OK, 247B, 11ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  articlesCount is 0 when feed is empty

❏ Articles, Favorite, Comments
↳ Create Article
  POST http://localhost:8080/api/articles [200 OK, 700B, 13ms]
  ✓  Response contains "article" property
  ✓  Article has "title" property
  ✓  Article has "slug" property
  ✓  Article has "body" property
  ✓  Article has "createdAt" property
  ✓  Article's "createdAt" property is an ISO 8601 timestamp
  ✓  Article has "updatedAt" property
  ✓  Article's "updatedAt" property is an ISO 8601 timestamp
  ✓  Article has "description" property
  ✓  Article has "tagList" property
  ✓  Article's "tagList" property is an Array
  ✓  Article has "author" property
  ✓  Article has "favorited" property
  ✓  Article has "favoritesCount" property
  ✓  favoritesCount is an integer

↳ Feed
  GET http://localhost:8080/api/articles/feed [200 OK, 247B, 8ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  articlesCount is 0 when feed is empty

↳ All Articles
  GET http://localhost:8080/api/articles [200 OK, 728B, 9ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  Article has "title" property
  ✓  Article has "slug" property
  ✓  Article has "body" property
  ✓  Article has "createdAt" property
  ✓  Article's "createdAt" property is an ISO 8601 timestamp
  ✓  Article has "updatedAt" property
  ✓  Article's "updatedAt" property is an ISO 8601 timestamp
  ✓  Article has "description" property
  ✓  Article has "tagList" property
  ✓  Article's "tagList" property is an Array
  ✓  Article has "author" property
  ✓  Article has "favorited" property
  ✓  Article has "favoritesCount" property
  ✓  favoritesCount is an integer

↳ All Articles with auth
  GET http://localhost:8080/api/articles [200 OK, 728B, 12ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  Article has "title" property
  ✓  Article has "slug" property
  ✓  Article has "body" property
  ✓  Article has "createdAt" property
  ✓  Article's "createdAt" property is an ISO 8601 timestamp
  ✓  Article has "updatedAt" property
  ✓  Article's "updatedAt" property is an ISO 8601 timestamp
  ✓  Article has "description" property
  ✓  Article has "tagList" property
  ✓  Article's "tagList" property is an Array
  ✓  Article has "author" property
  ✓  Article has "favorited" property
  ✓  Article has "favoritesCount" property
  ✓  favoritesCount is an integer

↳ Articles by Author
  GET http://localhost:8080/api/articles?author=u1561310429 [200 OK, 728B, 10ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  Article has "title" property
  ✓  Article has "slug" property
  ✓  Article has "body" property
  ✓  Article has "createdAt" property
  ✓  Article's "createdAt" property is an ISO 8601 timestamp
  ✓  Article has "updatedAt" property
  ✓  Article's "updatedAt" property is an ISO 8601 timestamp
  ✓  Article has "description" property
  ✓  Article has "tagList" property
  ✓  Article's "tagList" property is an Array
  ✓  Article has "author" property
  ✓  Article has "favorited" property
  ✓  Article has "favoritesCount" property
  ✓  favoritesCount is an integer

↳ Articles by Author with auth
  GET http://localhost:8080/api/articles?author=u1561310429 [200 OK, 728B, 13ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  Article has "title" property
  ✓  Article has "slug" property
  ✓  Article has "body" property
  ✓  Article has "createdAt" property
  ✓  Article's "createdAt" property is an ISO 8601 timestamp
  ✓  Article has "updatedAt" property
  ✓  Article's "updatedAt" property is an ISO 8601 timestamp
  ✓  Article has "description" property
  ✓  Article has "tagList" property
  ✓  Article's "tagList" property is an Array
  ✓  Article has "author" property
  ✓  Article has "favorited" property
  ✓  Article has "favoritesCount" property
  ✓  favoritesCount is an integer

↳ Articles Favorited by Username
  GET http://localhost:8080/api/articles?favorited=jane [200 OK, 247B, 7ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  articlesCount is 0 when feed is empty

↳ Articles Favorited by Username with auth
  GET http://localhost:8080/api/articles?favorited=jane [200 OK, 247B, 8ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  articlesCount is 0 when feed is empty

↳ Single Article by slug
  GET http://localhost:8080/api/articles/how-to-train-your-dragon [200 OK, 700B, 8ms]
  ✓  Response contains "article" property
  ✓  Article has "title" property
  ✓  Article has "slug" property
  ✓  Article has "body" property
  ✓  Article has "createdAt" property
  ✓  Article's "createdAt" property is an ISO 8601 timestamp
  ✓  Article has "updatedAt" property
  ✓  Article's "updatedAt" property is an ISO 8601 timestamp
  ✓  Article has "description" property
  ✓  Article has "tagList" property
  ✓  Article's "tagList" property is an Array
  ✓  Article has "author" property
  ✓  Article has "favorited" property
  ✓  Article has "favoritesCount" property
  ✓  favoritesCount is an integer

↳ Articles by Tag
  GET http://localhost:8080/api/articles?tag=dragons [200 OK, 728B, 10ms]
  ✓  Response code is 200 OK
  ✓  Response contains "articles" property
  ✓  Response contains "articlesCount" property
  ✓  articlesCount is an integer
  ✓  Article has "title" property
  ✓  Article has "slug" property
  ✓  Article has "body" property
  ✓  Article has "createdAt" property
  ✓  Article's "createdAt" property is an ISO 8601 timestamp
  ✓  Article has "updatedAt" property
  ✓  Article's "updatedAt" property is an ISO 8601 timestamp
  ✓  Article has "description" property
  ✓  Article has "tagList" property
  ✓  Article's "tagList" property is an Array
  ✓  Article has "author" property
  ✓  Article has "favorited" property
  ✓  Article has "favoritesCount" property
  ✓  favoritesCount is an integer

↳ Update Article
  PUT http://localhost:8080/api/articles/how-to-train-your-dragon [200 OK, 700B, 12ms]
  ✓  Response contains "article" property
  ✓  Article has "title" property
  ✓  Article has "slug" property
  ✓  Article has "body" property
  ✓  Article has "createdAt" property
  ✓  Article's "createdAt" property is an ISO 8601 timestamp
  ✓  Article has "updatedAt" property
  ✓  Article's "updatedAt" property is an ISO 8601 timestamp
  ✓  Article has "description" property
  ✓  Article has "tagList" property
  ✓  Article's "tagList" property is an Array
  ✓  Article has "author" property
  ✓  Article has "favorited" property
  ✓  Article has "favoritesCount" property
  ✓  favoritesCount is an integer

↳ Favorite Article
  POST http://localhost:8080/api/articles/how-to-train-your-dragon/favorite [200 OK, 699B, 14ms]
  ✓  Response contains "article" property
  ✓  Article has "title" property
  ✓  Article has "slug" property
  ✓  Article has "body" property
  ✓  Article has "createdAt" property
  ✓  Article's "createdAt" property is an ISO 8601 timestamp
  ✓  Article has "updatedAt" property
  ✓  Article's "updatedAt" property is an ISO 8601 timestamp
  ✓  Article has "description" property
  ✓  Article has "tagList" property
  ✓  Article's "tagList" property is an Array
  ✓  Article has "author" property
  ✓  Article has "favorited" property
  ✓  Article's 'favorited' property is true
  ✓  Article has "favoritesCount" property
  ✓  favoritesCount is an integer
  ✓  Article's 'favoritesCount' property is greater than 0

↳ Unfavorite Article
  DELETE http://localhost:8080/api/articles/how-to-train-your-dragon/favorite [200 OK, 700B, 12ms]
  ✓  Response contains "article" property
  ✓  Article has "title" property
  ✓  Article has "slug" property
  ✓  Article has "body" property
  ✓  Article has "createdAt" property
  ✓  Article's "createdAt" property is an ISO 8601 timestamp
  ✓  Article has "updatedAt" property
  ✓  Article's "updatedAt" property is an ISO 8601 timestamp
  ✓  Article has "description" property
  ✓  Article has "tagList" property
  ✓  Article's "tagList" property is an Array
  ✓  Article has "author" property
  ✓  Article has "favorited" property
  ✓  Article has "favoritesCount" property
  ✓  favoritesCount is an integer
  ✓  Article's "favorited" property is false

↳ Create Comment for Article
  POST http://localhost:8080/api/articles/how-to-train-your-dragon/comments [200 OK, 500B, 11ms]
  ✓  Response contains "comment" property
  ✓  Comment has "id" property
  ✓  Comment has "body" property
  ✓  Comment has "createdAt" property
  ✓  "createdAt" property is an ISO 8601 timestamp
  ✓  Comment has "updatedAt" property
  ✓  "updatedAt" property is an ISO 8601 timestamp
  ✓  Comment has "author" property

↳ All Comments for Article
  GET http://localhost:8080/api/articles/how-to-train-your-dragon/comments [200 OK, 505B, 8ms]
  ✓  Response code is 200 OK
  ✓  Response contains "comments" property
  ✓  Comment has "id" property
  ✓  Comment has "body" property
  ✓  Comment has "createdAt" property
  ✓  "createdAt" property is an ISO 8601 timestamp
  ✓  Comment has "updatedAt" property
  ✓  "updatedAt" property is an ISO 8601 timestamp
  ✓  Comment has "author" property

↳ Delete Comment for Article
  DELETE http://localhost:8080/api/articles/how-to-train-your-dragon/comments/5 [200 OK, 154B, 9ms]

↳ Delete Article
  DELETE http://localhost:8080/api/articles/how-to-train-your-dragon [200 OK, 154B, 12ms]

❏ Profiles
↳ Register Celeb
  POST http://localhost:8080/api/users [200 OK, 499B, 10ms]
  ✓  Response contains "user" property
  ✓  User has "email" property
  ✓  User has "username" property
  ✓  User has "bio" property
  ✓  User has "image" property
  ✓  User has "token" property

↳ Profile
  GET http://localhost:8080/api/profiles/celeb_u1561310429 [200 OK, 324B, 12ms]
  ✓  Response code is 200 OK
  ✓  Response contains "profile" property
  ✓  Profile has "username" property
  ✓  Profile has "bio" property
  ✓  Profile has "image" property
  ✓  Profile has "following" property

↳ Follow Profile
  POST http://localhost:8080/api/profiles/celeb_u1561310429/follow [200 OK, 323B, 14ms]
  ✓  Response code is 200 OK
  ✓  Response contains "profile" property
  ✓  Profile has "username" property
  ✓  Profile has "bio" property
  ✓  Profile has "image" property
  ✓  Profile has "following" property
  ✓  Profile's "following" property is true

↳ Unfollow Profile
  DELETE http://localhost:8080/api/profiles/celeb_u1561310429/follow [200 OK, 324B, 19ms]
  ✓  Response code is 200 OK
  ✓  Response contains "profile" property
  ✓  Profile has "username" property
  ✓  Profile has "bio" property
  ✓  Profile has "image" property
  ✓  Profile has "following" property
  ✓  Profile's "following" property is false

❏ Tags
↳ All Tags
  GET http://localhost:8080/api/tags [200 OK, 242B, 9ms]
  ✓  Response code is 200 OK
  ✓  Response contains "tags" property
  ✓  "tags" property returned as array

┌─────────────────────────┬──────────────────┬─────────────────┐
│                         │         executed │          failed │
├─────────────────────────┼──────────────────┼─────────────────┤
│              iterations │                1 │               0 │
├─────────────────────────┼──────────────────┼─────────────────┤
│                requests │               31 │               0 │
├─────────────────────────┼──────────────────┼─────────────────┤
│            test-scripts │               46 │               0 │
├─────────────────────────┼──────────────────┼─────────────────┤
│      prerequest-scripts │               17 │               0 │
├─────────────────────────┼──────────────────┼─────────────────┤
│              assertions │              280 │               0 │
├─────────────────────────┴──────────────────┴─────────────────┤
│ total run duration: 16.8s                                    │
├──────────────────────────────────────────────────────────────┤
│ total data received: 7.81KB (approx)                         │
├──────────────────────────────────────────────────────────────┤
│ average response time: 12ms [min: 7ms, max: 58ms, s.d.: 8ms] │
└──────────────────────────────────────────────────────────────┘

Is this good?

Anish Karandikar · Answer 19 · Mon Jun 24 2019 01:46:18 GMT+0800 (China Standard Time)

Yup looks good! It also helps a lot setting up CI - could you try that next?

Sourabh · Answer 20 · Mon Jun 24 2019 02:23:06 GMT+0800 (China Standard Time)

What kind of CI does need to be set up? For the .sh(postman tests) provided or ktor unit tests?
Edit: I did the setup for Travis which builds and runs ktor tests.

Sourabh · Answer 21 · Thu Jun 27 2019 11:01:56 GMT+0800 (China Standard Time)

Any update?

Anish Karandikar · Answer 22 · Thu Jun 27 2019 11:15:56 GMT+0800 (China Standard Time)

Hey why was build #3 cancelled? That had Postman tests correct?

Sourabh · Answer 23 · Thu Jun 27 2019 11:20:48 GMT+0800 (China Standard Time)

#3
was cancelled because the .travis.yaml configuration was wrong. I need help setting up configuration for postman test. My problem is how to run the server, run the .sh test and then stop the server gracefully.

Anish Karandikar · Answer 24 · Sat Aug 03 2019 05:35:56 GMT+0800 (China Standard Time)

Hmm. How about :

script:
  - ./gradlew test build
  - ./gradlew run &    ## <---- notice ampersand
  - ./postman_tests/run-api-tests.sh
  - ./gradlew --stop

Sourabh · Answer 25 · Sat Aug 10 2019 01:22:18 GMT+0800 (China Standard Time)

@anishkny thank you for your input. It works now. If there is nothing more to do, I think this repo is ready to be included in the realworld.io project.

Anish Karandikar · Answer 26 · Sat Aug 10 2019 01:52:03 GMT+0800 (China Standard Time)

great! LGTM PTAL @Cameron-C-Chapman

Sourabh · Answer 27 · Sun Aug 11 2019 01:06:45 GMT+0800 (China Standard Time)

@anishkny should I create a PR to add the repo link to README or someone else will update the README?