fix(common): #WB-3055, FolderManager.copyAllNoFail should not throw an exception when a thumbnail file is missing #490

Author: jcbe-ode

common/src/main/java/org/entcore/common/folders/impl/FolderManagerMongoImpl.java

@@ -345,18 +345,7 @@ private Future<List<Optional<JsonObject>>> duplicateFilesNoFail(
 				// merge shared after reset shared
 				InheritShareComputer.mergeShared(Optional.empty(), copy, true);
 				// copy file from storage
-				StorageHelper.replaceAll(copy, copiedFilesMap);
-
-				// Any fileId not copied must be removed from the new doc
-				final List<String> toRemove = new ArrayList<String>();
-				for( String fileId : fileIds) {
-					if(!copiedFilesMap.containsKey(fileId)) {
-						toRemove.add(fileId);
-					}
-				}
-				if( toRemove.size() > 0 ) {
-					StorageHelper.removeAll(copy, toRemove);
-				}
+				StorageHelper.replaceAll(copy, copiedFilesMap, true);
 
 				return Optional.of(copy);
 			});

common/src/main/java/org/entcore/common/folders/impl/StorageHelper.java

@@ -35,7 +35,21 @@ public static Set<String> getThumbnailsFilesIds(JsonObject jsonDocument) {
 		return thumbIds;
 	}
 
-	static void replaceAll(JsonObject jsonDocument, Map<String, String> oldFileIdForNewFileId) {
+	public static void replaceAll(JsonObject jsonDocument, Map<String, String> oldFileIdForNewFileId) {
+		replaceAll(jsonDocument, oldFileIdForNewFileId, false);
+	}
+
+	/**
+	 * Map all files ID in a Document to another "new" ID.
+	 * Useful when cloning a document.
+	 * @param jsonDocument
+	 * @param oldFileIdForNewFileId Map of (old,new) IDs
+	 * @param skipMissingThumbnails When truthy, drop thumbnail files that are not in the map.
+	 */
+	public static void replaceAll(
+			JsonObject jsonDocument, Map<String, String> oldFileIdForNewFileId,
+			boolean skipMissingThumbnails
+			) {
 		// replace file id
 		Set<String> fileIds = getFileId(jsonDocument);
 		for (String fileId : fileIds) {
@@ -44,32 +58,17 @@ static void replaceAll(JsonObject jsonDocument, Map<String, String> oldFileIdFor
 			}
 			setFileId(jsonDocument, oldFileIdForNewFileId.get(fileId));
 		}
-		// replace thumb values
+		// replace or drop thumb values
 		fileIds = getThumbnailsFilesIds(jsonDocument);
 		for (String fileId : fileIds) {
 			if (!oldFileIdForNewFileId.containsKey(fileId)) {
-				throw new IllegalStateException("Could not found newFileId of the file:" + fileId);
-			}
-			replaceThumbnailFileId(jsonDocument, fileId, oldFileIdForNewFileId.get(fileId));
-		}
-	}
-
-	/**
-	 * Clean a document, by removing any reference to a file (id is given),
-	 * in the `file` and `thumbnails` fields.
-	 * 
-	 * @param jsonDocument document to clean.
-	 * @param fileIds IDs of file to be removed from `file` or `thumbnails` fields.
-	 */
-	static void removeAll(JsonObject jsonDocument, Collection<String> fileIds) {
-		final JsonObject thumbnails = jsonDocument.getJsonObject("thumbnails", null);
-		final Set<Map.Entry<String,Object>> thumbnailEntries = thumbnails==null ? null : thumbnails.getMap().entrySet();
-		for (String fileId : fileIds) {
-			if( fileId == null ) continue;
-			if(getFileId(jsonDocument).contains(fileId)) {
-				jsonDocument.remove("file");
-			} else if(thumbnailEntries!=null) {
-				thumbnailEntries.removeIf(entry -> entry!=null && entry.getValue()!=null && fileId.equals(entry.getValue().toString()));
+				if(skipMissingThumbnails) {
+					dropThumbnailFileId(jsonDocument, fileId);
+				} else {
+					throw new IllegalStateException("Could not found newFileId of the file:" + fileId);
+				}
+			} else {
+				replaceThumbnailFileId(jsonDocument, fileId, oldFileIdForNewFileId.get(fileId));
 			}
 		}
 	}
@@ -95,6 +94,18 @@ static void replaceThumbnailFileId(JsonObject jsonDocument, String fileId, Strin
 		jsonDocument.put("thumbnails", meta);
 	}
 
+	static void dropThumbnailFileId(JsonObject jsonDocument, String fileId) {
+		JsonObject meta = jsonDocument.getJsonObject("thumbnails", new JsonObject());
+		for (String key : meta.fieldNames()) {
+			String value = meta.getString(key);
+			if (value != null && value.equals(fileId)) {
+				meta.remove(key);
+				break;
+			}
+		}
+		jsonDocument.put("thumbnails", meta);
+	}
+
 	public static List<String> getListOfFileIds(JsonObject jsonDocument) {
 		List<String> listOfFilesIds = new ArrayList<>(getFileId(jsonDocument));
 		listOfFilesIds.addAll(getThumbnailsFilesIds(jsonDocument));