Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add TopLayer layer at the top of every stack #737

Merged
merged 4 commits into from
Aug 1, 2021
Merged

Add TopLayer layer at the top of every stack #737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d38d8c8
Add `TopLayer` layer at the top of every stack
christopher-dG Jul 31, 2021
991ad7f
Update tests
christopher-dG Jul 31, 2021
e8ad3ce
Export TopLayer
christopher-dG Jul 31, 2021
04c3832
Fix tests one more time
christopher-dG Jul 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "HTTP"
uuid = "cd3eb016-35fb-5094-929b-558a96fad6f3"
authors = ["Jacob Quinn", "Sam O'Connor", "contributors: https://github.com/JuliaWeb/HTTP.jl/graphs/contributors"]
version = "0.9.12"
version = "0.9.13"

[deps]
Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
Expand Down
13 changes: 8 additions & 5 deletions src/HTTP.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module HTTP
export startwrite, startread, closewrite, closeread, stack, insert, insert_default!,
remove_default!, AWS4AuthLayer, BasicAuthLayer, CanonicalizeLayer, ConnectionPoolLayer,
ContentTypeDetectionLayer, DebugLayer, ExceptionLayer, MessageLayer, RedirectLayer,
RetryLayer, StreamLayer, TimeoutLayer,
RetryLayer, StreamLayer, TimeoutLayer, TopLayer,
@logfmt_str, common_logfmt, combined_logfmt

const DEBUG_LEVEL = Ref(0)
Expand Down Expand Up @@ -441,6 +441,7 @@ Shorthand for `HTTP.request("DELETE", ...)`. See [`HTTP.request`](@ref).
"""
delete(a...; kw...) = request("DELETE", a...; kw...)

include("TopRequest.jl"); using .TopRequest
include("RedirectRequest.jl"); using .RedirectRequest
include("BasicAuthRequest.jl"); using .BasicAuthRequest
include("AWS4AuthRequest.jl"); using .AWS4AuthRequest
Expand Down Expand Up @@ -492,7 +493,9 @@ relationship with [`HTTP.Response`](@ref), [`HTTP.Parsers`](@ref),
│ ────────────────────────── └─────────▲─────────┘ │ │ │
│ ║ ║ │ │
│ ┌────────────────────────────────────────────────────────────┐ │ │ │
│ │ request(RedirectLayer, method, ::URI, ::Headers, body) │ │ │
│ │ request(TopLayer, method, ::URI, ::Headers, body) │ │ │
│ ├────────────────────────────────────────────────────────────┤ │ │ │
│ │ request(BasicAuthLayer, method, ::URI, ::Headers, body) │ │ │
│ ├────────────────────────────────────────────────────────────┤ │ │ │
│ │ request(BasicAuthLayer, method, ::URI, ::Headers, body) │ │ │
│ ├────────────────────────────────────────────────────────────┤ │ │ │
Expand Down Expand Up @@ -581,8 +584,8 @@ function stack(;redirect=true,
kw...)

NoLayer = Union

stack = (redirect ? RedirectLayer : NoLayer){
stack = TopLayer{
(redirect ? RedirectLayer : NoLayer){
BasicAuthLayer{
(detect_content_type ? ContentTypeDetectionLayer : NoLayer){
(cookies === true || (cookies isa AbstractDict && !isempty(cookies)) ?
Expand All @@ -597,7 +600,7 @@ function stack(;redirect=true,
DEBUG_LEVEL[] >= 3 ? DebugLayer : NoLayer){
(readtimeout > 0 ? TimeoutLayer : NoLayer){
StreamLayer{Union{}}
}}}}}}}}}}}}
}}}}}}}}}}}}}

reduce(Layers.EXTRA_LAYERS; init=stack) do stack, (before, custom)
insert(stack, before, custom)
Expand Down
18 changes: 18 additions & 0 deletions src/TopRequest.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
module TopRequest

import ..Layer, ..request

export TopLayer

"""
request(TopLayer, args...; kwargs...)

This layer is at the top of every stack, and does nothing.
It's useful for inserting a custom layer at the top of the stack.
"""
abstract type TopLayer{Next <: Layer} <: Layer{Next} end

request(::Type{TopLayer{Next}}, args...; kwargs...) where Next =
request(Next, args...; kwargs...)

end
10 changes: 5 additions & 5 deletions test/insert_layers.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ using ..TestRequest

@testset "HTTP Stack Inserting" begin
@testset "Insert - Beginning" begin
expected = TestLayer{RedirectLayer{BasicAuthLayer{MessageLayer{RetryLayer{ExceptionLayer{ConnectionPoolLayer{StreamLayer{Union{}}}}}}}}}
result = insert(stack(), RedirectLayer, TestLayer)
expected = TestLayer{TopLayer{RedirectLayer{BasicAuthLayer{MessageLayer{RetryLayer{ExceptionLayer{ConnectionPoolLayer{StreamLayer{Union{}}}}}}}}}}
result = insert(stack(), TopLayer, TestLayer)

@test expected == result
end

@testset "Insert - Middle" begin
expected = RedirectLayer{BasicAuthLayer{MessageLayer{RetryLayer{TestLayer{ExceptionLayer{ConnectionPoolLayer{StreamLayer{Union{}}}}}}}}}
expected = TopLayer{RedirectLayer{BasicAuthLayer{MessageLayer{RetryLayer{TestLayer{ExceptionLayer{ConnectionPoolLayer{StreamLayer{Union{}}}}}}}}}}
result = insert(stack(), ExceptionLayer, TestLayer)

@test expected == result
end

@testset "Insert - End" begin
expected = RedirectLayer{BasicAuthLayer{MessageLayer{RetryLayer{ExceptionLayer{ConnectionPoolLayer{StreamLayer{TestLayer{Union{}}}}}}}}}
expected = TopLayer{RedirectLayer{BasicAuthLayer{MessageLayer{RetryLayer{ExceptionLayer{ConnectionPoolLayer{StreamLayer{TestLayer{Union{}}}}}}}}}}
result = insert(stack(), Union{}, TestLayer)

@test expected == result
Expand All @@ -31,7 +31,7 @@ using ..TestRequest
@testset "Insert - Multiple Same layer" begin
test_stack = insert(stack(), RetryLayer, ExceptionLayer)

expected = RedirectLayer{BasicAuthLayer{MessageLayer{TestLayer{ExceptionLayer{RetryLayer{ExceptionLayer{ConnectionPoolLayer{StreamLayer{Union{}}}}}}}}}}
expected = TopLayer{RedirectLayer{BasicAuthLayer{MessageLayer{TestLayer{ExceptionLayer{RetryLayer{ExceptionLayer{ConnectionPoolLayer{StreamLayer{Union{}}}}}}}}}}}
result = insert(test_stack, ExceptionLayer, TestLayer)

@test expected == result
Expand Down