substation refactoring

Author: abstrct

x/structs/keeper/substation.go

@@ -19,11 +19,8 @@ import (
 
 // GetNextPlayerId allocate a new substation ID
 func (k Keeper) GetNextSubstationId(ctx context.Context) uint64 {
-
     nextId := k.GetSubstationCount(ctx)
-
     k.SetSubstationCount(ctx, nextId + 1)
-
 	return nextId
 }
 
@@ -60,7 +57,6 @@ func (k Keeper) SetSubstation(ctx context.Context, substation types.Substation)
 
 	ctxSDK := sdk.UnwrapSDKContext(ctx)
     _ = ctxSDK.EventManager().EmitTypedEvent(&types.EventSubstation{Substation: &substation})
-
 }
 
 
@@ -74,77 +70,6 @@ func (k Keeper) ClearSubstation(ctx context.Context, substationId string) {
     _ = ctxSDK.EventManager().EmitTypedEvent(&types.EventDelete{ ObjectId: substationId })
 }
 
-// RemoveSubstation removes a substation from the store
-func (k Keeper) RemoveSubstation(ctx context.Context, substationId string, migrationSubstationId string) {
-	store := prefix.NewStore(runtime.KVStoreAdapter(k.storeService.OpenKVStore(ctx)), types.KeyPrefix(types.SubstationKey))
-
-	/*
-	 * This is going to start out very inefficient. We'll need to tackle
-	 * ways to improve these types of graph traversal
-	 */
-    playerConnections := k.GetGridAttribute(ctx, GetGridAttributeIDByObjectId(types.GridAttributeType_connectionCount, substationId))
-    if (playerConnections > 0) {
-
-        connectedPlayers := k.GetAllPlayerBySubstation(ctx, substationId)
-        // Need all players connected
-        if (migrationSubstationId == "") {
-            for _, disconnectPlayer := range connectedPlayers {
-                k.SubstationDisconnectPlayer(ctx, disconnectPlayer)
-            }
-        } else {
-            if (migrationSubstationId == substationId) {
-                // TODO Move/copy this check to the message verification
-                return  // error
-            }
-            migrationSubstation, migrationSubstationFound := k.GetSubstation(ctx, migrationSubstationId)
-            if (!migrationSubstationFound) {
-                return // error
-            }
-            for _, migratePlayer := range connectedPlayers {
-                k.SubstationConnectPlayer(ctx, migrationSubstation, migratePlayer)
-            }
-
-        }
-	}
-
-
-    /* TODO
-     * This isn't all super amazing, it's a lot of scans. Allocations Out being the
-     * least of the problem but Allocations In will be super inefficient.
-     *
-     * Potential solution in the future is to have a Decommissioning state for substations
-     * where the object isn't deleted until all other things are moved/disconnected but it
-     * monitors allocation connection count until these values are zero.
-     *
-     * Basically, don't let it be deleted until that's all dealt with manually.
-     */
-
-	// Destroy allocations out
-    allocationsOut := k.GetAllAllocationBySourceIndex(ctx, substationId)
-    k.DestroyAllAllocations(ctx, allocationsOut)
-
-	// Disconnect allocations in
-    // TODO Need a more efficient way than scan
-     allocationsIn := k.GetAllAllocationByDestinationIndex(ctx, substationId)
-     k.DestroyAllAllocations(ctx, allocationsIn)
-
-
-	// Clear out Grid attributes
-	k.ClearGridAttribute(ctx, GetGridAttributeIDByObjectId(types.GridAttributeType_load, substationId))
-    k.ClearGridAttribute(ctx, GetGridAttributeIDByObjectId(types.GridAttributeType_capacity, substationId))
-
-    k.ClearGridAttribute(ctx, GetGridAttributeIDByObjectId(types.GridAttributeType_connectionCount, substationId))
-    k.ClearGridAttribute(ctx, GetGridAttributeIDByObjectId(types.GridAttributeType_connectionCapacity, substationId))
-
-    k.ClearGridAttribute(ctx, GetGridAttributeIDByObjectId(types.GridAttributeType_allocationPointerStart, substationId))
-    k.ClearGridAttribute(ctx, GetGridAttributeIDByObjectId(types.GridAttributeType_allocationPointerEnd, substationId))
-
-	store.Delete([]byte(substationId))
-
-	ctxSDK := sdk.UnwrapSDKContext(ctx)
-    _ = ctxSDK.EventManager().EmitTypedEvent(&types.EventDelete{ ObjectId: substationId })
-}
-
 // GetSubstation returns a substation from its id
 func (k Keeper) GetSubstation(ctx context.Context, substationId string) (val types.Substation, found bool) {
 	store := prefix.NewStore(runtime.KVStoreAdapter(k.storeService.OpenKVStore(ctx)), types.KeyPrefix(types.SubstationKey))
@@ -175,44 +100,3 @@ func (k Keeper) GetAllSubstation(ctx context.Context) (list []types.Substation)
 }
 
 
-
-func (k Keeper) SubstationConnectPlayer(ctx context.Context, substation types.Substation, player types.Player) (types.Player, error) {
-
-    // If the player is already on a substation then disconnect them from it first
-    if (player.SubstationId != "") {
-        k.SetGridAttributeDecrement(ctx, GetGridAttributeIDByObjectId(types.GridAttributeType_connectionCount, player.SubstationId), 1)
-
-        // Update Connection Capacity for the old Substation
-        k.UpdateGridConnectionCapacity(ctx, player.SubstationId)
-    }
-
-    // Update the player record
-    player.SubstationId = substation.Id
-    // Commit the player changes
-    k.SetPlayer(ctx, player)
-
-
-    k.SetGridAttributeIncrement(ctx, GetGridAttributeIDByObjectId(types.GridAttributeType_connectionCount, player.SubstationId), 1)
-    // Update Connection Capacity
-    k.UpdateGridConnectionCapacity(ctx, player.SubstationId)
-
-    return player, nil
-
-}
-
-func (k Keeper) SubstationDisconnectPlayer(ctx context.Context, player types.Player) (types.Player, error) {
-
-    // If the player is already on a substation then disconnect them from it first
-    if (player.SubstationId != "") {
-        k.SetGridAttributeDecrement(ctx, GetGridAttributeIDByObjectId(types.GridAttributeType_connectionCount, player.SubstationId), 1)
-        // Update Connection Capacity for the old Substation
-        k.UpdateGridConnectionCapacity(ctx, player.SubstationId)
-    }
-
-    // Update the player record
-    player.SubstationId = ""
-    // Commit the player changes
-    k.SetPlayer(ctx, player)
-
-    return player, nil
-}

x/structs/keeper/substation_cache.go

@@ -88,6 +88,7 @@ func (cache *SubstationCache) Delete(migrationSubstation *SubstationCache) {
         connectedPlayers := cc.GetAllPlayerBySubstation(substationId)
         for _, disconnectPlayer := range connectedPlayers {
             if migrationSubstation.GetSubstationId() == cache.GetSubstationId() {
+               // Somewhat punishes tomfoolery but whatever
                disconnectPlayer.DisconnectSubstation()
             } else {
                disconnectPlayer.MigrateSubstation(migrationSubstation.GetSubstationId())