[GitHub] [daffodil] stevedlawrence commented on a diff in pull request #992: Remove warnings in serialized parser

["stevedlawrence (via GitHub)" <gi...@apache.org>]

stevedlawrence commented on code in PR #992:
URL: https://github.com/apache/daffodil/pull/992#discussion_r1143471339


##########
daffodil-core/src/test/scala/org/apache/daffodil/core/processor/TestSerialization.scala:
##########
@@ -0,0 +1,66 @@
+/*
+ * 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.
+ */
+
+package org.apache.daffodil.core.processor
+
+import java.io.File
+import java.io.FileOutputStream
+
+import org.apache.daffodil.core.compiler.Compiler
+
+import org.junit.Assert.assertTrue
+import org.junit.Test
+
+class TestSerialization {
+
+  /**
+   * DAFFODIL-2803
+   *
+   * Check that warnings are not serialized when saving a parser.
+   */
+  @Test def test_stripWarnings() = {
+    val schema =
+      <schema
+        xmlns="http://www.w3.org/2001/XMLSchema"
+        xmlns:dfdl="http://www.ogf.org/dfdl/dfdl-1.0/"
+        xmlns:ex="http://example.com"
+        targetNamespace="http://example.com"
+      >
+        <include schemaLocation="org/apache/daffodil/xsd/DFDLGeneralFormat.dfdl.xsd"/>
+        <annotation>
+          <!-- The invalid appinfo source generates a warning -->
+          <appinfo source="http://www.ogf.org/dfdl/WRONG">
+            <dfdl:format ref="ex:GeneralFormat"/>
+          </appinfo>
+        </annotation>
+        <element name="root" type="string" dfdl:lengthKind="explicit" dfdl:length="1"/>
+      </schema>
+
+    val factory = Compiler().compileNode(schema)
+    val processor = factory.onPath("/")
+    assertTrue(!processor.getDiagnostics.isEmpty)
+
+    val tmpFile = File.createTempFile("test_stripWarnings", null)
+    tmpFile.deleteOnExit()
+    val output = new FileOutputStream(tmpFile).getChannel()
+    processor.save(output)
+
+    val processor2 = Compiler().reload(tmpFile)
+    assertTrue(processor2.getDiagnostics.isEmpty)

Review Comment:
   Instead of creating a temp file and, can we save and reload to/from something in memory? It avoid cruft building up in /tmp/, especially since if you use an sbt console it wont' delete the file until you actually exit. We're really bad about trashing /tmp and I wish we could be better about it.



##########
daffodil-runtime1/src/main/scala/org/apache/daffodil/runtime1/processors/DataProcessor.scala:
##########
@@ -284,6 +284,18 @@ class DataProcessor(
     // serialize and compress the data processor to the outputstream
     val oos = new ObjectOutputStream(new GZIPOutputStream(os))
 
+    // DAFFODIL-2803
+    // Remove warnings from serialized parser
+    val diagsWithoutWarnings = ssrd.diagnostics.filter(_.isError)
+    val ssrdToSave = new SchemaSetRuntimeData(
+      ssrd.parser,
+      ssrd.unparser,
+      diagsWithoutWarnings,
+      ssrd.elementRuntimeData,
+      ssrd.originalVariables,
+      ssrd.typeCalculators,
+    )

Review Comment:
   Since there should only be warnings, and we want to get rid of them, can we just do somethign liek this
   
   ```scala
   val ssrdToSave = ssrd.copy(diagnostics = Seq.empty)
   ```
   
   Might need to make `SchemaSetRuntimeData` a case class to get the copy function if it's not already.



##########
daffodil-runtime1/src/main/scala/org/apache/daffodil/runtime1/processors/DataProcessor.scala:
##########
@@ -284,6 +284,18 @@ class DataProcessor(
     // serialize and compress the data processor to the outputstream
     val oos = new ObjectOutputStream(new GZIPOutputStream(os))
 
+    // DAFFODIL-2803
+    // Remove warnings from serialized parser
+    val diagsWithoutWarnings = ssrd.diagnostics.filter(_.isError)

Review Comment:
   There should *only* be warnings. If there are any errors then we shouldn't even allow saving, and probably want to throw a usage error.



##########
daffodil-runtime1/src/main/scala/org/apache/daffodil/runtime1/processors/DataProcessor.scala:
##########
@@ -292,6 +304,7 @@ class DataProcessor(
     // them back to their original values.
     //
     val dpToSave = this.copy(
+      ssrd = ssrdToSave,

Review Comment:
   `SchemaSetRuntimeData` has this comment about the `diagnostics` member:
   
   ```scala
   /*
      * Memory of the compiler's warnings. If we save a processor, it's useful to be able
      * to have these warnings.
      */
   ```
   This comment is now wrong and should probably be removed. Turns out it's not actually useful and just leads to too much verbose messages.
   
   In fact, I wonder if SSRD shouldn't even contain diagnostics and they should be somewhere else? No other RuntimeData objects contain diagnostics. Maybe the diags want to be stored on the `DataProcessor`, and those are removed when we save just like `variableMap` and `validationMode`? I'm not sure if `diagnostics` were moved from somewhere else to the SSRD so they could be serialized or if they were always there, but the `DataProcessor` seems like a reasonable place to store them. Also avoids the need to copy the SSRD since we are already copying the DataProcessor when we save. Simplifies things just a little bit.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org