From 6d19851e4330dc2e47a0927354dbd61a4199965f Mon Sep 17 00:00:00 2001
From: Colin Alworth <colinalworth@deephaven.io>
Date: Fri, 19 Jul 2024 16:55:07 -0500
Subject: [PATCH] refactor!: Remove or inline Assert/Require methods so the
 classes can be shared with JS API (#5782)

Where necessary, inlined these methods as one-liners. In some cases, the
instance checks are reduced to not-null checks, since Java already would
guarantee that the variables were the correct type.

BREAKING CHANGES: Removed holdsLock, notHoldsLock, instanceOf,
notInstanceOf from Assert and Require.
Partial #188
---
 .../java/io/deephaven/base/verify/Assert.java | 48 ------------------
 .../io/deephaven/base/verify/Require.java     | 49 -------------------
 .../multiseries/AbstractMultiSeries.java      |  2 +-
 .../util/channel/CachedChannelProvider.java   |  2 +-
 .../main/java/io/deephaven/util/Utils.java    |  2 +-
 .../util/datastructures/SubscriptionSet.java  |  2 +-
 .../engine/table/impl/SortOperation.java      |  1 -
 .../table/impl/by/AggregationProcessor.java   |  1 -
 .../table/impl/lang/QueryLanguageParser.java  |  1 -
 .../impl/util/BaseArrayBackedInputTable.java  |  2 +-
 .../table/impl/QueryTableAggregationTest.java |  2 +-
 .../engine/util/TestJobScheduler.java         | 29 +++++------
 .../barrage/table/BarrageTable.java           |  2 +-
 .../barrage/BarrageMessageProducer.java       |  8 +--
 .../HierarchicalTableViewSubscription.java    |  4 +-
 15 files changed, 24 insertions(+), 131 deletions(-)

diff --git a/Base/src/main/java/io/deephaven/base/verify/Assert.java b/Base/src/main/java/io/deephaven/base/verify/Assert.java
index 394eac6260b..ee33fe7af0a 100644
--- a/Base/src/main/java/io/deephaven/base/verify/Assert.java
+++ b/Base/src/main/java/io/deephaven/base/verify/Assert.java
@@ -23,12 +23,6 @@
  * <li>void valuesNeverOccur(value0, name0, value1, name1, ... )
  * </ul>
  * <ul>
- * <li>void holdsLock/notHoldsLock(Object, String name)
- * </ul>
- * <ul>
- * <li>void instanceOf/notInstanceOf(Object, String name, Class type[, int numCallsBelowRequirer])
- * </ul>
- * <ul>
  * <li>void eq/neq(boolean/char/byte/short/int/long/float/double, String name0,
  * boolean/char/byte/short/int/long/float/double[, String name1])
  * <li>void lt/leq/gt/geq(char/byte/short/int/long/float/double, String name0, char/byte/short/int/long/float/double[,
@@ -316,48 +310,6 @@ public static AssertionFailure valueNeverOccurs(double d, String name) {
         return null;
     }
 
-    // ################################################################
-    // holdsLock, notHoldsLock
-
-    // ----------------------------------------------------------------
-    /** assert (o != null &amp;&amp; (current thread holds o's lock)) */
-    public static void holdsLock(Object o, String name) {
-        neqNull(o, "o");
-        if (!Thread.holdsLock(o)) {
-            fail("\"" + Thread.currentThread().getName() + "\".holdsLock(" + name + ")");
-        }
-    }
-
-    // ----------------------------------------------------------------
-    /** assert (o != null &amp;&amp; !(current thread holds o's lock)) */
-    public static void notHoldsLock(Object o, String name) {
-        neqNull(o, "o");
-        if (Thread.holdsLock(o)) {
-            fail("!\"" + Thread.currentThread().getName() + "\".holdsLock(" + name + ")");
-        }
-    }
-
-    // ################################################################
-    // instanceOf, notInstanceOf
-
-    // ----------------------------------------------------------------
-    /** assert (o instanceof type) */
-    public static void instanceOf(Object o, String name, Class<?> type) {
-        if (!type.isInstance(o)) {
-            fail(name + " instanceof " + type, null == o ? ExceptionMessageUtil.valueAndName(o, name)
-                    : name + " instanceof " + o.getClass() + " (" + ExceptionMessageUtil.valueAndName(o, name) + ")");
-        }
-    }
-
-    // ----------------------------------------------------------------
-    /** assert !(o instanceof type) */
-    public static void notInstanceOf(Object o, String name, Class<?> type) {
-        if (type.isInstance(o)) {
-            fail("!(" + name + " instanceof " + type + ")",
-                    name + " instanceof " + o.getClass() + " (" + ExceptionMessageUtil.valueAndName(o, name) + ")");
-        }
-    }
-
     // ################################################################
     // eq (primitiveValue == primitiveValue)
 
diff --git a/Base/src/main/java/io/deephaven/base/verify/Require.java b/Base/src/main/java/io/deephaven/base/verify/Require.java
index 66ee25f39b4..19607f45aea 100644
--- a/Base/src/main/java/io/deephaven/base/verify/Require.java
+++ b/Base/src/main/java/io/deephaven/base/verify/Require.java
@@ -28,12 +28,6 @@
  * <li>void valuesNeverOccur(value0, name0, value1, name1, ... )
  * </ul>
  * <ul>
- * <li>void holdsLock/notHoldsLock(Object, String name)
- * </ul>
- * <ul>
- * <li>void instanceOf/notInstanceOf(Object, String name, Class type)
- * </ul>
- * <ul>
  * <li>void eq/neq(boolean/char/byte/short/int/long/float/double, String name0,
  * boolean/char/byte/short/int/long/float/double[, String name1])
  * <li>void lt/leq/gt/geq(char/byte/short/int/long/float/double, String name0, char/byte/short/int/long/float/double[,
@@ -337,49 +331,6 @@ public static RequirementFailure valueNeverOccurs(double d, String name) {
         return null;
     }
 
-    // ################################################################
-    // holdsLock, notHoldsLock
-
-    // ----------------------------------------------------------------
-
-    public static void holdsLock(Object o, String name) {
-        neqNull(o, "o");
-        if (!Thread.holdsLock(o)) {
-            fail("\"" + Thread.currentThread().getName() + "\".holdsLock(" + name + ")");
-        }
-    }
-
-    // ----------------------------------------------------------------
-
-    public static void notHoldsLock(Object o, String name) {
-        neqNull(o, "o");
-        if (Thread.holdsLock(o)) {
-            fail("!\"" + Thread.currentThread().getName() + "\".holdsLock(" + name + ")");
-        }
-    }
-
-
-    // ################################################################
-    // instanceOf, notInstanceOf
-
-    // ----------------------------------------------------------------
-
-    public static <T> void instanceOf(Object o, String name, Class<T> type) {
-        if (!type.isInstance(o)) {
-            fail(name + " instanceof " + type, null == o ? ExceptionMessageUtil.valueAndName(o, name)
-                    : name + " instanceof " + o.getClass() + " (" + ExceptionMessageUtil.valueAndName(o, name) + ")");
-        }
-    }
-
-    // ----------------------------------------------------------------
-
-    public static <T> void notInstanceOf(Object o, String name, Class<T> type) {
-        if (type.isInstance(o)) {
-            fail("!(" + name + " instanceof " + type + ")",
-                    name + " instanceof " + o.getClass() + " (" + ExceptionMessageUtil.valueAndName(o, name) + ")");
-        }
-    }
-
     // ################################################################
     // eq (primitiveValue == primitiveValue)
 
diff --git a/Plot/src/main/java/io/deephaven/plot/datasets/multiseries/AbstractMultiSeries.java b/Plot/src/main/java/io/deephaven/plot/datasets/multiseries/AbstractMultiSeries.java
index b8bbbf46c80..5df283c53b1 100644
--- a/Plot/src/main/java/io/deephaven/plot/datasets/multiseries/AbstractMultiSeries.java
+++ b/Plot/src/main/java/io/deephaven/plot/datasets/multiseries/AbstractMultiSeries.java
@@ -218,7 +218,7 @@ private List<SERIES> getSeries() {
     @Override
     // this should be run under a seriesLock
     public void addSeries(SERIES series, Object key) {
-        Assert.holdsLock(seriesLock, "seriesLock");
+        Assert.assertion(Thread.holdsLock(seriesLock), "Thread.holdsLock(seriesLock)");
 
         if (seriesKeys == null) {
             seriesKeys = new HashSet<>();
diff --git a/Util/channel/src/main/java/io/deephaven/util/channel/CachedChannelProvider.java b/Util/channel/src/main/java/io/deephaven/util/channel/CachedChannelProvider.java
index 92666983263..507bf46b286 100644
--- a/Util/channel/src/main/java/io/deephaven/util/channel/CachedChannelProvider.java
+++ b/Util/channel/src/main/java/io/deephaven/util/channel/CachedChannelProvider.java
@@ -172,7 +172,7 @@ private synchronized void returnPoolableChannel(@NotNull final CachedChannel cac
     }
 
     private long advanceClock() {
-        Assert.holdsLock(this, "this");
+        Assert.assertion(Thread.holdsLock(this), "Thread.holdsLock(this)");
         final long newClock = ++logicalClock;
         if (newClock > 0) {
             return newClock;
diff --git a/Util/src/main/java/io/deephaven/util/Utils.java b/Util/src/main/java/io/deephaven/util/Utils.java
index 6c5e0ea94ba..8645ac598aa 100644
--- a/Util/src/main/java/io/deephaven/util/Utils.java
+++ b/Util/src/main/java/io/deephaven/util/Utils.java
@@ -376,7 +376,7 @@ public static String getSimpleNameFor(@NotNull Class<?> objectClass) {
      * require (o instanceof type)
      */
     public static <T> T castTo(Object o, String name, Class<T> type) {
-        io.deephaven.base.verify.Require.instanceOf(o, name, type);
+        io.deephaven.base.verify.Require.requirement(type.isInstance(o), name);
         // noinspection unchecked
         return (T) o;
     }
diff --git a/Util/src/main/java/io/deephaven/util/datastructures/SubscriptionSet.java b/Util/src/main/java/io/deephaven/util/datastructures/SubscriptionSet.java
index 0d9fc96a8c0..ccb114cfbe1 100644
--- a/Util/src/main/java/io/deephaven/util/datastructures/SubscriptionSet.java
+++ b/Util/src/main/java/io/deephaven/util/datastructures/SubscriptionSet.java
@@ -54,7 +54,7 @@ private boolean isActive() {
          * Activate this subscription entry. Must hold the lock on the enclosing subscription set.
          */
         public void activate() {
-            Assert.holdsLock(SubscriptionSet.this, "SubscriptionSet.this");
+            Assert.assertion(Thread.holdsLock(SubscriptionSet.this), "Thread.holdsLock(SubscriptionSet.this)");
             active = true;
         }
     }
diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/SortOperation.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/SortOperation.java
index 34f65b86f7a..6bb82d86e58 100644
--- a/engine/table/src/main/java/io/deephaven/engine/table/impl/SortOperation.java
+++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/SortOperation.java
@@ -362,7 +362,6 @@ public static LongUnaryOperator getReverseLookup(@NotNull final Table parent, @N
             Assert.neqNull(value, "sort result reverse lookup");
         }
         if (value != null) {
-            Assert.instanceOf(value, "sort result reverse lookup", LongUnaryOperator.class);
             return (LongUnaryOperator) value;
         }
         final RowRedirection sortRedirection = getRowRedirection(sortResult);
diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/by/AggregationProcessor.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/by/AggregationProcessor.java
index ab1d7e83929..8ca700c7eda 100644
--- a/engine/table/src/main/java/io/deephaven/engine/table/impl/by/AggregationProcessor.java
+++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/by/AggregationProcessor.java
@@ -2005,7 +2005,6 @@ public void supplyRowLookup(@NotNull final Supplier<AggregationRowLookup> rowLoo
     public static AggregationRowLookup getRowLookup(@NotNull final Table aggregationResult) {
         final Object value = aggregationResult.getAttribute(AGGREGATION_ROW_LOOKUP_ATTRIBUTE);
         Assert.neqNull(value, "aggregation result row lookup");
-        Assert.instanceOf(value, "aggregation result row lookup", AggregationRowLookup.class);
         return (AggregationRowLookup) value;
     }
 }
diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/lang/QueryLanguageParser.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/lang/QueryLanguageParser.java
index 36b10f914fa..5cd2418c83b 100644
--- a/engine/table/src/main/java/io/deephaven/engine/table/impl/lang/QueryLanguageParser.java
+++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/lang/QueryLanguageParser.java
@@ -1670,7 +1670,6 @@ public Class<?> visit(UnaryExpr n, VisitArgs printer) {
             if (isNonequalOpOverload && printer.hasStringBuilder()) {
                 // sanity checks -- the inner expression *must* be a BinaryExpr (for ==), and it must be replaced in
                 // this UnaryExpr with a MethodCallExpr (for "eq()" or possibly "isNull()").
-                Assert.instanceOf(n.getExpression(), "n.getExpression()", MethodCallExpr.class);
                 final MethodCallExpr methodCall = (MethodCallExpr) n.getExpression();
                 final String methodName = methodCall.getNameAsString();
                 if (!"eq".equals(methodName) && !"isNull".equals(methodName)) {
diff --git a/engine/table/src/main/java/io/deephaven/engine/table/impl/util/BaseArrayBackedInputTable.java b/engine/table/src/main/java/io/deephaven/engine/table/impl/util/BaseArrayBackedInputTable.java
index b1d09589f73..88f5097080f 100644
--- a/engine/table/src/main/java/io/deephaven/engine/table/impl/util/BaseArrayBackedInputTable.java
+++ b/engine/table/src/main/java/io/deephaven/engine/table/impl/util/BaseArrayBackedInputTable.java
@@ -171,7 +171,7 @@ private final class PendingChange {
         String error;
 
         private PendingChange(@NotNull Table table, boolean delete) {
-            Assert.holdsLock(pendingChanges, "pendingChanges");
+            Assert.assertion(Thread.holdsLock(pendingChanges), "Thread.holdsLock(pendingChanges)");
             Assert.neqNull(table, "table");
             this.table = table;
             this.delete = delete;
diff --git a/engine/table/src/test/java/io/deephaven/engine/table/impl/QueryTableAggregationTest.java b/engine/table/src/test/java/io/deephaven/engine/table/impl/QueryTableAggregationTest.java
index 7dc900779b8..a9aa3a9c392 100644
--- a/engine/table/src/test/java/io/deephaven/engine/table/impl/QueryTableAggregationTest.java
+++ b/engine/table/src/test/java/io/deephaven/engine/table/impl/QueryTableAggregationTest.java
@@ -3921,7 +3921,7 @@ public void testKeyColumnMissing() {
             final Table agg = data.selectDistinct("NonExistentCol");
             fail("Should have thrown an exception");
         } catch (Exception ex) {
-            io.deephaven.base.verify.Assert.instanceOf(ex, "ex", IllegalArgumentException.class);
+            assertTrue(ex instanceof IllegalArgumentException);
             io.deephaven.base.verify.Assert.assertion(
                     ex.getMessage().contains("Missing columns: [NonExistentCol]"),
                     "ex.getMessage().contains(\"Missing columns: [NonExistentCol]\")",
diff --git a/engine/table/src/test/java/io/deephaven/engine/util/TestJobScheduler.java b/engine/table/src/test/java/io/deephaven/engine/util/TestJobScheduler.java
index 2e05d840473..1058cdb6e3a 100644
--- a/engine/table/src/test/java/io/deephaven/engine/util/TestJobScheduler.java
+++ b/engine/table/src/test/java/io/deephaven/engine/util/TestJobScheduler.java
@@ -23,6 +23,8 @@
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.atomic.AtomicInteger;
 
+import static org.junit.Assert.assertNotNull;
+
 public final class TestJobScheduler {
 
     @Rule
@@ -148,8 +150,7 @@ public void close() {
                     0,
                     50,
                     (context, idx, nec, resume) -> {
-                        // verify the type is correct
-                        Assert.instanceOf(context, "context", TestJobThreadContext.class);
+                        assertNotNull(context);
 
                         completed[idx] = true;
                         resume.run();
@@ -261,8 +262,7 @@ public void close() {
                     0,
                     50,
                     (context, idx, nec, resume) -> {
-                        // verify the type is correct
-                        Assert.instanceOf(context, "context", TestJobThreadContext.class);
+                        assertNotNull(context);
 
                         completed[idx] = true;
                         resume.run();
@@ -395,8 +395,7 @@ public void close() {
                     0,
                     50,
                     (context, idx, nec) -> {
-                        // verify the type is correct
-                        Assert.instanceOf(context, "context", TestJobThreadContext.class);
+                        assertNotNull(context);
 
                         // throw before "doing work" to make verification easy
                         if (idx == 10) {
@@ -466,8 +465,7 @@ public void close() {
                     0,
                     50,
                     (context, idx, nec, resume) -> {
-                        // verify the type is correct
-                        Assert.instanceOf(context, "context", TestJobThreadContext.class);
+                        assertNotNull(context);
 
                         completed[idx] = true;
 
@@ -551,8 +549,7 @@ public void close() {
                                 0,
                                 60,
                                 (context2, idx2, nec2) -> {
-                                    // verify the type is correct
-                                    Assert.instanceOf(context2, "context2", TestJobThreadContext.class);
+                                    assertNotNull(context2);
 
                                     // throw before "doing work" to make verification easy
                                     if (idx1 == 10 && idx2 == 10) {
@@ -631,8 +628,7 @@ public void close() {
                                 0,
                                 60,
                                 (context2, idx2, nec2) -> {
-                                    // verify the type is correct
-                                    Assert.instanceOf(context2, "context2", TestJobThreadContext.class);
+                                    assertNotNull(context2);
                                     completed[idx1][idx2] = true;
                                 }, r1, nec1);
                     },
@@ -701,8 +697,7 @@ public void close() {
                                 0,
                                 60,
                                 (context2, idx2, nec2) -> {
-                                    // verify the type is correct
-                                    Assert.instanceOf(context2, "context2", TestJobThreadContext.class);
+                                    assertNotNull(context2);
                                     completed[idx1][idx2] = true;
                                 }, r1, nec1);
                     },
@@ -769,8 +764,7 @@ public void close() {
                         0,
                         50,
                         (context, idx, nec) -> {
-                            // verify the type is correct
-                            Assert.instanceOf(context, "context", TestJobThreadContext.class);
+                            assertNotNull(context);
 
                             // throw before "doing work" to make verification easy
                             if (idx == 10) {
@@ -824,8 +818,7 @@ public void close() {
                         0,
                         50,
                         (context, idx, nec) -> {
-                            // verify the type is correct
-                            Assert.instanceOf(context, "context", TestJobThreadContext.class);
+                            assertNotNull(context);
                             completed[idx] = true;
                         },
                         () -> {
diff --git a/extensions/barrage/src/main/java/io/deephaven/extensions/barrage/table/BarrageTable.java b/extensions/barrage/src/main/java/io/deephaven/extensions/barrage/table/BarrageTable.java
index 118c968e479..514f76f05d6 100644
--- a/extensions/barrage/src/main/java/io/deephaven/extensions/barrage/table/BarrageTable.java
+++ b/extensions/barrage/src/main/java/io/deephaven/extensions/barrage/table/BarrageTable.java
@@ -293,7 +293,7 @@ protected synchronized void updateServerViewport(
             final RowSet viewport,
             final BitSet columns,
             final boolean reverseViewport) {
-        Assert.holdsLock(this, "BarrageTable.this");
+        Assert.assertion(Thread.holdsLock(this), "Thread.holdsLock(this)");
 
         final RowSet finalViewport = viewport == null ? null : viewport.copy();
         final BitSet finalColumns = (columns == null || columns.cardinality() == numColumns())
diff --git a/server/src/main/java/io/deephaven/server/barrage/BarrageMessageProducer.java b/server/src/main/java/io/deephaven/server/barrage/BarrageMessageProducer.java
index ddc067f0a33..e0420105d05 100644
--- a/server/src/main/java/io/deephaven/server/barrage/BarrageMessageProducer.java
+++ b/server/src/main/java/io/deephaven/server/barrage/BarrageMessageProducer.java
@@ -695,7 +695,7 @@ public void close() {
     }
 
     private void enqueueUpdate(final TableUpdate upstream) {
-        Assert.holdsLock(this, "enqueueUpdate must hold lock!");
+        Assert.assertion(Thread.holdsLock(this), "enqueueUpdate must hold lock!");
 
         final WritableRowSet addsToRecord;
         final RowSet modsToRecord;
@@ -952,7 +952,7 @@ private void enqueueUpdate(final TableUpdate upstream) {
     }
 
     private void schedulePropagation() {
-        Assert.holdsLock(this, "schedulePropagation must hold lock!");
+        Assert.assertion(Thread.holdsLock(this), "schedulePropagation must hold lock!");
 
         // copy lastUpdateTime so we are not duped by the re-read
         final long localLastUpdateTime = lastUpdateTime;
@@ -1625,7 +1625,7 @@ private void propagateSnapshotForSubscription(final Subscription subscription,
     }
 
     private BarrageMessage aggregateUpdatesInRange(final int startDelta, final int endDelta) {
-        Assert.holdsLock(this, "propagateUpdatesInRange must hold lock!");
+        Assert.assertion(Thread.holdsLock(this), "propagateUpdatesInRange must hold lock!");
 
         final boolean singleDelta = endDelta - startDelta == 1;
         final BarrageMessage downstream = new BarrageMessage();
@@ -2110,7 +2110,7 @@ private void buildPostSnapshotViewports(boolean ignorePending) {
     }
 
     private void promoteSnapshotToActive() {
-        Assert.holdsLock(this, "promoteSnapshotToActive must hold lock!");
+        Assert.assertion(Thread.holdsLock(this), "promoteSnapshotToActive must hold lock!");
 
         if (activeViewport != null) {
             activeViewport.close();
diff --git a/server/src/main/java/io/deephaven/server/hierarchicaltable/HierarchicalTableViewSubscription.java b/server/src/main/java/io/deephaven/server/hierarchicaltable/HierarchicalTableViewSubscription.java
index 4bf7f7e52b4..a0e18a46ad6 100644
--- a/server/src/main/java/io/deephaven/server/hierarchicaltable/HierarchicalTableViewSubscription.java
+++ b/server/src/main/java/io/deephaven/server/hierarchicaltable/HierarchicalTableViewSubscription.java
@@ -422,7 +422,7 @@ public void setViewport(
     }
 
     private void scheduleImmediately(final long currentTimeNanos) {
-        Assert.holdsLock(schedulingLock, "schedulingLock");
+        Assert.assertion(Thread.holdsLock(schedulingLock), "Thread.holdsLock(schedulingLock)");
         if (!snapshotPending || currentTimeNanos < scheduledTimeNanos) {
             snapshotPending = true;
             scheduledTimeNanos = currentTimeNanos;
@@ -431,7 +431,7 @@ private void scheduleImmediately(final long currentTimeNanos) {
     }
 
     private void scheduleAtInterval(final long currentTimeNanos) {
-        Assert.holdsLock(schedulingLock, "schedulingLock");
+        Assert.assertion(Thread.holdsLock(schedulingLock), "Thread.holdsLock(schedulingLock)");
         final long targetTimeNanos = lastSnapshotTimeNanos + intervalDurationNanos;
         final long delayNanos = targetTimeNanos - currentTimeNanos;
         if (delayNanos < 0) {