CustomRecipe to update dependency based on property type found in application.yaml(add dependency visitor not working)

[Sasivarnan1988]

doAfterVisit been invoked but its not updating the pom.xml with dependency. Please assist. Not sure what is being missed here.

@value
@EqualsAndHashCode(callSuper = false)
@slf4j
public class AddDependencyIfPropertyExists extends Recipe {
private final String propertyPath;
private final String groupId;
private final String artifactId;
private final String version;
@JsonCreator
public AddDependencyIfPropertyExists(String propertyPath, String groupId, String artifactId, String version) {
this.propertyPath = propertyPath;
this.groupId = groupId;
this.artifactId = artifactId;
this.version = version;
}

@Override
public String getDisplayName() {
    return "Add Maven dependency if YAML property exists";
}

@Override
public String getDescription() {
    return "Adds a Maven dependency to pom.xml if a specific property is found in application.yaml";
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
    return new YamlIsoVisitor<>() {
        private boolean propertyFound = false;

        @Override
        public Yaml.Document visitDocument(Yaml.Document document, ExecutionContext executionContext) {
            SourceFile sourceFile = getCursor().firstEnclosing(SourceFile.class);
            if (sourceFile != null) {
                String documentName = sourceFile.getSourcePath().toString();
                log.info("Processing document: " + documentName);

                if (documentName.endsWith("application.yaml")) {
                    log.info("Processing document application: " + documentName);
                    return super.visitDocument(document, executionContext);
                }
            }
            return document;
        }

        @Override
        public Yaml.Mapping visitMapping(Yaml.Mapping mapping, ExecutionContext ctx) {
            Yaml.Mapping m = super.visitMapping(mapping, ctx);

            if (propertyExists(m, propertyPath.split("\\."))) {
                propertyFound = true;
            }

            if (propertyFound) {
                log.info("inside property found" + groupId + artifactId + version);
                doAfterVisit(new AddDependency(
                        "com.sample",
                        "sample",
                        "4.7.0",
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null,
                        null
                ).getVisitor());

            }

            return m;
        }

        private boolean propertyExists(Yaml.Mapping mapping, String[] path) {
            if (path.length == 0) return true;
            log.info("path ::" + Arrays.stream(path).toList());
            for (Yaml.Mapping.Entry entry : mapping.getEntries()) {
                log.info("mapping yaml ::" + entry.getKey());
                if (entry.getKey().getValue().equals(path[0])) {
                    if (path.length == 1) {
                        log.info("property found");
                        return true;
                    }
                    if (entry.getValue() instanceof Yaml.Mapping) {
                        String[] remaining = new String[path.length - 1];
                        System.arraycopy(path, 1, remaining, 0, remaining.length);
                        return propertyExists((Yaml.Mapping) entry.getValue(), remaining);
                    }
                }
            }
            return false;
        }
    };
}

[shanman190]

You would need to implement this as a ScanningRecipe (See https://docs.openrewrite.org/concepts-and-explanations/recipes#scanning-recipes).

During the SCAN phase, you would use a YAML visitor to detect your property or potentially reuse the FindProperty recipe to help detect the property that you are search for and record it's presence and any other data in the accumulator object. Then during the EDIT phase, you would utilize the AddDependency recipe guarded by your condition to add the dependency to the pom.xml.

The reason that your current structure doesn't work is that the doAfterVisit executes the provided visitor against the same source file being visited presently which does not pass the isAcceptible check and is thus skipped internally.

[Sasivarnan1988]

Thank you @shanman190 for your help here. I am able to get this working now.