urbit/pkg/arvo/tests/sys/vane/eyre.hoon

/+  *test
/=  eyre-raw  /sys/vane/eyre
::
!:
::
=/  test-pit=vase  !>(..zuse)
=/  eyre-gate  (eyre-raw test-pit)
=/  eyre-id  '~.eyre_0v4.elsnk.20412.0h04v.50lom.5lq0o'
::
|%
++  test-init
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::
  results1
::
++  test-duplicate-bindings
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::  app1 binds successfully
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
      call-args=[duct=~[/app1] ~ [%connect [~ /] %app1]]
      expected-moves=[duct=~[/app1] %give %bound %.y [~ /]]~
    ==
  ::  app2 tries to bind to the same path and fails
  ::
  =^  results3  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.3
      scry=scry-provides-code
      call-args=[duct=~[/app2] ~ [%connect [~ /] %app2]]
      expected-moves=[duct=~[/app2] %give %bound %.n [~ /]]~
    ==
  ::
  ;:  weld
    results1
    results2
    results3
  ==
::
++  test-remove-binding
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::  app1 binds successfully
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
      call-args=[duct=~[/app1] ~ [%connect [~ /] %app1]]
      expected-moves=[duct=~[/app1] %give %bound %.y [~ /]]~
    ==
  ::  app1 unbinds
  ::
  =^  results3  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.3
      scry=scry-provides-code
      call-args=[duct=~[/app1] ~ [%disconnect [~ /]]]
      expected-moves=~
    ==
  ::  app2 binds successfully
  ::
  =^  results4  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.4
      scry=scry-provides-code
      call-args=[duct=~[/app2] ~ [%connect [~ /] %app2]]
      expected-moves=[duct=~[/app2] %give %bound %.y [~ /]]~
    ==
  ::
  ;:  weld
    results1
    results2
    results3
    results4
  ==
::
++  test-host-matching
  ;:  weld
  ::
    %+  expect-eq
      !>(%.y)
      !>((host-matches:eyre-gate ~ `'example.com'))
  ::
    %+  expect-eq
      !>(%.y)
      !>((host-matches:eyre-gate ~ ~))
  ::
    %+  expect-eq
      !>(%.n)
      !>((host-matches:eyre-gate `'example.com' ~))
  ::
    %+  expect-eq
      !>(%.y)
      !>((host-matches:eyre-gate `'example.com' `'example.com'))
  ::
    %+  expect-eq
      !>(%.n)
      !>((host-matches:eyre-gate `'example.com' `'blah.com'))
  ==
::
++  test-cant-remove-other-ducts-binding
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::  app1 binds successfully
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
      call-args=[duct=~[/app1] ~ [%connect [~ /] %app1]]
      expected-moves=[duct=~[/app1] %give %bound %.y [~ /]]~
    ==
  ::  app2 tries to steal the binding by disconnecting the path
  ::
  =^  results3  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.3
      scry=scry-provides-code
      call-args=[duct=~[/app2] ~ [%disconnect [~ /]]]
      expected-moves=~
    ==
  ::  app2 doesn't bind successfully because it couldn't remove app1's binding
  ::
  =^  results4  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.4
      scry=scry-provides-code
      call-args=[duct=~[/app2] ~ [%connect [~ /] %app2]]
      expected-moves=[duct=~[/app2] %give %bound %.n [~ /]]~
    ==
  ::
  ;:  weld
    results1
    results2
    results3
    results4
  ==
::  tests that when we have no match, that we fall back to the built-in 404
::
++  test-builtin-four-oh-four
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::  when there's no configuration and nothing matches, expect 404
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-blah]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            [%'GET' '/' ~ ~]
        ==
      ^=  expectec-moves
        ^-  (list move:eyre-gate)
        :~  :*  duct=~[/http-blah]
                %give
                %response
                %start
              ::
                %+  complete-http-start-event
                  :-  404
                  ['content-type' 'text/html']~
                [~ (error-page:eyre-gate 404 %.n '/' ~)]
        ==  ==
    ==
  ::
  ;:  weld
    results1
    results2
  ==
::
++  test-basic-app-request
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::  app1 binds successfully
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
      call-args=[duct=~[/app1] ~ [%connect [~ /] %app1]]
      expected-moves=[duct=~[/app1] %give %bound %.y [~ /]]~
    ==
  ::  outside requests a path that app1 has bound to
  ::
  =^  results3  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=~1111.1.3
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-blah]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            [%'GET' '/' ~ ~]
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([* * ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        ::
        =/  move-1=move:eyre-gate  i.moves
        =/  move-2=move:eyre-gate  i.t.moves
        ::
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-1))
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-2))
        ::
        %+  weld
          %+  expect-gall-deal
            :+  /watch-response/[eyre-id]
              [~nul ~nul]
            :*  %app1  %watch
                /http-response/[eyre-id]
            ==
          card.move-1
        ::
        %+  expect-gall-deal
          :+  /run-app-request/[eyre-id]  [~nul ~nul]
              :*  %app1  %poke  %handle-http-request
                  !>([eyre-id %.n %.n [%ipv4 .192.168.1.1] [%'GET' '/' ~ ~]])
              ==
          card.move-2
    ==
    ::  theoretical outside response
    ::
    =^  results4  eyre-gate
      %-  eyre-take  :*
        eyre-gate
        now=~1111.1.4
        scry=scry-provides-code
        ^=  take-args
          :*  wire=/watch-response/[eyre-id]  duct=~[/http-blah]
              ^-  (hypo sign:eyre-gate)
              :-  *type
              :*  %g  %unto  %fact
                  %http-response-header
                  !>([200 ['content-type' 'text/html']~])
              ==
           ==
        ^=  expected-move
          :~  :*  duct=~[/http-blah]  %give  %response
                  [%start [200 ['content-type' 'text/html']~] ~ %.n]
      ==  ==  ==

  ;:  weld
    results1
    results2
    results3
  ::  results4
  ==
::
++  test-app-error
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::  app1 binds successfully
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
      call-args=[duct=~[/app1] ~ [%connect [~ /] %app1]]
      expected-moves=[duct=~[/app1] %give %bound %.y [~ /]]~
    ==
  ::  outside requests a path that app1 has bound to
  ::
  =^  results3  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=~1111.1.3
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-blah]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            [%'GET' '/' ~ ~]
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([* * ~] moves)
          [[%leaf "wrong number of moves: {<(lent moves)>}"] >moves< ~]
        ::
        ::
        =/  move-1=move:eyre-gate  i.moves
        =/  move-2=move:eyre-gate  i.t.moves
        ::
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-1))
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-2))
        ::
        %+  weld
          %+  expect-gall-deal
            :+  /watch-response/[eyre-id]
              [~nul ~nul]
            :*  %app1  %watch
                /http-response/[eyre-id]
            ==
          card.move-1
        ::
        %+  expect-gall-deal
          :+  /run-app-request/[eyre-id]
            [~nul ~nul]
          :*  %app1  %poke  %handle-http-request
              !>([eyre-id %.n %.n [%ipv4 .192.168.1.1] [%'GET' '/' ~ ~]])
          ==
        card.move-2
    ==
  ::  the poke fails. we should relay this to the client
  ::
  =^  results4  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=~1111.1.4
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/run-app-request/app1  duct=~[/http-blah]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            :*  %g  %unto  %poke-ack  ~
                :~  [%leaf "/~zod/...../app1:<[1 1].[1 20]>"]
            ==  ==
         ==
      ^=  expected-move
        :~  :*  duct=~[/http-blah]  %pass
                /watch-response/[eyre-id]
                %g  %deal  [~nul ~nul]  %app1  %leave  ~
            ==
          ::
            :*  duct=~[/http-blah]  %give  %response
                %start
              ::
                %+  complete-http-start-event
                  :-  500
                  ['content-type' 'text/html']~
                [~ (internal-server-error:eyre-gate %.n '/' ~)]
    ==  ==  ==
  ::
  ;:  weld
    results1
    results2
    results3
    results4
  ==
::
++  test-multipart-app-request
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::  app1 binds successfully
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
      call-args=[duct=~[/app1] ~ [%connect [~ /] %app1]]
      expected-moves=[duct=~[/app1] %give %bound %.y [~ /]]~
    ==
  ::  outside requests a path that app1 has bound to
  ::
  =^  results3  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=~1111.1.3
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-blah]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            [%'GET' '/' ~ ~]
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([* * ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        ::
        =/  move-1=move:eyre-gate  i.moves
        =/  move-2=move:eyre-gate  i.t.moves
        ::
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-1))
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-2))
        ::
        %+  weld
          %+  expect-gall-deal
            :+  /watch-response/[eyre-id]
              [~nul ~nul]
            :*  %app1  %watch
                /http-response/[eyre-id]
            ==
          card.move-1
        ::
        %+  expect-gall-deal
          :+  /run-app-request/[eyre-id]  [~nul ~nul]
              :*  %app1  %poke  %handle-http-request
                  !>([eyre-id %.n %.n [%ipv4 .192.168.1.1] [%'GET' '/' ~ ~]])
              ==
          card.move-2
    ==
  ::  theoretical outside response
  ::
  =^  results4  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=~1111.1.4
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/watch-response/[eyre-id]  duct=~[/http-blah]
            ^-  (hypo sign:eyre-gate)  :-  *type
            :*  %g  %unto  %fact
                %http-response-header
                !>([200 ['content-type' 'text/html']~])
            ==
         ==
      ^=  expected-move
        :~  :*  duct=~[/http-blah]  %give  %response
                [%start [200 ['content-type' 'text/html']~] ~ %.n]
    ==  ==  ==
  ::  theoretical outside response
  ::
  =^  results5  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=~1111.1.4
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/watch-response/[eyre-id]  duct=~[/http-blah]
            ^-  (hypo sign:eyre-gate)  :-  *type
            :*  %g  %unto  %fact
                %http-response-data
                !>(`(as-octs:mimes:html 'ya!'))
            ==
         ==
      ^=  expected-move
        :~  :*  duct=~[/http-blah]  %give  %response
                [%continue `[3 'ya!'] %.n]
    ==  ==  ==
  ::
  ;:  weld
    results1
    results2
    results3
    results4
    results5
  ==
::  tests an app redirecting to the login handler, which then receives a post
::  and redirects back to app
::
++  test-login-handler-full-path
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::  app1 binds successfully
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
      call-args=[duct=~[/app1] ~ [%connect [~ /'~landscape'] %app1]]
      expected-moves=[duct=~[/app1] %give %bound %.y [~ /'~landscape']]~
    ==
  ::  outside requests a path that app1 has bound to
  ::
  =^  results3  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=~1111.1.3
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-blah]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            [%'GET' '/~landscape/inner-path' ~ ~]
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([* * ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        ::
        =/  move-1=move:eyre-gate  i.moves
        =/  move-2=move:eyre-gate  i.t.moves
        ::
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-1))
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-2))
        ::
        %+  weld
          %+  expect-gall-deal
            :+  /watch-response/[eyre-id]
              [~nul ~nul]
            :*  %app1  %watch
                /http-response/[eyre-id]
            ==
          card.move-1
        ::
        %+  expect-gall-deal
          :+  /run-app-request/[eyre-id]  [~nul ~nul]
              :*  %app1  %poke  %handle-http-request
                  !>([eyre-id %.n %.n [%ipv4 .192.168.1.1] [%'GET' '/~landscape/inner-path' ~ ~]])
              ==
          card.move-2
    ==
  ::  app then gives a redirect to Eyre
  ::
  =^  results4  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=~1111.1.4
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/watch-response/[eyre-id]  duct=~[/http-blah]
            ^-  (hypo sign:eyre-gate)  :-  *type
            :*  %g  %unto  %fact
                %http-response-header
                !>([303 ['location' '/~/login?redirect=/~landscape/inner-path']~])
            ==
         ==
      ^=  expected-move
        :~  :*  duct=~[/http-blah]  %give  %response
                [%start [303 ['location' '/~/login?redirect=/~landscape/inner-path']~] ~ %.n]
    ==  ==  ==
  ::  the browser then fetches the login page
  ::
  =^  results5  eyre-gate
    %-  perform-authentication  :*
      eyre-gate
      now=~1111.1.5
      scry=scry-provides-code
    ==
  ::  going back to the original url will acknowledge the authentication cookie
  ::
  =^  results6  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=~1111.1.5..1.0.0
      scry=scry-provides-code
      ^=  call-args
        ^-  [=duct type=* wrapped-task=(hobo task:able:eyre-gate)]
        :*  duct=~[/http-blah]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'GET'
            '/~landscape/inner-path'
            ['cookie' cookie-value]~
            ~
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([* * ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        ::
        =/  move-1=move:eyre-gate  i.moves
        =/  move-2=move:eyre-gate  i.t.moves
        ::
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-1))
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-2))
        ::
        %+  weld
          %+  expect-gall-deal
            :+  /watch-response/[eyre-id]
              [~nul ~nul]
            :*  %app1  %watch
                /http-response/[eyre-id]
            ==
          card.move-1
        ::
        ::  expect authenticated=%.y in the handle below
        ::
        %+  expect-gall-deal
          :+  /run-app-request/[eyre-id]  [~nul ~nul]
              :*  %app1  %poke  %handle-http-request
                  !>  :*
                    eyre-id
                    %.y
                    %.n
                    [%ipv4 .192.168.1.1]
                    :*  %'GET'
                        '/~landscape/inner-path'
                        ['cookie' cookie-value]~
                        ~
                  ==  ==
              ==
          card.move-2
    ==
  ::
  ;:  weld
    results1
    results2
    results3
    results4
    results5
    results6
  ==
::
++  test-generator
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::  gen1 binds successfully
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
      call-args=[duct=~[/gen1] ~ [%serve [~ /] [%home /gen/handler/hoon ~]]]
      expected-moves=[duct=~[/gen1] %give %bound %.y [~ /]]~
    ==
  ::  outside requests a path that app1 has bound to
  ::
  =^  results3  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.3
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-blah]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            [%'GET' '/' ~ ~]
        ==
      ^=  expected-moves
      :~  :+  ~[/http-blah]  %give
          [%response %start [404 headers=~] data=~ complete=%.y]
      ==
    ==
  ::
  ;:  weld
    results1
    results2
    results3
  ==
::
++  test-simplified-url-parser
  ;:  weld
    %+  expect-eq
      !>  `[[%site 'localhost'] [~ 8.000]]
      !>  (rush 'localhost:8000' simplified-url-parser:eyre-gate)
  ::
    %+  expect-eq
      !>  `[[%ip .192.168.1.1] ~]
      !>  (rush '192.168.1.1' simplified-url-parser:eyre-gate)
  ==
::
++  test-parse-channel-request
  ;:  weld
    %+  expect-eq
      !>  `[%ack 5]~
      !>  %-  parse-channel-request:eyre-gate
          (need (de-json:html '[{"action": "ack", "event-id": 5}]'))
  ::
    %+  expect-eq
      !>  `[%poke 0 ~nec %app1 %app-type [%n '5']]~
      !>  %-  parse-channel-request:eyre-gate
          %-  need  %-  de-json:html
          '''
          [{"action": "poke",
            "id": 0,
            "ship": "nec",
            "app": "app1",
            "mark": "app-type",
            "json": 5}]
          '''
  ::
    %+  expect-eq
      !>  `[%subscribe 1 ~sampyl-sipnym %hall /this/path]~
      !>  %-  parse-channel-request:eyre-gate
          %-  need  %-  de-json:html
          '''
          [{"action": "subscribe",
            "id": 1,
            "ship": "sampyl-sipnym",
            "app": "hall",
            "path": "/this/path"}]
          '''
  ::
    %+  expect-eq
      !>  `[%unsubscribe 2 1]~
      !>  %-  parse-channel-request:eyre-gate
          %-  need  %-  de-json:html
          '''
          [{"action": "unsubscribe",
            "id": 2,
            "subscription": 1}]
          '''
  ::
      %+  expect-eq
        !>  ~
        !>  %-  parse-channel-request:eyre-gate
            %-  need  %-  de-json:html
            '[{"noaction": "noaction"}]'
  ::
      %+  expect-eq
        !>  ~
        !>  %-  parse-channel-request:eyre-gate
            %-  need  %-  de-json:html
            '[{"action": "bad-action"}]'
  ::
      %+  expect-eq
        !>  ~
        !>  %-  parse-channel-request:eyre-gate
            %-  need  %-  de-json:html
            '[{"action": "ack", "event-id": 5}, {"action": "bad-action"}]'
  ::
      %+  expect-eq
        !>  :-  ~
            :~  [%ack 9]
                [%poke 3 ~bud %wut %wut-type [%a [%n '2'] [%n '1'] ~]]
            ==
        !>  %-  parse-channel-request:eyre-gate
            %-  need  %-  de-json:html
            '''
            [{"action": "ack", "event-id": 9},
             {"action": "poke",
              "id": 3,
              "ship": "bud",
              "app": "wut",
              "mark": "wut-type",
              "json": [2, 1]}]
            '''
  ==
::
++  test-channel-reject-unauthenticated
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-blah]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            [%'PUT' '/~/channel/1234567890abcdef' ~ ~]
        ==
      ^=  expected-moves
        ^-  (list move:eyre-gate)
        :~  :*  duct=~[/http-blah]
                %give
                %response
                %start
              ::
                %+  complete-http-start-event
                  :-  403
                  ['content-type' 'text/html']~
                :-  ~
                %-  error-page:eyre-gate  :*
                  403
                  %.n
                  '/~/channel/1234567890abcdef'
                  ~
                ==
        ==  ==
    ==
  ::
  ;:  weld
    results1
    results2
  ==
::
++  test-channel-open-never-used-expire
  =^  results1  eyre-gate  (perform-init-start-channel eyre-gate *roof)
  ::  the behn timer wakes us up; we cancel our subscription
  ::
  =^  results2  eyre-gate
    %-  eyre-take-with-comparator  :*
      eyre-gate
      now=(add ~1111.1.2 ~h12)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/timeout/'0123456789abcdef'  duct=~[/http-blah]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%b %wake ~]
         ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([^ ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        %+  expect-gall-deal
          :*  /channel/subscription/'0123456789abcdef'/1/~nul/two
              [~nul ~nul]  %two  %leave  ~
          ==
          card.i.moves
    ==
  ::
  ;:  weld
    results1
    results2
  ==
::
++  test-channel-results-before-open
  ::  common initialization
  ::
  =^  results1  eyre-gate  (perform-init-start-channel eyre-gate *roof)
  ::  poke gets a success message
  ::
  =^  results2  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m1)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/poke/'0123456789abcdef'/'0'  duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %poke-ack ~]
         ==
      moves=~
    ==
  ::  subscription gets a success message
  ::
  =^  results3  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m1)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %watch-ack ~]
         ==
      moves=~
    ==
  ::  subscription gets a result
  ::
  =^  results4  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m2)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %fact %json !>(`json`[%a [%n '1'] [%n '2'] ~])]
         ==
      moves=~
    ==
  ::  open up the channel
  ::
  ::  send the channel a poke and a subscription request
  ::
  =^  results5  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=(add ~1111.1.2 ~m3)
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-get-open]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'GET'
            '/~/channel/0123456789abcdef'
            ['cookie' cookie-value]~
            ~
        ==
      ^=  expected-moves
        ^-  (list move:eyre-gate)
        :~  :*  duct=~[/http-get-open]
                %pass
                /channel/heartbeat/'0123456789abcdef'
                [%b %wait ~1111.1.2..00.03.20]
                ==
            :*  duct=~[/http-get-open]
                %give
                %response
                %start
                :-  200
                :~  ['content-type' 'text/event-stream']
                    ['cache-control' 'no-cache']
                    ['connection' 'keep-alive']
                    ['set-cookie' cookie-string]
                ==
              ::
                :-  ~
                %-  as-octs:mimes:html
                '''
                id: 0
                data: {"ok":"ok","id":0,"response":"poke"}

                id: 1
                data: {"ok":"ok","id":1,"response":"subscribe"}

                id: 2
                data: {"json":[1,2],"id":1,"response":"diff"}


                '''
              ::
                complete=%.n
            ==
            ::  opening the channel cancels the timeout timer
            ::
            :*  duct=~[/http-put-request]  %pass
                /channel/timeout/'0123456789abcdef'
                [%b %rest ~1111.1.2..12.00.00]
    ==  ==  ==
  ::  we get a cancel when we notice the client has disconnected
  ::
  =^  results6  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=(add ~1111.1.2 ~m4)
      scry=scry-provides-code
      call-args=[duct=~[/http-get-open] ~ %cancel-request ~]
      ^=  expected-moves
        ^-  (list move:eyre-gate)
        ::  closing the channel cancels the sse heartbeat
        ::  (initialized in results5 above) and restarts the timeout timer
        ::
        :~  :*  duct=~[/http-get-open]  %pass
                /channel/heartbeat/'0123456789abcdef'
                %b  %rest  :(add ~1111.1.2 ~m3 ~s20)
            ==
            :*  duct=~[/http-get-open]  %pass
                /channel/timeout/'0123456789abcdef'
                %b  %wait  :(add ~1111.1.2 ~h12 ~m4)
        ==  ==
    ==
  ::
  ;:  weld
    results1
    results2
    results3
    results4
    results5
    results6
  ==
::
::
++  test-channel-second-get-updates-timer
  ::  common initialization
  ::
  =^  results1  eyre-gate  (perform-init-start-channel eyre-gate *roof)
  ::  perform another poke to a different app
  ::
  ::    Since we haven't connected with a GET, the old timer should be canceled
  ::    and a new one should be set.
  ::  send the channel a poke and a subscription request
  ::
  =^  results2  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=(add ~1111.1.2 ~m1)
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-put-request]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'PUT'
            '/~/channel/0123456789abcdef'
            ['cookie' cookie-value]~
        ::
            :-  ~
            %-  as-octs:mimes:html
            '''
            [{"action": "poke",
              "id": 2,
              "ship": "nul",
              "app": "eight",
              "mark": "a",
              "json": 9}]
            '''
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([^ ^ ^ ^ ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        ;:  weld
          %+  expect-gall-deal
            :*  /channel/poke/'0123456789abcdef'/'2'
                [~nul ~nul]  %eight
                %poke-as  %a  %json  !>([%n '9'])
            ==
            card.i.moves
        ::
          %+  expect-eq
            !>  put-204-response
            !>  i.t.moves
        ::
          %+  expect-eq
            !>  :*  ~[/http-put-request]  %pass
                    /channel/timeout/'0123456789abcdef'
                    %b  %rest  (add ~1111.1.2 ~h12)
                ==
            !>  i.t.t.moves
        ::
          %+  expect-eq
            !>  :*  ~[/http-put-request]  %pass
                    /channel/timeout/'0123456789abcdef'
                    %b  %wait  :(add ~1111.1.2 ~h12 ~m1)
                ==
            !>  i.t.t.t.moves
    ==  ==
  ::
  ;:  weld
    results1
    results2
  ==
::
++  test-channel-unsubscribe-stops-events
  ::  common initialization
  ::
  =^  results1  eyre-gate  (perform-init-start-channel eyre-gate *roof)
  ::  poke gets a success message
  ::
  =^  results2  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m1)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/poke/'0123456789abcdef'/'0'  duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %poke-ack ~]
         ==
      moves=~
    ==
  ::  subscription gets a success message
  ::
  =^  results3  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m2)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %watch-ack ~]
         ==
      moves=~
    ==
  ::  sending an unsubscribe sends an unsubscribe to gall
  ::
  =^  results4  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=(add ~1111.1.2 ~m3)
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-put-request]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'PUT'
            '/~/channel/0123456789abcdef'
            ['cookie' cookie-value]~
        ::
            :-  ~
            %-  as-octs:mimes:html
            '''
            [{"action": "unsubscribe",
              "id": 2,
              "subscription": 1}
            ]
            '''
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([^ ^ ^ ^ ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        ;:  weld
          ::  we want to cancel the subscription id on which we originally subscribed
          ::
          %+  expect-gall-deal
            :*  /channel/subscription/'0123456789abcdef'/'1'/~nul/two
                [~nul ~nul]  %two  %leave  ~
            ==
            card.i.moves
        ::
          %+  expect-eq
            !>  put-204-response
            !>  i.t.moves
        ::
          %+  expect-eq
            !>  :*  ~[/http-put-request]  %pass
                    /channel/timeout/'0123456789abcdef'
                    %b  %rest  (add ~1111.1.2 ~h12)
                ==
            !>  i.t.t.moves
        ::
          %+  expect-eq
            !>  :*  ~[/http-put-request]  %pass
                    /channel/timeout/'0123456789abcdef'
                    %b  %wait  :(add ~1111.1.2 ~h12 ~m3)
                ==
            !>  i.t.t.t.moves
    ==  ==
  ::
  ;:  weld
    results1
    results2
    results3
    results4
  ==
::
++  test-channel-double-subscription-works
  ::  common initialization
  ::
  =^  results1  eyre-gate  (perform-init-start-channel eyre-gate *roof)
  ::  poke gets a success message
  ::
  =^  results2  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m1)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/poke/'0123456789abcdef'/'0'  duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %poke-ack ~]
         ==
      moves=~
    ==
  ::  subscription gets a success message
  ::
  =^  results3  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m2)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %watch-ack ~]
         ==
      moves=~
    ==
  ::  now make a second subscription from the client on the same path
  ::
  =^  results3  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=(add ~1111.1.2 ~m3)
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-put-request]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'PUT'
            '/~/channel/0123456789abcdef'
            ['cookie' cookie-value]~
        ::
            :-  ~
            %-  as-octs:mimes:html
            '''
            [{"action": "subscribe",
              "id": 2,
              "ship": "nul",
              "app": "two",
              "path": "/one/two/three"}
            ]
            '''
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([^ ^ ^ ^ ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        ;:  weld
          %+  expect-gall-deal
            :*  /channel/subscription/'0123456789abcdef'/'2'/~nul/two
                [~nul ~nul]  %two
                %watch  /one/two/three
            ==
            card.i.moves
        ::
          %+  expect-eq
            !>  put-204-response
            !>  i.t.moves
        ::
          %+  expect-eq
            !>  :*  ~[/http-put-request]  %pass
                    /channel/timeout/'0123456789abcdef'
                    %b  %rest  (add ~1111.1.2 ~h12)
                ==
            !>  i.t.t.moves
        ::
          %+  expect-eq
            !>  :*  ~[/http-put-request]  %pass
                    /channel/timeout/'0123456789abcdef'
                    %b  %wait  :(add ~1111.1.2 ~h12 ~m3)
                ==
            !>  i.t.t.t.moves
    ==  ==
  ::  subscription gets a result (on the id 1)
  ::
  =^  results4  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m2)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %fact %json !>(`json`[%a [%n '1'] [%n '2'] ~])]
         ==
      moves=~
    ==
  ::  subscription gets a result (on the id 2)
  ::
  =^  results5  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m2)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'2'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %fact %json !>(`json`[%a [%n '1'] [%n '2'] ~])]
         ==
      moves=~
    ==
  ::  open up the channel
  ::
  =^  results6  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=(add ~1111.1.2 ~m3)
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-get-open]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'GET'
            '/~/channel/0123456789abcdef'
            ['cookie' cookie-value]~
            ~
        ==
      ^=  expected-moves
        ^-  (list move:eyre-gate)
        :~  :*  duct=~[/http-get-open]
                %pass
                /channel/heartbeat/'0123456789abcdef'
                [%b %wait ~1111.1.2..00.03.20]
                ==
            :*  duct=~[/http-get-open]
                %give
                %response
                %start
                :-  200
                :~  ['content-type' 'text/event-stream']
                    ['cache-control' 'no-cache']
                    ['connection' 'keep-alive']
                    ['set-cookie' cookie-string]
                ==
              ::
                :-  ~
                %-  as-octs:mimes:html
                '''
                id: 0
                data: {"ok":"ok","id":0,"response":"poke"}

                id: 1
                data: {"ok":"ok","id":1,"response":"subscribe"}

                id: 2
                data: {"json":[1,2],"id":1,"response":"diff"}

                id: 3
                data: {"json":[1,2],"id":2,"response":"diff"}


                '''
              ::
                complete=%.n
            ==
            ::  opening the channel cancels the timeout timer
            ::
            :*  duct=~[/http-put-request]  %pass
                /channel/timeout/'0123456789abcdef'
                [%b %rest ~1111.1.2..12.03.00]
    ==  ==  ==
  ::  we can close the first channel without closing the second
  ::
  =^  results7  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=(add ~1111.1.2 ~m3)
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-put-request]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'PUT'
            '/~/channel/0123456789abcdef'
            ['cookie' cookie-value]~
        ::
            :-  ~
            %-  as-octs:mimes:html
            '''
            [{"action": "unsubscribe",
              "id": 3,
              "subscription": 1}
            ]
            '''
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([^ ^ ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        ;:  weld
          %+  expect-gall-deal
            :*  /channel/subscription/'0123456789abcdef'/'1'/~nul/two
                [~nul ~nul]  %two  %leave  ~
            ==
            card.i.moves
        ::
          %+  expect-eq
            !>  put-204-response
            !>  i.t.moves
    ==  ==
  ::  gall responds on the second subscription.
  ::
  ::    This just tests that closing one of the two subscriptions doesn't
  ::    unsubscribe to the other.
  ::
  =^  results8  eyre-gate
    %-  eyre-take-with-comparator  :*
      eyre-gate
      now=(add ~1111.1.2 ~m2)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'2'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %fact %json !>(`json`[%a [%n '1'] [%n '2'] ~])]
         ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([^ ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        %+  expect-eq
          !>  :*  ~[/http-get-open]  %give  %response  %continue
                  :-  ~
                  %-  as-octs:mimes:html
                  '''
                  id: 4
                  data: {"json":[1,2],"id":2,"response":"diff"}


                  '''
                  complete=%.n
              ==
          !>  i.moves
    ==
  ::
  ;:  weld
    results1
    results2
    results3
    results4
    results5
    results6
    results7
    results8
  ==
::
++  test-prune-events
  =/  q=(qeu [id=@ud @ud channel-event:eyre])  ~
  =.  q  (~(put to q) [0 0 *channel-event:eyre])
  =.  q  (~(put to q) [1 0 *channel-event:eyre])
  =.  q  (~(put to q) [2 0 *channel-event:eyre])
  =.  q  (~(put to q) [3 1 *channel-event:eyre])
  =.  q  (~(put to q) [4 1 *channel-event:eyre])
  ::
  =^  a  q  (prune-events:eyre-gate q 3)
  ::
  %+  expect-eq
    !>
    :-  (~(gas by *(map @ud @ud)) ~[0^3 1^1])
    [~ [4 1 *channel-event:eyre]]
  !>([a ~(top to q)])
::
++  test-subtract-acked-events
  =/  a  (~(gas by *(map @ud @ud)) ~[0^3 1^1])
  =/  u  (~(gas by *(map @ud @ud)) ~[0^4 2^1])
  =/  e  (~(gas by *(map @ud @ud)) ~[0^1 2^1])
  =/  r  (subtract-acked-events:eyre-gate a u)
  (expect-eq !>(e) !>(r))
::
++  test-channel-sends-unacknowledged-events-on-reconnection
  ::  common initialization
  ::
  =^  results1  eyre-gate  (perform-init-start-channel eyre-gate *roof)
  ::  poke gets a success message
  ::
  =^  results2  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m1)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/poke/'0123456789abcdef'/'0'  duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %poke-ack ~]
         ==
      moves=~
    ==
  ::  subscription gets a success message
  ::
  =^  results3  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m2)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %watch-ack ~]
         ==
      moves=~
    ==
  ::  opens the http channel
  ::
  =^  results4  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=(add ~1111.1.2 ~m3)
      scry=scry-provides-code
      ^=  call-args
      ^-  [duct * (hobo task:able:eyre-gate)]
        :*  duct=~[/http-get-open]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'GET'
            '/~/channel/0123456789abcdef'
            ['cookie' cookie-value]~
            ~
        ==
      ^=  expected-moves
        ^-  (list move:eyre-gate)
        :~  :*  duct=~[/http-get-open]
                %pass
                /channel/heartbeat/'0123456789abcdef'
                [%b %wait ~1111.1.2..00.03.20]
                ==
            :*  duct=~[/http-get-open]
                %give
                %response
                %start
                :-  200
                :~  ['content-type' 'text/event-stream']
                    ['cache-control' 'no-cache']
                    ['connection' 'keep-alive']
                    ['set-cookie' cookie-string]
                ==
              ::
                :-  ~
                %-  as-octs:mimes:html
                '''
                id: 0
                data: {"ok":"ok","id":0,"response":"poke"}

                id: 1
                data: {"ok":"ok","id":1,"response":"subscribe"}


                '''
              ::
                complete=%.n
            ==
            ::  opening the channel cancels the timeout timer
            ::
            :*  duct=~[/http-put-request]  %pass
                /channel/timeout/'0123456789abcdef'
                [%b %rest :(add ~1111.1.2 ~h12)]
    ==  ==  ==
  ::  first subscription result gets sent to the user
  ::
  =^  results5  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m4)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %fact %json !>(`json`[%a [%n '1'] ~])]
         ==
      ^=  moves
        ^-  (list move:eyre-gate)
        :~  :*  duct=~[/http-get-open]
                %give
                %response
                %continue
                :-  ~
                %-  as-octs:mimes:html
                '''
                id: 2
                data: {"json":[1],"id":1,"response":"diff"}


                '''
                complete=%.n
    ==  ==  ==
  ::  the client now acknowledges up to event 1
  ::
  ::  send the channel a poke and a subscription request
  ::
  =^  results6  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=(add ~1111.1.2 ~m5)
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-put-request]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'PUT'
            '/~/channel/0123456789abcdef'
            ['cookie' cookie-value]~
        ::
            :-  ~
            %-  as-octs:mimes:html
            '''
            [{"action": "ack",
              "event-id": 1}
            ]
            '''
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([^ ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        %+  expect-eq
          !>  put-204-response
          !>  i.moves
    ==
  ::  the client connection is detected to be broken
  ::
  =^  results7  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=(add ~1111.1.2 ~m6)
      scry=scry-provides-code
      call-args=[duct=~[/http-get-open] ~ %cancel-request ~]
      ^=  expected-moves
        ^-  (list move:eyre-gate)
        ::  closing the channel cancels the sse heartbeat
        ::  (initialized in results4 above) and restarts the timeout timer
        ::
        :~  :*  duct=~[/http-get-open]  %pass
                /channel/heartbeat/'0123456789abcdef'
                %b  %rest  :(add ~1111.1.2 ~m3 ~s20)
            ==
            :*  duct=~[/http-get-open]  %pass
                /channel/timeout/'0123456789abcdef'
                %b  %wait  :(add ~1111.1.2 ~h12 ~m6)
        ==  ==
    ==
  ::  another subscription result while the user is disconnected
  ::
  =^  results8  eyre-gate
    %-  eyre-take  :*
      eyre-gate
      now=(add ~1111.1.2 ~m7)
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %fact %json !>(`json`[%a [%n '2'] ~])]
         ==
      moves=~
    ==
  ::  the client now retries to connect
  ::
  ::    Because the client has acknowledged up to event 1, we should start the connection by
  ::    resending events 2 and 3.
  ::
  =^  results9  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=(add ~1111.1.2 ~m8)
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-get-open]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'GET'
            '/~/channel/0123456789abcdef'
            ['cookie' cookie-value]~
            ~
        ==
      ^=  expected-moves
        ^-  (list move:eyre-gate)
        :~  :*  duct=~[/http-get-open]
                %pass
                /channel/heartbeat/'0123456789abcdef'
                [%b %wait ~1111.1.2..00.08.20]
                ==
            :*  duct=~[/http-get-open]
                %give
                %response
                %start
                :-  200
                :~  ['content-type' 'text/event-stream']
                    ['cache-control' 'no-cache']
                    ['connection' 'keep-alive']
                    ['set-cookie' cookie-string]
                ==
              ::
                :-  ~
                %-  as-octs:mimes:html
                '''
                id: 2
                data: {"json":[1],"id":1,"response":"diff"}

                id: 3
                data: {"json":[2],"id":1,"response":"diff"}


                '''
              ::
                complete=%.n
            ==
            ::  opening the channel cancels the timeout timer
            ::
            :*  duct=~[/http-get-open]  %pass
                /channel/timeout/'0123456789abcdef'
                ::  add ~m6 because that was the time of the last GET
                ::
                [%b %rest :(add ~1111.1.2 ~m6 ~h12)]
    ==  ==  ==
  ::
  ;:  weld
    results1
    results2
    results3
    results4
    results5
    results6
    results7
    results8
    results9
  ==
::
++  test-channel-subscription-clogged
  ::  common initialization
  ::
  =^  tested-elsewhere  eyre-gate
    (perform-init-start-channel eyre-gate *roof)
  ::
  =/  now=@da  :(add ~1111.1.2 clog-timeout:eyre-gate ~s1)
  ::  subscription gets a success message
  ::
  =^  tested-elsewhere  eyre-gate
    %:  eyre-take
      eyre-gate
      now
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %watch-ack ~]
         ==
      moves=~
    ==
  ::  opens the http channel
  ::
  =^  tested-elsewhere  eyre-gate
    %:  eyre-call
      eyre-gate
      now
      scry=scry-provides-code
      ^=  call-args
      ^-  [duct * (hobo task:able:eyre-gate)]
        :*  duct=~[/http-get-open]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'GET'
            '/~/channel/0123456789abcdef'
            ['cookie' cookie-value]~
            ~
        ==
      ^=  expected-moves
      ~  ::NOTE  tested elsewhere
    ==
  ::  user gets sent multiple subscription results
  ::
  =/  max=@ud  clog-threshold:eyre-gate
  =/  cur=@ud  0
  |-  =*  loop-fact  $
  ?.  =(cur max)
    =^  tested-elsewhere  eyre-gate
      %:  eyre-take
        eyre-gate
        now
        scry=scry-provides-code
        ^=  take-args
          :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
              duct=~[/http-put-request]
              ^-  (hypo sign:eyre-gate)
              :-  *type
              [%g %unto %fact %json !>(`json`[%a [%n '1'] ~])]
          ==
        ^=  moves
        ~  ::NOTE  tested elsewhere
      ==
    loop-fact(cur +(cur))
  ::  the next subscription result should trigger a clog
  ::
  =^  results1  eyre-gate
    %:  eyre-take
      eyre-gate
      now
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %fact %json !>(`json`[%a [%n '1'] ~])]
        ==
      ^=  moves
        :~  :*  duct=~[/http-get-open]
              %give
              %response
              %continue
              :-  ~
              %-  as-octt:mimes:html
              """
              id: {((d-co:co 1) +(clog-threshold:eyre-gate))}
              data: \{"json":[1],"id":1,"response":"diff"}


              """
              complete=%.n
            ==
            :*  duct=~[/http-put-request]  %pass
              /channel/subscription/'0123456789abcdef'/'1'/~nul/two
              %g  %deal  [~nul ~nul]  %two  %leave  ~
            ==
            :*  duct=~[/http-get-open]
                %give
                %response
                %continue
                :-  ~
                %-  as-octt:mimes:html
                """
                id: {((d-co:co 1) (add 2 clog-threshold:eyre-gate))}
                data: \{"id":1,"response":"quit"}


                """
                complete=%.n
            ==
        ==
    ==
  ::  subsequent subscription updates, which might have gotten sent out during
  ::  the same event in which a clog triggered, should be silently ignored
  ::
  =^  results2  eyre-gate
    %:  eyre-take
      eyre-gate
      now
      scry=scry-provides-code
      ^=  take-args
        :*  wire=/channel/subscription/'0123456789abcdef'/'1'/~nul/two
            duct=~[/http-put-request]
            ^-  (hypo sign:eyre-gate)
            :-  *type
            [%g %unto %fact %json !>(`json`[%a [%n '1'] ~])]
        ==
      ^=  moves
        ~
    ==
  (weld results1 results2)
::
++  test-born-sends-pending-cancels
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::  app1 binds successfully
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
      call-args=[duct=~[/app1] ~ [%connect [~ /] %app1]]
      expected-moves=[duct=~[/app1] %give %bound %.y [~ /]]~
    ==
  ::  start a request to app1
  ::
  ::  outside requests a path that app1 has bound to
  ::
  =^  results3  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=~1111.1.3
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-blah]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            [%'GET' '/' ~ ~]
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([* * ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        =/  move-1=move:eyre-gate  i.moves
        =/  move-2=move:eyre-gate  i.t.moves
        ::
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-1))
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct.move-2))
        ::
        %+  weld
          %+  expect-gall-deal
            :+  /watch-response/[eyre-id]
              [~nul ~nul]
            :*  %app1  %watch
                /http-response/[eyre-id]
            ==
          card.move-1
        ::
        %+  expect-gall-deal
          :+  /run-app-request/[eyre-id]  [~nul ~nul]
              :*  %app1  %poke  %handle-http-request
                  !>([eyre-id %.n %.n [%ipv4 .192.168.1.1] [%'GET' '/' ~ ~]])
              ==
          card.move-2
    ==
  ::  but app1 doesn't respond before our urbit gets shut down. ensure we send
  ::  cancels on open connections.
  ::
  =^  results4  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=~1111.1.4
      scry=scry-provides-code
      call-args=[duct=~[/born] ~ [%born ~]]
      ^=  expected-moves
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([^ ^ ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        ::  we don't care about the first one, which is just a static
        ::  configuration move.
        ::
        =/  move=move:eyre-gate                              i.t.moves
        =/  =duct                                             duct.move
        =/  card=(wind note:eyre-gate gift:able:eyre-gate)  card.move
        ::
        %+  weld
          (expect-eq !>(~[/http-blah]) !>(duct))
        ::
        %+  expect-gall-deal
          :+  /watch-response/[eyre-id]  [~nul ~nul]
            [%app1 %leave ~]
          card
    ==
  ::
  ;:  weld
    results1
    results2
    results3
    results4
  ==
::
++  eyre-call
  |=  $:  eyre-gate=_eyre-gate
          now=@da
          scry=roof
          call-args=[=duct type=* wrapped-task=(hobo task:able:eyre-gate)]
          expected-moves=(list move:eyre-gate)
      ==
  ^-  [tang _eyre-gate]
  ::
  =/  eyre-core
    (eyre-gate our=~nul now=now eny=`@uvJ`0xdead.beef scry=scry)
  ::
  =^  moves  eyre-gate
    (call:eyre-core [duct ~ type wrapped-task]:call-args)
  ::
  =/  output=tang
    %+  expect-eq
      !>  expected-moves
      !>  moves
  ::
  [output eyre-gate]
::
++  eyre-call-with-comparator
  |=  $:  eyre-gate=_eyre-gate
          now=@da
          scry=roof
          call-args=[=duct type=* wrapped-task=(hobo task:able:eyre-gate)]
          move-comparator=$-((list move:eyre-gate) tang)
      ==
  ^-  [tang _eyre-gate]
  ::
  =/  eyre-core  (eyre-gate our=~nul now=now eny=`@uvJ`0xdead.beef scry=scry)
  ::
  =^  moves  eyre-gate  (call:eyre-core [duct ~ type wrapped-task]:call-args)
  ::
  =/  output=tang  (move-comparator moves)
  ::
  [output eyre-gate]
::
++  eyre-take
  |=  $:  eyre-gate=_eyre-gate
          now=@da
          scry=roof
          take-args=[=wire =duct wrapped-sign=(hypo sign:eyre-gate)]
          expected-moves=(list move:eyre-gate)
      ==
  ^-  [tang _eyre-gate]
  ::
  =/  eyre-core  (eyre-gate our=~nul now=now eny=`@uvJ`0xdead.beef scry=scry)
  ::
  =^  moves  eyre-gate  (take:eyre-core [wire duct ~ wrapped-sign]:take-args)
  ::
  =/  output=tang
    %+  expect-eq
      !>  expected-moves
      !>  moves
  ::
  [output eyre-gate]
::
++  eyre-take-with-comparator
  |=  $:  eyre-gate=_eyre-gate
          now=@da
          scry=roof
          take-args=[=wire =duct wrapped-sign=(hypo sign:eyre-gate)]
          move-comparator=$-((list move:eyre-gate) tang)
      ==
  ^-  [tang _eyre-gate]
  ::
  =/  eyre-core  (eyre-gate our=~nul now=now eny=`@uvJ`0xdead.beef scry=scry)
  ::
  =^  moves  eyre-gate  (take:eyre-core [wire duct ~ wrapped-sign]:take-args)
  ::
  =/  output=tang  (move-comparator moves)
  ::
  [output eyre-gate]
::
++  expect-gall-deal
  |=  $:  expected=[wire=path id=sock app=term =deal:gall]
          actual=(wind note:eyre-gate gift:able:eyre-gate)
      ==
  ^-  tang
  ::
  ?.  ?=(%pass -.actual)
    [%leaf "bad move, not a %pass: {<actual>}"]~
  ::
  %+  weld
    (expect-eq !>(wire.expected) !>(p.actual))
  ::
  =/  note=note:eyre-gate  q.actual
  ?.  ?=([%g %deal *] note)
    [%leaf "bad move, not a %deal: {<actual>}"]~
  ::
  %+  weld
    (expect-eq !>(id.expected) !>(p.note))
  ::
  %+  weld
    (expect-eq !>(app.expected) !>(q.note))
  ::
  ?:  ?=([%poke *] deal.expected)
    ?.  ?=([%poke *] r.note)
      [%leaf "expected %poke, actual {<r.note>}"]~
    ::
    %+  weld
      (expect-eq !>(p.cage.deal.expected) !>(p.cage.r.note))
    ::  compare the payload vases
    ::
    (expect-eq q.cage.deal.expected q.cage.r.note)
  ::
  ?:  ?=([%poke-as *] deal.expected)
    ?.  ?=([%poke-as *] r.note)
      [%leaf "expected %poke-as, actual {<r.note>}"]~
    ::  compare the mark type
    ::
    %+  weld
      (expect-eq !>(mark.deal.expected) !>(mark.r.note))
    ::  compare the cage mark
    ::
    %+  weld
      (expect-eq !>(p.cage.deal.expected) !>(p.cage.r.note))
    ::  compare the payload vases
    ::
    (expect-eq q.cage.deal.expected q.cage.r.note)
  ::
  ?:  ?=([%watch *] deal.expected)
    ?.  ?=([%watch *] r.note)
      [%leaf "expected %watch, actual {<r.note>}"]~
    ::  compare the path
    ::
    (expect-eq !>(path.deal.expected) !>(path.r.note))
  ::
  ?:  ?=([%watch-as *] deal.expected)
    ?.  ?=([%watch-as *] r.note)
      [%leaf "expected %watch-as, actual {<r.note>}"]~
    ::  compare the result mark
    ::
    %+  weld
      (expect-eq !>(mark.deal.expected) !>(mark.r.note))
    ::  compare the path
    ::
    (expect-eq !>(path.deal.expected) !>(path.r.note))
  ::
  ?:  ?=([%leave *] deal.expected)
    ?.  ?=([%leave *] r.note)
      [%leaf "expected %leave, actual {<r.note>}"]~
    ::
    ~
  ::  todo: handle other deals
  ::
  [%leaf "unexpected %deal type"]~
::  +perform-authentication: goes through the authentication flow
::
++  perform-authentication
  |=  $:  eyre-gate=_eyre-gate
          start-now=@da
          scry=roof
      ==
  ^-  [tang _eyre-gate]
  ::  the browser then fetches the login page
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=start-now
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-blah]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            [%'GET' '/~/login?redirect=/~landscape/inner-path' ~ ~]
        ==
      ^=  expected-moves
        ^-  (list move:eyre-gate)
        :~  :*  duct=~[/http-blah]
                %give
                %response
                %start
              ::
                %+  complete-http-start-event
                  :-  200
                  ['content-type' 'text/html']~
                [~ (login-page:eyre-gate `'/~landscape/inner-path' ~nul)]
        ==  ==
    ==
  ::  a response post redirects back to the application, setting cookie
  ::
  =^  results2  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=(add start-now ~m1)
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-blah]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'POST'
            '/~/login'
            ~
            :-  ~
            %-  as-octs:mimes:html
            'password=lidlut-tabwed-pillex-ridrup&redirect=/~landscape'
        ==
      ^=  expected-moves
        ^-  (list move:eyre-gate)
        :~  ::NOTE  this ~d7 is tied to the eyre-internal +session-timeout...
            :-  duct=~[/http-blah]
            [%pass p=/sessions/expire q=[%b [%wait p=(add start-now ~d7.m1)]]]
          ::
            :*  duct=~[/http-blah]
                %give
                %response
                %start
                :-  303
                :~  ['location' '/~landscape']
                    ['set-cookie' cookie-string]
                ==
                ~
                complete=%.y
        ==  ==
    ==
  ::
  :_  eyre-gate
  (weld results1 results2)
::  performs all initialization and an initial PUT.
::
++  perform-init-start-channel
  |=  $:  eyre-gate=_eyre-gate
          scry=roof
      ==
  ^-  [tang _eyre-gate]
  ::
  =^  results1  eyre-gate
    %-  eyre-call  :*
      eyre-gate
      now=~1111.1.1
      scry=scry-provides-code
      call-args=[duct=~[/init] ~ [%init ~nul]]
      expected-moves=~
    ==
  ::  ensure there's an authenticated session
  ::
  =^  results2  eyre-gate
    %-  perform-authentication  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
    ==
  ::  send the channel a poke and a subscription request
  ::
  =^  results3  eyre-gate
    %-  eyre-call-with-comparator  :*
      eyre-gate
      now=~1111.1.2
      scry=scry-provides-code
      ^=  call-args
        :*  duct=~[/http-put-request]  ~
            %request
            %.n
            [%ipv4 .192.168.1.1]
            %'PUT'
            '/~/channel/0123456789abcdef'
            ['cookie' cookie-value]~
        ::
            :-  ~
            %-  as-octs:mimes:html
            '''
            [{"action": "poke",
              "id": 0,
              "ship": "nul",
              "app": "one",
              "mark": "a",
              "json": 5},
             {"action": "subscribe",
              "id": 1,
              "ship": "nul",
              "app": "two",
              "path": "/one/two/three"}
            ]
            '''
        ==
      ^=  comparator
        |=  moves=(list move:eyre-gate)
        ^-  tang
        ::
        ?.  ?=([^ ^ ^ ^ ~] moves)
          [%leaf "wrong number of moves: {<(lent moves)>}"]~
        ::
        ;:  weld
          %+  expect-gall-deal
            :*  /channel/poke/'0123456789abcdef'/'0'
                [~nul ~nul]  %one
                %poke-as  %a  %json  !>([%n '5'])
            ==
            card.i.moves
        ::
          %+  expect-gall-deal
            :*  /channel/subscription/'0123456789abcdef'/'1'/~nul/two
                [~nul ~nul]  %two
                %watch  /one/two/three
            ==
            card.i.t.moves
        ::
          %+  expect-eq
            !>  put-204-response
            !>  i.t.t.moves
        ::
          %+  expect-eq
            !>  :*  ~[/http-put-request]  %pass
                    /channel/timeout/'0123456789abcdef'
                    %b  %wait  (add ~1111.1.2 ~h12)
                ==
            !>  i.t.t.t.moves
    ==  ==
  ::
  :_  eyre-gate
  :(weld results1 results2 results3)
::
++  scry-provides-code  ^-  roof
  |=  [gang =term =beam]
  ^-  (unit (unit cage))
  ?:  &(=(%ca term) =(/gen/handler/hoon s.beam))
    :+  ~  ~
    vase+!>(!>(|=(* |=(* [[%404 ~] ~]))))
  ?:  &(=(%cb term) =(/json s.beam))
    :^  ~  ~  %dais
    !>  ^-  dais:clay
    |_  sam=vase
    ++  bunt  !!
    ++  diff  !!
    ++  form  !!
    ++  join  !!
    ++  mash  !!
    ++  pact  !!
    ++  vale  |=(=noun !>(;;(json noun)))
    ++  volt  !!
    --
  ::
  ?>  =(%j term)
  ?>  =(~nul p.beam)
  ?>  =(%code q.beam)
  ?>  =(%da -.r.beam)
  ?>  =(/~nul s.beam)
  ::  This is the default code for a fakeship.
  ::
  [~ ~ %noun !>(.~lidlut-tabwed-savheb-loslux)]
::  produce the body of a %start http-event with the correct content-length
::
++  complete-http-start-event
  |=  [response-header:http data=(unit octs)]
  =-  [[status-code -] data %.y]
  ?~  data  headers
  %+  weld  headers
  ['content-length' (crip ((d-co:co 1) p.u.data))]~
::  produce the 204 response to a put request
::
++  put-204-response
  :*  ~[/http-put-request]
      %give
      %response
      %start
      [204 ['set-cookie' cookie-string]~]
      ~
      %.y
  ==
::
++  cookie-value
  'urbauth-~nul=0v3.q0p7t.mlkkq.cqtto.p0nvi.2ieea'
::
++  cookie-string
  %^  cat  3  cookie-value
  '; Path=/; Max-Age=604800'
--