Merge branch 'issue-30552-containers-tm-support' of https://github.com/dotCMS/core into issue-30552-containers-tm-support

Author: fabrizzio-dotCMS

core-web/libs/sdk/client/README.md

@@ -1,16 +1,16 @@
-# DotCMS API Client - `@dotcms/client`
+# dotCMS API Client - `@dotcms/client`
 
-The `@dotcms/client` is a JavaScript/TypeScript library for interacting with a DotCMS instance. It allows you to easily fetch pages, content, and navigation information in JSON format, as well as to make complex queries on content collections.
+The `@dotcms/client` is a JavaScript/TypeScript library for interacting with a dotCMS instance. It allows you to easily fetch pages, content, and navigation information in JSON format, as well as to make complex queries on content collections.
 
 This client library provides a streamlined, promise-based interface to fetch pages and navigation API.
 
 ## Features
 
--   Easy-to-use methods to interact with the [DotCMS Page](https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas) and [Navigation APIs](https://www.dotcms.com/docs/latest/navigation-rest-api).
--   Support for custom actions to communicate with the DotCMS page editor.
+-   Easy-to-use methods to interact with [dotCMS pages](https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas) and the [Navigation API](https://www.dotcms.com/docs/latest/navigation-rest-api).
+-   Support for custom actions to communicate with the dotCMS page editor.
 -   Comprehensive TypeScript typings for better development experience.
 
-# DotCMS API Client
+# dotCMS API Client
 
 ## Installation
 
@@ -42,7 +42,9 @@ import { DotCmsClient } from '@dotcms/client';
 const { DotCmsClient } = require('@dotcms/client');
 ```
 
-First, initialize the client with your DotCMS instance details.
+### Initialization
+
+First, initialize the client with your dotCMS instance details.
 
 ```javascript
 const client = DotCmsClient.init({
@@ -54,7 +56,7 @@ const client = DotCmsClient.init({
 
 ### Fetching a Page
 
-You can retrieve the elements of any page in your DotCMS system in JSON format using the client.page.get() method.
+You can retrieve the elements of any page in your dotCMS system in JSON format using the `client.page.get()` method.
 
 ```javascript
 const pageData = await client.page.get({
@@ -66,7 +68,7 @@ const pageData = await client.page.get({
 
 ### Fetching Navigation
 
-Retrieve the DotCMS file and folder tree to get information about the navigation structure.
+Retrieve the dotCMS file and folder tree to get information about the navigation structure.
 
 ```javascript
 const navData = await client.nav.get({
@@ -78,7 +80,7 @@ const navData = await client.nav.get({
 
 ### Fetching a Collection of Content
 
-The `getCollection` method allows you to fetch a collection of content items using a builder pattern for complex queries.
+The `getCollection` method allows you to fetch a collection of content items (sometimes called "contentlets") using a builder pattern for complex queries.
 
 #### Basic Usage
 
@@ -125,7 +127,7 @@ const languageFilteredResponse = await client.content
 
 #### Using Complex Queries
 
-You can build more complex queries using the query builder. For example, filter by author and `title`:
+You can build more complex queries using the query builder. For example, filter by `author` and `title`:
 
 ```typescript
 const complexQueryResponse = await client.content
@@ -206,26 +208,27 @@ Detailed documentation of the `@dotcms/client` methods, parameters, and types ca
 
 ### `DotCmsClient.init(config: ClientConfig): DotCmsClient`
 
-Initializes the DotCMS client with the specified configuration.
+Initializes the dotCMS client with the specified configuration.
 
 ### `DotCmsClient.page.get(options: PageApiOptions): Promise<unknown>`
 
-Retrieves the specified page's elements from your DotCMS system in JSON format.
+Retrieves the specified page's elements from your dotCMS system in JSON format.
 
 ### `DotCmsClient.nav.get(options: NavApiOptions): Promise<unknown>`
 
-Retrieves information about the DotCMS file and folder tree.
+Retrieves information about the dotCMS file and folder tree.
 
 ### `DotCmsClient.content.getCollection(contentType: string): CollectionBuilder<T>`
-Creates a builder to filter and fetch a collection of content items for a specific content type.
+
+Creates a builder to filter and fetches a collection of content items for a specific content type.
 
 #### Parameters
 
-contentType (string): The content type to retrieve.
+`contentType` (string): The content type to retrieve.
 
 #### Returns
 
-CollectionBuilder<T>: A builder instance for chaining filters and executing the query.
+`CollectionBuilder<T>`: A builder instance for chaining filters and executing the query.
 
 ## Contributing
 
@@ -241,7 +244,7 @@ If you need help or have any questions, please [open an issue](https://github.co
 
 ## Documentation
 
-Always refer to the official [DotCMS documentation](https://www.dotcms.com/docs/latest/) for comprehensive guides and API references.
+Always refer to the official [dotCMS documentation](https://www.dotcms.com/docs/latest/) for comprehensive guides and API references.
 
 ## Getting Help
 
@@ -252,4 +255,4 @@ Always refer to the official [DotCMS documentation](https://www.dotcms.com/docs/
 | Videos          | [Helpful Videos](http://dotcms.com/videos/)                         |
 | Forums/Listserv | [via Google Groups](https://groups.google.com/forum/#!forum/dotCMS) |
 | Twitter         | @dotCMS                                                             |
-| Main Site       | [dotCMS.com](https://dotcms.com/)                                   |
+| Main Site       | [dotCMS.com](https://dotcms.com/)                                   |

dotCMS/src/main/java/com/dotcms/analytics/track/collectors/BasicProfileCollector.java

@@ -73,7 +73,7 @@ public CollectorPayloadBean collect(final CollectorContextMap collectorContextMa
         collectorPayloadBean.put(IS_EXPERIMENT_PAGE, false);
         collectorPayloadBean.put(IS_TARGET_PAGE, false);
 
-        if (Objects.nonNull(collectorPayloadBean.get(EVENT_SOURCE))) {
+        if (Objects.isNull(collectorPayloadBean.get(EVENT_SOURCE))) {
             // this is the default event source
             collectorPayloadBean.put(EVENT_SOURCE, EventSource.DOT_CMS.getName());
         }

dotCMS/src/main/java/com/dotcms/analytics/track/collectors/CharacterCollectorContextMap.java

@@ -6,6 +6,7 @@
 import java.io.Serializable;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Objects;
 
 /**
  * This Context Map has the character map
@@ -16,6 +17,7 @@ public class CharacterCollectorContextMap implements CollectorContextMap {
     private final Map<String, Object> contextMap = new HashMap<>();
     private final RequestMatcher requestMatcher;
     private final Map<String, Serializable> characterMap;
+    private final Map<String, Object> customValuesMap;
 
     public CharacterCollectorContextMap(final Character character,
                                         final RequestMatcher requestMatcher,
@@ -24,13 +26,29 @@ public CharacterCollectorContextMap(final Character character,
         this.characterMap = character.getMap();
         this.requestMatcher = requestMatcher;
         this.contextMap.putAll(contextMap);
+        this.customValuesMap = Map.of();
+    }
+
+    public CharacterCollectorContextMap(final Character character,
+                                        final RequestMatcher requestMatcher,
+                                        final Map<String, Object> contextMap,
+                                        Map<String, Object> customValuesMap) {
+
+        this.characterMap = character.getMap();
+        this.requestMatcher = requestMatcher;
+        this.contextMap.putAll(contextMap);
+        this.customValuesMap = Objects.nonNull(customValuesMap)?customValuesMap:Map.of();
     }
 
 
 
     @Override
     public Object get(final String key) {
 
+        if (this.customValuesMap.containsKey(key)) {
+            return this.customValuesMap.get(key);
+        }
+
         if (this.characterMap.containsKey(key)) {
             return this.characterMap.get(key);
         }

dotCMS/src/main/java/com/dotcms/analytics/track/collectors/ConcurrentCollectorPayloadBeanWithBaseMap.java

@@ -0,0 +1,42 @@
+package com.dotcms.analytics.track.collectors;
+
+import java.io.Serializable;
+import java.util.Map;
+
+/**
+ * This class provides the default implementation for the {@link CollectorPayloadBean}
+ * interface.
+ * Concurrent Collector Payload Bean, but using a base map with is the source fo truth,
+ * means that the map is the one that is going to be used and can not be overriden by any collector
+ *
+ * @author jsanca
+ */
+public class ConcurrentCollectorPayloadBeanWithBaseMap extends ConcurrentCollectorPayloadBean {
+
+    private final Map<String, Serializable> baseMap;
+
+    public ConcurrentCollectorPayloadBeanWithBaseMap(final Map<String, Serializable> customMap) {
+        super(customMap);
+        this.baseMap = customMap;
+    }
+
+    @Override
+    public CollectorPayloadBean put(final String key, final Serializable value) {
+
+        if (baseMap.containsKey(key)) {
+            return this;
+        }
+
+        super.put(key, value);
+        return this;
+    }
+
+
+    public CollectorPayloadBean add(final CollectorPayloadBean other) {
+
+        other.toMap().entrySet().stream()
+                .filter(entry -> !baseMap.containsKey(entry.getKey()))
+                .forEach(entry -> super.put(entry.getKey(), entry.getValue()));
+        return this;
+    }
+}

dotCMS/src/main/java/com/dotcms/analytics/track/collectors/RequestCharacterCollectorContextMap.java

@@ -6,6 +6,8 @@
 import com.dotmarketing.business.web.WebAPILocator;
 
 import javax.servlet.http.HttpServletRequest;
+import java.util.Map;
+import java.util.Objects;
 
 /**
  * This Context Map has the request + character map
@@ -15,21 +17,37 @@ public class RequestCharacterCollectorContextMap implements CollectorContextMap
 
     private final RequestMatcher requestMatcher;
     private final Character character;
-    final HttpServletRequest request;
+    private final HttpServletRequest request;
+    private final Map<String, Object> customValuesMap;
+
+    public RequestCharacterCollectorContextMap(final HttpServletRequest request,
+                                               final Character character,
+                                               final RequestMatcher requestMatcher,
+                                               final Map<String, Object> customValuesMap) {
+        this.request = request;
+        this.character = character;
+        this.requestMatcher = requestMatcher;
+        this.customValuesMap = Objects.nonNull(customValuesMap)?customValuesMap:Map.of();
+    }
 
     public RequestCharacterCollectorContextMap(final HttpServletRequest request,
                                                final Character character,
                                                final RequestMatcher requestMatcher) {
         this.request = request;
         this.character = character;
         this.requestMatcher = requestMatcher;
+        this.customValuesMap = Map.of();
     }
 
 
 
     @Override
     public Object get(final String key) {
 
+        if (this.customValuesMap.containsKey(key)) {
+            return this.customValuesMap.get(key);
+        }
+
         if (request.getParameter(key) != null) {
             return request.getParameter(key);
         }

dotCMS/src/main/java/com/dotcms/analytics/track/collectors/WebEventsCollectorService.java

@@ -37,10 +37,11 @@ void fireCollectors (final HttpServletRequest request, final HttpServletResponse
      * @param requestMatcher The {@link RequestMatcher} that matched the dotCMS object being
      *                       processed, such as: HTML Page, File Asset, URL Mapped Content,
      *                       Vanity URL, etc.
-     * @param basePayloadMap A Map containing all the properties that were retrieved by a given
-     *                       {@link Collector}.
+     * @param basePayloadMap A Map containing all payload properties that were given user
+     * @param baseContextMap A Map containing all context the properties that were given user
      */
     void fireCollectorsAndEmitEvent(final HttpServletRequest request, final HttpServletResponse response,
-                                    final RequestMatcher requestMatcher, final Map<String, Serializable> userEventPayload);
+                                    final RequestMatcher requestMatcher, final Map<String, Serializable> basePayloadMap,
+                                    Map<String, Object> baseContextMap);
 
 }

dotCMS/src/main/java/com/dotcms/analytics/track/collectors/WebEventsCollectorServiceFactory.java

@@ -102,15 +102,16 @@ public void fireCollectors(final HttpServletRequest request,
         public void fireCollectorsAndEmitEvent(final HttpServletRequest request,
                                                 final HttpServletResponse response,
                                                 final RequestMatcher requestMatcher,
-                                               final Map<String, Serializable> basePayloadMap) {
+                                               final Map<String, Serializable> basePayloadMap,
+                                               final Map<String, Object> baseContextMap) {
 
             final Character character = WebAPILocator.getCharacterWebAPI().getOrCreateCharacter(request, response);
             final Host site = WebAPILocator.getHostWebAPI().getCurrentHostNoThrow(request);
 
             final CollectorPayloadBean base = UtilMethods.isSet(basePayloadMap)?
-                    new ConcurrentCollectorPayloadBean(basePayloadMap): new ConcurrentCollectorPayloadBean();
+                    new ConcurrentCollectorPayloadBeanWithBaseMap(basePayloadMap): new ConcurrentCollectorPayloadBean();
             final CollectorContextMap syncCollectorContextMap =
-                    new RequestCharacterCollectorContextMap(request, character, requestMatcher);
+                    new RequestCharacterCollectorContextMap(request, character, requestMatcher, baseContextMap);
 
             Logger.debug(this, ()-> "Running sync collectors");
 
@@ -122,7 +123,7 @@ public void fireCollectorsAndEmitEvent(final HttpServletRequest request,
             // if there is anything to run async
             final PageMode pageMode = PageMode.get(request);
             final CollectorContextMap collectorContextMap = new CharacterCollectorContextMap(character, requestMatcher,
-                    getCollectorContextMap(request, pageMode, site));
+                    getCollectorContextMap(request, pageMode, site), baseContextMap);
 
             try {
                 this.submitter.logEvent(
@@ -138,7 +139,7 @@ public void fireCollectorsAndEmitEvent(final HttpServletRequest request,
                                     .map(CollectorPayloadBean::toMap)
                                     .collect(java.util.stream.Collectors.toList());
                         }));
-            } catch (Exception e) {
+            } catch (Exception e) { // todo: should we catch a more specific exception?
                 Logger.debug(WebEventsCollectorServiceFactory.class, () -> "Error saving Analytics Events:" + e.getMessage());
             }
         }
@@ -147,7 +148,7 @@ private void fireCollectorsAndEmitEvent(final HttpServletRequest request,
                                                 final HttpServletResponse response,
                                                 final RequestMatcher requestMatcher) {
 
-            this.fireCollectorsAndEmitEvent(request, response, requestMatcher, Map.of());
+            this.fireCollectorsAndEmitEvent(request, response, requestMatcher, Map.of(), Map.of());
         }
 
         private static Map<String, Object> getCollectorContextMap(final HttpServletRequest request,