nfsantos commented on code in PR #1021: URL: https://github.com/apache/jackrabbit-oak/pull/1021#discussion_r1262181768
########## oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/SimpleFlatFileUtil.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 + * + * 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.jackrabbit.oak.index.indexer.document.flatfile; + +import java.io.BufferedWriter; +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.util.ArrayList; +import java.util.function.Predicate; + +import org.apache.jackrabbit.oak.index.indexer.document.NodeStateEntry; +import org.apache.jackrabbit.oak.plugins.document.DocumentNodeState; +import org.apache.jackrabbit.oak.spi.state.ChildNodeEntry; +import org.apache.jackrabbit.oak.spi.state.NodeState; +import org.apache.jackrabbit.oak.spi.state.NodeStateUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * This util class can be used to export a tree (eg entire repository) to a flat + * file, without index dependency/involvement. + */ +public class SimpleFlatFileUtil { + + private static final Logger log = LoggerFactory.getLogger(SimpleFlatFileUtil.class); + + private static final String LINE_SEPARATOR = System.getProperty("line.separator"); + + private final FileWriter fw; + private final BufferedWriter bw; + private final ArrayList<StateInBytesHolder> entryBatch = new ArrayList<>(); + private final Predicate<String> pathPredicate = path -> true; + private final NodeStateEntryWriter entryWriter; + private long totalLines = 0; + + private SimpleFlatFileUtil(File f) throws IOException { + // blobStore is only used for deserialization - so pass null here: + entryWriter = new NodeStateEntryWriter(null); + fw = new FileWriter(f); + bw = new BufferedWriter(fw); + } + + public static void createFlatFileFor(NodeState ns, File f) throws IOException { + final SimpleFlatFileUtil h = new SimpleFlatFileUtil(f); + log.info("createFlatFileFor : writing to {}", f.getCanonicalPath()); + h.addEntryAndTraverseChildren(ns); + h.close(); + log.info("createFlatFileFor : done. wrote {} lines in total.", h.totalLines); + } + + private void close() throws IOException { + flush(); + bw.close(); + fw.close(); + } + + private void flush() throws IOException { + for (StateInBytesHolder nsh : entryBatch) { + String line = entryWriter.toString(nsh.getPathElements(), nsh.getLine()); + bw.append(line); + bw.append(LINE_SEPARATOR); + } + log.info("flush : wrote another {} nodes, total so far: {} lines.", + entryBatch.size(), totalLines); + totalLines += entryBatch.size(); + entryBatch.clear(); + } + + private void addEntryAndTraverseChildren(NodeState ns) throws IOException { + addEntry(ns); + if (entryBatch.size() > 999) { + flush(); + } + for (ChildNodeEntry e : ns.getChildNodeEntries()) { Review Comment: If I understood correctly, this will be querying directly the local MongoDB instance. And this is doing a depth-first traversal of the tree rooted in NodeState given to the createFlatFileFor method. Is return of `getChildNodeEntries` deterministic? That is, can you be sure that the FFS file will always be the same for repositories with equivalent contents? Running a revision GC might change the order by which Mongo answers to some queries, even if the results are equivalent. If the order of results of `getChildNodeEntries` is not deterministic, then you could sort the child nodes before iterating over them. ########## oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/SimpleFlatFileUtil.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 + * + * 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.jackrabbit.oak.index.indexer.document.flatfile; + +import java.io.BufferedWriter; +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.util.ArrayList; +import java.util.function.Predicate; + +import org.apache.jackrabbit.oak.index.indexer.document.NodeStateEntry; +import org.apache.jackrabbit.oak.plugins.document.DocumentNodeState; +import org.apache.jackrabbit.oak.spi.state.ChildNodeEntry; +import org.apache.jackrabbit.oak.spi.state.NodeState; +import org.apache.jackrabbit.oak.spi.state.NodeStateUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * This util class can be used to export a tree (eg entire repository) to a flat + * file, without index dependency/involvement. + */ +public class SimpleFlatFileUtil { + + private static final Logger log = LoggerFactory.getLogger(SimpleFlatFileUtil.class); + + private static final String LINE_SEPARATOR = System.getProperty("line.separator"); + + private final FileWriter fw; + private final BufferedWriter bw; + private final ArrayList<StateInBytesHolder> entryBatch = new ArrayList<>(); + private final Predicate<String> pathPredicate = path -> true; + private final NodeStateEntryWriter entryWriter; + private long totalLines = 0; + + private SimpleFlatFileUtil(File f) throws IOException { + // blobStore is only used for deserialization - so pass null here: + entryWriter = new NodeStateEntryWriter(null); + fw = new FileWriter(f); + bw = new BufferedWriter(fw); + } + + public static void createFlatFileFor(NodeState ns, File f) throws IOException { + final SimpleFlatFileUtil h = new SimpleFlatFileUtil(f); + log.info("createFlatFileFor : writing to {}", f.getCanonicalPath()); + h.addEntryAndTraverseChildren(ns); + h.close(); Review Comment: nitpick: would be better to use try with resources to ensure the file is closed even when an error occurs. ########## oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/indexer/document/flatfile/SimpleFlatFileUtil.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 + * + * 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.jackrabbit.oak.index.indexer.document.flatfile; + +import java.io.BufferedWriter; +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.util.ArrayList; +import java.util.function.Predicate; + +import org.apache.jackrabbit.oak.index.indexer.document.NodeStateEntry; +import org.apache.jackrabbit.oak.plugins.document.DocumentNodeState; +import org.apache.jackrabbit.oak.spi.state.ChildNodeEntry; +import org.apache.jackrabbit.oak.spi.state.NodeState; +import org.apache.jackrabbit.oak.spi.state.NodeStateUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * This util class can be used to export a tree (eg entire repository) to a flat + * file, without index dependency/involvement. + */ +public class SimpleFlatFileUtil { + + private static final Logger log = LoggerFactory.getLogger(SimpleFlatFileUtil.class); + + private static final String LINE_SEPARATOR = System.getProperty("line.separator"); + + private final FileWriter fw; + private final BufferedWriter bw; + private final ArrayList<StateInBytesHolder> entryBatch = new ArrayList<>(); + private final Predicate<String> pathPredicate = path -> true; + private final NodeStateEntryWriter entryWriter; + private long totalLines = 0; + + private SimpleFlatFileUtil(File f) throws IOException { + // blobStore is only used for deserialization - so pass null here: + entryWriter = new NodeStateEntryWriter(null); + fw = new FileWriter(f); + bw = new BufferedWriter(fw); + } + + public static void createFlatFileFor(NodeState ns, File f) throws IOException { + final SimpleFlatFileUtil h = new SimpleFlatFileUtil(f); + log.info("createFlatFileFor : writing to {}", f.getCanonicalPath()); + h.addEntryAndTraverseChildren(ns); + h.close(); + log.info("createFlatFileFor : done. wrote {} lines in total.", h.totalLines); + } + + private void close() throws IOException { + flush(); + bw.close(); + fw.close(); + } + + private void flush() throws IOException { + for (StateInBytesHolder nsh : entryBatch) { + String line = entryWriter.toString(nsh.getPathElements(), nsh.getLine()); + bw.append(line); + bw.append(LINE_SEPARATOR); + } + log.info("flush : wrote another {} nodes, total so far: {} lines.", + entryBatch.size(), totalLines); + totalLines += entryBatch.size(); + entryBatch.clear(); + } + + private void addEntryAndTraverseChildren(NodeState ns) throws IOException { + addEntry(ns); + if (entryBatch.size() > 999) { + flush(); + } + for (ChildNodeEntry e : ns.getChildNodeEntries()) { + addEntryAndTraverseChildren(e.getNodeState()); + } + } + + private void addEntry(NodeState ns) { + DocumentNodeState dns = (DocumentNodeState) ns; + NodeStateEntry e = new NodeStateEntry.NodeStateEntryBuilder(dns, + dns.getPath().toString()).build(); + String path = e.getPath(); + if (!NodeStateUtils.isHiddenPath(path) && pathPredicate.test(path)) { + String jsonText = entryWriter.asJson(e.getNodeState()); + // Here logic differs from NodeStateEntrySorter in sense that + // Holder line consist only of json and not 'path|json' + StateInBytesHolder h = new StateInBytesHolder(path, jsonText); + entryBatch.add(h); Review Comment: Why not writing the entry directly to the file instead of having an intermediate step of storing it in the `entryBatch` array? The code is using a buffered writer, so I don't see what is the advantage of having a second layer of buffering with this entryBatch array. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
