-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CIF-1629 - Enrich PLP / PDP automatically with metadata (#416)
* CIF-1629 - Enrich PLP / PDP automatically with metadata - enable caching for Product and ProductList Sling models - add meta title, description, and keywords * CIF-1629 - Enrich PLP / PDP automatically with metadata - add unit tests * CIF-1629 - Enrich PLP / PDP automatically with metadata - extend unit tests for launch pages * CIF-1629 - Enrich PLP / PDP automatically with metadata - minor fix * CIF-1629 - Enrich PLP / PDP automatically with metadata - implement canonical url * CIF-1629 - Enrich PLP / PDP automatically with metadata - fix unit test and extend examples to be used in Venia integration tests * CIF-1629 - Enrich PLP / PDP automatically with metadata - automate dependency versioning in integration tests * CIF-1629 - Enrich PLP / PDP automatically with metadata - fix a bug that the ResourceResolver is sometimes closed after the @PostConstruct method executed * CIF-1629 - Enrich PLP / PDP automatically with metadata - fix branch merge issue
- Loading branch information
Showing
28 changed files
with
612 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
101 changes: 101 additions & 0 deletions
101
.../java/com/adobe/cq/commerce/core/components/internal/models/v1/page/PageMetadataImpl.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| /******************************************************************************* | ||
| * | ||
| * Copyright 2020 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| * | ||
| ******************************************************************************/ | ||
|
|
||
| package com.adobe.cq.commerce.core.components.internal.models.v1.page; | ||
|
|
||
| import javax.annotation.PostConstruct; | ||
|
|
||
| import org.apache.sling.api.SlingHttpServletRequest; | ||
| import org.apache.sling.api.resource.ValueMap; | ||
| import org.apache.sling.models.annotations.Model; | ||
| import org.apache.sling.models.annotations.injectorspecific.ScriptVariable; | ||
| import org.apache.sling.models.annotations.injectorspecific.Self; | ||
|
|
||
| import com.adobe.cq.commerce.core.components.models.page.PageMetadata; | ||
| import com.adobe.cq.commerce.core.components.models.product.Product; | ||
| import com.adobe.cq.commerce.core.components.models.productlist.ProductList; | ||
| import com.adobe.cq.commerce.core.components.utils.SiteNavigation; | ||
| import com.day.cq.commons.jcr.JcrConstants; | ||
| import com.day.cq.wcm.api.Page; | ||
|
|
||
| @Model( | ||
| adaptables = SlingHttpServletRequest.class, | ||
| adapters = PageMetadata.class) | ||
| public class PageMetadataImpl implements PageMetadata { | ||
|
|
||
| @Self | ||
| private SlingHttpServletRequest request; | ||
|
|
||
| @ScriptVariable | ||
| private Page currentPage; | ||
|
|
||
| @ScriptVariable | ||
| private ValueMap properties; | ||
|
|
||
| private PageMetadata provider; | ||
|
|
||
| @PostConstruct | ||
| void initModel() { | ||
| if (isProductPage()) { | ||
| Product product = request.adaptTo(Product.class); | ||
| provider = product; | ||
| } else if (isCategoryPage()) { | ||
| ProductList productList = request.adaptTo(ProductList.class); | ||
| provider = productList; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public String getMetaDescription() { | ||
| String metaDescription = provider != null ? provider.getMetaDescription() : null; | ||
| return metaDescription != null ? metaDescription : properties.get(JcrConstants.JCR_DESCRIPTION, String.class); | ||
| } | ||
|
|
||
| @Override | ||
| public String getMetaKeywords() { | ||
| String metaKeywords = provider != null ? provider.getMetaKeywords() : null; | ||
| if (metaKeywords == null && currentPage instanceof com.adobe.cq.wcm.core.components.models.Page) { | ||
| metaKeywords = ((com.adobe.cq.wcm.core.components.models.Page) currentPage).getKeywords().toString(); | ||
| } | ||
| return metaKeywords; | ||
| } | ||
|
|
||
| @Override | ||
| public String getMetaTitle() { | ||
| String metaTitle = provider != null ? provider.getMetaTitle() : null; | ||
| return metaTitle != null ? metaTitle : currentPage.getTitle(); | ||
| } | ||
|
|
||
| @Override | ||
| public String getCanonicalUrl() { | ||
| return provider != null ? provider.getCanonicalUrl() : null; | ||
| } | ||
|
|
||
| private boolean isProductPage() { | ||
| Page productPage = SiteNavigation.getProductPage(currentPage); | ||
|
|
||
| // The product page might be in a Launch so we use 'endsWith' to compare the paths, for example | ||
| // - product page: /content/launches/2020/09/15/mylaunch/content/venia/us/en/products/category-page | ||
| // - current page: /content/venia/us/en/products/category-page | ||
| return productPage != null ? productPage.getPath().endsWith(currentPage.getPath()) : false; | ||
| } | ||
|
|
||
| private boolean isCategoryPage() { | ||
| Page categoryPage = SiteNavigation.getCategoryPage(currentPage); | ||
|
|
||
| // See comment above | ||
| return categoryPage != null ? categoryPage.getPath().endsWith(currentPage.getPath()) : false; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
...es/core/src/main/java/com/adobe/cq/commerce/core/components/models/page/PageMetadata.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /******************************************************************************* | ||
| * | ||
| * Copyright 2020 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| * | ||
| ******************************************************************************/ | ||
| package com.adobe.cq.commerce.core.components.models.page; | ||
|
|
||
| import com.adobe.cq.commerce.core.components.models.productlist.ProductList; | ||
|
|
||
| public interface PageMetadata { | ||
|
|
||
| /** | ||
| * @return The content for the meta description tag of the HTML page. | ||
| */ | ||
| String getMetaDescription(); | ||
|
|
||
| /** | ||
| * @return The content for the meta keywords tag of the HTML page. | ||
| */ | ||
| String getMetaKeywords(); | ||
|
|
||
| /** | ||
| * Although this method refers to "metaTitle", this is used to set the title tag of the HTML page. | ||
| * The method is not called <code>getTitle()</code> to avoid confusion with {@link ProductList#getTitle()} | ||
| * | ||
| * @return The content for the title tag of the HTML page. | ||
| */ | ||
| String getMetaTitle(); | ||
|
|
||
| /** | ||
| * @return The fully-qualified canonical url, to set the canonical link element of the HTML page. | ||
| */ | ||
| String getCanonicalUrl(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.