Content Package Post Processors: Add Option "dependencyChainIgnore" (#179)

stefanseifert · web-flow · commit ab6f8b04a20c · 2025-06-18T14:47:48.000+02:00
diff --git a/changes.xml b/changes.xml
@@ -24,7 +24,10 @@
     xsi:schemaLocation="http://maven.apache.org/changes/2.0.0 https://maven.apache.org/xsd/changes-2.0.0.xsd">
   <body>
 
-    <release version="2.20.4" date="not released">
+    <release version="2.21.0" date="not released">
+      <action type="add" dev="sseifert" issue="179">
+        Content Package Post Processors: Add option "dependencyChainIgnore" to ignore a content package in the dependency chain, i.e. it does not play a role for this package in which order it is deployed compared to other packages.
+      </action>
       <action type="update" dev="sseifert" issue="178">
         Omit CONGA file header in generated content packages and use single creation date.
       </action>
diff --git a/conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackageOptions.java b/conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackageOptions.java
@@ -103,4 +103,10 @@ private ContentPackageOptions() {
    */
   public static final String PROPERTY_PACKAGE_ALLOW_INDEX_DEFINITIONS = "contentPackage.allowIndexDefinitions";
 
+  /**
+   * Ignore this package in dependency chain, i.e. it does not play a role for this package in which order
+   * it is deployed compared to other packages.
+   */
+  public static final String PROPERTY_DEPENCY_CHAIN_IGNORE = "dependencyChainIgnore";
+
 }
diff --git a/conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePropertiesPostProcessor.java b/conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePropertiesPostProcessor.java
@@ -19,6 +19,7 @@
  */
 package io.wcm.devops.conga.plugins.aem.postprocessor;
 
+import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_DEPENCY_CHAIN_IGNORE;
 import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackageOptions.PROPERTY_PACKAGE_PACKAGE_TYPE;
 import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_PACKAGE_TYPE;
 
@@ -54,6 +55,11 @@ public class ContentPackagePropertiesPostProcessor extends AbstractPostProcessor
    */
   public static final String MODEL_OPTIONS_PROPERTY = "aemContentPackageProperties";
 
+  /**
+   * Marks content package to be ignored in dependency chain.
+   */
+  public static final String DEPENDENCY_CHAIN_IGNORE_PROPERTY = "aemContentPackageDepenencyChainIgnore";
+
   private static final String FILE_EXTENSION = "zip";
   private static final String ALTERNATE_FILE_EXTENSION = "jar";
 
@@ -94,6 +100,12 @@ public List<FileContext> apply(FileContext fileContext, PostProcessorContext con
         }
 
         fileContext.getModelOptions().put(MODEL_OPTIONS_PROPERTY, properties);
+
+        boolean dependencyChainIgnore = ContentPackageUtil.getOptionalPropBoolean(context.getOptions(), PROPERTY_DEPENCY_CHAIN_IGNORE);
+        if (dependencyChainIgnore) {
+          fileContext.getModelOptions().put(DEPENDENCY_CHAIN_IGNORE_PROPERTY, true);
+        }
+
         logger.info("Extracted properties from AEM content package.");
       }
     }
diff --git a/conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/util/ContentPackageUtil.java b/conga-aem-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/util/ContentPackageUtil.java
@@ -264,7 +264,7 @@ else if (value != null) {
    * @param key Key
    * @return Option value or false
    */
-  private static boolean getOptionalPropBoolean(Map<String, Object> options, String key) {
+  public static boolean getOptionalPropBoolean(Map<String, Object> options, String key) {
     Object value = getOptionalProp(options, key);
     if (value instanceof Boolean) {
       return (Boolean)value;
diff --git a/conga-aem-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePropertiesPostProcessorTest.java b/conga-aem-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/postprocessor/ContentPackagePropertiesPostProcessorTest.java
@@ -62,6 +62,21 @@ void testContentPackage() {
     assertEquals(false, props.get("requiresRoot"));
     assertEquals(2, props.get("packageFormatVersion"));
     assertNull(props.get("packageType"));
+
+    assertNull(fileContext.getModelOptions().get(ContentPackagePropertiesPostProcessor.DEPENDENCY_CHAIN_IGNORE_PROPERTY));
+  }
+
+  @Test
+  void testContentPackageIgnoreDependencyChain() {
+
+    FileContext fileContext = new FileContext()
+        .file(new File("src/test/resources/package/example.zip"));
+
+    // post-process
+    applyPlugin(fileContext, Map.of(ContentPackageOptions.PROPERTY_DEPENCY_CHAIN_IGNORE, true));
+
+    // validate
+    assertEquals(true, fileContext.getModelOptions().get(ContentPackagePropertiesPostProcessor.DEPENDENCY_CHAIN_IGNORE_PROPERTY));
   }
 
   @SuppressWarnings("unchecked")
diff --git a/src/site/markdown/extensions.md b/src/site/markdown/extensions.md
@@ -45,6 +45,7 @@ Both post processor plugins support a set of options that allow further configur
 | `contentPackage.requiresRoot`   | Package requires root.
 | `contentPackage.requiresRestart`| Package requires restart.
 | `contentPackage.allowIndexDefinitions` | Package allows index definitions.
+| `dependencyChainIgnore`         | Ignore this package in dependency chain, i.e. it does not play a role for this package in which order it is deployed compared to other packages.
 
 
 Example for defining package properties with a set of filters:
diff --git a/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilder.java b/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilder.java
@@ -416,6 +416,8 @@ private void buildAddContentPackages(ContentPackage contentPackage, String rootP
         .filter(item -> isAuthorAndPublish(item)
             || (isOnlyAuthor(item) && isOnlyAuthor(currentPackage))
             || (isOnlyPublish(item) && isOnlyPublish(currentPackage)))
+        // ignore packages that are marked as dependency chain ignore
+        .filter(item -> !item.isDependencyChainIgnore())
         // get last in list
         .reduce((first, second) -> second).orElse(null);
   }
@@ -602,7 +604,7 @@ private List<TemporaryContentPackageFile> processContentPackage(ContentPackageFi
 
                 // update package dependencies
                 ContentPackageFile dependencyFile = previousPkg;
-                if (autoDependenciesMode == AutoDependenciesMode.OFF) {
+                if (autoDependenciesMode == AutoDependenciesMode.OFF || pkg.isDependencyChainIgnore()) {
                   dependencyFile = null;
                 }
                 updateDependencies(pkg, props, dependencyFile, environmentRunMode, allPackagesFromFileSets);
diff --git a/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/TemporaryContentPackageFile.java b/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/TemporaryContentPackageFile.java
@@ -88,4 +88,9 @@ public String getPackageInfoWithDependencies() {
     return sb.toString();
   }
 
+  @Override
+  public boolean isDependencyChainIgnore() {
+    return false;
+  }
+
 }
diff --git a/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/model/ContentPackageFile.java b/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/model/ContentPackageFile.java
@@ -52,6 +52,11 @@ public interface ContentPackageFile extends InstallableFile {
   @Nullable
   String getPackageType();
 
+  /**
+   * @return Ignore in dependency chain
+   */
+  boolean isDependencyChainIgnore();
+
   default String getPackageInfo() {
     return StringUtils.defaultString(getGroup())
         + ":" + StringUtils.defaultString(getName())
diff --git a/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/model/ModelContentPackageFile.java b/tooling/conga-aem-maven-plugin/src/main/java/io/wcm/devops/conga/plugins/aem/maven/model/ModelContentPackageFile.java
@@ -19,6 +19,8 @@
  */
 package io.wcm.devops.conga.plugins.aem.maven.model;
 
+import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackagePropertiesPostProcessor.DEPENDENCY_CHAIN_IGNORE_PROPERTY;
+import static io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackagePropertiesPostProcessor.MODEL_OPTIONS_PROPERTY;
 import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_GROUP;
 import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_NAME;
 import static org.apache.jackrabbit.vault.packaging.PackageProperties.NAME_PACKAGE_TYPE;
@@ -31,8 +33,6 @@
 
 import org.jetbrains.annotations.Nullable;
 
-import io.wcm.devops.conga.plugins.aem.postprocessor.ContentPackagePropertiesPostProcessor;
-
 /**
  * Represents a content package file generated or referenced by CONGA.
  */
@@ -43,6 +43,7 @@ public final class ModelContentPackageFile extends AbstractInstallableFile imple
   private final Boolean recursive;
   private final Integer delayAfterInstallSec;
   private final Integer httpSocketTimeoutSec;
+  private final Boolean dependencyChainIgnore;
 
   private final String name;
   private final String group;
@@ -63,11 +64,11 @@ public ModelContentPackageFile(File file, Map<String, Object> fileData, List<Str
     this.recursive = (Boolean)fileData.get("recursive");
     this.delayAfterInstallSec = (Integer)fileData.get("delayAfterInstallSec");
     this.httpSocketTimeoutSec = (Integer)fileData.get("httpSocketTimeoutSec");
+    this.dependencyChainIgnore = (Boolean)fileData.get(DEPENDENCY_CHAIN_IGNORE_PROPERTY);
 
-    Map<String, Object> contentPackageProperties = (Map<String, Object>)fileData.get(
-        ContentPackagePropertiesPostProcessor.MODEL_OPTIONS_PROPERTY);
+    Map<String, Object> contentPackageProperties = (Map<String, Object>)fileData.get(MODEL_OPTIONS_PROPERTY);
     if (contentPackageProperties == null) {
-      throw new IllegalArgumentException(ContentPackagePropertiesPostProcessor.MODEL_OPTIONS_PROPERTY + " missing.");
+      throw new IllegalArgumentException(MODEL_OPTIONS_PROPERTY + " missing.");
     }
     this.name = Objects.toString(contentPackageProperties.get(NAME_NAME), null);
     this.group = Objects.toString(contentPackageProperties.get(NAME_GROUP), null);
@@ -119,4 +120,9 @@ public String getPackageType() {
     return this.packageType;
   }
 
+  @Override
+  public boolean isDependencyChainIgnore() {
+    return dependencyChainIgnore != null && dependencyChainIgnore;
+  }
+
 }
diff --git a/tooling/conga-aem-maven-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilderAuthorPublishTest.java b/tooling/conga-aem-maven-plugin/src/test/java/io/wcm/devops/conga/plugins/aem/maven/allpackage/AllPackageBuilderAuthorPublishTest.java
@@ -121,6 +121,7 @@ void testBuild_AUTODEPENDENCIES_OFF_RUNMODEOPTIMIZATION_OFF() throws Exception {
         contentPackage("acs-aem-commons-ui.content{runmode}", "4.10.0",
             dep("adobe/consulting:acs-aem-commons-ui.apps{runmode}:4.10.0")),
         contentPackage("wcm-io-samples-sample-content{runmode}", "1.3.1-SNAPSHOT"),
+        contentPackage("aem-cms-publish-sling-mapping-dependencyChainIgnore{runmode}"),
         contentPackage("aem-cms-publish-sling-mapping{runmode}"));
 
     File containerDir = new File(appsDir, "container");
@@ -192,6 +193,7 @@ void testBuild_AUTODEPENDENCIES_OFF() throws Exception {
         contentPackage("aem-cms-author-replicationagents{runmode}"));
     File contentInstallDirPublish = new File(contentDir, "install.publish");
     assertFiles(contentInstallDirPublish, ".publish",
+        contentPackage("aem-cms-publish-sling-mapping-dependencyChainIgnore{runmode}"),
         contentPackage("aem-cms-publish-sling-mapping{runmode}"));
 
     File containerDir = new File(appsDir, "container");
@@ -341,6 +343,7 @@ void testBuild_IMMUTABLE_MUTABLE_SEPARATE() throws Exception {
             dep("adobe/consulting:acs-aem-commons-ui.content:4.10.0")));
     File contentInstallDirPublish = new File(contentDir, "install.publish");
     assertFiles(contentInstallDirPublish, ".publish",
+        contentPackage("aem-cms-publish-sling-mapping-dependencyChainIgnore{runmode}"),
         contentPackage("aem-cms-publish-sling-mapping{runmode}",
             dep("wcm-io-samples:wcm-io-samples-sample-content:1.3.1-SNAPSHOT")));
 
@@ -418,6 +421,7 @@ void testBuild_IMMUTABLE_ONLY() throws Exception {
         contentPackage("aem-cms-author-replicationagents{runmode}"));
     File contentInstallDirPublish = new File(contentDir, "install.publish");
     assertFiles(contentInstallDirPublish, ".publish",
+        contentPackage("aem-cms-publish-sling-mapping-dependencyChainIgnore{runmode}"),
         contentPackage("aem-cms-publish-sling-mapping{runmode}"));
 
     File containerDir = new File(appsDir, "container");
diff --git a/tooling/conga-aem-maven-plugin/src/test/resources/node/aem-publish/model.yaml b/tooling/conga-aem-maven-plugin/src/test/resources/node/aem-publish/model.yaml
@@ -26,6 +26,17 @@ roles:
         set of standardized components for AEM 6.3+ that can be used to speed up development
         of websites., group: adobe/cq60, groupId: com.adobe.cq, name: core.wcm.components.all,
       packageType: container, requiresRoot: false, version: 2.17.0}
+  - path: packages/aem-cms-publish-sling-mapping-dependencyChainIgnore.zip
+    postProcessors: [aem-contentpackage, aem-contentpackage-properties]
+    aemContentPackageDepenencyChainIgnore: true
+    aemContentPackageProperties:
+      allowIndexDefinitions: false
+      created: '2020-04-07T10:36:38.346+02:00'
+      createdBy: admin
+      group: wcm-io-samples
+      name: aem-cms-publish-sling-mapping-dependencyChainIgnore
+      packageType: content
+      version: 1.3.1-SNAPSHOT
   - path: packages/aem-cms-publish-sling-mapping.zip
     postProcessors: [aem-contentpackage, aem-contentpackage-properties]
     aemContentPackageProperties:
diff --git a/tooling/conga-aem-maven-plugin/src/test/resources/node/aem-publish/packages/aem-cms-publish-sling-mapping-dependencyChainIgnore.zip b/tooling/conga-aem-maven-plugin/src/test/resources/node/aem-publish/packages/aem-cms-publish-sling-mapping-dependencyChainIgnore.zip

Original file line number	Diff line number	Diff line change
`@@ -88,4 +88,9 @@ public String getPackageInfoWithDependencies() {`
`88`	`88`	`return sb.toString();`
`89`	`89`	`}`
`90`	`90`
	`91`	`+ @Override`
	`92`	`+ public boolean isDependencyChainIgnore() {`
	`93`	`+ return false;`
	`94`	`+ }`
	`95`	`+`
`91`	`96`	`}`