tmcgilchrist / airship Goto Github PK

View Code? Open in Web Editor NEW

245.0 37.0 14.0 338 KB

Helium + Webmachine = Airship. A toolkit for building declarative, RESTful web apps.

Home Page: http://tmcgilchrist.github.io/airship/

Haskell 100.00%

haskell webmachine github-actions

airship's People

Contributors

Stargazers

Watchers

Forkers

silky argv0 mgsloan gitter-badger errorific patrickt kellymclaughlin missingfaktor digits88 happy-ferret ericnething isabella232

airship's Issues

Implement Charset negotiation

https://github.com/helium/airship/blob/master/src/Airship/Internal/Decision.hs#L320-L324

Implement generateETag resource function

And associated decision point G11.

Improve 'boolean blind' resource return types

Resource functions like serviceAvailable, allowMissingPost, and forbidden (there are more) should be updated to return specific types like data ServiceAvailable = Available | Unavailable, so that users don't have to think about the meaning of a particular boolean.

Ensure compilation on GHC 7.10.x

Add cookie-handling functions

Allow wildcard Content-Type matching

Currently you have to provide a Content-Type if you want the processPost function ever to engage a * or unprovided Content-Type. Need to fix this for an API endpoint.

Move example executable into its own cabal file

Making Airship-Trace an optional header?

It's possibly not a good idea to alway provide this header for services, exposing extra information about how the server is making decisions about what to return back.

There's 2 good solutions to make this optional:

Pass some configuration option into resourceToWai and toWaiResponse
Provide some wai middleware that strips off the header

Which option would you favour as the suggested solution for Airship?
Have you run into something similar with using Airship for applications?

Happy to provide some code or examples for both options.

Implement Encoding negotiation

https://github.com/helium/airship/blob/master/src/Airship/Internal/Decision.hs#L339-L342

Build failure with GHC 8

> /tmp/stackage-build8$ stack unpack airship-0.5.0
Unpacked airship-0.5.0 to /tmp/stackage-build8/airship-0.5.0/
> /tmp/stackage-build8/airship-0.5.0$ runghc -clear-package-db -global-package-db -package-db=/home/stackage/work/builds/nightly/pkgdb Setup configure --package-db=clear --package-db=global --package-db=/home/stackage/work/builds/nightly/pkgdb --libdir=/home/stackage/work/builds/nightly/lib --bindir=/home/stackage/work/builds/nightly/bin --datadir=/home/stackage/work/builds/nightly/share --libexecdir=/home/stackage/work/builds/nightly/libexec --sysconfdir=/home/stackage/work/builds/nightly/etc --docdir=/home/stackage/work/builds/nightly/doc/airship-0.5.0 --htmldir=/home/stackage/work/builds/nightly/doc/airship-0.5.0 --haddockdir=/home/stackage/work/builds/nightly/doc/airship-0.5.0 --flags=
Configuring airship-0.5.0...
> /tmp/stackage-build8/airship-0.5.0$ runghc -clear-package-db -global-package-db -package-db=/home/stackage/work/builds/nightly/pkgdb Setup build
Building airship-0.5.0...
Preprocessing library airship-0.5.0...
[ 1 of 13] Compiling Airship.Internal.Date ( src/Airship/Internal/Date.hs, dist/build/Airship/Internal/Date.o )
[ 2 of 13] Compiling Airship.Types    ( src/Airship/Types.hs, dist/build/Airship/Types.o )
[ 3 of 13] Compiling Airship.Internal.Parsers ( src/Airship/Internal/Parsers.hs, dist/build/Airship/Internal/Parsers.o )
[ 4 of 13] Compiling Airship.Headers  ( src/Airship/Headers.hs, dist/build/Airship/Headers.o )
[ 5 of 13] Compiling Airship.Resource ( src/Airship/Resource.hs, dist/build/Airship/Resource.o )

src/Airship/Resource.hs:131:58: error:
    • Couldn't match type ‘forall a. Maybe a’ with ‘Maybe ETag’
      Expected type: Webmachine m (Maybe ETag)
        Actual type: Webmachine m (forall a. Maybe a)
    • In the ‘generateETag’ field of a record
      In the expression:
        Resource
          {allowMissingPost = return False,
           allowedMethods = return [methodOptions, methodGet, methodHead],
           contentTypesAccepted = return [],
           contentTypesProvided = return [("text/html", halt status405)],
           deleteCompleted = return False, deleteResource = return False,
           entityTooLarge = return False, forbidden = return False,
           generateETag = return Nothing, implemented = return True,
           isAuthorized = return True, isConflict = return False,
           knownContentType = return True, lastModified = return Nothing,
           languageAvailable = return True, malformedRequest = return False,
           movedPermanently = return Nothing,
           movedTemporarily = return Nothing, multipleChoices = return False,
           patchContentTypesAccepted = return [],
           previouslyExisted = return False,
           processPost = return (PostProcess []),
           resourceExists = return True, serviceAvailable = return True,
           uriTooLong = return False, validContentHeaders = return True}
      In an equation for ‘defaultResource’:
          defaultResource
            = Resource
                {allowMissingPost = return False,
                 allowedMethods = return [methodOptions, methodGet, ....],
                 contentTypesAccepted = return [],
                 contentTypesProvided = return [("text/html", halt status405)],
                 deleteCompleted = return False, deleteResource = return False,
                 entityTooLarge = return False, forbidden = return False,
                 generateETag = return Nothing, implemented = return True,
                 isAuthorized = return True, isConflict = return False,
                 knownContentType = return True, lastModified = return Nothing,
                 languageAvailable = return True, malformedRequest = return False,
                 movedPermanently = return Nothing,
                 movedTemporarily = return Nothing, multipleChoices = return False,
                 patchContentTypesAccepted = return [],
                 previouslyExisted = return False,
                 processPost = return (PostProcess []),
                 resourceExists = return True, serviceAvailable = return True,
                 uriTooLong = return False, validContentHeaders = return True}

src/Airship/Resource.hs:136:58: error:
    • Couldn't match type ‘forall a. Maybe a’ with ‘Maybe UTCTime’
      Expected type: Webmachine m (Maybe UTCTime)
        Actual type: Webmachine m (forall a. Maybe a)
    • In the ‘lastModified’ field of a record
      In the expression:
        Resource
          {allowMissingPost = return False,
           allowedMethods = return [methodOptions, methodGet, methodHead],
           contentTypesAccepted = return [],
           contentTypesProvided = return [("text/html", halt status405)],
           deleteCompleted = return False, deleteResource = return False,
           entityTooLarge = return False, forbidden = return False,
           generateETag = return Nothing, implemented = return True,
           isAuthorized = return True, isConflict = return False,
           knownContentType = return True, lastModified = return Nothing,
           languageAvailable = return True, malformedRequest = return False,
           movedPermanently = return Nothing,
           movedTemporarily = return Nothing, multipleChoices = return False,
           patchContentTypesAccepted = return [],
           previouslyExisted = return False,
           processPost = return (PostProcess []),
           resourceExists = return True, serviceAvailable = return True,
           uriTooLong = return False, validContentHeaders = return True}
      In an equation for ‘defaultResource’:
          defaultResource
            = Resource
                {allowMissingPost = return False,
                 allowedMethods = return [methodOptions, methodGet, ....],
                 contentTypesAccepted = return [],
                 contentTypesProvided = return [("text/html", halt status405)],
                 deleteCompleted = return False, deleteResource = return False,
                 entityTooLarge = return False, forbidden = return False,
                 generateETag = return Nothing, implemented = return True,
                 isAuthorized = return True, isConflict = return False,
                 knownContentType = return True, lastModified = return Nothing,
                 languageAvailable = return True, malformedRequest = return False,
                 movedPermanently = return Nothing,
                 movedTemporarily = return Nothing, multipleChoices = return False,
                 patchContentTypesAccepted = return [],
                 previouslyExisted = return False,
                 processPost = return (PostProcess []),
                 resourceExists = return True, serviceAvailable = return True,
                 uriTooLong = return False, validContentHeaders = return True}

src/Airship/Resource.hs:139:58: error:
    • Couldn't match type ‘forall a. Maybe a’ with ‘Maybe ByteString’
      Expected type: Webmachine m (Maybe ByteString)
        Actual type: Webmachine m (forall a. Maybe a)
    • In the ‘movedPermanently’ field of a record
      In the expression:
        Resource
          {allowMissingPost = return False,
           allowedMethods = return [methodOptions, methodGet, methodHead],
           contentTypesAccepted = return [],
           contentTypesProvided = return [("text/html", halt status405)],
           deleteCompleted = return False, deleteResource = return False,
           entityTooLarge = return False, forbidden = return False,
           generateETag = return Nothing, implemented = return True,
           isAuthorized = return True, isConflict = return False,
           knownContentType = return True, lastModified = return Nothing,
           languageAvailable = return True, malformedRequest = return False,
           movedPermanently = return Nothing,
           movedTemporarily = return Nothing, multipleChoices = return False,
           patchContentTypesAccepted = return [],
           previouslyExisted = return False,
           processPost = return (PostProcess []),
           resourceExists = return True, serviceAvailable = return True,
           uriTooLong = return False, validContentHeaders = return True}
      In an equation for ‘defaultResource’:
          defaultResource
            = Resource
                {allowMissingPost = return False,
                 allowedMethods = return [methodOptions, methodGet, ....],
                 contentTypesAccepted = return [],
                 contentTypesProvided = return [("text/html", halt status405)],
                 deleteCompleted = return False, deleteResource = return False,
                 entityTooLarge = return False, forbidden = return False,
                 generateETag = return Nothing, implemented = return True,
                 isAuthorized = return True, isConflict = return False,
                 knownContentType = return True, lastModified = return Nothing,
                 languageAvailable = return True, malformedRequest = return False,
                 movedPermanently = return Nothing,
                 movedTemporarily = return Nothing, multipleChoices = return False,
                 patchContentTypesAccepted = return [],
                 previouslyExisted = return False,
                 processPost = return (PostProcess []),
                 resourceExists = return True, serviceAvailable = return True,
                 uriTooLong = return False, validContentHeaders = return True}

src/Airship/Resource.hs:140:58: error:
    • Couldn't match type ‘forall a. Maybe a’ with ‘Maybe ByteString’
      Expected type: Webmachine m (Maybe ByteString)
        Actual type: Webmachine m (forall a. Maybe a)
    • In the ‘movedTemporarily’ field of a record
      In the expression:
        Resource
          {allowMissingPost = return False,
           allowedMethods = return [methodOptions, methodGet, methodHead],
           contentTypesAccepted = return [],
           contentTypesProvided = return [("text/html", halt status405)],
           deleteCompleted = return False, deleteResource = return False,
           entityTooLarge = return False, forbidden = return False,
           generateETag = return Nothing, implemented = return True,
           isAuthorized = return True, isConflict = return False,
           knownContentType = return True, lastModified = return Nothing,
           languageAvailable = return True, malformedRequest = return False,
           movedPermanently = return Nothing,
           movedTemporarily = return Nothing, multipleChoices = return False,
           patchContentTypesAccepted = return [],
           previouslyExisted = return False,
           processPost = return (PostProcess []),
           resourceExists = return True, serviceAvailable = return True,
           uriTooLong = return False, validContentHeaders = return True}
      In an equation for ‘defaultResource’:
          defaultResource
            = Resource
                {allowMissingPost = return False,
                 allowedMethods = return [methodOptions, methodGet, ....],
                 contentTypesAccepted = return [],
                 contentTypesProvided = return [("text/html", halt status405)],
                 deleteCompleted = return False, deleteResource = return False,
                 entityTooLarge = return False, forbidden = return False,
                 generateETag = return Nothing, implemented = return True,
                 isAuthorized = return True, isConflict = return False,
                 knownContentType = return True, lastModified = return Nothing,
                 languageAvailable = return True, malformedRequest = return False,
                 movedPermanently = return Nothing,
                 movedTemporarily = return Nothing, multipleChoices = return False,
                 patchContentTypesAccepted = return [],
                 previouslyExisted = return False,
                 processPost = return (PostProcess []),
                 resourceExists = return True, serviceAvailable = return True,
                 uriTooLong = return False, validContentHeaders = return True}

Build with cryptohash 0.11.7

Currently the .cabal file specifies cryptohash ==0.11.6.*

Correctly set response headers like ETag and Last modified

Add travis-ci (or equivalent) spec

Add handler to catch exceptions within/during the decision tree

I'm thinking it'd be something like

uncaughtException :: SomeException -> Handler s m ()

which would then be used in an invocation of catch during the decision tree's evalState call.

Add Lens' w/out depending on Lens

https://github.com/ekmett/lens/wiki/How-can-I-write-lenses-without-depending-on-lens%3F

No good way to handle PATCH requests

Right now, having a resource that responds to both GET and PATCH requests is difficult. We need to institute a processPatch function that operates on principles similar to processPost.

No wildcard support in contentTypesProvided

I had a resource defined with:

contentTypesProvided = return [("*/*", return Empty)]

But airship was unable to handle it. Any requests with specific Accept headers resulted in 406 Not Acceptable being returned. The only case where it would work is if I passed along the exact string */*.

I think what should happen is that regardless of the value of the Accept header this should match and execute the function.

Convert O(n) routing to trie-based routing.

Should be a fun little exercise.

Partial function fromJust used in Decision.hs

Would be good to remove the use of partial functions like fromJust from the Decision module and anywhere else really.

Don't have the time right now to dig into it, but flagging as something to do.

I haven't looked into it deeply but I assume;

wai / warp is catching those errors and presenting something sensible 500 error
the reason they're like that is it's impossible to reach that point in the web machine state without that header. Would be good to enforce this via types.

Per Resource State

The current setup has a single State type, if you choose to use it, across all resources. So you end up with a State type that knows about all the various resources and what they want to store. Plus when you put or ask for the State, you need to know about the other values. Clearly not ideal.
e.g.

data State = State { resource1 :: Text, resource2 :: Int }

Ideally each resource would have private state, which got run per-resource. I've got no specific ideas right now, suggestions welcome.

Question about Handler s m types on Resource

This is more a query about the types of allowedMethods, contentTypesAccepted [1] and possibly contentTypesProvided. At the moment each of them is wrapped in a Handler s m a. I'm wondering why they can't just be say Bool or [(MediaType, Handler s m ())]. It doesn't seem like you'd want either of them to dynamic or perhaps I'm missing a use-case where you do.

We are thinking if they're not wrapped in Handler s m a we could generate nice API docs from each of the resources.

[1]https://github.com/helium/airship/blob/master/src/Airship/Resource.hs#L37-L46

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.