You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by GitBox <gi...@apache.org> on 2021/02/03 17:02:34 UTC
[GitHub] [avro] RyanSkraba opened a new pull request #1081: AVRO-3014: Log a warning on ignored logicalType
RyanSkraba opened a new pull request #1081:
URL: https://github.com/apache/avro/pull/1081
When parsing a schema, we currently log a warning when a `logicalType` property is ignored on a schema if the underlying primitive is not supported.
The `logicalType` annotation is also always ignored on a field, since the annotation only has meaning on a schema. This is a very common mistake. This PR logs a warning if there is a `logicalType` property on a field, and missing from the field's schema.
### Jira
- [ ] My PR addresses the following [Avro Jira](https://issues.apache.org/jira/browse/AVRO/) issues and references them in the PR title. For example, "AVRO-1234: My Avro PR"
- https://issues.apache.org/jira/browse/AVRO-3014
- In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
### Tests
- [X] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
### Commits
- [X] My commits all reference Jira issues in their subject lines. In addition, my commits follow the guidelines from "[How to write a good git commit message](https://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Documentation
- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
- All the public functions and the classes in the PR contain Javadoc that explain what it does
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [avro] iemejia merged pull request #1081: AVRO-3014: Log a warning on ignored logicalType
Posted by GitBox <gi...@apache.org>.
iemejia merged pull request #1081:
URL: https://github.com/apache/avro/pull/1081
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [avro] RyanSkraba commented on a change in pull request #1081: AVRO-3014: Log a warning on ignored logicalType
Posted by GitBox <gi...@apache.org>.
RyanSkraba commented on a change in pull request #1081:
URL: https://github.com/apache/avro/pull/1081#discussion_r569584664
##########
File path: lang/java/avro/src/test/java/org/apache/avro/TestSchemaWarnings.java
##########
@@ -0,0 +1,109 @@
+/*
+ * 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
+ *
+ * https://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.avro;
+
+import org.junit.AfterClass;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
+
+import static org.apache.avro.LogicalType.LOGICAL_TYPE_PROP;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.nullValue;
+
+public class TestSchemaWarnings {
+
+ private final static PrintStream originalErr = System.err;
+
+ /**
+ * The capturable replacement for the system err stream.
+ */
+ private final ByteArrayOutputStream capturedErr = new ByteArrayOutputStream();
+
+ @Before
+ public void setupStdErr() {
+ capturedErr.reset();
+ System.setErr(new PrintStream(capturedErr));
+ }
+
+ @AfterClass
+ public static void restoreStdErr() {
+ System.setErr(originalErr);
+ }
+
+ public String getCapturedStdErr() {
+ System.out.flush();
+ String stderr = new String(capturedErr.toByteArray(), StandardCharsets.UTF_8);
+ capturedErr.reset();
+ return stderr;
+ }
+
+ @Test
+ public void testWarnWhenTheLogicalTypeIsOnTheField() {
+ // A record with a single int field.
+ Schema s = SchemaBuilder.record("A").fields().requiredInt("a1").endRecord();
+
+ // Force reparsing the schema, and no warning should be logged.
+ s = new Schema.Parser().parse(s.toString());
+ assertThat(s.getField("a1").schema().getLogicalType(), nullValue());
+ assertThat(getCapturedStdErr(), is(""));
+
+ // Add the logical type annotation to the field (as opposed to the field schema)
+ // and parse it again. This is a common error, see AVRO-3014, AVRO-2015.
+ s.getField("a1").addProp(LOGICAL_TYPE_PROP, LogicalTypes.date().getName());
+ assertThat(s.getField("a1").schema().getLogicalType(), nullValue());
+
+ // Force reparsing the schema, and a warning should be logged.
+ s = new Schema.Parser().parse(s.toString());
+ assertThat(getCapturedStdErr(), containsString("Ignored the A.a1.logicalType property (\"date\"). It should"
+ + " probably be nested inside the \"type\" for the field."));
+ assertThat(s.getField("a1").schema().getLogicalType(), nullValue());
+
+ // Add the logical type annotation to the field schema. This doesn't change the
+ // logical type of an already parsed schema.
+ s.getField("a1").schema().addProp(LOGICAL_TYPE_PROP, LogicalTypes.date().getName());
+ assertThat(s.getField("a1").schema().getLogicalType(), nullValue());
+
+ // Force reparsing the schema. No warning should be logged, and the logical type
+ // should be applied.
+ s = new Schema.Parser().parse(s.toString());
+ assertThat(getCapturedStdErr(), is(""));
+ assertThat(s.getField("a1").schema().getLogicalType(), is(LogicalTypes.date()));
+
+ }
+
+ @Test
+ public void testWarnWhenTheLogicalTypeIsIgnored() {
Review comment:
(This test is for the existing warning, no changes here in this PR).
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org