|
| 1 | +import { EventEmitter } from 'events'; |
| 2 | +import * as Net from 'net'; |
| 3 | +import * as winston from 'winston'; |
| 4 | +import Blacklist from '../../dimensions/blacklist.js'; |
| 5 | +import BlacklistCheckClient from '../../dimensions/blacklistcheckclient.js'; |
| 6 | +import ClientArgs from '../../dimensions/clientargs.js'; |
| 7 | +import RawPacket from '../../dimensions/packets/rawpacket.js'; |
| 8 | +import { ClientUuidPacket, ConnectRequestPacket, Parser, PlayerInfoPacket } from 'terraria-packet'; |
| 9 | + |
| 10 | +describe("BlacklistCheckClient", () => { |
| 11 | + const uuid = "29be7f8f-25ae-4c10-9664-6f7c783cba32"; |
| 12 | + |
| 13 | + function unwrapBuffer(result: { TAG: "Ok"; _0: Buffer } | { TAG: "Error"; _0: unknown }): Buffer { |
| 14 | + if (result.TAG === "Error") { |
| 15 | + throw new Error(`Error creating packet: ${String(result._0)}`); |
| 16 | + } |
| 17 | + |
| 18 | + return result._0; |
| 19 | + } |
| 20 | + |
| 21 | + function makeSocket(): Net.Socket & { write: jasmine.Spy } { |
| 22 | + const socket = new EventEmitter() as Net.Socket & { write: jasmine.Spy }; |
| 23 | + Object.defineProperty(socket, "remoteAddress", { |
| 24 | + value: "127.0.0.1", |
| 25 | + configurable: true |
| 26 | + }); |
| 27 | + socket.write = jasmine.createSpy("write"); |
| 28 | + |
| 29 | + return socket; |
| 30 | + } |
| 31 | + |
| 32 | + function makeClientArgs(socket: Net.Socket): ClientArgs { |
| 33 | + return { |
| 34 | + socket, |
| 35 | + globalHandlers: { |
| 36 | + extensions: {} |
| 37 | + }, |
| 38 | + options: { |
| 39 | + log: { |
| 40 | + extensionError: false |
| 41 | + } |
| 42 | + }, |
| 43 | + logging: winston.createLogger({ silent: true }) |
| 44 | + } as unknown as ClientArgs; |
| 45 | + } |
| 46 | + |
| 47 | + function makeBlacklist(isBlacklisted = false): Blacklist & { checkInformation: jasmine.Spy } { |
| 48 | + return { |
| 49 | + checkInformation: jasmine.createSpy("checkInformation").and.returnValue(Promise.resolve(isBlacklisted)) |
| 50 | + } as unknown as Blacklist & { checkInformation: jasmine.Spy }; |
| 51 | + } |
| 52 | + |
| 53 | + function makeClient(socket = makeSocket(), blacklist = makeBlacklist()) { |
| 54 | + const client = new BlacklistCheckClient({ |
| 55 | + blacklist, |
| 56 | + clientArgs: makeClientArgs(socket) |
| 57 | + }); |
| 58 | + const accepted: { bufferPacket: Buffer; packetsReceived: RawPacket[] }[] = []; |
| 59 | + const callbacks = { |
| 60 | + clientAcceptedCb: (bufferPacket: Buffer, packetsReceived: RawPacket[]) => { |
| 61 | + accepted.push({ bufferPacket, packetsReceived }); |
| 62 | + }, |
| 63 | + clientBlacklistedCb: jasmine.createSpy("clientBlacklistedCb"), |
| 64 | + errorCheckingBlacklistCb: jasmine.createSpy("errorCheckingBlacklistCb"), |
| 65 | + packetErrorCheckingBlacklistCb: jasmine.createSpy("packetErrorCheckingBlacklistCb"), |
| 66 | + disconnectCb: jasmine.createSpy("disconnectCb") |
| 67 | + }; |
| 68 | + |
| 69 | + client.setupCallbacks(callbacks); |
| 70 | + |
| 71 | + return { client, socket, blacklist, callbacks, accepted }; |
| 72 | + } |
| 73 | + |
| 74 | + function connectRequestPacket(): Buffer { |
| 75 | + return unwrapBuffer(ConnectRequestPacket.toBuffer({ version: "Terraria319" })); |
| 76 | + } |
| 77 | + |
| 78 | + function playerInfoPacket(): Buffer { |
| 79 | + const color = { R: 0, G: 0, B: 0 }; |
| 80 | + return unwrapBuffer(PlayerInfoPacket.toBuffer({ |
| 81 | + playerId: 0, |
| 82 | + skinVariant: 1, |
| 83 | + voiceVariant: 1, |
| 84 | + voicePitchOffset: 0, |
| 85 | + hair: 1, |
| 86 | + name: "Smekku", |
| 87 | + hairDye: 0, |
| 88 | + hideVisuals: 0, |
| 89 | + hideVisuals2: 0, |
| 90 | + hideMisc: 0, |
| 91 | + hairColor: color, |
| 92 | + skinColor: color, |
| 93 | + eyeColor: color, |
| 94 | + shirtColor: color, |
| 95 | + underShirtColor: color, |
| 96 | + pantsColor: color, |
| 97 | + shoeColor: color, |
| 98 | + difficulty: "Softcore", |
| 99 | + mode: "Classic", |
| 100 | + extraAccessory: false, |
| 101 | + usingBiomeTorches: false, |
| 102 | + unlockedBiomeTorches: false, |
| 103 | + happyFunTorchTime: false, |
| 104 | + unlockedSuperCart: false, |
| 105 | + enabledSuperCart: false, |
| 106 | + usedAegisCrystal: false, |
| 107 | + usedAegisFruit: false, |
| 108 | + usedArcaneCrystal: false, |
| 109 | + usedGalaxyPearl: false, |
| 110 | + usedGummyWorm: false, |
| 111 | + usedAmbrosia: false, |
| 112 | + ateArtisanBread: false |
| 113 | + })); |
| 114 | + } |
| 115 | + |
| 116 | + function clientUuidPacket(): Buffer { |
| 117 | + return unwrapBuffer(ClientUuidPacket.toBuffer({ uuid })); |
| 118 | + } |
| 119 | + |
| 120 | + function parseServerPacketTag(packet: Buffer): string { |
| 121 | + const parsed = Parser.parse(packet, true); |
| 122 | + if (parsed.TAG === "Error") { |
| 123 | + throw new Error(`Error parsing packet: ${String(parsed._0)}`); |
| 124 | + } |
| 125 | + |
| 126 | + return parsed._0.TAG; |
| 127 | + } |
| 128 | + |
| 129 | + function parseClientPacketTag(packet: Buffer): string { |
| 130 | + const parsed = Parser.parse(packet, false); |
| 131 | + if (parsed.TAG === "Error") { |
| 132 | + throw new Error(`Error parsing packet: ${String(parsed._0)}`); |
| 133 | + } |
| 134 | + |
| 135 | + return parsed._0.TAG; |
| 136 | + } |
| 137 | + |
| 138 | + it("does not write setup packets before receiving ConnectRequest", () => { |
| 139 | + const { socket } = makeClient(); |
| 140 | + |
| 141 | + expect(socket.write).not.toHaveBeenCalled(); |
| 142 | + }); |
| 143 | + |
| 144 | + it("writes status then player slot setup after receiving ConnectRequest", () => { |
| 145 | + const { client, socket } = makeClient(); |
| 146 | + |
| 147 | + client.handleData(connectRequestPacket()); |
| 148 | + |
| 149 | + expect(socket.write).toHaveBeenCalledTimes(2); |
| 150 | + const writes = socket.write.calls.allArgs().map(args => args[0] as Buffer); |
| 151 | + expect(parseServerPacketTag(writes[0])).toBe("Status"); |
| 152 | + expect(parseServerPacketTag(writes[1])).toBe("PlayerSlotSet"); |
| 153 | + }); |
| 154 | + |
| 155 | + it("accepts clients after ConnectRequest, PlayerInfo, and ClientUuid and replays ConnectRequest first", async () => { |
| 156 | + const { client, blacklist, accepted } = makeClient(); |
| 157 | + |
| 158 | + client.handleData(Buffer.concat([ |
| 159 | + connectRequestPacket(), |
| 160 | + playerInfoPacket(), |
| 161 | + clientUuidPacket() |
| 162 | + ])); |
| 163 | + await Promise.resolve(); |
| 164 | + |
| 165 | + expect(blacklist.checkInformation).toHaveBeenCalledOnceWith("Smekku", "127.0.0.1", uuid); |
| 166 | + expect(accepted.length).toBe(1); |
| 167 | + expect(accepted[0].bufferPacket.length).toBe(0); |
| 168 | + expect(accepted[0].packetsReceived.map(packet => parseClientPacketTag(packet.data))).toEqual([ |
| 169 | + "ConnectRequest", |
| 170 | + "PlayerInfo", |
| 171 | + "ClientUuid" |
| 172 | + ]); |
| 173 | + }); |
| 174 | + |
| 175 | + it("rejects PlayerInfo before ConnectRequest", () => { |
| 176 | + const { client, socket, callbacks } = makeClient(); |
| 177 | + |
| 178 | + client.handleData(playerInfoPacket()); |
| 179 | + |
| 180 | + expect(callbacks.packetErrorCheckingBlacklistCb).toHaveBeenCalledOnceWith(jasmine.any(Error)); |
| 181 | + expect(socket.write).not.toHaveBeenCalled(); |
| 182 | + }); |
| 183 | +}); |
0 commit comments