[beam] 02/11: Add SerializationDebugger

[ec...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

echauchot pushed a commit to branch spark-runner_structured-streaming
in repository https://gitbox.apache.org/repos/asf/beam.git

commit 5c9fcd34b7b092c1d2c0935aee06ae1fd412ed30
Author: Etienne Chauchot <ec...@apache.org>
AuthorDate: Fri Jan 11 10:07:23 2019 +0100

    Add SerializationDebugger
---
 .../utils/SerializationDebugger.java               | 130 +++++++++++++++++++++
 .../structuredstreaming/utils/package-info.java    |  20 ++++
 2 files changed, 150 insertions(+)

diff --git a/runners/spark-structured-streaming/src/test/java/org/apache/beam/runners/spark/structuredstreaming/utils/SerializationDebugger.java b/runners/spark-structured-streaming/src/test/java/org/apache/beam/runners/spark/structuredstreaming/utils/SerializationDebugger.java
new file mode 100644
index 0000000..0e47969
--- /dev/null
+++ b/runners/spark-structured-streaming/src/test/java/org/apache/beam/runners/spark/structuredstreaming/utils/SerializationDebugger.java
@@ -0,0 +1,130 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** Testing utils for spark structured streaming runner. */
+package org.apache.beam.runners.spark.structuredstreaming.utils;
+
+import java.io.IOException;
+import java.io.ObjectOutputStream;
+import java.io.OutputStream;
+import java.lang.reflect.Field;
+import java.util.ArrayList;
+import java.util.List;
+
+public class SerializationDebugger {
+
+  public static void testSerialization(Object object) throws IOException {
+    DebuggingObjectOutputStream out =
+        new DebuggingObjectOutputStream();
+    try {
+      out.writeObject(object);
+    } catch (Exception e) {
+      throw new RuntimeException(
+          "Serialization error. Path to bad object: "
+              + out.getStack(), e);
+    }
+  }
+
+  private static class DebuggingObjectOutputStream extends ObjectOutputStream {
+
+    public DebuggingObjectOutputStream() throws IOException, SecurityException {
+    }
+
+    private static final Field DEPTH_FIELD;
+
+    static {
+      try {
+        DEPTH_FIELD = ObjectOutputStream.class.getDeclaredField("depth");
+        DEPTH_FIELD.setAccessible(true);
+      } catch (NoSuchFieldException e) {
+        throw new AssertionError(e);
+      }
+    }
+
+    final List<Object> stack = new ArrayList<Object>();
+
+    /**
+     * Indicates whether or not OOS has tried to
+     * write an IOException (presumably as the
+     * result of a serialization error) to the
+     * stream.
+     */
+    boolean broken = false;
+
+    public DebuggingObjectOutputStream(OutputStream out) throws IOException {
+      super(out);
+      enableReplaceObject(true);
+    }
+
+    /**
+     * Abuse {@code replaceObject()} as a hook to
+     * maintain our stack.
+     */
+    protected Object replaceObject(Object o) {
+      // ObjectOutputStream writes serialization
+      // exceptions to the stream. Ignore
+      // everything after that so we don't lose
+      // the path to a non-serializable object. So
+      // long as the user doesn't write an
+      // IOException as the root object, we're OK.
+      int currentDepth = currentDepth();
+      if (o instanceof IOException && currentDepth == 0) {
+        broken = true;
+      }
+      if (!broken) {
+        truncate(currentDepth);
+        stack.add(o);
+      }
+      return o;
+    }
+
+    private void truncate(int depth) {
+      while (stack.size() > depth) {
+        pop();
+      }
+    }
+
+    private Object pop() {
+      return stack.remove(stack.size() - 1);
+    }
+
+    /**
+     * Returns a 0-based depth within the object
+     * graph of the current object being
+     * serialized.
+     */
+    private int currentDepth() {
+      try {
+        Integer oneBased = ((Integer) DEPTH_FIELD.get(this));
+        return oneBased - 1;
+      } catch (IllegalAccessException e) {
+        throw new AssertionError(e);
+      }
+    }
+
+    /**
+     * Returns the path to the last object
+     * serialized. If an exception occurred, this
+     * should be the path to the non-serializable
+     * object.
+     */
+    public List<Object> getStack() {
+      return stack;
+    }
+  }
+}
\ No newline at end of file
diff --git a/runners/spark-structured-streaming/src/test/java/org/apache/beam/runners/spark/structuredstreaming/utils/package-info.java b/runners/spark-structured-streaming/src/test/java/org/apache/beam/runners/spark/structuredstreaming/utils/package-info.java
new file mode 100644
index 0000000..3d7da11
--- /dev/null
+++ b/runners/spark-structured-streaming/src/test/java/org/apache/beam/runners/spark/structuredstreaming/utils/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** Testing utils for spark structured streaming runner. */
+package org.apache.beam.runners.spark.structuredstreaming.utils;