onasty/web/src/Effect.elm(view raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 |
module Effect exposing
( Effect
, none, batch
, sendCmd, sendMsg
, pushRoute, replaceRoute
, pushRoutePath, replaceRoutePath
, loadExternalUrl, back
, sendApiRequest, refreshTokens
, sendToClipboard
, signin, logout, saveUser, clearUser
, map, toCmd
)
{-|
@docs Effect
@docs none, batch
@docs sendCmd, sendMsg
@docs pushRoute, replaceRoute
@docs pushRoutePath, replaceRoutePath
@docs loadExternalUrl, back
@docs sendApiRequest, refreshTokens
@docs sendToClipboard
@docs signin, logout, saveUser, clearUser
@docs map, toCmd
-}
import Api
import Auth.User
import Browser.Navigation
import Data.Credentials exposing (Credentials)
import Data.Error
import Dict exposing (Dict)
import Http
import Json.Decode
import Json.Encode
import Ports
import Route
import Route.Path
import Shared.Model
import Shared.Msg
import Task
import Url exposing (Url)
type Effect msg
= -- BASICS
None
| Batch (List (Effect msg))
| SendCmd (Cmd msg)
-- ROUTING
| PushUrl String
| ReplaceUrl String
| LoadExternalUrl String
| Back
-- SHARED
| SendSharedMsg Shared.Msg.Msg
| SendToLocalStorage { key : String, value : Json.Encode.Value }
| SendToClipboard String
| SendApiRequest (HttpRequestDetails msg)
type alias HttpRequestDetails msg =
{ endpoint : String
, method : String
, body : Http.Body
, decoder : Json.Decode.Decoder msg
, onHttpError : Api.Error -> msg
}
-- BASICS
{-| Don't send any effect.
-}
none : Effect msg
none =
None
{-| Send multiple effects at once.
-}
batch : List (Effect msg) -> Effect msg
batch =
Batch
{-| Send a normal `Cmd msg` as an effect, something like `Http.get` or `Random.generate`.
-}
sendCmd : Cmd msg -> Effect msg
sendCmd =
SendCmd
{-| Send a message as an effect. Useful when emitting events from UI components.
-}
sendMsg : msg -> Effect msg
sendMsg msg =
Task.succeed msg
|> Task.perform identity
|> SendCmd
-- ROUTING
{-| Set the new route, and make the back button go back to the current route.
-}
pushRoute :
{ path : Route.Path.Path
, query : Dict String String
, hash : Maybe String
}
-> Effect msg
pushRoute route =
PushUrl (Route.toString route)
{-| Same as `Effect.pushRoute`, but without `query` or `hash` support
-}
pushRoutePath : Route.Path.Path -> Effect msg
pushRoutePath path =
PushUrl (Route.Path.toString path)
{-| Set the new route, but replace the previous one, so clicking the back
button **won't** go back to the previous route.
-}
replaceRoute :
{ path : Route.Path.Path
, query : Dict String String
, hash : Maybe String
}
-> Effect msg
replaceRoute route =
ReplaceUrl (Route.toString route)
{-| Same as `Effect.replaceRoute`, but without `query` or `hash` support
-}
replaceRoutePath : Route.Path.Path -> Effect msg
replaceRoutePath path =
ReplaceUrl (Route.Path.toString path)
{-| Redirect users to a new URL, somewhere external to your web application.
-}
loadExternalUrl : String -> Effect msg
loadExternalUrl =
LoadExternalUrl
{-| Navigate back one page
-}
back : Effect msg
back =
Back
-- SHARED
sendApiRequest :
{ endpoint : String
, method : String
, body : Http.Body
, decoder : Json.Decode.Decoder value
, onResponse : Result Api.Error value -> msg
}
-> Effect msg
sendApiRequest opts =
SendApiRequest
{ endpoint = opts.endpoint
, method = opts.method
, body = opts.body
, onHttpError = \e -> opts.onResponse (Err e)
, decoder =
opts.decoder
|> Json.Decode.map Ok
|> Json.Decode.map opts.onResponse
}
sendToClipboard : String -> Effect msg
sendToClipboard text =
SendToClipboard text
refreshTokens : Effect msg
refreshTokens =
SendSharedMsg Shared.Msg.TriggerTokenRefresh
signin : Credentials -> Effect msg
signin credentials =
SendSharedMsg (Shared.Msg.SignedIn credentials)
logout : Effect msg
logout =
SendSharedMsg Shared.Msg.Logout
saveUser : String -> String -> Effect msg
saveUser accessToken refreshToken =
batch
[ SendToLocalStorage { key = "access_token", value = Json.Encode.string accessToken }
, SendToLocalStorage { key = "refresh_token", value = Json.Encode.string refreshToken }
]
clearUser : Effect msg
clearUser =
batch
[ SendToLocalStorage { key = "access_token", value = Json.Encode.null }
, SendToLocalStorage { key = "refresh_token", value = Json.Encode.null }
]
-- INTERNALS
{-| Elm Land depends on this function to connect pages and layouts
together into the overall app.
-}
map : (msg1 -> msg2) -> Effect msg1 -> Effect msg2
map fn effect =
case effect of
None ->
None
Batch list ->
Batch (List.map (map fn) list)
SendCmd cmd ->
SendCmd (Cmd.map fn cmd)
PushUrl url ->
PushUrl url
ReplaceUrl url ->
ReplaceUrl url
Back ->
Back
LoadExternalUrl url ->
LoadExternalUrl url
SendSharedMsg sharedMsg ->
SendSharedMsg sharedMsg
SendToLocalStorage options ->
SendToLocalStorage options
SendToClipboard text ->
SendToClipboard text
SendApiRequest opts ->
SendApiRequest
{ endpoint = opts.endpoint
, method = opts.method
, body = opts.body
, decoder = Json.Decode.map fn opts.decoder
, onHttpError = \err -> fn (opts.onHttpError err)
}
{-| Elm Land depends on this function to perform your effects.
-}
toCmd :
{ key : Browser.Navigation.Key
, url : Url
, shared : Shared.Model.Model
, fromSharedMsg : Shared.Msg.Msg -> msg
, batch : List msg -> msg
, toCmd : msg -> Cmd msg
}
-> Effect msg
-> Cmd msg
toCmd options effect =
case effect of
None ->
Cmd.none
Batch list ->
Cmd.batch (List.map (toCmd options) list)
SendCmd cmd ->
cmd
PushUrl url ->
Browser.Navigation.pushUrl options.key url
ReplaceUrl url ->
Browser.Navigation.replaceUrl options.key url
Back ->
Browser.Navigation.back options.key 1
LoadExternalUrl url ->
Browser.Navigation.load url
SendSharedMsg sharedMsg ->
Task.succeed sharedMsg
|> Task.perform options.fromSharedMsg
SendToLocalStorage opts ->
Ports.sendToLocalStorage opts
SendToClipboard text ->
Ports.sendToClipboard text
SendApiRequest opts ->
let
headers : List Http.Header
headers =
case options.shared.user of
Auth.User.SignedIn cred ->
if not (String.contains opts.endpoint "refresh-tokens") then
[ Http.header "Authorization" ("Bearer " ++ cred.accessToken) ]
else
[]
_ ->
[]
in
Http.request
{ method = opts.method
, url = opts.endpoint
, headers = headers
, body = opts.body
, expect =
Http.expectStringResponse
(\httpResult ->
case httpResult of
Ok msg ->
msg
Err err ->
opts.onHttpError err
)
(\resp -> fromHttpResponseToCustomError opts.decoder resp)
, timeout = Just (1000 * 60) -- 60 second timeout
, tracker = Nothing
}
fromHttpResponseToCustomError : Json.Decode.Decoder msg -> Http.Response String -> Result Api.Error msg
fromHttpResponseToCustomError decoder response =
case response of
Http.GoodStatus_ _ body ->
case
Json.Decode.decodeString decoder
(if String.isEmpty body then
"\"\""
else
body
)
of
Ok value ->
Ok value
Err err ->
Err (Api.JsonDecodeError { message = "Failed to decode response", reason = err })
Http.BadStatus_ { statusCode } body ->
case Json.Decode.decodeString Data.Error.decode body of
Ok err ->
Err (Api.HttpError { message = err.message, reason = Http.BadStatus statusCode })
Err err ->
Err (Api.JsonDecodeError { message = "Failed to decode response", reason = err })
Http.BadUrl_ url ->
Err (Api.HttpError { message = "Unexpected URL format", reason = Http.BadUrl url })
Http.Timeout_ ->
Err (Api.HttpError { message = "Request timed out, please try again", reason = Http.Timeout })
Http.NetworkError_ ->
Err (Api.HttpError { message = "Could not connect, please try again", reason = Http.NetworkError })
|