Skip to content

refactor: unify settings validation in REST API #41465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Pr241singh wants to merge 2 commits into
base: develop
Choose a base branch
from
+17 −5
Open

refactor: unify settings validation in REST API #41465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
260589e
refactor: unify settings validation in REST API
Pr241singh Jul 19, 2026
df72dba
Merge branch 'develop' into refactor/41460-unify-setting-validation
Pr241singh Jul 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions apps/meteor/server/api/v1/settings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,13 @@ import {
import { Meteor } from 'meteor/meteor';
import type { FindOptions } from 'mongodb';
import _ from 'underscore';

import { SettingValidationError } from '../../lib/settingValidationRules';
import { validateSetting } from '../../settings/validateSetting';
import { hasPermissionAsync } from '../../lib/authorization/hasPermission';
import { notifyOnSettingChanged, notifyOnSettingChangedById } from '../../lib/notifyListener';
import { SettingValidationError, validateSettingRules } from '../../lib/settingValidationRules';
import { disableCustomScripts } from '../../lib/shared/disableCustomScripts';
import { addOAuthServiceMethod } from '../../meteor-methods/auth/addOAuthService';
import { SettingsEvents, settings } from '../../settings';
import { checkSettingValueBounds } from '../../settings/checkSettingValueBonds';
import { updateAuditedByUser } from '../../settings/lib/auditedSettingUpdates';
import { saveSettingsBulk } from '../../settings/lib/saveSettingsBulk';
import { setValue } from '../../settings/raw';
Expand Down Expand Up @@ -390,14 +389,18 @@ API.v1.post(

if (isSettingsUpdatePropDefault(bodyParams)) {
// TODO(next major): unify both validations into one function with a common API error response
checkSettingValueBounds(setting, bodyParams.value);

try {
validateSettingRules([{ _id, value: bodyParams.value }]);
validateSetting(setting, bodyParams.value);
} catch (error) {
if (error instanceof SettingValidationError) {
return API.v1.failure(error.message, 'error-setting-validation-failed');
}

if (error instanceof Meteor.Error && error.error === 'error-invalid-setting-value') {
return API.v1.failure(error.reason ?? error.message, 'error-setting-validation-failed');
Comment thread
Pr241singh marked this conversation as resolved.
}
Comment thread
Pr241singh marked this conversation as resolved.

Comment thread
Pr241singh marked this conversation as resolved.
throw error;
}

Expand Down
9 changes: 9 additions & 0 deletions apps/meteor/server/settings/validateSetting.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import type { ISetting } from '@rocket.chat/core-typings';

import { validateSettingRules } from '../lib/settingValidationRules';
import { checkSettingValueBounds } from './checkSettingValueBonds';

export const validateSetting = (setting: ISetting, value?: ISetting['value']): void => {
Comment thread
Pr241singh marked this conversation as resolved.
Comment thread
Pr241singh marked this conversation as resolved.
checkSettingValueBounds(setting, value);
validateSettingRules([{ _id: setting._id, value }]);
};