SWIFT-876 Implement more complex example Vapor application #493

kmahar · 2020-06-01T04:48:51Z

Implements the application laid out in the recent scope/design doc.

I'm definitely not following best web dev practices on the frontend stuff here, but the aim of this application is really to demonstrate the backend, so I think that's fine. I put a disclaimer in the README that the app is not production-ready and the HTML/js is not following best practices. That said if you think I've done anything glaringly bad that is easy to fix, let me know.

Examples/ComplexVaporExample/Package.swift

kmahar · 2020-06-01T04:52:48Z

Examples/ComplexVaporExample/Resources/Views/kitten.leaf

+<a href="/">Home</a>
+<div id="error-info"></div>
+
+<script type="text/javascript">


TIL (or maybe I used to know this, but I'd long forgotten) that you can't use a form to send a DELETE or PATCH request, so I had to break out the jQuery here to exercise those code paths. sigh.

Examples/ComplexVaporExample/Sources/App/Kitten.swift

codecov-commenter · 2020-06-01T05:03:30Z

Codecov Report

Merging #493 into master will increase coverage by 0.62%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #493      +/-   ##
==========================================
+ Coverage   76.96%   77.59%   +0.62%     
==========================================
  Files         125      128       +3     
  Lines       12994    14641    +1647     
==========================================
+ Hits        10001    11360    +1359     
- Misses       2993     3281     +288

Impacted Files	Coverage Δ
Sources/MongoSwift/ChangeStream.swift	`25.33% <0.00%> (-5.32%)`	⬇️
...estRunner/TestOperations/TestOperationResult.swift	`34.33% <0.00%> (-2.43%)`	⬇️
Sources/MongoSwift/ConnectionPool.swift	`59.09% <0.00%> (-1.89%)`	⬇️
Sources/MongoSwift/MongoClient.swift	`86.10% <0.00%> (-1.00%)`	⬇️
Sources/MongoSwift/MongoCursor.swift	`100.00% <0.00%> (ø)`
Tests/MongoSwiftTests/AuthTests.swift	`100.00% <0.00%> (ø)`
Sources/MongoSwiftSync/ChangeStream.swift	`0.00% <0.00%> (ø)`
Sources/MongoSwift/BSON/Overwritable.swift	`100.00% <0.00%> (ø)`
...ts/MongoSwiftTests/ReadWriteConcernSpecTests.swift	`100.00% <0.00%> (ø)`
Sources/MongoSwift/BSON/BSONUtil.swift	`30.76% <0.00%> (ø)`
... and 19 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f00cb40...2d02e0a. Read the comment docs.

kmahar · 2020-06-01T15:59:57Z

Examples/ComplexVaporExample/Package.swift

+    dependencies: [
+        .package(url: "https://github.com/vapor/vapor", .upToNextMajor(from: "4.7.0")),
+        .package(url: "https://github.com/vapor/leaf", .exact("4.0.0-rc.1.2")),
+        .package(url: "https://github.com/mongodb/mongo-swift-driver", .branch("master"))


this should be updated to 1.0.0 before merging but I am leaving it on master now while in development

nbbeeken

Looks good, I don't think this is an issue on our end but when I go to ctrl-c the app it hangs for a bit and then I get:

2020-06-01T12:43:40-0400 error: Could not stop HTTP server: Abort(identifier: "500", status: NIOHTTP1.HTTPResponseStatus.internalServerError, headers: , reason: "Server stop took too long.", source: Vapor.ErrorSource(file: "/Users/neal/code/drivers/swift/mongo-swift-driver/Examples/ComplexVaporExample/.build/checkouts/vapor/Sources/Vapor/HTTP/Server/HTTPServer.swift", function: "close()", line: 310, column: 31, range: nil))
ERROR: Cannot schedule tasks on an EventLoop that has already shut down. This will be upgraded to a forced crash in future SwiftNIO versions.

nbbeeken · 2020-06-01T16:21:28Z

Examples/ComplexVaporExample/README.md

+
+This is a fully asynchronous application. At its core is [SwiftNIO](https://github.com/apple/swift-nio), which is used to implement both Vapor and the MongoDB driver.
+
+The application is a basic HTTP server combined with a minimal frontend, which supports storing a list of kittens and details about them. The application provides examples of various common CRUD operations through its HTTP endpointsS:


nit: endpoints

nbbeeken · 2020-06-01T16:34:20Z

Examples/ComplexVaporExample/Sources/App/routes.swift

+        return collection.findOne(idFilter)
+            // Hop to ensure that the final response future happens on the request's event loop.
+            .hop(to: req.eventLoop)
+            .unwrap(or: Abort(.notFound, reason: "No kitten with matching ID")


nit: missing paren? )

good catch, I must have deleted that somehow before committing 😅

nbbeeken · 2020-06-01T16:35:13Z

Examples/ComplexVaporExample/Sources/App/routes.swift

+        }
+        .flatMapErrorThrowing { error in
+            // Give a more helpful error message in case of a duplicate key error.
+            if let err = error as? MongoSwift.WriteError, err.writeFailure?.code == 11000 {


nit: MongoSwift.MongoError.WriteError

good catch, that wasn't merged yet when I started working on this and I hadn't pulled in the new changes!

kmahar

yeah I am having that shutdown issue as well, even with a totally blank template app that doesn't use the driver. not sure what's up with it 🤔

kmahar · 2020-06-01T17:05:02Z

Examples/ComplexVaporExample/README.md

+
+This is a fully asynchronous application. At its core is [SwiftNIO](https://github.com/apple/swift-nio), which is used to implement both Vapor and the MongoDB driver.
+
+The application is a basic HTTP server combined with a minimal frontend, which supports storing a list of kittens and details about them. The application provides examples of various common CRUD operations through its HTTP endpointsS:


kmahar · 2020-06-01T17:05:53Z

Examples/ComplexVaporExample/Sources/App/routes.swift

+        return collection.findOne(idFilter)
+            // Hop to ensure that the final response future happens on the request's event loop.
+            .hop(to: req.eventLoop)
+            .unwrap(or: Abort(.notFound, reason: "No kitten with matching ID")


good catch, I must have deleted that somehow before committing 😅

kmahar · 2020-06-01T17:09:27Z

Examples/ComplexVaporExample/Sources/App/routes.swift

+        }
+        .flatMapErrorThrowing { error in
+            // Give a more helpful error message in case of a duplicate key error.
+            if let err = error as? MongoSwift.WriteError, err.writeFailure?.code == 11000 {


good catch, that wasn't merged yet when I started working on this and I hadn't pulled in the new changes!

patrickfreed

looks good, just have a few suggestions

patrickfreed · 2020-06-01T22:49:27Z

Examples/ComplexVaporExample/README.md

+
+This is a fully asynchronous application. At its core is [SwiftNIO](https://github.com/apple/swift-nio), which is used to implement both Vapor and the MongoDB driver.
+
+The application is a basic HTTP server combined with a minimal frontend, which supports storing a list of kittens and details about them. The application provides examples of various common CRUD operations through its HTTP endpoints:


I think one of the last two sentences was meant to be omitted.

whoops, condensed

patrickfreed · 2020-06-02T16:48:59Z

Examples/ComplexVaporExample/README.md

+This application is a basic HTTP server built using [Vapor](vapor.codes). The server will handle the following types of requests:
+1. A GET request at the root URL `/` loads the main index page containing a list of kittens.
+1. A POST request at the root URL `/` adds a new kitten.
+1. A GET request at the URL `/kittens/{_id}` loads information about the kitten with the specified MongoDB `_id`.


since we have a unique index on the names, I think it might be preferable to use them for URLs. they'll look much nicer in the server log and in the browser header having the kitten's names instead of a long hexstring.

good point. done

Code looks good, but this prose section still needs to be updated to reflect the changes.

Examples/ComplexVaporExample/Resources/Views/kitten.leaf

Examples/ComplexVaporExample/README.md

patrickfreed · 2020-06-02T18:08:04Z

When starting up the application, it gives an error when trying to get the favicon. It would clean up the log a little bit (and make the tab a little cuter in the browse) if we could use a royalty-free kitten favicon.

kmahar · 2020-06-03T02:12:23Z

hmmm, I'm not seeing the favicon error. what browser are you using?

patrickfreed

When I start up the server and load the page, I see the following logs:

[ NOTICE ] Server starting on http://127.0.0.1:8080
[ INFO ] GET /
[ INFO ] GET /favicon.ico
[ ERROR ] Not Found

From looking at the docs, it looks like it would need to go in the Public directory. The favicon itself kind of a surface level thing, but I think the [ ERROR ] in the logs might distract users.

patrickfreed · 2020-06-03T15:39:27Z

Examples/ComplexVaporExample/README.md

+This application is a basic HTTP server built using [Vapor](vapor.codes). The server will handle the following types of requests:
+1. A GET request at the root URL `/` loads the main index page containing a list of kittens.
+1. A POST request at the root URL `/` adds a new kitten.
+1. A GET request at the URL `/kittens/{_id}` loads information about the kitten with the specified MongoDB `_id`.


Code looks good, but this prose section still needs to be updated to reflect the changes.

Examples/ComplexVaporExample/Sources/App/routes.swift

kmahar

added favicon

kmahar · 2020-06-03T18:32:22Z

Examples/ComplexVaporExample/README.md

+This application is a basic HTTP server built using [Vapor](vapor.codes). The server will handle the following types of requests:
+1. A GET request at the root URL `/` loads the main index page containing a list of kittens.
+1. A POST request at the root URL `/` adds a new kitten.
+1. A GET request at the URL `/kittens/{_id}` loads information about the kitten with the specified MongoDB `_id`.


Examples/ComplexVaporExample/Sources/App/routes.swift

patrickfreed

favicon is very cute 🐱

lgtm!

kmahar · 2020-06-03T19:19:44Z

credits to @nbbeeken for finding it 🙂

kmahar added 5 commits May 28, 2020 13:07

Create app template

caf7056

wip

6a95f5a

done-ish

f8cee25

format/lint

fac58f5

Update kitten.leaf

999baf4

kmahar requested review from nbbeeken and patrickfreed June 1, 2020 04:49

kmahar commented Jun 1, 2020

View reviewed changes

nbbeeken suggested changes Jun 1, 2020

View reviewed changes

kmahar commented Jun 1, 2020

View reviewed changes

nbbeeken approved these changes Jun 1, 2020

View reviewed changes

kmahar added 2 commits June 1, 2020 17:51

address comments

a31bde4

format

fd2636b

patrickfreed reviewed Jun 2, 2020

View reviewed changes

address comments mod favicon

1d4fd46

patrickfreed reviewed Jun 3, 2020

View reviewed changes

kmahar added 2 commits June 3, 2020 14:29

add favicon

00f2b3e

address comments

b9dd4a6

kmahar commented Jun 3, 2020

View reviewed changes

patrickfreed approved these changes Jun 3, 2020

View reviewed changes

Update driver dependency version

2d02e0a

kmahar merged commit facf2ee into master Jun 3, 2020

kmahar deleted the SWIFT-876/example-app branch June 3, 2020 19:21


		This is a fully asynchronous application. At its core is [SwiftNIO](https://github.com/apple/swift-nio), which is used to implement both Vapor and the MongoDB driver.

		The application is a basic HTTP server combined with a minimal frontend, which supports storing a list of kittens and details about them. The application provides examples of various common CRUD operations through its HTTP endpointsS:

SWIFT-876 Implement more complex example Vapor application #493

SWIFT-876 Implement more complex example Vapor application #493

Uh oh!

Conversation

kmahar commented Jun 1, 2020

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov-commenter commented Jun 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nbbeeken 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!

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!

kmahar 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!

patrickfreed 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!

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!

Uh oh!

Uh oh!

Uh oh!

patrickfreed commented Jun 2, 2020

Uh oh!

kmahar commented Jun 3, 2020

Uh oh!

patrickfreed left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kmahar left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

patrickfreed left a comment

Choose a reason for hiding this comment

Uh oh!

kmahar commented Jun 3, 2020

Uh oh!

Reviewers

codecov-commenter commented Jun 1, 2020 •

edited

Loading