master..7a6c433 · typeable/request-track

README.orgdeleted−18

since splitsnapshots

unifiedsplit

@@ -1,18 +0,0 @@

1−#+TITLE: Request tracking framework

2−#+AUTHOR: Nick <nick@typeable.io>

3−

4−* Mechanism

5−

6−See [[https://github.com/typeable/technical_notes/blob/master/Request%20Tracking/Tracking.org][this note]] for the mechanism description.

7−

8−* Lower-level API

9−

10−~request-track~ library provides WAI primitives to handle the passed headers. At the very least you would want to use ~echoMiddleware~ in order to send back the tracking headers in every HTTP reply.

11−

12−* Servant API

13−

14−~request-track-servant~ provides combinators to use with Servant. See the haddock documentation for more info.

15−

16−* Example server

17−

18−~example-server~ directory contains a simple HTTP server that uses all this stuff.

request-track-servant/request-track-servant.cabal+1−9

@@ -11,11 +11,6 @@ maintainer: nick@typeable.io

11category: Web

12build-type: Simple

13

14−flag openapi

15− description: Enable openapi instances

16− default: False

17− manual: True

18−

19common warnings

14common warnings

20 ghc-options: -Wall

15 ghc-options: -Wall

21

16

@@ -23,6 +18,7 @@ library

23 import: warnings

18 import: warnings

24 exposed-modules: Web.Tracking.Servant

19 exposed-modules: Web.Tracking.Servant

25 other-modules: Web.Tracking.Servant.Types

20 other-modules: Web.Tracking.Servant.Types

21+ -- other-extensions:

26 build-depends: base >=4.14.0.0 && < 5,

22 build-depends: base >=4.14.0.0 && < 5,

27 bytestring >= 0.11,

23 bytestring >= 0.11,

28 containers >= 0.6,

24 containers >= 0.6,

@@ -32,9 +28,5 @@ library

32 servant-client-core >= 0.19,

28 servant-client-core >= 0.19,

33 servant-server >= 0.19,

29 servant-server >= 0.19,

34 wai >= 3.2

30 wai >= 3.2

35− if flag(openapi)

36− other-modules: Web.Tracking.Servant.OpenAPI

37− build-depends: servant-openapi3

38− cpp-options: -DOPENAPI

39 hs-source-dirs: src

31 hs-source-dirs: src

40 default-language: GHC2021

32 default-language: GHC2021

request-track-servant/src/Web/Tracking/Servant.hs−4

@@ -1,8 +1,4 @@

1−{-# LANGUAGE CPP #-}

2module Web.Tracking.Servant (module Export) where

1module Web.Tracking.Servant (module Export) where

3

2

4import Web.Tracking as Export (ReqtrackInfo(..))

3import Web.Tracking as Export (ReqtrackInfo(..))

5import Web.Tracking.Servant.Types as Export

4import Web.Tracking.Servant.Types as Export

6−#ifdef OPENAPI

7−import Web.Tracking.Servant.OpenAPI as Export ()

8−#endif

request-track-servant/src/Web/Tracking/Servant/OpenAPI.hsdeleted−14

@@ -1,14 +0,0 @@

1−{-# OPTIONS_GHC -Wno-orphans #-}

2−module Web.Tracking.Servant.OpenAPI where

3−

4−import Web.Tracking.Servant.Types (RequestTracking, RequestTracking_)

5−

6−import Data.Proxy

7−import Servant.API

8−import Servant.OpenApi

9−

10−instance HasOpenApi api => HasOpenApi (RequestTracking :> api) where

11− toOpenApi _ = toOpenApi (Proxy :: Proxy api)

12−

13−instance HasOpenApi api => HasOpenApi (RequestTracking_ :> api) where

14− toOpenApi _ = toOpenApi (Proxy :: Proxy api)

stack.yaml+1−5

@@ -1,4 +1,4 @@

1−resolver: lts-21.6

1+resolver: lts-20.26

2

3packages:

4- example-server

@@ -11,7 +11,3 @@ extra-deps:

11

12nix:

13 packages: [ zlib ]

14−

15−flags:

16− request-track-servant:

17− openapi: true