Skip to content

feat(api): migrate users.getPreferences to OpenAPI pattern #38325

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
Mohamed-Sobea wants to merge 11 commits into
base: develop
Choose a base branch
from
Open

feat(api): migrate users.getPreferences to OpenAPI pattern #38325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
01a8720
migrate: users.getPreferences to new OpenAPI pattern
Mohamed-Sobea Dec 8, 2025
e5674dc
chore: add changeset for users.getPreferences
Mohamed-Sobea Jan 24, 2026
4396c0a
feat: consolidate migration, enable swagger, and purge legacy typings
Mohamed-Sobea Jan 28, 2026
5664ef8
Merge branch 'develop' into feat/migrate-users-getPreferences
Mohamed-Sobea Jan 29, 2026
9bde0f1
migrate: users.getPreferences to new OpenAPI pattern
Mohamed-Sobea Dec 8, 2025
e21b72c
chore: add changeset for users.getPreferences
Mohamed-Sobea Jan 24, 2026
e49b8d7
feat: consolidate migration, enable swagger, and purge legacy typings
Mohamed-Sobea Jan 28, 2026
3098aaa
feat: migrate users.getPreferences and resolve type conflicts
Mohamed-Sobea Mar 4, 2026
c5fbfcc
chore: resolve merge conflicts and fix global type collisions
Mohamed-Sobea Mar 4, 2026
1da067c
edit: users.getPreferences logic and types
Mohamed-Sobea Mar 4, 2026
0b372c8
refactor: revert logic, and clean up types
Mohamed-Sobea Mar 16, 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
5 changes: 5 additions & 0 deletions .changeset/strong-insects-brush.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@rocket.chat/meteor': patch
Copy link
Copy Markdown
Contributor

@ahmed-n-abdeltwab ahmed-n-abdeltwab Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we use minor instead of patch anymore for this project

---

Migrated users.getPreferences to OpenAPI pattern with AJV validation
2 changes: 1 addition & 1 deletion .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
"tmid",
"tshow"
]
}
}
Copy link
Copy Markdown
Contributor

@ahmed-n-abdeltwab ahmed-n-abdeltwab Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.vscode settings is out of the scoop for this PR could you fix this

45 changes: 33 additions & 12 deletions apps/meteor/app/api/server/v1/users.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,6 +752,21 @@ API.v1.addRoute(
},
);

const UserPreferencesResponseSchema = {
type: 'object',
properties: {
preferences: {
type: 'object',
additionalProperties: true,
},
success: { type: 'boolean', enum: [true] },
},
required: ['preferences', 'success'],
additionalProperties: false,
};

const isUserPreferencesResponse = ajv.compile(UserPreferencesResponseSchema);

const usersEndpoints = API.v1
.post(
'users.createToken',
Expand Down Expand Up @@ -877,26 +892,32 @@ const usersEndpoints = API.v1

return API.v1.success({ suggestions });
},
);

API.v1.addRoute(
'users.getPreferences',
{ authRequired: true },
{
async get() {
)
.get(
'users.getPreferences',
{
authRequired: true,
response: {
400: validateBadRequestErrorResponse,
401: validateUnauthorizedErrorResponse,
200: isUserPreferencesResponse,
},
},
async function action() {
const user = await Users.findOneById(this.userId);

if (user?.settings) {
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot Mar 16, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: users.getPreferences regresses null-safe behavior by failing when settings is missing and may throw if settings.preferences is null.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At apps/meteor/app/api/server/v1/users.ts, line 909:

<comment>`users.getPreferences` regresses null-safe behavior by failing when `settings` is missing and may throw if `settings.preferences` is `null`.</comment>

<file context>
@@ -909,21 +906,19 @@ const usersEndpoints = API.v1
-			if (!user) {
-				throw new Meteor.Error('error-invalid-user', 'Invalid user');
-			}
+			if (user?.settings) {
+				const { preferences = {} } = user.settings;
+				preferences.language = user.language;
</file context>
Fix with Cubic

const { preferences = {} } = user?.settings;
preferences.language = user?.language;
const { preferences = {} } = user.settings;
preferences.language = user.language;

return API.v1.success({
preferences,
});
}

return API.v1.failure(i18n.t('Accounts_Default_User_Preferences_not_available').toUpperCase());
},
},
);
);

API.v1.addRoute(
'users.forgotPassword',
Expand Down Expand Up @@ -1554,7 +1575,7 @@ settings.watch<number>('Rate_Limiter_Limit_RegisterUser', (value) => {
API.v1.updateRateLimiterDictionaryForRoute(userRegisterRoute, value);
});

type UsersEndpoints = ExtractRoutesFromAPI<typeof usersEndpoints>;
export type UsersEndpoints = ExtractRoutesFromAPI<typeof usersEndpoints>;

declare module '@rocket.chat/rest-typings' {
// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-interface
Expand Down
⚡