CCS-3388 Preprocessing the adoc to create an xref using uuid #248
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| package com.redhat.pantheon.asciidoctor.extension; | ||
|
|
||
| import org.asciidoctor.ast.Document; | ||
| import org.asciidoctor.extension.Preprocessor; | ||
| import org.asciidoctor.extension.PreprocessorReader; | ||
| import com.redhat.pantheon.jcr.JcrQueryHelper; | ||
| import org.apache.sling.api.resource.ResourceResolver; | ||
| import java.util.Optional; | ||
|
|
||
| import org.apache.sling.api.resource.Resource; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class UuidPreProcessor extends Preprocessor { // (1) | ||
|
|
||
| private static Resource module; | ||
| private static final Logger log = LoggerFactory.getLogger(UuidPreProcessor.class); | ||
| private static String newModulePath; | ||
|
Comment on lines
+18
to
+20
There was a problem hiding this comment. These fields cannot be static. I'm happy to explain why, if you'd like me to. |
||
|
|
||
| public UuidPreProcessor(Resource module) { | ||
| this.module = module; | ||
| } | ||
|
|
||
| @Override | ||
| public void process(Document document, PreprocessorReader reader) { | ||
|
|
||
| List<String> lines = reader.readLines(); | ||
| List<String> newLines = new ArrayList<String>(); | ||
| String[] split; | ||
| String uuid, newLink; | ||
|
|
||
| for (String line: lines) { | ||
| if(line.startsWith("xref:")){ | ||
|
There was a problem hiding this comment. This is a good start but it needs to be updated so that it works for all of these scenarios:
There was a problem hiding this comment. Yes Ben, |
||
| split = line.split(",pantheon-id="); | ||
| uuid = split[1].replace(split[1].substring(split[1].length()-1), ""); | ||
|
Comment on lines
+36
to
+37
There was a problem hiding this comment. I'm not quite sure what this does. Are we assuming that the 'pantheon-id' parameter is the final parameter of the xref, and then the last character is the closing Don't spend too much time making the code update "perfect" - I'm not sure that we'll stick with UUIDs for the final solution, so just getting the next N characters (N = however long a UUID is) from the string would be good enough for this POC. There was a problem hiding this comment. This approach was done considering the last character to be ']' and assuming 'pantheon-id' as the final parameter of xref. |
||
| resolveActualPath(module.getResourceResolver(), uuid); | ||
| newLink = split[0].replaceAll(":.*?\\[", ":"+newModulePath+"["); | ||
|
There was a problem hiding this comment. OOF, regex syntax! I think I can read this. It mostly makes sense, but what is the purpose of the There was a problem hiding this comment. Explained the use of "?" in the below example: There was a problem hiding this comment. Ahhhh, the "?" makes it non-greedy! Ok, that makes sense, thank you very much! |
||
| newLink = newLink + "]"; | ||
| newLines.add(newLink); | ||
|
Comment on lines
+38
to
+41
There was a problem hiding this comment. I would like to see this logic being conditional based on whether or not the UUID query returns a result. It looks like the current behavior is that if the UUID fails to resolve, the xref is totally wiped out and replaced with nothing. What the code should do is leave the original author-supplied xref target intact. |
||
| }else { | ||
| newLines.add(line); | ||
| } | ||
| } | ||
| reader.restoreLines(newLines); | ||
| } | ||
|
|
||
| private static void resolveActualPath(ResourceResolver resolver, String uuid) { | ||
| JcrQueryHelper qh = new JcrQueryHelper(resolver); | ||
| try { | ||
| Optional<Resource> result = | ||
| qh.query("select * from [nt:base] WHERE [jcr:uuid] = '" + uuid + "'") | ||
|
There was a problem hiding this comment. I know we talked about having There was a problem hiding this comment. This makes sense, since this is searching for all the UUIDs across the hierarchy, we might have to switch to [pant:module] |
||
| .findFirst(); | ||
|
|
||
| result.ifPresent(output -> { | ||
| assignValue(output.getPath()); | ||
| log.info("result:", output.getPath()); | ||
| }); | ||
| }catch (Exception e) { | ||
| e.printStackTrace(); | ||
| } | ||
| }; | ||
|
|
||
| private static void assignValue(String path){ | ||
| newModulePath = path + ".preview"; | ||
| log.info("newPath2:"+ newModulePath); | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove these lines. You are calling
.convert()twice here - the first result gets overwritten by the second, so it must be unnecessary. We probably don't need thelogstatement here either.