Redirect Manager: Support for context aware configurations #2564

YegorKozlov · 2021-03-29T13:46:40Z

The patch introduces support for context aware configurations in Redirect Manager. Users can put their redirects in the default storage or create configurations per-context.

UI Changes.

The UI is split into two parts. ACS AEM Commons / Manage Redirects opens the list of redirect configurations, where each config represents a table of redirect rules:

The default storage is /conf/global/settings/redirects . This node is created by a repo-init script . The bucket name 'settings' and config name 'redirects' are configurable via OSGi.

Click on a configuration opens the old UI to edit rules. The only change here is that the storage is explicitly passed in the url:

Adding rules to the default storage will result in a structure like this;

/conf/global
    + settings
      + redirects
        + rule-1
            - source = "/content/we-retail/page1"
            - target = "/content/we-retail/page2"
            - statusCode = 302
        + rule-2
            - source = "/content/wknd/page1"
            - target = "/content/wknd/page2"
            - statusCode = 302

This requires zero configuration in content sites. Just put your redirects in the global list, replicate them to publish and they will work.

However, there can be cases where user will want to have different configurations for each site, for example, we-retail and wknd would havevtheir own tables of redirects, any other site will fallback to /conf/global :

Redirects for /content/we-retail

/content/we-retail
    + jcr:content
      - cq:conf = "/conf/we-retail"

/conf/we-retail
    + settings
      + redirects
        + rule-1
            - source = "/content/we-retail/page1"
            - target = "/content/we-retail/page2"
            - statusCode = 302

Redirects for /content/wknd

/content/wknd
    + jcr:content
      - cq:conf = "/conf/wknd"

/conf/we-retail
    + settings
      + redirects
        + rule-1
            - source = "/content/wknd/page1"
            - target = "/content/wknd/page2"
            - statusCode = 302

Redirects for other sites

# sites that don't have cq:conf will fallback to this configuration
/conf/global
    + settings
      + redirects
        + rule-1
            - source = "/content/geometrixx/page1"
            - target = "/content/geometrixx/page2"
            - statusCode = 302

Configuration Resolution

The code leverages org.apache.sling.caconfig.resource.ConfigurationResourceResolver#getResource(Resource resource, String bucketName, String configName) to lookup configurations based on context. If context config is not set then /conf/global is used as a fallback. In order to resolve contextual configurations a request needs read access to it, e.g. web request to /content/geometrixx/page1 needs to read /conf/global/settings/redirects This is enabled in the repo-init script

# web requests need read access to redirect configurations, e.g. /conf/global/settings/redirects
set ACL for anonymous
    allow jcr:read on /conf  restriction(rep:glob,/*/settings/redirects)
end

Example:

User requests /content/we-retail/page1
RedirectFilter goes up the content tree until a resource with the _cq:conf_property is found: /content/we-retail
Check if a configuration resource exists at the path the property points to: /conf/we-retail
Check if the redirect configuration exists below the configuration resource: /conf/we-retail/settings/redirects
Use /conf/global as fallback path

Upgrade rules created with v5.0.4

The default storage in v5.0.4 was /conf/acs-commons/redirects which is not compatible with context aware configurations. This means redirects previously defined under /conf/acs-commons/redirects need to be moved to /conf/global/settings/redirects

This is done automatically on first load of the GUI. The redirects are moved and user sees a message:

we can reflect it in the release notes too.

Changes in the 'Until Date' field

In v5.0.4 the 'Until Date' field was saved a 'dd MMMM yyyy' string, e.g. '16 February 2001'. This implementation had two issues

not flexible because untilDate was rounded to days
failed on non-english locales, e.g. when user is running their browser in the ES locale and AEM is running EN. The browser will submit '05 abril 2021' but AEM expects '05 April 2021'.
This patch changes untilDate to be saved as a JCR Date. Any previously saved untilDate are converted. See RedirectManager: problems with non-english locale #2569

Paginated output

Each redirect on http://localhost:4502/apps/acs-commons/content/redirect-manager.html is rendered as a sly-resource which can result in a 'Too Many Includes' exception when the number of redirects is large (greater than 1500, configurable in org.apache.sling.engine.impl.SlingMainServlet) To avoid this error redirects are paginated . The pages size is 1000. If the number of redirects is less than 1000 then user will use the usual UI. If the number of redirects is greater than 100 the user will see the 1st page and a navigation bar below:

For now search works within the current page only.

New Optional "Notes" field

See #2571
The "Create Rule" dialog now includes a new optional field "Notes"

coveralls · 2021-03-29T14:15:02Z

Pull Request Test Coverage Report for Build 6401

242 of 308 (78.57%) changed or added relevant lines in 9 files are covered.
28 unchanged lines in 3 files lost coverage.
Overall coverage increased (+0.03%) to 56.498%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
bundle/src/main/java/com/adobe/acs/commons/redirects/models/RedirectConfiguration.java	35	37	94.59%
bundle/src/main/java/com/adobe/acs/commons/redirects/servlets/CreateRedirectConfigurationServlet.java	30	36	83.33%
bundle/src/main/java/com/adobe/acs/commons/redirects/models/UpgradeLegacyRedirects.java	46	53	86.79%
bundle/src/main/java/com/adobe/acs/commons/redirects/models/Configurations.java	0	14	0.0%
bundle/src/main/java/com/adobe/acs/commons/redirects/filter/RedirectFilter.java	92	110	83.64%
bundle/src/main/java/com/adobe/acs/commons/redirects/models/Redirects.java	0	19	0.0%

Files with Coverage Reduction	New Missed Lines	%
bundle/src/main/java/com/adobe/acs/commons/redirects/servlets/ImportRedirectMapServlet.java	2	94.87%
bundle/src/main/java/com/adobe/acs/commons/redirects/filter/RedirectFilter.java	6	84.86%
bundle/src/main/java/com/adobe/acs/commons/rewriter/impl/VersionedClientlibsTransformerFactory.java	20	83.91%

Totals
Change from base Build 6380:	0.03%
Covered Lines:	16794
Relevant Lines:	29725

💛 - Coveralls

# Conflicts: # bundle/src/main/java/com/adobe/acs/commons/redirects/filter/RedirectFilter.java # bundle/src/main/java/com/adobe/acs/commons/redirects/models/package-info.java

…ects > 1000

davidjgonzalez · 2021-04-09T03:13:39Z

test.xlsx

Here's my test Excel file with ~50k rows if its useful.

davidjgonzalez · 2021-04-09T03:22:12Z

...c/main/java/com/adobe/acs/commons/redirects/servlets/CreateRedirectConfigurationServlet.java

+    private static final long serialVersionUID = -3564475196678277711L;
+
+    @Reference
+    private RedirectFilterMBean redirectFilter;


Suggested change

private RedirectFilterMBean redirectFilter;

private transient RedirectFilterMBean redirectFilter;

YegorKozlov · 2021-04-09T15:17:49Z

The PR is finally in a good shape to get reviewed and applied.

@davidjgonzalez Thanks for the spreadsheet. The tool can now swallow it without chocking. I did some load testing using Apache Benchmark and didn't see any significant performance impact with the ~50K set.

BTW, I see you are using the .html extension in the mappings, e.g.

/this/is/the/original/path/49976.html	/this/is/the/new/path/to/redirect/to/49976.html

this is not quite correct. So far the assumption was to use extension-less paths to match request, e.g. the rule below will work but yours won't:

/this/is/the/original/path/49976	/this/is/the/new/path/to/redirect/to/49976

I'm inclined to change it to support both versions, with and without .html. It's a very common habit to append the .html extension and the code should support both.

davidjgonzalez · 2021-04-12T13:49:19Z

@YegorKozlov awesome! im gonna try to find time this week to check this out! im pumped!

Also, I used the format of the real customer w/ the 50k redirects to mock out the format of this file, FWIW.

…nager

YegorKozlov added 7 commits March 23, 2021 20:02

caconfig support in redirect manager

76d5c17

bean to upgrade 5.0.4 redirects to context aware

9275cda

refactoring models

feb8019

refactoring models

6723722

more unit tests

b5bafc2

more unit tests

25844bc

caconfig redirects: code polishing

3792252

code climate warnings

ea34972

YegorKozlov mentioned this pull request Apr 5, 2021

RedirectManager: problems with non-english locale #2569

Closed

YegorKozlov added 7 commits April 5, 2021 18:50

save untilDate as JCR date, make it locale-independent

7a873d6

Merge branch 'redirect_locales' into redirects-caconfig

bc9c90a

# Conflicts: # bundle/src/main/java/com/adobe/acs/commons/redirects/filter/RedirectFilter.java # bundle/src/main/java/com/adobe/acs/commons/redirects/models/package-info.java

convert untilDate to JCR Date, make build locale-independent

cdbd611

fixes to make code climate happy

6585270

fixes to make code climate happy - part 2

7a8bad7

bug fixes and code cleanup

03220a5

support paginatation to avoid Too Many Includes errors when num redir…

0123552

…ects > 1000

davidjgonzalez reviewed Apr 9, 2021

View reviewed changes

fix failing ScrMetadataIT.test

f8680a5

YegorKozlov added 2 commits April 13, 2021 13:25

allow .html extension when defining rules

d2ecb6e

support for matching mapped source urls

83a4d32

YegorKozlov mentioned this pull request Apr 18, 2021

[Feature] Add a "notes" field to the Redirect Manager #2571

Closed

YegorKozlov added 2 commits April 20, 2021 15:57

Adobe-Consulting-Services#2571 add a 'notes' field to the Redirect Ma…

6f94469

…nager

prevent NPE when catching events wo path property

1c22fa2

YegorKozlov mentioned this pull request May 7, 2021

documentation updates for PR#2564 Adobe-Consulting-Services/adobe-consulting-services.github.io#210

Merged

davidjgonzalez approved these changes May 9, 2021

View reviewed changes

Merge branch 'master' into redirects-caconfig

68da222

davidjgonzalez merged commit fdd9364 into Adobe-Consulting-Services:master May 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Redirect Manager: Support for context aware configurations #2564

Redirect Manager: Support for context aware configurations #2564

YegorKozlov commented Mar 29, 2021 •

edited

coveralls commented Mar 29, 2021 •

edited

davidjgonzalez commented Apr 9, 2021

davidjgonzalez Apr 9, 2021

YegorKozlov commented Apr 9, 2021

davidjgonzalez commented Apr 12, 2021

	private RedirectFilterMBean redirectFilter;
	private transient RedirectFilterMBean redirectFilter;

Redirect Manager: Support for context aware configurations #2564

Redirect Manager: Support for context aware configurations #2564

Conversation

YegorKozlov commented Mar 29, 2021 • edited

UI Changes.

Redirects for /content/we-retail

Redirects for /content/wknd

Redirects for other sites

Configuration Resolution

Upgrade rules created with v5.0.4

Changes in the 'Until Date' field

Paginated output

New Optional "Notes" field

coveralls commented Mar 29, 2021 • edited

Pull Request Test Coverage Report for Build 6401

💛 - Coveralls

davidjgonzalez commented Apr 9, 2021

davidjgonzalez Apr 9, 2021

Choose a reason for hiding this comment

YegorKozlov commented Apr 9, 2021

davidjgonzalez commented Apr 12, 2021

YegorKozlov commented Mar 29, 2021 •

edited

coveralls commented Mar 29, 2021 •

edited