Apache Solr open-source search software
SOLR-16512 : Eliminate noggit JSONWriter.Writable from Solr classes (#1159)
Noble Paul2dc110850a7e
diff --git a/solr/core/src/java/org/apache/solr/core/snapshots/CollectionSnapshotMetaData.java b/solr/core/src/java/org/apache/solr/core/snapshots/CollectionSnapshotMetaData.javaindex 483170db598..fabfb90f52f 100644--- a/solr/core/src/java/org/apache/solr/core/snapshots/CollectionSnapshotMetaData.java+++ b/solr/core/src/java/org/apache/solr/core/snapshots/CollectionSnapshotMetaData.java@@ -16,23 +16,23 @@*/package org.apache.solr.core.snapshots;+import java.io.IOException;import java.util.ArrayList;import java.util.Collection;import java.util.Collections;import java.util.Date;import java.util.HashSet;-import java.util.LinkedHashMap;import java.util.List;import java.util.Map;import java.util.Set;+import org.apache.solr.common.MapWriter;import org.apache.solr.common.cloud.Replica;import org.apache.solr.common.params.CoreAdminParams;import org.apache.solr.common.util.NamedList;-import org.noggit.JSONWriter;/** This class defines the meta-data about a collection level snapshot */-public class CollectionSnapshotMetaData implements JSONWriter.Writable {- public static class CoreSnapshotMetaData implements JSONWriter.Writable {+public class CollectionSnapshotMetaData implements MapWriter {+ public static class CoreSnapshotMetaData implements MapWriter {private final String coreName;private final String indexDirPath;private final long generationNumber;@@ -90,15 +90,13 @@ public class CollectionSnapshotMetaData implements JSONWriter.Writable {}@Override- public void write(JSONWriter arg0) {- LinkedHashMap<String, Object> info = new LinkedHashMap<>();- info.put(CoreAdminParams.CORE, getCoreName());- info.put(SolrSnapshotManager.INDEX_DIR_PATH, getIndexDirPath());- info.put(SolrSnapshotManager.GENERATION_NUM, getGenerationNumber());- info.put(SolrSnapshotManager.SHARD_ID, getShardId());- info.put(SolrSnapshotManager.LEADER, isLeader());- info.put(SolrSnapshotManager.FILE_LIST, getFiles());- arg0.write(info);+ public void writeMap(EntryWriter ew) throws IOException {+ ew.put(CoreAdminParams.CORE, getCoreName());+ ew.put(SolrSnapshotManager.INDEX_DIR_PATH, getIndexDirPath());+ ew.put(SolrSnapshotManager.GENERATION_NUM, getGenerationNumber());+ ew.put(SolrSnapshotManager.SHARD_ID, getShardId());+ ew.put(SolrSnapshotManager.LEADER, isLeader());+ ew.put(SolrSnapshotManager.FILE_LIST, getFiles());}public NamedList<Object> toNamedList() {@@ -229,13 +227,11 @@ public class CollectionSnapshotMetaData implements JSONWriter.Writable {}@Override- public void write(JSONWriter arg0) {- LinkedHashMap<String, Object> result = new LinkedHashMap<>();- result.put(CoreAdminParams.NAME, this.name);- result.put(SolrSnapshotManager.SNAPSHOT_STATUS, this.status.toString());- result.put(SolrSnapshotManager.CREATION_DATE, this.getCreationDate().getTime());- result.put(SolrSnapshotManager.SNAPSHOT_REPLICAS, this.replicaSnapshots);- arg0.write(result);+ public void writeMap(EntryWriter ew) throws IOException {+ ew.put(CoreAdminParams.NAME, this.name);+ ew.put(SolrSnapshotManager.SNAPSHOT_STATUS, this.status.toString());+ ew.put(SolrSnapshotManager.CREATION_DATE, this.getCreationDate().getTime());+ ew.put(SolrSnapshotManager.SNAPSHOT_REPLICAS, this.replicaSnapshots);}public NamedList<Object> toNamedList() {diff --git a/solr/solrj-zookeeper/src/java/org/apache/solr/client/solrj/impl/ZkClientClusterStateProvider.java b/solr/solrj-zookeeper/src/java/org/apache/solr/client/solrj/impl/ZkClientClusterStateProvider.javaindex cfb0911a142..1ff8ba5d253 100644--- a/solr/solrj-zookeeper/src/java/org/apache/solr/client/solrj/impl/ZkClientClusterStateProvider.java+++ b/solr/solrj-zookeeper/src/java/org/apache/solr/client/solrj/impl/ZkClientClusterStateProvider.java@@ -25,6 +25,7 @@ import java.util.List;import java.util.Map;import java.util.Set;import org.apache.solr.common.AlreadyClosedException;+import org.apache.solr.common.MapWriter;import org.apache.solr.common.SolrException;import org.apache.solr.common.cloud.ClusterState;import org.apache.solr.common.cloud.DocCollection;@@ -34,7 +35,6 @@ import org.apache.solr.common.cloud.ZkStateReader;import org.apache.solr.common.cloud.ZooKeeperException;import org.apache.solr.common.util.Utils;import org.apache.zookeeper.KeeperException;-import org.noggit.JSONWriter;import org.slf4j.Logger;import org.slf4j.LoggerFactory;@@ -77,7 +77,7 @@ public class ZkClientClusterStateProvider implements ClusterStateProvider {** @param bytes a byte array of a Json representation of a mapping from collection name to the* Json representation of a {@link DocCollection} as written by {@link- * ClusterState#write(JSONWriter)}. It can represent one or more collections.+ * ClusterState#writeMap(MapWriter.EntryWriter)}. It can represent one or more collections.* @param liveNodes list of live nodes* @param coll collection name* @param zkClient ZK clientdiff --git a/solr/solrj/src/java/org/apache/solr/common/MapWriter.java b/solr/solrj/src/java/org/apache/solr/common/MapWriter.javaindex 9e2a25d00dd..b9005057c38 100644--- a/solr/solrj/src/java/org/apache/solr/common/MapWriter.java+++ b/solr/solrj/src/java/org/apache/solr/common/MapWriter.java@@ -158,5 +158,8 @@ public interface MapWriter extends MapSerializable, NavigableObject {}}+ /** A marker interface to denote that this is to be serialized using {@link Object#toString()} */+ interface StringValue {}+MapWriter EMPTY = new MapWriterMap(Collections.emptyMap());}diff --git a/solr/solrj/src/java/org/apache/solr/common/cloud/ClusterState.java b/solr/solrj/src/java/org/apache/solr/common/cloud/ClusterState.javaindex a4516f73bf1..708c0af97fd 100644--- a/solr/solrj/src/java/org/apache/solr/common/cloud/ClusterState.java+++ b/solr/solrj/src/java/org/apache/solr/common/cloud/ClusterState.java@@ -18,6 +18,7 @@ package org.apache.solr.common.cloud;import static org.apache.solr.common.util.Utils.STANDARDOBJBUILDER;+import java.io.IOException;import java.lang.invoke.MethodHandles;import java.util.Collection;import java.util.Collections;@@ -33,13 +34,13 @@ import java.util.function.Consumer;import java.util.function.Function;import java.util.function.Supplier;import java.util.stream.Collectors;+import org.apache.solr.common.MapWriter;import org.apache.solr.common.SolrException;import org.apache.solr.common.SolrException.ErrorCode;import org.apache.solr.common.cloud.DocCollection.CollectionStateProps;import org.apache.solr.common.cloud.Replica.ReplicaStateProps;import org.apache.solr.common.util.Utils;import org.noggit.JSONParser;-import org.noggit.JSONWriter;import org.noggit.ObjectBuilder;import org.slf4j.Logger;import org.slf4j.LoggerFactory;@@ -50,7 +51,7 @@ import org.slf4j.LoggerFactory;** @lucene.experimental*/-public class ClusterState implements JSONWriter.Writable {+public class ClusterState implements MapWriter {/** Cluster Prop that is http or https. */public static final String URL_SCHEME = "urlScheme";@@ -222,8 +223,8 @@ public class ClusterState implements JSONWriter.Writable {* thus don't call it where that's important** @param bytes a byte array of a Json representation of a mapping from collection name to the- * Json representation of a {@link DocCollection} as written by {@link #write(JSONWriter)}. It- * can represent one or more collections.+ * Json representation of a {@link DocCollection} as written by {@link+ * #writeMap(EntryWriter)}. It can represent one or more collections.* @param liveNodes list of live nodes* @return the ClusterState*/@@ -295,15 +296,8 @@ public class ClusterState implements JSONWriter.Writable {}@Override- public void write(JSONWriter jsonWriter) {- LinkedHashMap<String, DocCollection> map = new LinkedHashMap<>();- for (Entry<String, CollectionRef> e : collectionStates.entrySet()) {- if (e.getValue().getClass() == CollectionRef.class) {- DocCollection coll = e.getValue().get();- map.put(coll.getName(), coll);- }- }- jsonWriter.write(map);+ public void writeMap(EntryWriter ew) throws IOException {+ collectionStates.forEach(ew.getBiConsumer());}@Override@@ -376,7 +370,7 @@ public class ClusterState implements JSONWriter.Writable {});}- public static class CollectionRef {+ public static class CollectionRef implements MapWriter {protected final AtomicInteger gets = new AtomicInteger();private final DocCollection coll;@@ -412,6 +406,11 @@ public class ClusterState implements JSONWriter.Writable {return false;}+ @Override+ public void writeMap(EntryWriter ew) throws IOException {+ get().writeMap(ew);+ }+@Overridepublic String toString() {if (coll != null) {diff --git a/solr/solrj/src/java/org/apache/solr/common/cloud/DocCollection.java b/solr/solrj/src/java/org/apache/solr/common/cloud/DocCollection.javaindex 6d4f6394d45..275e986485e 100644--- a/solr/solrj/src/java/org/apache/solr/common/cloud/DocCollection.java+++ b/solr/solrj/src/java/org/apache/solr/common/cloud/DocCollection.java@@ -18,13 +18,13 @@ package org.apache.solr.common.cloud;import static org.apache.solr.common.util.Utils.toJSONString;+import java.io.IOException;import java.lang.invoke.MethodHandles;import java.util.ArrayList;import java.util.Collection;import java.util.EnumSet;import java.util.HashMap;import java.util.Iterator;-import java.util.LinkedHashMap;import java.util.List;import java.util.Map;import java.util.Objects;@@ -32,7 +32,6 @@ import java.util.Set;import java.util.function.BiConsumer;import java.util.function.BiPredicate;import org.apache.solr.common.cloud.Replica.ReplicaStateProps;-import org.noggit.JSONWriter;import org.slf4j.Logger;import org.slf4j.LoggerFactory;@@ -324,11 +323,9 @@ public class DocCollection extends ZkNodeProps implements Iterable<Slice> {}@Override- public void write(JSONWriter jsonWriter) {- LinkedHashMap<String, Object> all = new LinkedHashMap<>(slices.size() + 1);- all.putAll(propMap);- all.put(CollectionStateProps.SHARDS, slices);- jsonWriter.write(all);+ public void writeMap(EntryWriter ew) throws IOException {+ propMap.forEach(ew.getBiConsumer());+ ew.put(CollectionStateProps.SHARDS, slices);}public Replica getReplica(String coreNodeName) {diff --git a/solr/solrj/src/java/org/apache/solr/common/cloud/DocRouter.java b/solr/solrj/src/java/org/apache/solr/common/cloud/DocRouter.javaindex af0ebc66f12..70a4b4b3e5a 100644--- a/solr/solrj/src/java/org/apache/solr/common/cloud/DocRouter.java+++ b/solr/solrj/src/java/org/apache/solr/common/cloud/DocRouter.java@@ -25,12 +25,12 @@ import java.util.LinkedHashMap;import java.util.List;import java.util.Map;import org.apache.solr.cluster.api.HashRange;+import org.apache.solr.common.MapWriter;import org.apache.solr.common.SolrException;import org.apache.solr.common.SolrInputDocument;import org.apache.solr.common.cloud.DocCollection.CollectionStateProps;import org.apache.solr.common.params.SolrParams;import org.apache.solr.common.util.StrUtils;-import org.noggit.JSONWriter;/*** Class to partition int range into n ranges.@@ -89,7 +89,7 @@ public abstract class DocRouter {// Hash ranges can't currently "wrap" - i.e. max must be greater or equal to min.// TODO: ranges may not be all contiguous in the future (either that or we will// need an extra class to model a collection of ranges)- public static class Range implements JSONWriter.Writable, Comparable<Range>, HashRange {+ public static class Range implements MapWriter.StringValue, Comparable<Range>, HashRange {public int min; // inclusivepublic int max; // inclusive@@ -141,11 +141,6 @@ public abstract class DocRouter {return this.min == other.min && this.max == other.max;}- @Override- public void write(JSONWriter writer) {- writer.write(toString());- }-@Overridepublic int compareTo(Range that) {int mincomp = Integer.compare(this.min, that.min);diff --git a/solr/solrj/src/java/org/apache/solr/common/cloud/Replica.java b/solr/solrj/src/java/org/apache/solr/common/cloud/Replica.javaindex bf1dca1ca96..87990a5844c 100644--- a/solr/solrj/src/java/org/apache/solr/common/cloud/Replica.java+++ b/solr/solrj/src/java/org/apache/solr/common/cloud/Replica.java@@ -17,12 +17,10 @@package org.apache.solr.common.cloud;import static org.apache.solr.common.ConditionalMapWriter.NON_NULL_VAL;-import static org.apache.solr.common.ConditionalMapWriter.dedupeKeyPredicate;import java.io.IOException;import java.lang.invoke.MethodHandles;import java.util.HashMap;-import java.util.HashSet;import java.util.LinkedHashMap;import java.util.Locale;import java.util.Map;@@ -31,7 +29,6 @@ import java.util.Set;import java.util.function.BiPredicate;import org.apache.solr.common.MapWriter;import org.apache.solr.common.util.Utils;-import org.noggit.JSONWriter;import org.slf4j.Logger;import org.slf4j.LoggerFactory;@@ -369,7 +366,7 @@ public class Replica extends ZkNodeProps implements MapWriter {@Overridepublic void writeMap(MapWriter.EntryWriter ew) throws IOException {- ew.put(name, _allPropsWriter());+ _allPropsWriter().writeMap(ew);}private static final Map<String, State> STATES = new HashMap<>();@@ -386,16 +383,15 @@ public class Replica extends ZkNodeProps implements MapWriter {}private MapWriter _allPropsWriter() {- BiPredicate<CharSequence, Object> p = dedupeKeyPredicate(new HashSet<>()).and(NON_NULL_VAL);+ BiPredicate<CharSequence, Object> p =+ ((BiPredicate<CharSequence, Object>) (k, o) -> !propMap.containsKey(k.toString()))+ .and(NON_NULL_VAL);return writer -> {// XXX this is why this class should be immutable - it's a mess !!!// propMap takes precedence because it's mutable and we can't control its// contents, so a third party may override some declared fields- for (Map.Entry<String, Object> e : propMap.entrySet()) {- writer.put(e.getKey(), e.getValue(), p);- }-+ propMap.forEach(writer.getBiConsumer());writer.put(ReplicaStateProps.CORE_NAME, core, p).put(ReplicaStateProps.SHARD_ID, shard, p)@@ -406,14 +402,6 @@ public class Replica extends ZkNodeProps implements MapWriter {};}- @Override- public void write(JSONWriter jsonWriter) {- Map<String, Object> map = new LinkedHashMap<>();- // this serializes also our declared properties- _allPropsWriter().toMap(map);- jsonWriter.write(map);- }-@Overridepublic String toString() {return namediff --git a/solr/solrj/src/java/org/apache/solr/common/cloud/Slice.java b/solr/solrj/src/java/org/apache/solr/common/cloud/Slice.javaindex 5414942b480..c8f0e7bbbfa 100644--- a/solr/solrj/src/java/org/apache/solr/common/cloud/Slice.java+++ b/solr/solrj/src/java/org/apache/solr/common/cloud/Slice.java@@ -32,7 +32,6 @@ import java.util.Set;import java.util.function.Predicate;import java.util.stream.Collectors;import org.apache.solr.common.cloud.Replica.Type;-import org.noggit.JSONWriter;import org.slf4j.Logger;import org.slf4j.LoggerFactory;@@ -307,11 +306,6 @@ public class Slice extends ZkNodeProps implements Iterable<Replica> {return name + ':' + toJSONString(propMap);}- @Override- public void write(JSONWriter jsonWriter) {- jsonWriter.write(propMap);- }-/** JSON properties related to a slice's state. */public interface SliceStateProps {diff --git a/solr/solrj/src/java/org/apache/solr/common/cloud/ZkNodeProps.java b/solr/solrj/src/java/org/apache/solr/common/cloud/ZkNodeProps.javaindex 0e6dcef7108..b187e475fe8 100644--- a/solr/solrj/src/java/org/apache/solr/common/cloud/ZkNodeProps.java+++ b/solr/solrj/src/java/org/apache/solr/common/cloud/ZkNodeProps.java@@ -28,10 +28,9 @@ import java.util.Set;import org.apache.solr.common.MapWriter;import org.apache.solr.common.util.JavaBinCodec;import org.apache.solr.common.util.Utils;-import org.noggit.JSONWriter;/** ZkNodeProps contains generic immutable properties. */-public class ZkNodeProps implements JSONWriter.Writable, MapWriter {+public class ZkNodeProps implements MapWriter {protected final Map<String, Object> propMap;@@ -105,11 +104,6 @@ public class ZkNodeProps implements JSONWriter.Writable, MapWriter {return new ZkNodeProps(props);}- @Override- public void write(JSONWriter jsonWriter) {- jsonWriter.write(propMap);- }-/** Get a string property value. */public String getStr(String key) {return getStr(key, null);diff --git a/solr/solrj/src/java/org/apache/solr/common/util/JavaBinCodec.java b/solr/solrj/src/java/org/apache/solr/common/util/JavaBinCodec.javaindex abe9c9d8619..c4a44090d1e 100644--- a/solr/solrj/src/java/org/apache/solr/common/util/JavaBinCodec.java+++ b/solr/solrj/src/java/org/apache/solr/common/util/JavaBinCodec.java@@ -1102,6 +1102,9 @@ public class JavaBinCodec implements PushWriter {} else if (val instanceof LongAccumulator) {daos.writeLong(((LongAccumulator) val).longValue());return true;+ } else if (val instanceof MapWriter.StringValue) {+ writeStr(val.toString());+ return true;}return false;}diff --git a/solr/solrj/src/java/org/apache/solr/common/util/NoggitJSONWriter.java b/solr/solrj/src/java/org/apache/solr/common/util/NoggitJSONWriter.javanew file mode 100644index 00000000000..d31e598604c--- /dev/null+++ b/solr/solrj/src/java/org/apache/solr/common/util/NoggitJSONWriter.java@@ -0,0 +1,97 @@+/*+ * 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.solr.common.util;++import java.io.IOException;+import org.apache.solr.common.IteratorWriter;+import org.apache.solr.common.MapWriter;+import org.noggit.CharArr;+import org.noggit.JSONWriter;++/** Serialize JSON using noggit */+public class NoggitJSONWriter extends JSONWriter {++ public NoggitJSONWriter(CharArr out, int indentSize) {+ super(out, indentSize);+ }++ @Override+ public void write(Object o) {+ if (o instanceof MapWriter) {+ MapWriter mapWriter = (MapWriter) o;+ startObject();+ try {+ mapWriter.writeMap(entryWriter());+ } catch (IOException e) {+ throw new RuntimeException(e);+ }+ endObject();+ } else if (o instanceof IteratorWriter) {+ IteratorWriter iteratorWriter = (IteratorWriter) o;+ startArray();+ try {+ iteratorWriter.writeIter(itemWriter());+ } catch (IOException e) {+ throw new RuntimeException("this should never happen", e);+ }+ endArray();+ } else if (o instanceof MapWriter.StringValue) {+ super.write(o.toString());+ } else {+ super.write(o);+ }+ }++ private IteratorWriter.ItemWriter itemWriter() {+ return new IteratorWriter.ItemWriter() {+ private boolean first;++ @Override+ public IteratorWriter.ItemWriter add(Object o) {+ if (first) {+ first = false;+ } else {+ writeValueSeparator();+ }+ indent();+ write(o);+ return this;+ }+ };+ }++ private MapWriter.EntryWriter entryWriter() {+ return new MapWriter.EntryWriter() {+ private boolean first;++ @Override+ public MapWriter.EntryWriter put(CharSequence k, Object v) {+ if (first) {+ first = false;+ } else {+ writeValueSeparator();+ }+ indent();+ writeString(k.toString());+ writeNameSeparator();+ write(v);+ return this;+ }+ };+ }+}diff --git a/solr/solrj/src/java/org/apache/solr/common/util/TextWriter.java b/solr/solrj/src/java/org/apache/solr/common/util/TextWriter.javaindex 3ec8df2168b..66b6bcff23e 100644--- a/solr/solrj/src/java/org/apache/solr/common/util/TextWriter.java+++ b/solr/solrj/src/java/org/apache/solr/common/util/TextWriter.java@@ -105,6 +105,8 @@ public interface TextWriter extends PushWriter {} else {writeStr(name, val.toString(), true);}+ } else if (val instanceof MapWriter.StringValue) {+ writeStr(name, val.toString(), true);} else {// default... for debugging only. Would be nice to "assert false" ?writeStr(name, val.getClass().getName() + ':' + val.toString(), true);diff --git a/solr/solrj/src/java/org/apache/solr/common/util/Utils.java b/solr/solrj/src/java/org/apache/solr/common/util/Utils.javaindex 576bfbaa771..3e883ed7a95 100644--- a/solr/solrj/src/java/org/apache/solr/common/util/Utils.java+++ b/solr/solrj/src/java/org/apache/solr/common/util/Utils.java@@ -81,7 +81,6 @@ import org.apache.solr.common.annotation.JsonProperty;import org.apache.solr.common.params.CommonParams;import org.noggit.CharArr;import org.noggit.JSONParser;-import org.noggit.JSONWriter;import org.noggit.ObjectBuilder;import org.slf4j.Logger;import org.slf4j.LoggerFactory;@@ -214,65 +213,6 @@ public class Utils {return writer;}- private static class MapWriterJSONWriter extends JSONWriter {-- public MapWriterJSONWriter(CharArr out, int indentSize) {- super(out, indentSize);- }-- @Override- public void handleUnknownClass(Object o) {- // avoid materializing MapWriter / IteratorWriter to Map / List- // instead serialize them directly- if (o instanceof MapWriter) {- MapWriter mapWriter = (MapWriter) o;- startObject();- final boolean[] first = new boolean[1];- first[0] = true;- int sz = mapWriter._size();- mapWriter._forEachEntry(- (k, v) -> {- if (first[0]) {- first[0] = false;- } else {- writeValueSeparator();- }- if (sz > 1) indent();- writeString(k.toString());- writeNameSeparator();- write(v);- });- endObject();- } else if (o instanceof IteratorWriter) {- IteratorWriter iteratorWriter = (IteratorWriter) o;- startArray();- final boolean[] first = new boolean[1];- first[0] = true;- try {- iteratorWriter.writeIter(- new IteratorWriter.ItemWriter() {- @Override- public IteratorWriter.ItemWriter add(Object o) throws IOException {- if (first[0]) {- first[0] = false;- } else {- writeValueSeparator();- }- indent();- write(o);- return this;- }- });- } catch (IOException e) {- throw new RuntimeException("this should never happen", e);- }- endArray();- } else {- super.handleUnknownClass(o);- }- }- }-public static byte[] toJSON(Object o) {if (o == null) return new byte[0];CharArr out = new CharArr();@@ -283,7 +223,7 @@ public class Utils {// o = ((IteratorWriter) o).toList(new ArrayList<>());// }// }- new MapWriterJSONWriter(out, 2).write(o); // indentation by default+ new NoggitJSONWriter(out, 2).write(o); // indentation by defaultreturn toUTF8(out);}