mirror of
				https://github.com/karl0ss/homepage.git
				synced 2025-11-04 00:10:57 +00:00 
			
		
		
		
	Basic widget data validation
This commit is contained in:
		
							parent
							
								
									5b7d2eaf07
								
							
						
					
					
						commit
						7b7740563e
					
				@ -13,7 +13,11 @@
 | 
				
			|||||||
    "widget": {
 | 
					    "widget": {
 | 
				
			||||||
        "missing_type": "Missing Widget Type: {{type}}",
 | 
					        "missing_type": "Missing Widget Type: {{type}}",
 | 
				
			||||||
        "api_error": "API Error",
 | 
					        "api_error": "API Error",
 | 
				
			||||||
        "status": "Status"
 | 
					        "status": "Status",
 | 
				
			||||||
 | 
					        "debug_info": "Debug Information",
 | 
				
			||||||
 | 
					        "url": "URL",
 | 
				
			||||||
 | 
					        "raw_error": "Raw Error",
 | 
				
			||||||
 | 
					        "response_data": "Response Data"
 | 
				
			||||||
    },
 | 
					    },
 | 
				
			||||||
    "weather": {
 | 
					    "weather": {
 | 
				
			||||||
        "current": "Current Location",
 | 
					        "current": "Current Location",
 | 
				
			||||||
 | 
				
			|||||||
							
								
								
									
										48
									
								
								src/components/services/widget/error.jsx
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										48
									
								
								src/components/services/widget/error.jsx
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,48 @@
 | 
				
			|||||||
 | 
					import { useTranslation } from "react-i18next";
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					function displayError(error) {
 | 
				
			||||||
 | 
					  return JSON.stringify(error[1] ? error[1] : error, null, 4);
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					function displayData(data) {
 | 
				
			||||||
 | 
					  return (data.type === 'Buffer') ? Buffer.from(data).toString() : JSON.stringify(data, 4);
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					export default function Error({ error }) {
 | 
				
			||||||
 | 
					  const { t } = useTranslation();
 | 
				
			||||||
 | 
					  
 | 
				
			||||||
 | 
					  if (error?.data?.error) {
 | 
				
			||||||
 | 
					    error = error.data.error; // eslint-disable-line no-param-reassign
 | 
				
			||||||
 | 
					  }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					  return (
 | 
				
			||||||
 | 
					    <div className="text-sm bg-rose-100 text-rose-900 dark:bg-rose-900 dark:text-rose-100 rounded-md p-2 m-1">
 | 
				
			||||||
 | 
					      <div className="font-medium mb-1">Something went wrong.</div>
 | 
				
			||||||
 | 
					      <details className="text-xs font-mono whitespace-pre-wrap break-all">
 | 
				
			||||||
 | 
					        <summary>{t("widget.debug_info")}</summary>
 | 
				
			||||||
 | 
					        <div className="bg-white p-2 text-rose-900">
 | 
				
			||||||
 | 
					          <ul>
 | 
				
			||||||
 | 
					            <li className="mb-2">
 | 
				
			||||||
 | 
					              <span className="text-black">{t("widget.api_error")}:</span> {error.message}
 | 
				
			||||||
 | 
					            </li>
 | 
				
			||||||
 | 
					            {error.url && <li className="mb-2">
 | 
				
			||||||
 | 
					              <span className="text-black">{t("widget.url")}:</span> {error.url}
 | 
				
			||||||
 | 
					            </li>}
 | 
				
			||||||
 | 
					            {error.rawError && <li className="mb-2">
 | 
				
			||||||
 | 
					              <span className="text-black">{t("widget.raw_error")}:</span>
 | 
				
			||||||
 | 
					              <div className="ml-2">
 | 
				
			||||||
 | 
					                {displayError(error.rawError)}
 | 
				
			||||||
 | 
					              </div>
 | 
				
			||||||
 | 
					            </li>}
 | 
				
			||||||
 | 
					            {error.data && <li className="mb-2">
 | 
				
			||||||
 | 
					              <span className="text-black">{t("widget.response_data")}:</span>
 | 
				
			||||||
 | 
					              <div className="ml-2">
 | 
				
			||||||
 | 
					                {displayData(error.data)}
 | 
				
			||||||
 | 
					              </div>
 | 
				
			||||||
 | 
					            </li>}
 | 
				
			||||||
 | 
					          </ul>
 | 
				
			||||||
 | 
					        </div>
 | 
				
			||||||
 | 
					      </details>
 | 
				
			||||||
 | 
					    </div>
 | 
				
			||||||
 | 
					  );
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
@ -1,5 +1,6 @@
 | 
				
			|||||||
import getServiceWidget from "utils/config/service-helpers";
 | 
					import getServiceWidget from "utils/config/service-helpers";
 | 
				
			||||||
import { formatApiCall } from "utils/proxy/api-helpers";
 | 
					import { formatApiCall } from "utils/proxy/api-helpers";
 | 
				
			||||||
 | 
					import validateWidgetData from "utils/proxy/validate-widget-data";
 | 
				
			||||||
import { httpProxy } from "utils/proxy/http";
 | 
					import { httpProxy } from "utils/proxy/http";
 | 
				
			||||||
import createLogger from "utils/logger";
 | 
					import createLogger from "utils/logger";
 | 
				
			||||||
import widgets from "widgets/widgets";
 | 
					import widgets from "widgets/widgets";
 | 
				
			||||||
@ -54,6 +55,10 @@ export default async function credentialedProxyHandler(req, res) {
 | 
				
			|||||||
        logger.debug("HTTP Error %d calling %s//%s%s...", status, url.protocol, url.hostname, url.pathname);
 | 
					        logger.debug("HTTP Error %d calling %s//%s%s...", status, url.protocol, url.hostname, url.pathname);
 | 
				
			||||||
      }
 | 
					      }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					      if (!validateWidgetData(widget, endpoint, data)) {
 | 
				
			||||||
 | 
					        return res.status(500).json({error: {message: "Invalid data", url, data}});
 | 
				
			||||||
 | 
					      }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
      if (contentType) res.setHeader("Content-Type", contentType);
 | 
					      if (contentType) res.setHeader("Content-Type", contentType);
 | 
				
			||||||
      return res.status(status).send(data);
 | 
					      return res.status(status).send(data);
 | 
				
			||||||
    }
 | 
					    }
 | 
				
			||||||
 | 
				
			|||||||
@ -1,5 +1,6 @@
 | 
				
			|||||||
import getServiceWidget from "utils/config/service-helpers";
 | 
					import getServiceWidget from "utils/config/service-helpers";
 | 
				
			||||||
import { formatApiCall } from "utils/proxy/api-helpers";
 | 
					import { formatApiCall } from "utils/proxy/api-helpers";
 | 
				
			||||||
 | 
					import validateWidgetData from "utils/proxy/validate-widget-data";
 | 
				
			||||||
import { httpProxy } from "utils/proxy/http";
 | 
					import { httpProxy } from "utils/proxy/http";
 | 
				
			||||||
import createLogger from "utils/logger";
 | 
					import createLogger from "utils/logger";
 | 
				
			||||||
import widgets from "widgets/widgets";
 | 
					import widgets from "widgets/widgets";
 | 
				
			||||||
@ -32,6 +33,11 @@ export default async function genericProxyHandler(req, res, map) {
 | 
				
			|||||||
      });
 | 
					      });
 | 
				
			||||||
 | 
					
 | 
				
			||||||
      let resultData = data;
 | 
					      let resultData = data;
 | 
				
			||||||
 | 
					      
 | 
				
			||||||
 | 
					      if (!validateWidgetData(widget, endpoint, resultData)) {
 | 
				
			||||||
 | 
					        return res.status(status).json({error: {message: "Invalid data", url, data: resultData}});
 | 
				
			||||||
 | 
					      }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
      if (status === 200 && map) {
 | 
					      if (status === 200 && map) {
 | 
				
			||||||
        resultData = map(data);
 | 
					        resultData = map(data);
 | 
				
			||||||
      }
 | 
					      }
 | 
				
			||||||
@ -44,6 +50,7 @@ export default async function genericProxyHandler(req, res, map) {
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
      if (status >= 400) {
 | 
					      if (status >= 400) {
 | 
				
			||||||
        logger.debug("HTTP Error %d calling %s//%s%s...", status, url.protocol, url.hostname, url.pathname);
 | 
					        logger.debug("HTTP Error %d calling %s//%s%s...", status, url.protocol, url.hostname, url.pathname);
 | 
				
			||||||
 | 
					        return res.status(status).json({error: {message: "HTTP Error", url, data}});
 | 
				
			||||||
      }
 | 
					      }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
      return res.status(status).send(resultData);
 | 
					      return res.status(status).send(resultData);
 | 
				
			||||||
 | 
				
			|||||||
@ -98,6 +98,6 @@ export async function httpProxy(url, params = {}) {
 | 
				
			|||||||
  catch (err) {
 | 
					  catch (err) {
 | 
				
			||||||
    logger.error("Error calling %s//%s%s...", url.protocol, url.hostname, url.pathname);
 | 
					    logger.error("Error calling %s//%s%s...", url.protocol, url.hostname, url.pathname);
 | 
				
			||||||
    logger.error(err);
 | 
					    logger.error(err);
 | 
				
			||||||
    return [500, "application/json", { error: "Unexpected error" }, null];
 | 
					    return [500, "application/json", { error: {message: err?.message ?? "Unknown error", url, rawError: err} }, null];
 | 
				
			||||||
  }
 | 
					  }
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 | 
				
			|||||||
							
								
								
									
										22
									
								
								src/utils/proxy/validate-widget-data.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								src/utils/proxy/validate-widget-data.js
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,22 @@
 | 
				
			|||||||
 | 
					import widgets from "widgets/widgets";
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					export default function validateWidgetData(widget, endpoint, data) {
 | 
				
			||||||
 | 
					    let valid = true;
 | 
				
			||||||
 | 
					    let dataParsed;
 | 
				
			||||||
 | 
					    try {
 | 
				
			||||||
 | 
					        dataParsed = JSON.parse(data);
 | 
				
			||||||
 | 
					    } catch (e) {
 | 
				
			||||||
 | 
					        valid = false;
 | 
				
			||||||
 | 
					    }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    if (dataParsed) {
 | 
				
			||||||
 | 
					        const validate = widgets[widget.type]?.mappings?.[endpoint]?.validate;
 | 
				
			||||||
 | 
					        validate.forEach(key => {
 | 
				
			||||||
 | 
					            if (dataParsed[key] === undefined) {
 | 
				
			||||||
 | 
					                valid = false;
 | 
				
			||||||
 | 
					            }
 | 
				
			||||||
 | 
					        });
 | 
				
			||||||
 | 
					    }
 | 
				
			||||||
 | 
					    
 | 
				
			||||||
 | 
					    return valid;
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user