Fix minor CodeRabbit suggestions

SokolovskyiK · SokolovskyiK · commit f4c36fba5e58 · 2025-04-24T14:10:34.000+04:00
diff --git a/components/google_search_console/actions/retrieve-site-performance-data/README.md b/components/google_search_console/actions/retrieve-site-performance-data/README.md
@@ -1,4 +1,4 @@
-#  Google Search Console – Site Performance (Analytics) Action
+# Google Search Console – Site Performance (Analytics) Action
 
 This action queries **search performance data** for a verified website using the [Google Search Console API](https://developers.google.com/webmaster-tools/search-console-api-original/v3/searchanalytics/query). It allows you to extract insights like:
 
@@ -9,15 +9,15 @@ This action queries **search performance data** for a verified website using the
 
 ---
 
-##  Use Cases
+## Use Cases
 
 - Automate SEO reporting  
 - Analyze organic search trends  
 - Filter and break down traffic by dimensions (e.g. query, device, country)  
 
 ---
 
-##  Internals
+## Internals
 
 - Supports all relevant props from the [Search Analytics Query API](https://developers.google.com/webmaster-tools/search-console-api-original/v3/searchanalytics/query)  
 - Trims and validates all input props  
@@ -28,83 +28,81 @@ This action queries **search performance data** for a verified website using the
 
 ---
 
-##  Auth
+## Auth
 
-Requires OAuth 2.0 with the following scope: https://www.googleapis.com/auth/webmasters.readonly
+Requires OAuth 2.0 with the following scope: `https://www.googleapis.com/auth/webmasters.readonly`
 
 
-##  Endpoint
-https://searchconsole.googleapis.com/webmasters/v3/sites/{siteUrl}/searchAnalytics/query
+## Endpoint
+`https://searchconsole.googleapis.com/webmasters/v3/sites/{siteUrl}/searchAnalytics/query`
 
 
 ## 📦 Example Request Payload
 
 
 
-
+```json
 {
-  // The site you want to query data for.
-  // Must be verified in your Google Search Console account.
-  "siteUrl": "https://falc1.com/soda_can",
 
-  // The start date of the reporting period (inclusive), in YYYY-MM-DD format.
+  "siteUrl": "https://falc1.com/page",
+
   "startDate": "2025-12-22",
 
-  // The end date of the reporting period (inclusive), in YYYY-MM-DD format.
   "endDate": "2025-12-31",
 
-  // The dimensions you want to break down the data by.
-  // Valid values: "query", "page", "country", "device", "searchAppearance", "date".
-  // Order matters — it affects how rows are grouped in the response.
   "dimensions": ["query", "page", "country", "device"],
 
-  // The type of search data to include.
-  // Valid values: "web", "image", "video", "news", "googleNews", "discover"
   "searchType": "web",
 
-  // Maximum number of rows to return (1–25,000)
   "rowLimit": 10,
 
-  // Optional: Skips the first N rows — used for pagination.
   "startRow": 0,
 
-  // Optional: How to group data.
-  // "auto" = Google's default grouping.
-  // "byPage" = Group by page (useful for getting per-page breakdowns).
   "aggregationType": "auto",
 
-  // Optional: Data freshness filter.
-  // "final" = Only finalized data (more accurate).
-  // "all" = Includes fresh but possibly incomplete data.
   "dataState": "final",
 
-  // Optional filter group(s) to restrict which rows are returned.
-  // Each group applies logical AND/OR across its filters.
   "dimensionFilterGroups": [
     {
-      // Logical grouping operator for the filters inside this group.
-      // "and" = all filters must match
-      // "or" = any filter can match
+
       "groupType": "and",
 
-      // List of individual filters to apply within the group
       "filters": [
         {
-          // Which dimension to filter by (must match a dimension in your request)
+
           "dimension": "query",
 
-          // Filter operator — e.g., "equals", "contains", "notEquals", etc.
           "operator": "contains",
 
-          // Value to match against
           "expression": "example"
         },
         {
           "dimension": "country",
+
           "operator": "equals",
+
           "expression": "USA"
         }
       ]
     }
   ]
-}
+}
+```
+
+### Field Descriptions
+
+ **siteUrl**: The site you want to query data for. Must be verified in your Google Search Console account.
+ **startDate**: The start date of the reporting period (inclusive), in YYYY-MM-DD format.
+ **endDate**: The end date of the reporting period (inclusive), in YYYY-MM-DD format.
+ **dimensions**: The dimensions you want to break down the data by. Valid values: "query", "page", "country", "device", "searchAppearance", "date". Order matters — it affects how rows are grouped in the response.
+ **searchType**: The type of search data to include. Valid values: "web", "image", "video", "news", "googleNews", "discover"
+ **rowLimit**: Maximum number of rows to return (1–25,000)
+ **startRow**: Optional: Skips the first N rows — used for pagination.
+ **aggregationType**: Optional: How to group data. "auto" = Google's default grouping. "byPage" = Group by page (useful for getting per-page breakdowns).
+ **dataState**: Optional: Data freshness filter. "final" = Only finalized data (more accurate). "all" = Includes fresh but possibly incomplete data.
+ **dimensionFilterGroups**: Optional filter group(s) to restrict which rows are returned. Each group applies logical AND/OR across its filters.
+   **groupType**: Logical grouping operator for the filters inside this group. "and" = all filters must match, "or" = any filter can match
+   **filters**: List of individual filters to apply within the group
+      **dimension**: Which dimension to filter by (must match a dimension in your request)
+      **operator**: Filter operator — e.g., "equals", "contains", "notEquals", etc.
+      **expression**: Value to match against
diff --git a/components/google_search_console/actions/retrieve-site-performance-data/retrieve-site-performance-data.mjs b/components/google_search_console/actions/retrieve-site-performance-data/retrieve-site-performance-data.mjs
@@ -180,12 +180,12 @@ export default {
        // Identify if the error was thrown by internal validation or by the API call
       const thrower = this.gsConsole.checkWhoThrewError(error);
                                             
-      throw new Error(`Failed to fetch data ( ${thrower.whoThrew} error ) : ${error.message}. ` + warnings.join("*!*"));
+      throw new Error(`Failed to fetch data ( ${thrower.whoThrew} error ) : ${error.message}. ` + warnings.join("\n- "));
     
     };
     
     // Output summary and any warnings for the user
-    $.export("$summary", ` Fetched ${response.rows?.length || 0} rows of data. ` + warnings.join("*!*"));
+    $.export("$summary", ` Fetched ${response.rows?.length || 0} rows of data. ` + warnings.join("\n- "));
     return response;
   },
 };
diff --git a/components/google_search_console/actions/submit-url-for-indexing/submit-url-for-indexing.mjs b/components/google_search_console/actions/submit-url-for-indexing/submit-url-for-indexing.mjs
@@ -5,7 +5,7 @@
 
 import { axios } from "@pipedream/platform";
 import gsConsole from "../../google_search_console.app.mjs";
-import {trimIfString } from "../../common/utils.mjs"
+import { trimIfString } from "../../common/utils.mjs"
 
 
  
@@ -57,7 +57,7 @@ export default {
         url: "https://indexing.googleapis.com/v3/urlNotifications:publish",
         headers: {
 
-          Authorization: `Bearer  ${this.gsConsole.$auth.oauth_access_token}`,
+          Authorization: `Bearer ${this.gsConsole.$auth.oauth_access_token}`,
           "Content-Type": "application/json",
         },
         data: {
@@ -75,11 +75,11 @@ export default {
       */
       const thrower = gsConsole.methods.checkWhoThrewError(error);
                                                   
-      throw new Error(`Failed to fetch data ( ${thrower.whoThrew} error ) : ${error.message}. ` + warnings.join("*!*"));
+      throw new Error(`Failed to fetch data ( ${thrower.whoThrew} error ) : ${error.message}. ` + warnings.join("\n- "));
           
     };
     // Output a summary message and any accumulated warnings
-    $.export("$summary", ` URL submitted to Google: ${this.siteUrl}`  + warnings.join("*!*"));
+    $.export("$summary", ` URL submitted to Google: ${this.siteUrl}`  + warnings.join("\n- "));
      // Return the raw API response
     return response;
   },
diff --git a/components/google_search_console/common/methods.mjs b/components/google_search_console/common/methods.mjs
@@ -193,8 +193,8 @@ throwIfNotObjectOrArray(input, reason) {
     if (dubiousMatches) {
       const uniqueChars = [...new Set(dubiousMatches)].join(" ");
      
-         warnings.push(`*!* URL contains dubious or non-standard characters " ${uniqueChars} " ` + 
-          `that may be rejected by Google. Proceed only if you know what you are doing.  ${this._reasonMsg(reason)}*!*`) ;
+         warnings.push(` URL contains dubious or non-standard characters " ${uniqueChars} " ` + 
+          `that may be rejected by Google. Proceed only if you know what you are doing.  ${this._reasonMsg(reason)}`) ;
     };
 
     // urlObject for further use if the next check passes.
@@ -206,8 +206,8 @@ throwIfNotObjectOrArray(input, reason) {
       // Warn if user typed only one slash (e.g., https:/)
       if (/^(https?):\/(?!\/)/.test(input)) {
 
-         warnings.push(`*!* It looks like you're missing one slash after "${urlObject.protocol}".` + 
-        `Did you mean "${urlObject.protocol}//..."? ${this._reasonMsg(reason)} *!*`);
+         warnings.push(` It looks like you're missing one slash after "${urlObject.protocol}".` + 
+        `Did you mean "${urlObject.protocol}//..."? ${this._reasonMsg(reason)} `);
         
       };
 
@@ -217,11 +217,11 @@ throwIfNotObjectOrArray(input, reason) {
           // If it works then there was no protocol in the input string;
           urlObject = new URL("http://" + trimmedInput); 
 
-          warnings.push(`*!* URL does not have http or https protocol *!*"`);
+          warnings.push(` URL does not have http or https protocol "`);
                     
         } catch(err) {
           // If after all checks we are here that means that the url contain potentially unacceptable characters.
-          warnings.push(`*!* URL contains potentionally unacceptable characters*!*"  ${this._reasonMsg(reason)}`);
+          warnings.push(` URL contains potentionally unacceptable characters"  ${this._reasonMsg(reason)}`);
 
         };
 
diff --git a/components/google_search_console/tests/action-tests/test-retrieve-site-performance-data.mjs b/components/google_search_console/tests/action-tests/test-retrieve-site-performance-data.mjs
@@ -176,7 +176,7 @@ const testAction = {
 */ 
     for (let propName in propsMeta){
 
-      console.log("===VALUE", this[propName]); // TEST ONLY
+      console.log("===VALUE", this[propName]);
       const meta = propsMeta[propName];
 
        // Trim the input if it's a string
@@ -195,7 +195,7 @@ const testAction = {
       // If the prop should be included in the POST request, add it to the body
       if (meta.postBody === true) body[propName] = this[propName];
 
-      console.log(" SUCCESS"); // TEST ONLY
+      console.log(" SUCCESS"); 
     };
 
     // Trimmed in loop above
@@ -220,12 +220,12 @@ const testAction = {
  // Check who threw the error. Internal code or the request. To ease debugging.
       const thrower = gsConsole.methods.checkWhoThrewError(error);
                                             
-      throw new Error(`Failed to fetch data ( ${thrower.whoThrew} error ) : ${error.message}. `);
+      throw new Error(`Failed to fetch data ( ${thrower.whoThrew} error ) : ${error.message}. `  + warnings.join("\n- "));
     
     };
     
 
-    $.export("$summary", ` Fetched ${response.rows?.length || 0} rows of data. ` + warnings.join("*!*"));
+    $.export("$summary", ` Fetched ${response.rows?.length || 0} rows of data. ` + warnings.join("\n- "));
     return response;
   },
 };
diff --git a/components/google_search_console/tests/action-tests/test-submit-url-for-indexing.mjs b/components/google_search_console/tests/action-tests/test-submit-url-for-indexing.mjs
@@ -61,7 +61,7 @@ const testAction = { // TEST ONLY. Replace to export in real code
         url: "https://indexing.googleapis.com/v3/urlNotifications:publish",
         headers: {
           // Tested with real hardcoded token that had required scopes.
-          Authorization: `Bearer *HARDCODED TOKEN HERE*`,
+          Authorization: `Bearer *HARDCODED TOKEN HERE*`, // Replace with a token from get-token.mjs with scope: "https://www.googleapis.com/auth/indexing".
           "Content-Type": "application/json",
         },
         data: {
@@ -73,11 +73,11 @@ const testAction = { // TEST ONLY. Replace to export in real code
       // Check who threw the error. Internal code or the request. To ease debugging.
       const thrower = gsConsole.methods.checkWhoThrewError(error);
                                                   
-      throw new Error(`Failed to fetch data ( ${thrower.whoThrew} error ) : ${error.message}. ` + warnings.join("*!*"));
+      throw new Error(`Failed to fetch data ( ${thrower.whoThrew} error ) : ${error.message}. ` + warnings.join("\n- "));
           
     };
 
-    $.export("$summary", ` URL submitted to Google: ${this.siteUrl}`  + warnings.join("*!*"));
+    $.export("$summary", ` URL submitted to Google: ${this.siteUrl}`  + warnings.join("\n- "));
     return response;
   },
 };
