From 0005b195b1c97d1a9c49a114465a4bdcb3b2da01 Mon Sep 17 00:00:00 2001 From: Shemy Gan Date: Tue, 22 Oct 2024 09:31:00 -0400 Subject: [PATCH 01/13] - update based review --- Client/src/Validation/validation.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Client/src/Validation/validation.js b/Client/src/Validation/validation.js index a6ec7688c..8978f5ffa 100644 --- a/Client/src/Validation/validation.js +++ b/Client/src/Validation/validation.js @@ -152,8 +152,8 @@ const advancedSettingsValidation = joi.object({ "string.empty": "Redis host is required", }), redisPort: joi.string().allow('').custom((value, helpers) => { - if(value && isNaN(parseInt(value))){ - return helpers.message("Redit port must be a number") + if(value && Number.isNaN(parseInt(value))){ + return helpers.message("Redis port must be a number") } return value }), From 4966f3fd38e43960e2e6d3fbea78afb205c08883 Mon Sep 17 00:00:00 2001 From: Shemy Gan Date: Tue, 22 Oct 2024 14:15:11 -0400 Subject: [PATCH 02/13] - Update jwt ttl validation --- Client/src/Pages/AdvancedSettings/index.jsx | 26 ++++++++++- .../Maintenance/CreateMaintenance/index.jsx | 27 ++---------- Client/src/Validation/validation.js | 44 ++++++++++++------- 3 files changed, 57 insertions(+), 40 deletions(-) diff --git a/Client/src/Pages/AdvancedSettings/index.jsx b/Client/src/Pages/AdvancedSettings/index.jsx index ce1c89250..b71123ca7 100644 --- a/Client/src/Pages/AdvancedSettings/index.jsx +++ b/Client/src/Pages/AdvancedSettings/index.jsx @@ -12,6 +12,8 @@ import { useNavigate } from "react-router"; import { getAppSettings, updateAppSettings } from "../../Features/Settings/settingsSlice"; import { useState, useEffect } from "react"; import Select from "../../Components/Inputs/Select"; +import { advancedSettingsValidation } from "../../Validation/validation"; +import { buildErrors, hasValidationErrors } from "../../Validation/error"; const AdvancedSettings = ({ isAdmin }) => { const navigate = useNavigate(); @@ -21,7 +23,7 @@ const AdvancedSettings = ({ isAdmin }) => { navigate("/"); } }, [navigate, isAdmin]); - + const [errors, setErrors] = useState({}); const theme = useTheme(); const { authToken } = useSelector((state) => state.auth); const dispatch = useDispatch(); @@ -75,9 +77,20 @@ const AdvancedSettings = ({ isAdmin }) => { const handleChange = (event) => { const { value, id } = event.target; setLocalSettings({ ...localSettings, [id]: value }); + const { error } = advancedSettingsValidation.validate( + { [id]: value }, + { + abortEarly: false, + } + ); + setErrors((prev) => { + return buildErrors(prev, id, error); + }); }; const handleSave = async () => { + if (hasValidationErrors(localSettings, advancedSettingsValidation, setErrors)) + return; const action = await dispatch( updateAppSettings({ settings: localSettings, authToken }) ); @@ -118,6 +131,7 @@ const AdvancedSettings = ({ isAdmin }) => { label="API URL Host" value={localSettings.apiBaseUrl} onChange={handleChange} + error={errors.apiBaseUrl} /> { items={logItems} value={logItemLookup[localSettings.logLevel]} onChange={handleLogLevel} + onBlur={handleBlur} error={errors.logLevel} /> @@ -160,6 +167,7 @@ const AdvancedSettings = ({ isAdmin }) => { name="systemEmailHost" value={localSettings.systemEmailHost} onChange={handleChange} + onBlur={handleBlur} error={errors.systemEmailHost} /> { name="systemEmailPort" value={localSettings.systemEmailPort.toString()} onChange={handleChange} + onBlur={handleBlur} error={errors.systemEmailPort} /> { name="systemEmailPassword" value={localSettings.systemEmailPassword} onChange={handleChange} + onBlur={handleBlur} error={errors.systemEmailPassword} /> @@ -206,6 +216,7 @@ const AdvancedSettings = ({ isAdmin }) => { name="jwtTTL" value={localSettings.jwtTTL} onChange={handleChange} + onBlur={handleBlur} error={errors.jwtTTL} /> { name="dbType" value={localSettings.dbType} onChange={handleChange} + onBlur={handleBlur} error={errors.dbType} /> { name="redisHost" value={localSettings.redisHost} onChange={handleChange} + onBlur={handleBlur} error={errors.redisHost} /> { name="redisPort" value={localSettings.redisPort.toString()} onChange={handleChange} + onBlur={handleBlur} error={errors.redisPort} /> { name="pagespeedApiKey" value={localSettings.pagespeedApiKey} onChange={handleChange} + onBlur={handleBlur} error={errors.pagespeedApiKey} /> diff --git a/Client/src/Validation/validation.js b/Client/src/Validation/validation.js index a5c0e029f..83f94db4e 100644 --- a/Client/src/Validation/validation.js +++ b/Client/src/Validation/validation.js @@ -147,7 +147,7 @@ const advancedSettingsValidation = joi.object({ .custom((value, helpers) => { // test against regx start with a number followed by number or ., //ends with d or h - const regex = /^[1-9]+\d*(.)*(d|h)$/; + const regex = /^[1-9]+\d*(d|h)$/; const found = value.match(regex); if (!found) { return helpers.message( From a4344b89a23692d4d7cb2a534b90d99044d5ae24 Mon Sep 17 00:00:00 2001 From: Shemy Gan Date: Wed, 23 Oct 2024 21:03:40 -0400 Subject: [PATCH 05/13] - Add select dropdown for jwt ttl units --- Client/src/Pages/AdvancedSettings/index.jsx | 43 +++++++++++++++++---- Client/src/Validation/validation.js | 20 ++++------ 2 files changed, 43 insertions(+), 20 deletions(-) diff --git a/Client/src/Pages/AdvancedSettings/index.jsx b/Client/src/Pages/AdvancedSettings/index.jsx index d5ac22b26..836722db6 100644 --- a/Client/src/Pages/AdvancedSettings/index.jsx +++ b/Client/src/Pages/AdvancedSettings/index.jsx @@ -36,6 +36,7 @@ const AdvancedSettings = ({ isAdmin }) => { systemEmailAddress: "", systemEmailPassword: "", jwtTTL: "", + jwtTTLUnits: "days", dbType: "", redisHost: "", redisPort: "", @@ -68,12 +69,30 @@ const AdvancedSettings = ({ isAdmin }) => { warn: 4, }; + const unitItems = [ + { _id: 1, name: "days" }, + { _id: 2, name: "weeks" }, + { _id: 3, name: "months" } + ]; + + const unitItemLookup = { + days: 1, + weeks: 2, + months: 3, + }; + const handleLogLevel = (e) => { const id = e.target.value; const newLogLevel = logItems.find((item) => item._id === id).name; setLocalSettings({ ...localSettings, logLevel: newLogLevel }); }; + const handleJWTTTLUnits = (e) => { + const id = e.target.value; + const newUnits = unitItems.find((item) => item._id === id).name; + setLocalSettings({ ...localSettings, jwtTTLUnits: newUnits }); + }; + const handleBlur = (event) => { const { value, id } = event.target; const { error } = advancedSettingsValidation.validate( @@ -82,11 +101,9 @@ const AdvancedSettings = ({ isAdmin }) => { abortEarly: false, } ); - if (error) { - setErrors((prev) => { - return buildErrors(prev, id, error); - }); - } + setErrors((prev) => { + return buildErrors(prev, id, error); + }); }; const handleChange = (event) => { const { value, id } = event.target; @@ -209,8 +226,8 @@ const AdvancedSettings = ({ isAdmin }) => { - { onBlur={handleBlur} error={errors.jwtTTL} /> + { value={unitItemLookup[localSettings.jwtTTLUnits]} onChange={handleJWTTTLUnits} onBlur={handleBlur} - error={errors.jwtttlUnits} + error={errors.jwtTTLUnits} /> { if (error) { const newErrors = {}; error.details.forEach((err) => { - newErrors[err.path[0]] = err.message?? "Validation error"; + if ( + ![ + "clientHost", + "refreshTokenSecret", + "dbConnectionString", + "refreshTokenTTL", + "jwtTTL", + ].includes(err.path[0]) + ) { + newErrors[err.path[0]] = err.message ?? "Validation error"; + } }); - setErrors(newErrors); - return true; + if (Object.keys(newErrors).length > 0) { + setErrors(newErrors); + return true; + } else return false; } return false; }; diff --git a/Client/src/Validation/validation.js b/Client/src/Validation/validation.js index 43f3904b9..dfdacd3b1 100644 --- a/Client/src/Validation/validation.js +++ b/Client/src/Validation/validation.js @@ -138,18 +138,20 @@ const advancedSettingsValidation = joi.object({ systemEmailPort: joi.string().allow(""), systemEmailAddress: joi.string().allow(""), systemEmailPassword: joi.string().allow(""), - jwtTTL: joi.string().trim().messages({ - "string.empty": "JWT TTL is required.", - }), + jwtTTLNum: joi + .number() + .messages({ + "any.required": "JWT TTL is required.", + }), jwtTTLUnits: joi .string() .trim() .custom((value, helpers) => { - if (value == 0) { + if( !["days", "hours"].includes(value)) { return helpers.message("JWT TTL unit is required."); } return value; - }), + }), dbType: joi.string().trim().messages({ "string.empty": "DB type is required.", }), From 410f3b7ab1e8abf8bb01f723f6dfcf45b8383c8c Mon Sep 17 00:00:00 2001 From: Shemy Gan Date: Thu, 24 Oct 2024 13:33:05 -0400 Subject: [PATCH 07/13] - updated js doc --- guides/users-guide/server-settings.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/guides/users-guide/server-settings.md b/guides/users-guide/server-settings.md index 6276f3c42..ae1380dff 100644 --- a/guides/users-guide/server-settings.md +++ b/guides/users-guide/server-settings.md @@ -26,10 +26,12 @@ Here you can setup the following: **Email settings:** Set your host email settings here. These settings are used for sending system emails. -Server settings: Several server settings can be done here. Alternatively, you can add a pagespeed API key to bypass Google's limitations (albeit they are generous about it) +**Server settings:** Several server settings can be done here. Alternatively, you can add a pagespeed API key to bypass Google's limitations (albeit they are generous about it) + +Select a number for jwt TTL and a unit for it (days or hours), the combined result +would be in vercel/ms time format, e.g "99d", this will be sent to server to persist -\ From fd261d3eb12e87aa801c6f709dacc0a8be78bea0 Mon Sep 17 00:00:00 2001 From: Shemy Gan Date: Thu, 24 Oct 2024 14:13:07 -0400 Subject: [PATCH 08/13] - update number validation --- Client/src/Validation/validation.js | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/Client/src/Validation/validation.js b/Client/src/Validation/validation.js index dfdacd3b1..71495cfa1 100644 --- a/Client/src/Validation/validation.js +++ b/Client/src/Validation/validation.js @@ -138,20 +138,18 @@ const advancedSettingsValidation = joi.object({ systemEmailPort: joi.string().allow(""), systemEmailAddress: joi.string().allow(""), systemEmailPassword: joi.string().allow(""), - jwtTTLNum: joi - .number() - .messages({ - "any.required": "JWT TTL is required.", - }), + jwtTTLNum: joi.number().messages({ + "number.base": "JWT TTL is required.", + }), jwtTTLUnits: joi .string() .trim() .custom((value, helpers) => { - if( !["days", "hours"].includes(value)) { + if (!["days", "hours"].includes(value)) { return helpers.message("JWT TTL unit is required."); } return value; - }), + }), dbType: joi.string().trim().messages({ "string.empty": "DB type is required.", }), From 1526b50fd2044ca2df035c6f0a41eaab0e3c56c2 Mon Sep 17 00:00:00 2001 From: Shemy Gan Date: Thu, 24 Oct 2024 14:40:04 -0400 Subject: [PATCH 09/13] - update unitItems with lookup --- Client/src/Pages/AdvancedSettings/index.jsx | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/Client/src/Pages/AdvancedSettings/index.jsx b/Client/src/Pages/AdvancedSettings/index.jsx index 853817544..3f04653cb 100644 --- a/Client/src/Pages/AdvancedSettings/index.jsx +++ b/Client/src/Pages/AdvancedSettings/index.jsx @@ -81,15 +81,14 @@ const AdvancedSettings = ({ isAdmin }) => { warn: 4, }; - const unitItems = [ - { _id: "d", name: "days" }, - { _id: "h", name: "hours" } - ]; - const unitItemLookup = { days: "d", hours: "h", }; + const unitItems = Object.keys(unitItemLookup).map((key) => ({ + _id: unitItemLookup[key], + name: key, + })); const handleLogLevel = (e) => { const id = e.target.value; From 2427bdb78804732071a288e4d69c54f43bae804f Mon Sep 17 00:00:00 2001 From: Shemy Gan Date: Fri, 25 Oct 2024 10:00:10 -0400 Subject: [PATCH 10/13] - Fix the wrong label --- Client/src/Pages/AdvancedSettings/index.jsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Client/src/Pages/AdvancedSettings/index.jsx b/Client/src/Pages/AdvancedSettings/index.jsx index 3f04653cb..bfcc66a8b 100644 --- a/Client/src/Pages/AdvancedSettings/index.jsx +++ b/Client/src/Pages/AdvancedSettings/index.jsx @@ -202,7 +202,7 @@ const AdvancedSettings = ({ isAdmin }) => { Date: Fri, 25 Oct 2024 14:27:11 -0400 Subject: [PATCH 11/13] - change joi to be optional number for redis port and email port --- Client/src/Validation/validation.js | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/Client/src/Validation/validation.js b/Client/src/Validation/validation.js index 71495cfa1..08b1632c3 100644 --- a/Client/src/Validation/validation.js +++ b/Client/src/Validation/validation.js @@ -135,7 +135,7 @@ const advancedSettingsValidation = joi.object({ }), logLevel: joi.string().valid("debug", "none", "error", "warn").allow(""), systemEmailHost: joi.string().allow(""), - systemEmailPort: joi.string().allow(""), + systemEmailPort: joi.number().allow(null, ""), systemEmailAddress: joi.string().allow(""), systemEmailPassword: joi.string().allow(""), jwtTTLNum: joi.number().messages({ @@ -156,15 +156,7 @@ const advancedSettingsValidation = joi.object({ redisHost: joi.string().trim().messages({ "string.empty": "Redis host is required.", }), - redisPort: joi - .string() - .allow("") - .custom((value, helpers) => { - if (value && Number.isNaN(parseInt(value))) { - return helpers.message("Redis port must be a number."); - } - return value; - }), + redisPort: joi.number().allow(null, ""), pagespeedApiKey: joi.string().allow(""), }); From 39e8ad4308ce37a74c3424b20da5f631b2f0dedc Mon Sep 17 00:00:00 2001 From: Shemy Gan Date: Fri, 25 Oct 2024 14:37:43 -0400 Subject: [PATCH 12/13] - Fix empty port number case --- Client/src/Pages/AdvancedSettings/index.jsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Client/src/Pages/AdvancedSettings/index.jsx b/Client/src/Pages/AdvancedSettings/index.jsx index bfcc66a8b..bc9affad6 100644 --- a/Client/src/Pages/AdvancedSettings/index.jsx +++ b/Client/src/Pages/AdvancedSettings/index.jsx @@ -204,7 +204,7 @@ const AdvancedSettings = ({ isAdmin }) => { id="systemEmailPort" label="System email port" name="systemEmailPort" - value={localSettings.systemEmailPort.toString()} + value={localSettings.systemEmailPort?.toString()} onChange={handleChange} onBlur={handleBlur} error={errors.systemEmailPort} @@ -285,7 +285,7 @@ const AdvancedSettings = ({ isAdmin }) => { id="redisPort" label="Redis port" name="redisPort" - value={localSettings.redisPort.toString()} + value={localSettings.redisPort?.toString()} onChange={handleChange} onBlur={handleBlur} error={errors.redisPort} From f61cb275ffd2a3c2f2897be7ef620c1762e325f7 Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Sat, 26 Oct 2024 09:36:15 +0800 Subject: [PATCH 13/13] email host -> System email host --- Client/src/Pages/AdvancedSettings/index.jsx | 61 +++++++++++---------- 1 file changed, 33 insertions(+), 28 deletions(-) diff --git a/Client/src/Pages/AdvancedSettings/index.jsx b/Client/src/Pages/AdvancedSettings/index.jsx index bc9affad6..a830159b8 100644 --- a/Client/src/Pages/AdvancedSettings/index.jsx +++ b/Client/src/Pages/AdvancedSettings/index.jsx @@ -58,7 +58,7 @@ const AdvancedSettings = ({ isAdmin }) => { const getSettings = async () => { const action = await dispatch(getAppSettings({ authToken })); if (action.payload.success) { - parseJWTTTL(action.payload.data) + parseJWTTTL(action.payload.data); setLocalSettings(action.payload.data); } else { createToast({ body: "Failed to get settings" }); @@ -100,7 +100,7 @@ const AdvancedSettings = ({ isAdmin }) => { const id = e.target.value; const newUnits = unitItems.find((item) => item._id === id).name; setLocalSettings({ ...localSettings, jwtTTLUnits: newUnits }); - }; + }; const handleBlur = (event) => { const { value, id } = event.target; @@ -116,7 +116,7 @@ const AdvancedSettings = ({ isAdmin }) => { }; const handleChange = (event) => { const { value, id } = event.target; - setLocalSettings({ ...localSettings, [id]: value }); + setLocalSettings({ ...localSettings, [id]: value }); }; const handleSave = async () => { @@ -125,12 +125,12 @@ const AdvancedSettings = ({ isAdmin }) => { if (hasValidationErrors(localSettings, advancedSettingsValidation, setErrors)) { return; } - const action = await dispatch( + const action = await dispatch( updateAppSettings({ settings: localSettings, authToken }) ); let body = ""; if (action.payload.success) { - parseJWTTTL(action.payload.data) + parseJWTTTL(action.payload.data); setLocalSettings(action.payload.data); body = "Settings saved successfully"; } else { @@ -192,7 +192,7 @@ const AdvancedSettings = ({ isAdmin }) => { { - - +