ACS AEM Commons 4.0.0 Release

[davidjgonzalez]

ACS Commons 4.0.0 will be a breaking release.

• ACS Commons 4.0.0 supported AEM versions: 6.3.x, 6.4.x and 6.5.x (dropping support for AEM 6.2). (6.5.x support is to the best of our ability given the current pre-release Load)

• master will act as the release branch

• Moving forward NO issues should be merged unless they address issues outlined in this issue (ONLY PRs directly in support fo 4.0.0 release are to be merged to master until 4.0.0 is release)

The following list defines the issues to included (and are required) to release 4.0.0

• Decide if its ACS Commons 4.0.0 or 5.0.0 (see discussion w JE) (Decision: AEM Commons 4.0.0)
• Support short-names on TLDs (fixed via add short names and remove tldgen (which is non-functional anyway). f… #1748)
• Review and merge Disabling auto-on clientlibs by default #1614 - (Breaking change) Disables all auto-on clientlibs by default,… #1715 (Requires documentation; @davidjgonzalez will do this)
• Revert to SCR Annotations (Revert back to SCR annotations #1741 (comment))
• Handle XSS API import range for AEM 6.5 compatability (#1742 Allowing wider range of XSS version support #1743)
• Fix Http Cache MBean errors at startup (All CacheMBeans produce stack trace on startup #1747) (fixed via Revert back to SCR annotations #1741)
• Align osgi property names, and align name felix namehints for HttpCache (fixed via HttpCache - Prep for 4.x release (Removes Combined* support for 4.0.0) #1749)

In preparation for the 4.0.0 release, ONLY required bug-fixes are to be merged in for the 4.0.0. Else, they will be deferred to 4.0.2 or 4.1.0 (whichever comes first)

The following features breaking changes

Functional breaking changes

• Auto-on clientlibs described in #1614 - (Breaking change) Disables all auto-on clientlibs by default,… #1715

Major Package Changes (API breaking changes)

• com.adobe.acs.commons.fam

• com.adobe.acs.commons.functions

• com.adobe.acs.commons.http

• com.adobe.acs.commons.httpcache.store

• com.adobe.acs.commons.json

• com.adobe.acs.commons.mcp.form

• com.adobe.acs.commons.mcp.util

• com.adobe.acs.commons.quickly

• com.adobe.acs.commons.quickly.results

• com.adobe.acs.commons.redirectmaps.models

• com.adobe.acs.commons.synth.children

• com.adobe.acs.commons.util

• com.adobe.acs.commons.wcm

• com.adobe.acs.commons.workflow.bulk.execution.model

• com.adobe.acs.commons.workflow.bulk.removal

• com.adobe.acs.commons.workflow.synthetic

• com.adobe.acs.commons.xss

• HTTP Cache JMX object names have changed:

Property jmx.objectname on component com.adobe.acs.commons.httpcache.engine.impl.HttpCacheEngineImpl has different values (was: {com.adobe.acs.httpcache:type=HTTP Cache Engine}, is: {com.adobe.acs.commons.httpcache:type=HTTP Cache - Engine})
Property jmx.objectname on component com.adobe.acs.commons.httpcache.store.jcr.impl.JCRHttpCacheStoreImpl has different values (was: {com.adobe.acs.httpcache:type=JCR HTTP Cache Store}, is: {com.adobe.acs.commons.httpcache:type=HTTP Cache - JCR Cache Store})
Property jmx.objectname on component com.adobe.acs.commons.httpcache.store.mem.impl.MemHttpCacheStoreImpl has different values (was: {com.adobe.acs.httpcache:type=In Memory HTTP Cache Store}, is: {com.adobe.acs.commons.httpcache:type=HTTP Cache - In-Memory Cache Store}}

/cc @justinedelson @heervisscher @kwin @niekraaijmakers @joerghoh @badvision

[davidjgonzalez]

@badvision , @joerghoh , @heervisscher - can you jot down what is breaking in 4.0.0 using the template above? and/or CC other folks you know what PR'd breaking changes?

[joerghoh]

• New contributions need to use OSGI annotations, the support for the SCR annotations has been removed.
• org.apache.sling.commons.json package can no longer be used in acs-aem-commons; com.google.gson should be used as replacement (proper package imports already available)
• Support for AEM 6.2 dropped; this version requires at least AEM 6.3 SP (??)

[badvision]

• Feature/remove deprecated methods #1568 - Removal of all deprecated classes and methods in ACS Commons -- Many of these have been deprecated for two years with recommendations in the deprecation warnings of how to resolve.
• Conversion to GSON instead of deprecated Sling JSON library, this changes what classes are used but doesn't affect any method signatures in a major way. Switching to the equivalent GSON classes is sufficient.
• Updating dependencies to 6.3 (test PR, will be closed after coverage and unit tests finish) #1555 - Updated dependencies to 6.3 bundle versions -- This doesn't break anything but it does prevent backwards compatibility for newer code using newer library functions.

[heervisscher]

PIDs impacted by the changed OSGi property-names (because hyphens are not supported in OSGi R6)
com.adobe.acs.commons.errorpagehandler.impl.ErrorPageHandlerImpl
com.adobe.acs.commons.hc.impl.HealthCheckStatusEmailer
com.adobe.acs.commons.http.headers.impl.MonthlyExpiresHeaderFilter
com.adobe.acs.commons.http.headers.impl.WeeklyExpiresHeaderFilter
com.adobe.acs.commons.httpcache.config.impl.GroupHttpCacheConfigExtension
com.adobe.acs.commons.httpcache.config.impl.HttpCacheConfigImpl
com.adobe.acs.commons.httpcache.config.impl.ResourceTypeHttpCacheConfigExtension
com.adobe.acs.commons.httpcache.engine.impl.HttpCacheEngineImpl
com.adobe.acs.commons.images.impl.NamedTransformImageServlet
com.adobe.acs.commons.images.transformers.impl.ResizeImageTransformerImpl
com.adobe.acs.commons.oak.impl.EnsureOakIndex
com.adobe.acs.commons.replication.dispatcher.impl.DispatcherFlusherServlet
com.adobe.acs.commons.replication.dispatcher.impl.DispatcherFlushRulesImpl
com.adobe.acs.commons.replication.status.impl.JcrPackageReplicationStatusEventHandler
com.adobe.acs.commons.users.impl.EnsureGroup
com.adobe.acs.commons.util.impl.DelegatingServletFactoryImpl
com.adobe.acs.commons.wcm.impl.AemEnvironmentIndicatorFilter
com.adobe.acs.commons.wcm.impl.AuthorUIHelperImpl
com.adobe.acs.commons.wcm.impl.ComponentErrorHandlerImpl
com.adobe.acs.commons.wcm.impl.CQIncludePropertyNamespaceServlet
com.adobe.acs.commons.wcm.views.impl.WCMViewsFilter
com.adobe.acs.commons.wcm.views.impl.WCMViewsServlet
com.adobe.acs.commons.workflow.bulk.removal.impl.WorkflowInstanceRemoverScheduler

If you have existing configs for these classes, check if the property-names still match.

[badvision]

Is it somehow possible that we can finish this one week from today? It would be helpful to have some of these fixes and features available at Adobe Summit and they'll be building the software images very soon.

[heervisscher]

for me it is not fully clear what direction we are taking here.

[davidjgonzalez]

@justinedelson @heervisscher @kwin @niekraaijmakers @joerghoh @badvision

Hand is finally pretty good - I took a spin through last night to see where we are wrt to 4.0.0 release.

We need to nail this down and only merge PR's directly in support of 4.0.0 (all these other non-crtical PRs are just noise in an already noisy process). I've outlined my understanding of what the outstanding issues are (though i couldnt find GH issues for some?)

Does this look right? Can we check off specific items we know to be done/validated?

[kwin]

@davidjgonzalez I would recommend to also switch to bnd-maven-plugin instead of maven-bundle-plugin. Doing that in a minor release might not be a good idea. I mentioned this in #1560 (comment) but this issue was resolved meanwhile. Should I create a dedicated new issue for that?

[badvision]

I can confirm our target is ACS Commons 4.0 for this work. I will review the Granite main pom to see which dependencies it uses so we confirm we are using the same for 6.4 compatibility.

[davidjgonzalez]

@kwin sure - that'd be great if you could make a dedicated issue so we can track/close it out.