@griddo/cx 1.75.185 → 1.75.187

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@griddo/cx",
 	"description": "Griddo SSG based on Gatsby",
-	"version": "1.75.185",
+	"version": "1.75.187",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
@@ -32,12 +32,12 @@
 		"watch:tscheck": "tsc --noEmit --watch"
 	},
 	"dependencies": {
-		"@babel/core": "^7.6.0",
+		"@babel/core": "^7.21.0",
 		"@babel/plugin-proposal-class-properties": "^7.7.4",
 		"@babel/preset-env": "^7.14.5",
 		"@babel/preset-react": "^7.14.5",
 		"@babel/preset-typescript": "^7.16.5",
-		"@griddo/core": "^1.75.185",
+		"@griddo/core": "^1.75.187",
 		"@svgr/webpack": "^5.5.0",
 		"babel-loader": "^8.0.6",
 		"babel-plugin-styled-components": "^1.10.7",
@@ -69,7 +69,7 @@
 		"react-helmet": "^6.0.0"
 	},
 	"devDependencies": {
-		"@griddo/eslint-config-back": "^1.75.185",
+		"@griddo/eslint-config-back": "^1.75.187",
 		"@types/babel__core": "^7.20.0",
 		"@types/babel__preset-env": "^7.9.2",
 		"@types/csvtojson": "^2.0.0",
@@ -117,5 +117,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "56f210bb1f9aadf8827b33f0f759155531702526"
+	"gitHead": "7f7d7f9fc1368ba04ac5b5ec23af4ed2374901a9"
 }

package/src/types/api.ts

@@ -107,7 +107,7 @@ export interface LanguagesResponse {
 }
 
 /** Describes common props for api responses. */
-interface APIRequest {
+export interface APIRequest {
 	/** The URL of the API endpoint. */
 	endpoint: string;
 	/** The parameters to be sent in the request body. */
@@ -116,10 +116,12 @@ interface APIRequest {
 	cached?: unknown;
 	/** Number of connection attempts (in case it fails on the first attempt). */
 	attempt?: number;
+	/** Headers for the post api fetch */
+	headers?: any;
 }
 
 /** Type with the POST request properties. */
-export interface PostAPI extends APIRequest {
+export interface PostAPI extends Omit<APIRequest, "headers"> {
 	headers?: { lang?: number } & Record<string, unknown>;
 }
 

package/src/utils/api.ts

@@ -1,5 +1,6 @@
 // Types
 import type {
+	APIRequest,
 	APIResponses,
 	Error,
 	GetAPI,
@@ -8,7 +9,7 @@ import type {
 } from "../types/api";
 
 // External libraries
-import axios from "axios";
+import axios, { Method } from "axios";
 import chalk from "chalk";
 import dotenv from "dotenv";
 
@@ -27,63 +28,47 @@ const {
 } = process;
 
 /**
- * Make a GET request to the Griddo API.
+ * Make a GET/PUT/POST request to the Griddo API.
  *
  * @template T Response Type returned.
  * @returns {Promise<T>} A promise that is resolved with the data from the API response.
  * @todo Maybe remove the loggin responsability
  * @example
- *	const response = await get<Site>({
+ *	const response = await requestAPI<Site>({
  *		endpoint: "...",
  *		cached: true,
- *	});
+ *	}, { method:"get" });
  */
-async function getApi<T extends APIResponses>(props: GetAPI): Promise<T> {
-	const { endpoint, body, cached, attempt } = props;
+async function requestAPI<T extends APIResponses>(
+	props: APIRequest & { method: Method }
+): Promise<T> {
+	const { endpoint, body, cached, attempt, method, headers } = props;
 	const cacheOptions = { endpoint, body, cached };
 
-	// Start a timer
-	const start = new Date();
-
-	// Filesystem
+	// Cache
 	if (cached) {
-		const cachedResponse = getCache<T>(cacheOptions);
-
-		if (cachedResponse) {
-			const duration = msToSec(new Date().getTime() - start.getTime());
-			const siteId = getSafeSiteId(cachedResponse);
-			const siteIdMsg = siteId ? `site: ${siteId} ` : "";
+		const cacheData = getCache<T>(cacheOptions);
 
-			logInfo(`GET  (cache) ${siteIdMsg}${endpoint} - ${duration}s`);
-
-			return cachedResponse;
+		if (cacheData) {
+			return cacheData;
 		}
 	}
 
-	// Network API
+	// Network
 	try {
-		// Success. Connection stablished.
 		const { data }: { data: T } = await axios({
 			url: endpoint,
-			method: "get",
-			headers: { ...AuthService.headers },
+			method,
+			headers: { ...headers, ...AuthService.headers },
 			data: body,
 		});
 
-		const duration = msToSec(new Date().getTime() - start.getTime());
-		const siteId = getSafeSiteId(data);
-		const siteIdMsg = siteId ? `site: ${siteId} ` : "";
-
-		logInfo(`GET  (fetch) ${siteIdMsg}${endpoint} - ${duration}s`);
-
-		// Save page object into filesystem
 		saveCache(cacheOptions, data);
 
-		// Return page object from API
 		return data;
 	} catch (e) {
-		// Failure. Network error
 		const error = e as Error;
+
 		showApiError(
 			error,
 			{ endpoint, body, attempt },
@@ -95,168 +80,82 @@ async function getApi<T extends APIResponses>(props: GetAPI): Promise<T> {
 			return null;
 		}
 
-		// Try again `RETRY_ATTEMPTS` times
 		if (attempt && attempt < parseInt(RETRY_ATTEMPTS)) {
-			console.warn("Waiting for retry: GET", endpoint);
+			console.warn(`Waiting for retry: ${method}`, endpoint);
+
 			await delay(parseInt(RETRY_WAIT_SECONDS) * 1000);
 
-			// Lets try again!
-			return getApi({ endpoint, body, cached, attempt: attempt + 1 });
+			return requestAPI({
+				endpoint,
+				body,
+				cached,
+				method,
+				attempt: attempt + 1,
+			});
 		} else {
-			throw new Error("Error in getApi()");
+			throw new Error(`Error in ${method}`);
 		}
 	}
 }
 
-/**
- * Make a PUT request to the Griddo API.
- *
- * @template T Response Type returned.
- * @returns {Promise<T>} A promise that is resolved with the data from the API response.
- */
-async function putApi<T extends APIResponses>(props: PutAPI): Promise<T> {
-	const { endpoint, body, cached = false, attempt = 0 } = props;
-	const cacheOptions = { endpoint, body, cached };
-
-	// Start a timer
+async function getApi<T extends APIResponses>(props: GetAPI) {
+	// Starts
 	const start = new Date();
+	const { endpoint } = props;
 
-	// Filesystem
-	if (cached) {
-		const cachedResponse = getCache<T>(cacheOptions);
-
-		if (cachedResponse) {
-			const duration = msToSec(new Date().getTime() - start.getTime());
-
-			logInfo(`PUT  (cache) ${endpoint} - ${duration}s`);
-
-			return cachedResponse;
-		}
-	}
+	// Fetching...
+	const response = await requestAPI<T>({ ...props, method: "get" });
 
-	// Network API
-	try {
-		const { data }: { data: T } = await axios({
-			url: endpoint,
-			method: "put",
-			headers: { ...AuthService.headers },
-			data: body,
-		});
+	// Ends
+	const cacheMsg = props.cached ? "(cached)" : "(fetch)";
+	const siteId = getSafeSiteId(response);
+	const siteIdMsg = siteId ? `site: ${siteId} ` : "";
+	const duration = msToSec(new Date().getTime() - start.getTime());
 
-		const duration = msToSec(new Date().getTime() - start.getTime());
+	logInfo(`GET ${cacheMsg} ${siteIdMsg} ${endpoint} - ${duration}s`);
 
-		logInfo(`PUT  (fetch) ${endpoint} - ${duration}s`);
+	return response;
+}
 
-		// Save page object to filesystem
-		saveCache(cacheOptions, data);
+async function putApi<T extends APIResponses>(props: PutAPI) {
+	// Starts
+	const start = new Date();
+	const { endpoint } = props;
 
-		// Return page object from API
-		return data;
-	} catch (e) {
-		// Failure. Network error
-		const error = e as Error;
-		showApiError(
-			error,
-			{ endpoint, body, attempt },
-			error.response.status !== 404
-		);
+	// Fetching...
+	const response = await requestAPI<T>({ ...props, method: "put" });
 
-		if (error.response.status === 404) {
-			// @ts-expect-error
-			return null;
-		}
+	// Ends
+	const cacheMsg = props.cached ? "(cached)" : "(fetch)";
+	const duration = msToSec(new Date().getTime() - start.getTime());
 
-		// Try again `RETRY_ATTEMPTS` times
-		if (attempt < parseInt(RETRY_ATTEMPTS)) {
-			console.warn("Waiting for retry: PUT", endpoint);
-			await delay(parseInt(RETRY_WAIT_SECONDS) * 1000);
+	logInfo(`PUT ${cacheMsg} ${endpoint} - ${duration}s`);
 
-			// Lets try again!
-			return putApi({ endpoint, body, cached, attempt: attempt + 1 });
-		} else {
-			throw new Error("Error in putApi()");
-		}
-	}
+	return response;
 }
 
-/**
- * Make a POST request to the Griddo API.
- *
- * @template T Response Type returned.
- * @returns {Promise<T>} A promise that is resolved with the data from the API response.
- */
-async function postApi<T extends APIResponses>(props: PostAPI): Promise<T> {
-	const { endpoint, body, headers, cached, attempt = 0 } = props;
-
-	const cacheOptions = { endpoint, body, headers, cached };
-
-	// Start a timer
+async function postApi<T extends APIResponses>(props: PostAPI) {
+	// Starts
 	const start = new Date();
+	const { endpoint, body, headers } = props;
 	const distributorBodyParams = endpoint.endsWith("/distributor")
 		? `# Distributor body: ${JSON.stringify(body)} - lang: ${JSON.stringify(
 				headers?.lang
 		  )}`
 		: "";
 
-	// Filesystem
-	if (cached) {
-		const cachedResponse = getCache<T>(cacheOptions);
-
-		if (cachedResponse) {
-			const duration = msToSec(new Date().getTime() - start.getTime());
-
-			logInfo(
-				`POST (cache) ${endpoint} - ${duration}s ${distributorBodyParams}`
-			);
-
-			return cachedResponse;
-		}
-	}
-
-	// Network API
-	try {
-		// Success. Connection stablished.
-		const { data }: { data: T } = await axios({
-			url: endpoint,
-			method: "post",
-			headers: { ...headers, ...AuthService.headers },
-			data: body,
-		});
+	// Fetching...
+	const response = await requestAPI<T>({ ...props, method: "post" });
 
-		const duration = msToSec(new Date().getTime() - start.getTime());
+	// Ends
+	const cacheMsg = props.cached ? "(cached)" : "(fetch)";
+	const duration = msToSec(new Date().getTime() - start.getTime());
 
-		logInfo(`POST (fetch) ${endpoint} - ${duration}s`);
-
-		// Save page object to filesystem
-		saveCache(cacheOptions, data);
-
-		// Return page object from API
-		return data;
-	} catch (e) {
-		// Failure. Network error
-		const error = e as Error;
-		showApiError(
-			error,
-			{ endpoint, body, headers, attempt },
-			error.response.status !== 404
-		);
-
-		if (error.response.status === 404) {
-			// @ts-expect-error
-			return null;
-		}
-
-		// Try again `RETRY_ATTEMPTS` times
-		if (attempt < parseInt(RETRY_ATTEMPTS)) {
-			console.warn("Waiting for retry: POST", endpoint);
-			await delay(parseInt(RETRY_WAIT_SECONDS) * 1000);
+	logInfo(
+		`POST ${cacheMsg} ${endpoint} - ${duration}s ${distributorBodyParams}`
+	);
 
-			// Lets try again!
-			return postApi({ endpoint, body, headers, cached, attempt: attempt + 1 });
-		} else {
-			throw new Error("Error in postApi()");
-		}
-	}
+	return response;
 }
 
 /**