SYS-332, SYS-375, SYS-376, SYS-377, SYS-378: Add validateJoinRequest.test.ts

src/p2p/Join/logging.ts

@@ -0,0 +1,26 @@
+import { Logger } from 'log4js'
+import { logger } from '../Context'
+
+export function initLogging(): void {
+  p2pLogger = logger.getLogger('p2p')
+}
+
+let p2pLogger: Logger
+export function getP2PLogger(): Logger {
+  return p2pLogger
+}
+
+export function info(...msg: string[]): void {
+  const entry = `Join: ${msg.join(' ')}`
+  getP2PLogger().info(entry)
+}
+
+export function warn(...msg: string[]): void {
+  const entry = `Join: ${msg.join(' ')}`
+  getP2PLogger().warn(entry)
+}
+
+export function error(...msg: string[]): void {
+  const entry = `Join: ${msg.join(' ')}`
+  getP2PLogger().error(entry)
+}

src/p2p/Join/routes.ts

@@ -11,16 +11,11 @@
 import {
   addJoinRequest,
   computeSelectionNum,
-  getAllowBogon,
-  setAllowBogon,
-  validateJoinRequest,
   verifyJoinRequestSignature,
-  warn,
   queueStandbyRefreshRequest,
   queueJoinRequest,
   queueUnjoinRequest,
-  verifyJoinRequestTypes,
-  nodeListFromStates
+  nodeListFromStates,
 } from '.'
 import { config } from '../Context'
 import { isBogonIP } from '../../utils/functions/checkIP'
@@ -43,7 +38,9 @@
 import { addStandbyRefresh } from './v2/standbyRefresh'
 import { Utils } from '@shardus/types'
 import { testFailChance } from '../../utils'
-import { shardusGetTime } from '../../network'
+import { validateJoinRequest } from './validate'
+import { warn } from './logging'
+import { getAllowBogon, setAllowBogon } from './state'
 
 const cycleMarkerRoute: P2P.P2PTypes.Route<Handler> = {
   method: 'GET',
@@ -341,7 +338,7 @@
 const acceptedRoute: P2P.P2PTypes.Route<Handler> = {
   method: 'POST',
   name: 'accepted',
   handler: async (req, res) => {
     // Turns out the cycle check is unnecessary because the joining node will robust query for its node ID
     // The joinNetwork fn in startupV2 will handle acceptance
     acceptance.getEventEmitter().emit('accepted')
@@ -444,14 +441,14 @@
  * Part of Join Protocol v2. Gossips all valid join requests.
  */
 const gossipValidJoinRequests: P2P.P2PTypes.GossipHandler<
-{
-  joinRequest: P2P.JoinTypes.JoinRequest,
-  sign: P2P.P2PTypes.Signature
-},
+  {
+    joinRequest: P2P.JoinTypes.JoinRequest
+    sign: P2P.P2PTypes.Signature
+  },
   P2P.NodeListTypes.Node['id']
 > = (
   payload: {
-    joinRequest: P2P.JoinTypes.JoinRequest,
+    joinRequest: P2P.JoinTypes.JoinRequest
     sign: P2P.P2PTypes.Signature
   },
   sender: P2P.NodeListTypes.Node['id'],
@@ -541,10 +538,17 @@
   sender: P2P.NodeListTypes.Node['id'],
   tracker: string
 ) => {
-  if(!checkGossipPayload(payload, {
-    publicKey: 's',
-    sign: 'o',
-  }, 'gossip-unjoin', sender)) {
+  if (
+    !checkGossipPayload(
+      payload,
+      {
+        publicKey: 's',
+        sign: 'o',
+      },
+      'gossip-unjoin',
+      sender
+    )
+  ) {
     return
   }
 
@@ -724,7 +728,15 @@
 }
 
 export const routes = {
-  external: [cycleMarkerRoute, joinRoute, joinedRoute, joinedV2Route, acceptedRoute, unjoinRoute, standbyRefreshRoute],
+  external: [
+    cycleMarkerRoute,
+    joinRoute,
+    joinedRoute,
+    joinedV2Route,
+    acceptedRoute,
+    unjoinRoute,
+    standbyRefreshRoute,
+  ],
   gossip: {
     'gossip-join': gossipJoinRoute,
     'gossip-valid-join-requests': gossipValidJoinRequests,

src/p2p/Join/state.ts

@@ -0,0 +1,17 @@
+import { P2P } from '@shardus/types'
+
+let seen: Set<P2P.P2PTypes.Node['publicKey']>
+export function getSeen(): Set<string> {
+  return seen
+}
+export function resetSeen(): void {
+  seen = new Set()
+}
+
+let allowBogon = false
+export function setAllowBogon(value: boolean): void {
+  allowBogon = value
+}
+export function getAllowBogon(): boolean {
+  return allowBogon
+}

src/p2p/Join/types.ts

@@ -0,0 +1,10 @@
+export interface JoinRequestResponse {
+  /** Whether the join request was accepted. TODO: consider renaming to `accepted`? */
+  success: boolean
+
+  /** A message explaining the result of the join request. */
+  reason: string
+
+  /** Whether the join request could not be accepted due to some error, usually in validating a join request. TODO: consider renaming to `invalid`? */
+  fatal: boolean
+}