From ca4ccbe37fd1136ae22ef1c125675d08fc9b1b17 Mon Sep 17 00:00:00 2001 From: Dmitriy Ryajov Date: Thu, 29 Aug 2019 23:18:10 -0600 Subject: [PATCH] don't use method as handler in protocol base --- libp2p/multistreamselect.nim | 118 -------------- libp2p/protocol.nim | 2 - tests/testmultistreamselect.nim | 265 -------------------------------- 3 files changed, 385 deletions(-) delete mode 100644 libp2p/multistreamselect.nim delete mode 100644 tests/testmultistreamselect.nim diff --git a/libp2p/multistreamselect.nim b/libp2p/multistreamselect.nim deleted file mode 100644 index b606050b7..000000000 --- a/libp2p/multistreamselect.nim +++ /dev/null @@ -1,118 +0,0 @@ -## Nim-LibP2P -## Copyright (c) 2018 Status Research & Development GmbH -## Licensed under either of -## * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE)) -## * MIT license ([LICENSE-MIT](LICENSE-MIT)) -## at your option. -## This file may not be copied, modified, or distributed except according to -## those terms. - -import sequtils, strutils -import chronos -import connection, varint, vbuffer, protocol - -const MsgSize* = 64*1024 -const Codec* = "/multistream/1.0.0" -const MultiCodec* = "\x13" & Codec & "\n" -const Na = "\x03na\n" -const Ls = "\x03ls\n" - -type - MultisteamSelectException = object of CatchableError - Matcher* = proc (proto: string): bool - - HandlerHolder* = object - proto: string - protocol: LPProtocol - handler: LPProtoHandler - match: Matcher - - MultisteamSelect* = ref object of RootObj - handlers*: seq[HandlerHolder] - codec*: string - na: string - ls: string - -proc newMultistream*(): MultisteamSelect = - new result - result.codec = MultiCodec - result.ls = Ls - result.na = Na - -proc select*(m: MultisteamSelect, - conn: Connection, - proto: string = ""): Future[bool] {.async.} = - ## select a remote protocol - ## TODO: select should support a list of protos to be selected - - await conn.write(m.codec) # write handshake - if proto.len() > 0: - await conn.writeLp(proto) # select proto - - var ms = cast[string](await conn.readLp()) - ms.removeSuffix("\n") - if ms != Codec: - return false - - if proto.len() <= 0: - return true - - ms = cast[string](await conn.readLp()) - ms.removeSuffix("\n") - result = ms == proto - -proc list*(m: MultisteamSelect, - conn: Connection): Future[seq[string]] {.async.} = - ## list remote protos requests on connection - if not (await m.select(conn)): - return - - await conn.write(m.ls) # send ls - - var list = newSeq[string]() - let ms = cast[string](await conn.readLp()) - for s in ms.split("\n"): - if s.len() > 0: - list.add(s) - - result = list - -proc handle*(m: MultisteamSelect, conn: Connection) {.async, gcsafe.} = - ## handle requests on connection - if not (await m.select(conn)): - return - - while not conn.closed: - var ms = cast[string](await conn.readLp()) - ms.removeSuffix("\n") - if ms.len() <= 0: - await conn.write(m.na) - - if m.handlers.len() == 0: - await conn.write(m.na) - continue - - case ms: - of "ls": - var protos = "" - for h in m.handlers: - protos &= (h.proto & "\n") - await conn.writeLp(cast[seq[byte]](toSeq(protos.items))) - else: - for h in m.handlers: - if (not isNil(h.match) and h.match(ms)) or ms == h.proto: - await conn.writeLp(h.proto & "\n") - await h.handler(h.protocol, conn, ms) - return - await conn.write(m.na) - -proc addHandler*[T: LPProtocol](m: MultisteamSelect, - proto: string, - protocol: T, - handler: LPProtoHandler, - matcher: Matcher = nil) = - ## register a handler for the protocol - m.handlers.add(HandlerHolder(proto: proto, - handler: handler, - protocol: protocol, - match: matcher)) diff --git a/libp2p/protocol.nim b/libp2p/protocol.nim index eb6424464..d38603d1a 100644 --- a/libp2p/protocol.nim +++ b/libp2p/protocol.nim @@ -26,5 +26,3 @@ proc newProtocol*(p: typedesc[LPProtocol], result.init() method init*(p: LPProtocol) {.base.} = discard -method handle*(protocol: LPProtocol, conn: Connection, proto: string): Future[void] - {.base, async.} = discard diff --git a/tests/testmultistreamselect.nim b/tests/testmultistreamselect.nim deleted file mode 100644 index 3a758a1c1..000000000 --- a/tests/testmultistreamselect.nim +++ /dev/null @@ -1,265 +0,0 @@ -import unittest, strutils, sequtils, sugar -import chronos -import ../libp2p/connection, ../libp2p/multistreamselect, - ../libp2p/stream, ../libp2p/connection, ../libp2p/multiaddress, - ../libp2p/transport, ../libp2p/tcptransport, ../libp2p/protocol - -## Mock stream for select test -type - TestSelectStream = ref object of LPStream - step*: int - -method readExactly*(s: TestSelectStream, - pbytes: pointer, - nbytes: int): Future[void] {.async.} = - case s.step: - of 1: - var buf = newSeq[byte](1) - buf[0] = 19 - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - s.step = 2 - of 2: - var buf = "/multistream/1.0.0\n" - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - s.step = 3 - of 3: - var buf = newSeq[byte](1) - buf[0] = 18 - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - s.step = 4 - of 4: - var buf = "/test/proto/1.0.0\n" - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - else: - copyMem(cast[pointer](cast[uint](pbytes)), - cstring("\0x3na\n"), - "\0x3na\n".len()) - -proc newTestSelectStream(): TestSelectStream = - new result - result.step = 1 - -## Mock stream for handles `ls` test -type - LsHandler = proc(procs: seq[byte]): Future[void] - - TestLsStream = ref object of LPStream - step*: int - ls*: LsHandler - -method readExactly*(s: TestLsStream, - pbytes: pointer, - nbytes: int): Future[void] {.async.} = - case s.step: - of 1: - var buf = newSeq[byte](1) - buf[0] = 19 - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - s.step = 2 - of 2: - var buf = "/multistream/1.0.0\n" - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - s.step = 3 - of 3: - var buf = newSeq[byte](1) - buf[0] = 3 - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - s.step = 4 - of 4: - var buf = "ls\n" - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - else: - copyMem(cast[pointer](cast[uint](pbytes)), - cstring("\0x3na\n"), - "\0x3na\n".len()) - -method write*(s: TestLsStream, msg: seq[byte], msglen = -1) {.async.} = - if s.step == 4: - await s.ls(msg) - -proc newTestLsStream(ls: LsHandler): TestLsStream = - new result - result.ls = ls - result.step = 1 - -## Mock stream for handles `na` test -type - NaHandler = proc(procs: string): Future[void] - - TestNaStream = ref object of LPStream - step*: int - na*: NaHandler - -method readExactly*(s: TestNaStream, - pbytes: pointer, - nbytes: int): Future[void] {.async.} = - case s.step: - of 1: - var buf = newSeq[byte](1) - buf[0] = 19 - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - s.step = 2 - of 2: - var buf = "/multistream/1.0.0\n" - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - s.step = 3 - of 3: - var buf = newSeq[byte](1) - buf[0] = 18 - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - s.step = 4 - of 4: - var buf = "/test/proto/1.0.0\n" - copyMem(cast[pointer](cast[uint](pbytes)), addr buf[0], buf.len()) - else: - copyMem(cast[pointer](cast[uint](pbytes)), - cstring("\0x3na\n"), - "\0x3na\n".len()) - -method write*(s: TestNaStream, msg: string, msglen = -1) {.async.} = - if s.step == 4: - await s.na(msg) - -proc newTestNaStream(na: NaHandler): TestNaStream = - new result - result.na = na - result.step = 1 - -suite "Multistream select": - test "test select custom proto": - proc testSelect(): Future[bool] {.async.} = - let ms = newMultistream() - let conn = newConnection(newTestSelectStream()) - result = await ms.select(conn, "/test/proto/1.0.0") - - check: - waitFor(testSelect()) == true - - test "test handle custom proto": - proc testHandle(): Future[bool] {.async.} = - let ms = newMultistream() - let conn = newConnection(newTestSelectStream()) - - var protocol: LPProtocol - proc testHandler(protocol: LPProtocol, - conn: Connection, - proto: string): Future[void] {.async, gcsafe.} = - check proto == "/test/proto/1.0.0" - - ms.addHandler("/test/proto/1.0.0", protocol, testHandler) - await ms.handle(conn) - result = true - - check: - waitFor(testHandle()) == true - - test "test handle `ls`": - proc testLs(): Future[bool] {.async.} = - let ms = newMultistream() - - proc testLs(proto: seq[byte]): Future[void] {.async.} - let conn = newConnection(newTestLsStream(testLs)) - - proc testLs(proto: seq[byte]): Future[void] {.async.} = - var strProto: string = cast[string](proto) - check strProto == "\x26/test/proto1/1.0.0\n/test/proto2/1.0.0\n" - await conn.close() - - var protocol: LPProtocol - proc testHandler(protocol: LPProtocol, - conn: Connection, - proto: string): Future[void] {.async, gcsafe.} = discard - ms.addHandler("/test/proto1/1.0.0", protocol, testHandler) - ms.addHandler("/test/proto2/1.0.0", protocol, testHandler) - await ms.handle(conn) - result = true - - check: - waitFor(testLs()) == true - - test "test handle `na`": - proc testNa(): Future[bool] {.async.} = - let ms = newMultistream() - - proc testNa(msg: string): Future[void] {.async.} - let conn = newConnection(newTestNaStream(testNa)) - - proc testNa(msg: string): Future[void] {.async.} = - check cast[string](msg) == "\x3na\n" - await conn.close() - - var protocol: LPProtocol - proc testHandler(protocol: LPProtocol, - conn: Connection, - proto: string): Future[void] {.async, gcsafe.} = discard - ms.addHandler("/unabvailable/proto/1.0.0", protocol, testHandler) - - await ms.handle(conn) - result = true - - check: - waitFor(testNa()) == true - - test "e2e - handle": - proc endToEnd(): Future[bool] {.async.} = - let ma: MultiAddress = Multiaddress.init("/ip4/127.0.0.1/tcp/53350") - var protocol: LPProtocol - proc testHandler(protocol: LPProtocol, - conn: Connection, - proto: string): Future[void] {.async, gcsafe.} = - check proto == "/test/proto/1.0.0" - await conn.writeLp("Hello!") - await conn.close() - - let msListen = newMultistream() - msListen.addHandler("/test/proto/1.0.0", protocol, testHandler) - - proc connHandler(conn: Connection): Future[void] {.async, gcsafe.} = - await msListen.handle(conn) - - let transport1: TcpTransport = newTransport(TcpTransport) - await transport1.listen(ma, connHandler) - - let msDial = newMultistream() - let transport2: TcpTransport = newTransport(TcpTransport) - let conn = await transport2.dial(ma) - - let res = await msDial.select(conn, "/test/proto/1.0.0") - check res == true - - let hello = cast[string](await conn.readLp()) - result = hello == "Hello!" - await conn.close() - - check: - waitFor(endToEnd()) == true - - test "e2e - ls": - proc endToEnd(): Future[bool] {.async.} = - let ma: MultiAddress = Multiaddress.init("/ip4/127.0.0.1/tcp/53351") - - let msListen = newMultistream() - var protocol: LPProtocol - proc testHandler(protocol: LPProtocol, - conn: Connection, - proto: string): Future[void] {.async.} = discard - msListen.addHandler("/test/proto1/1.0.0", protocol, testHandler) - msListen.addHandler("/test/proto2/1.0.0", protocol, testHandler) - - let transport1: TcpTransport = newTransport(TcpTransport) - proc connHandler(conn: Connection): Future[void] {.async, gcsafe.} = - await msListen.handle(conn) - - await transport1.listen(ma, connHandler) - - let msDial = newMultistream() - let transport2: TcpTransport = newTransport(TcpTransport) - let conn = await transport2.dial(ma) - - let ls = await msDial.list(conn) - let protos: seq[string] = @["/test/proto1/1.0.0", "/test/proto2/1.0.0"] - await conn.close() - result = ls == protos - - check: - waitFor(endToEnd()) == true