feat: MOP GUI (#22489)

Signed-off-by: Lazar Petrovic <[email protected]>

Author: lpetrovic05

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/gui/hashgraph/HashgraphPictureOptions.java

@@ -10,11 +10,6 @@ public interface HashgraphPictureOptions {
      */
     boolean isPictureFrozen();
 
-    /**
-     * @return should the hashgraph be expanded
-     */
-    boolean isExpanded();
-
     /**
      * @return should round created be written for every event
      */

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/gui/hashgraph/internal/EventSelector.java

@@ -73,7 +73,7 @@ public void mouseClicked(final MouseEvent me) {
 
         stronglySeen.clear();
         for (final EventImpl e : eventsInPicture) {
-            final int xEvent = metadata.xpos(null, e);
+            final int xEvent = metadata.xpos(e);
             final int yEvent = metadata.ypos(e);
             final double distanceSquared = Math.pow(xEvent - xClicked, 2) + Math.pow(yEvent - yClicked, 2);
             if (distanceSquared <= rSquared - 20) {

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/gui/hashgraph/internal/HashgraphGuiControls.java

@@ -28,8 +28,6 @@ public class HashgraphGuiControls implements HashgraphPictureOptions {
     private final Checkbox freezeCheckbox;
     /** if checked, color vertices only green (non-consensus) or blue (consensus) */
     private final Checkbox simpleColorsCheckbox;
-    /** if checked, use multiple columns per member to void lines crossing */
-    private final Checkbox expandCheckbox;
 
     // the following control which labels to print on each vertex
 
@@ -66,7 +64,6 @@ public HashgraphGuiControls(final ItemListener freezeListener) {
         freezeCheckbox = new Checkbox("Freeze: don't change this window");
         freezeCheckbox.addItemListener(freezeListener);
         simpleColorsCheckbox = new Checkbox("Colors: blue=consensus, green=not");
-        expandCheckbox = new Checkbox("Expand: wider so lines don't cross");
         labelRoundCheckbox = new Checkbox("Labels: Round created");
         labelVoteCheckbox = new Checkbox("Labels: Vote");
         labelEventHashCheckbox = new Checkbox("Labels: Event Hash (h)");
@@ -106,7 +103,6 @@ public HashgraphGuiControls(final ItemListener freezeListener) {
         comps = new Component[] {
             freezeCheckbox,
             simpleColorsCheckbox,
-            expandCheckbox,
             labelRoundCheckbox,
             labelVoteCheckbox,
             labelEventHashCheckbox,
@@ -121,16 +117,6 @@ public HashgraphGuiControls(final ItemListener freezeListener) {
         };
     }
 
-    /**
-     * Set the state of the expanded control
-     *
-     * @param expand
-     * 		the state to set it to
-     */
-    public void setExpanded(final boolean expand) {
-        expandCheckbox.setState(expand);
-    }
-
     /**
      * @return a {@link JPanel} with the controls
      */
@@ -220,11 +206,6 @@ public boolean isPictureFrozen() {
         return freezeCheckbox.getState();
     }
 
-    @Override
-    public boolean isExpanded() {
-        return expandCheckbox.getState();
-    }
-
     @Override
     public boolean writeRoundCreated() {
         return labelRoundCheckbox.getState();

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/gui/hashgraph/internal/HashgraphPicture.java

@@ -7,7 +7,6 @@
 import com.hedera.hapi.node.state.roster.Roster;
 import com.hedera.hapi.node.state.roster.RosterEntry;
 import com.hedera.hapi.platform.event.GossipEvent;
-import com.swirlds.platform.Consensus;
 import com.swirlds.platform.gui.hashgraph.HashgraphGuiConstants;
 import com.swirlds.platform.gui.hashgraph.HashgraphGuiSource;
 import com.swirlds.platform.gui.hashgraph.HashgraphPictureOptions;
@@ -55,8 +54,7 @@ public class HashgraphPicture extends JPanel {
     /** used to store an image when the freeze checkbox is checked */
     private BufferedImage image = null;
 
-    private RosterMetadata nonExpandedMetadata;
-    private RosterMetadata expandedMetadata;
+    private RosterMetadata metadata;
 
     /** used to store coordinates for branched events with a given generation for each branching node */
     private final Map<Long, Map<Long, GenerationCoordinates>> nodeIdToBranchIndexToCoordinates = new HashMap<>();
@@ -70,9 +68,8 @@ public HashgraphPicture(final HashgraphGuiSource hashgraphSource, final Hashgrap
     }
 
     private void createMetadata() {
-        if ((expandedMetadata == null || nonExpandedMetadata == null) && hashgraphSource.isReady()) {
-            expandedMetadata = new RosterMetadata(hashgraphSource.getRoster(), true);
-            nonExpandedMetadata = new RosterMetadata(hashgraphSource.getRoster(), false);
+        if (metadata == null && hashgraphSource.isReady()) {
+            metadata = new RosterMetadata(hashgraphSource.getRoster());
         }
     }
 
@@ -93,7 +90,6 @@ public void paintComponent(final Graphics g) {
             final FontMetrics fm = g.getFontMetrics();
             final Roster roster = hashgraphSource.getRoster();
             final int numMem = roster.rosterEntries().size();
-            final RosterMetadata currentMetadata = options.isExpanded() ? expandedMetadata : nonExpandedMetadata;
 
             List<EventImpl> events;
             if (options.displayLatestEvents()) {
@@ -115,15 +111,15 @@ public void paintComponent(final Graphics g) {
                     .toList();
 
             pictureMetadata = new PictureMetadata(
-                    fm, this.getSize(), currentMetadata, events, hashgraphSource, nodeIdToBranchIndexToCoordinates);
+                    fm, this.getSize(), metadata, events, hashgraphSource, nodeIdToBranchIndexToCoordinates);
 
             selector.setMetadata(pictureMetadata);
             selector.setEventsInPicture(events);
 
             g.setColor(Color.BLACK);
 
-            for (int i = 0; i < currentMetadata.getNumColumns(); i++) {
-                final String name = currentMetadata.getLabel(i);
+            for (int i = 0; i < metadata.getNumColumns(); i++) {
+                final String name = metadata.getLabel(i);
 
                 // gap between columns
                 final int betweenGap = pictureMetadata.getGapBetweenColumns();
@@ -183,8 +179,7 @@ public void paintComponent(final Graphics g) {
      * @param borderColor the color of the border
      */
     private void drawBorderAroundEvent(final Graphics g, final int d, final EventImpl event, final Color borderColor) {
-        final int xPos =
-                pictureMetadata.xpos(event.getOtherParent() != null ? event.getOtherParent() : event, event) - d / 2;
+        final int xPos = pictureMetadata.xpos(event) - d / 2;
         final int yPos = pictureMetadata.ypos(event) - d / 2;
         g.setColor(borderColor);
         g.fillOval(xPos - 5, yPos - 5, d + 10, d + 10);
@@ -195,50 +190,38 @@ private void drawLinksToParents(final Graphics g, final EventImpl event) {
         final Graphics2D g2d = (Graphics2D) g;
         Stroke savedStroke = null;
         g.setColor(HashgraphGuiUtils.eventColor(event, options));
-        boolean selectedLines = selector.isSelected(event);
+        final boolean selectedLines = selector.isSelected(event);
         if (selectedLines) {
             g.setColor(Color.MAGENTA);
             savedStroke = g2d.getStroke();
             g2d.setStroke(new BasicStroke(3));
         }
 
-        final EventImpl e1 = event.getSelfParent();
-        EventImpl e2 = event.getOtherParent();
         final Roster roster = hashgraphSource.getRoster();
-        if (e2 != null
-                && (RosterUtils.getIndex(roster, e2.getCreatorId().id()) == -1
-                        || RosterUtils.getIndex(roster, e2.getCreatorId().id())
-                                >= roster.rosterEntries().size())) {
-            // if the creator of the other parent has been removed,
-            // treat it as if there is no other parent
-            e2 = null;
-        }
-
-        if (e1 != null && e1.getNGen() >= pictureMetadata.getMinGen()) {
-            g.drawLine(
-                    pictureMetadata.xpos(e2, event),
-                    pictureMetadata.ypos(event),
-                    pictureMetadata.xpos(e2, e1),
-                    pictureMetadata.ypos(e1));
-
-            if (selectedLines) {
-                final Color currentColor = g.getColor();
-                drawBorderAroundEvent(g, d, e1, Color.MAGENTA);
-                drawEventCircle(g, e1, options, d);
-                g.setColor(currentColor);
+        for (final EventImpl parent : event.getAllParents()) {
+            final long id = parent.getCreatorId().id();
+            if ((RosterUtils.getIndex(roster, id) == -1
+                    || RosterUtils.getIndex(roster, id)
+                            >= roster.rosterEntries().size())) {
+                // if the creator of the other parent has been removed,
+                // treat it as if there is no other parent
+                continue;
             }
-        }
-        if (e2 != null && e2.getNGen() >= pictureMetadata.getMinGen()) {
+            if (parent.getNGen() < pictureMetadata.getMinGen()) {
+                // parent is out of range, don't draw line to it
+                continue;
+            }
+
             g.drawLine(
-                    pictureMetadata.xpos(e2, event),
+                    pictureMetadata.xpos(event),
                     pictureMetadata.ypos(event),
-                    pictureMetadata.xpos(event, e2),
-                    pictureMetadata.ypos(e2));
+                    pictureMetadata.xpos(parent),
+                    pictureMetadata.ypos(parent));
 
             if (selectedLines) {
                 final Color currentColor = g.getColor();
-                drawBorderAroundEvent(g, d, e2, Color.MAGENTA);
-                drawEventCircle(g, e2, options, d);
+                drawBorderAroundEvent(g, d, parent, Color.MAGENTA);
+                drawEventCircle(g, parent, options, d);
                 g.setColor(currentColor);
             }
         }
@@ -250,7 +233,6 @@ private void drawLinksToParents(final Graphics g, final EventImpl event) {
 
     private void drawEventCircle(
             final Graphics g, final EventImpl event, final HashgraphPictureOptions options, final int d) {
-        final Consensus consensus = hashgraphSource.getEventStorage().getConsensus();
         final FontMetrics fm = g.getFontMetrics();
         final int fa = fm.getMaxAscent();
         final int fd = fm.getMaxDescent();
@@ -270,7 +252,7 @@ private void drawEventCircle(
             color = HashgraphGuiUtils.eventColor(event, options);
         }
 
-        final int xPos = pictureMetadata.xpos(e2, event) - d / 2;
+        final int xPos = pictureMetadata.xpos(event) - d / 2;
         final int yPos = pictureMetadata.ypos(event) - d / 2;
 
         if (selector.isSelected(event)) {
@@ -335,7 +317,7 @@ private void drawEventCircle(
         if (!s.isEmpty()) {
             final Rectangle2D rect = fm.getStringBounds(s, g);
 
-            final int x = (int) (pictureMetadata.xpos(e2, event) - rect.getWidth() / 2. - fa / 4.);
+            final int x = (int) (pictureMetadata.xpos(event) - rect.getWidth() / 2. - fa / 4.);
             final int y = (int) (pictureMetadata.ypos(event) + rect.getHeight() / 2. - fd / 2);
             g.setColor(HashgraphGuiConstants.LABEL_OUTLINE);
             g.drawString(s, x - 1, y - 1);

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/gui/hashgraph/internal/PictureMetadata.java

@@ -96,8 +96,8 @@ public int getSideGap() {
         return (int) (getGapBetweenColumns() * MARGIN_FRACTION);
     }
 
-    /** find x position on the screen for event e2 which has an other-parent of e1 (or null if none) */
-    public int xpos(final EventImpl e1, final EventImpl e2) {
+    /** find x position on the screen for event e */
+    public int xpos(final EventImpl e) {
         // the gap between left side of screen and leftmost column
         // is marginFraction times the gap between columns (and similarly for right side)
         final double marginFraction = 0.5;
@@ -106,14 +106,14 @@ public int xpos(final EventImpl e1, final EventImpl e2) {
         // gap between leftmost column and left edge (and similar on right)
         final int sideGap = (int) (betweenGap * marginFraction);
 
-        // find the column for e2 next to the column for e1
-        int xPos = sideGap + rosterMetadata.mems2col(e1, e2) * betweenGap;
+        // find the column for e
+        int xPos = sideGap + rosterMetadata.mems2col(e) * betweenGap;
 
-        final GossipEvent e2GossipEvent = e2.getBaseEvent().getGossipEvent();
+        final GossipEvent e2GossipEvent = e.getBaseEvent().getGossipEvent();
 
         // check if we have a branched event
         if (hashgraphSource.getEventStorage().getBranchedEventsMetadata().containsKey(e2GossipEvent)) {
-            return calculateXPosForBranchedEvent(e2, xPos);
+            return calculateXPosForBranchedEvent(e, xPos);
         }
 
         return xPos;

platform-sdk/swirlds-platform-core/src/main/java/com/swirlds/platform/gui/hashgraph/internal/RosterMetadata.java

@@ -4,7 +4,6 @@
 import com.hedera.hapi.node.state.roster.Roster;
 import com.swirlds.platform.internal.EventImpl;
 import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 import java.util.Objects;
 import org.hiero.consensus.roster.RosterUtils;
 
@@ -19,20 +18,7 @@ public class RosterMetadata {
     /** the labels of all the members */
     private final String[] memberLabels;
 
-    // the following allow each member to have multiple columns so lines don't cross
-    /** number of columns (more than number of members if preventCrossings) */
-    private final int numColumns;
-    /** mems2col[a][b] = which member-b column is adjacent to some member-a column */
-    private final int[][] mems2col;
-    /** col2mems[c][0] = the member for column c, col2mems[c][1] = second member or -1 if none */
-    private final int[][] col2mems;
-
-    /**
-     * In order to draw this "expanded" hashgraph (where each member has multiple columns and lines don't
-     * cross), we need several data tables. So fill in four arrays: numMembers, mems2col, col2mems, and
-     * names, if they haven't already been filled in, or if the number of members has changed.
-     */
-    public RosterMetadata(@NonNull final Roster roster, final boolean expand) {
+    public RosterMetadata(@NonNull final Roster roster) {
         this.roster = Objects.requireNonNull(roster, "roster must not be null");
         final int m = roster.rosterEntries().size();
         numMembers = m;
@@ -43,54 +29,6 @@ public RosterMetadata(@NonNull final Roster roster, final boolean expand) {
                             roster.rosterEntries().get(i).nodeId(),
                             roster.rosterEntries().get(i).weight());
         }
-
-        // fix corner cases missed by the formulas here
-        if (numMembers == 1) {
-            numColumns = 1;
-            col2mems = new int[][] {{0, -1}};
-            mems2col = new int[][] {{0}};
-            return;
-        } else if (numMembers == 2) {
-            numColumns = 2;
-            col2mems = new int[][] {{0, -1}, {1, -1}};
-            mems2col = new int[][] {{0, 1}, {0, 0}};
-            return;
-        }
-
-        if (!expand) { // if unchecked so only one column per member, then the arrays are trivial
-            numColumns = m;
-            mems2col = new int[m][m];
-            col2mems = new int[numColumns][2];
-            for (int i = 0; i < m; i++) {
-                col2mems[i][0] = i;
-                col2mems[i][1] = -1;
-                for (int j = 0; j < m; j++) {
-                    mems2col[i][j] = j;
-                }
-            }
-            return;
-        }
-
-        numColumns = m * (m - 1) / 2 + 1;
-        mems2col = new int[m][m];
-        col2mems = new int[numColumns][2];
-
-        for (int x = 0; x < m * (m - 1) / 2 + 1; x++) {
-            final int d1 = ((m % 2) == 1) ? 0 : 2 * ((x - 1) / (m - 1)); // amount to add to x to skip
-            // columns
-            col2mems[x][0] =
-                    HashgraphGuiUtils.col2mem(m, d1 + x); // find even m answer by asking for m+1 with skipped cols
-            col2mems[x][1] = (((m % 2) == 1) || ((x % (m - 1)) > 0) || (x == 0) || (x == m * (m - 1) / 2))
-                    ? -1
-                    : HashgraphGuiUtils.col2mem(m, d1 + x + 2);
-            final int d = ((m % 2) == 1) ? 0 : 2 * (x / (m - 1)); // amount to add to x to skip columns
-            final int a = HashgraphGuiUtils.col2mem(m, d + x);
-            final int b = HashgraphGuiUtils.col2mem(m, d + x + 1);
-            if (x < m * (m - 1) / 2) { // on the last iteration, x+1 is invalid, so don't record it
-                mems2col[b][a] = x;
-                mems2col[a][b] = x + 1;
-            }
-        }
     }
 
     /**
@@ -104,24 +42,15 @@ public int getNumMembers() {
      * @return the number of columns to draw
      */
     public int getNumColumns() {
-        return numColumns;
+        return numMembers;
     }
 
     /**
-     * find the column for e2 next to the column for e1
+     * find the column for e
      */
-    public int mems2col(@Nullable final EventImpl e1, @NonNull final EventImpl e2) {
-        Objects.requireNonNull(e2, "e2 must not be null");
-        // To support Noncontiguous NodeId in the roster,
-        // the mems2col array is now based on indexes of NodeIds in the roster.
-        final int e2Index = RosterUtils.getIndex(roster, e2.getCreatorId().id());
-        if (e1 != null) {
-            final int e1Index = RosterUtils.getIndex(roster, e1.getCreatorId().id());
-            return mems2col[e1Index][e2Index];
-        }
-        // there is no e1, so pick one of the e2 columns arbitrarily (next to 0 or 1). If there is only 1
-        // member, avoid the array out of bounds exception
-        return mems2col[e2Index == 0 ? getNumColumns() == 1 ? 0 : 1 : 0][e2Index];
+    public int mems2col(@NonNull final EventImpl e) {
+        Objects.requireNonNull(e, "e must not be null");
+        return RosterUtils.getIndex(roster, e.getCreatorId().id());
     }
 
     /**
@@ -130,10 +59,6 @@ public int mems2col(@Nullable final EventImpl e1, @NonNull final EventImpl e2) {
      * @return the label of the member with the provided index
      */
     public String getLabel(final int i) {
-        if (col2mems[i][1] == -1) {
-            return "" + memberLabels[col2mems[i][0]];
-        } else {
-            return "" + memberLabels[col2mems[i][0]] + "|" + memberLabels[col2mems[i][1]];
-        }
+        return memberLabels[i];
     }
 }