Skip to content

refactor(api): migrate push endpoints to chained API pattern #39625

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

Closed
smirk-dev wants to merge 6 commits into from
Closed

refactor(api): migrate push endpoints to chained API pattern #39625

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bc76410
refactor(api): migrate push endpoints to chained API pattern
smirk-dev Mar 14, 2026
97267f7
merge: resolve conflicts with upstream develop
smirk-dev Mar 14, 2026
20aa60a
fix(api): remove manual PushEndpoints type and add changeset
smirk-dev Mar 17, 2026
11be43e
fix(api): replace additionalProperties: true with \$ref in push.get r…
smirk-dev Mar 18, 2026
9af3565
chore(api): align push migration with openapi template
smirk-dev Mar 19, 2026
2f989a4
fix apps-engine return post-event listener promises
smirk-dev Mar 20, 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
79 changes: 53 additions & 26 deletions apps/meteor/app/api/server/v1/push.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ import type { IPushToken, IPushTokenTypes } from '@rocket.chat/core-typings';
import { Messages, PushToken, Users, Rooms, Settings } from '@rocket.chat/models';
import {
ajv,
isPushGetProps,
validateNotFoundErrorResponse,
validateBadRequestErrorResponse,
validateUnauthorizedErrorResponse,
validateForbiddenErrorResponse,
} from '@rocket.chat/rest-typings';
import type { JSONSchemaType } from 'ajv';
import { Accounts } from 'meteor/accounts-base';
import { Match, check } from 'meteor/check';
import { Meteor } from 'meteor/meteor';

import { executePushTest } from '../../../../server/lib/pushConfig';
Expand Down Expand Up @@ -220,27 +220,43 @@ const pushTokenEndpoints = API.v1

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

API.v1.addRoute(
'push.get',
{ authRequired: true },
{
async get() {
const params = this.queryParams;
check(
params,
Match.ObjectIncluding({
id: String,
)
.get(
'push.get',
{
authRequired: true,
query: isPushGetProps,
response: {
200: ajv.compile<{ data: { message: object; notification: object }; success: true }>({
type: 'object',
properties: {
data: {
type: 'object',
properties: {
message: { type: 'object', additionalProperties: true },
notification: { type: 'object', additionalProperties: true },
},
required: ['message', 'notification'],
additionalProperties: false,
},
success: { type: 'boolean', enum: [true] },
},
required: ['data', 'success'],
additionalProperties: false,
Copy link
Copy Markdown
Contributor

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

Choose a reason for hiding this comment

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

We avoid using additionalProperties: true because it weakens validation. Instead, we use the $ref tags from Typia or explicitly define the properties if they are simple. In this specific case, I think you should use the Typia reference props

Copy link
Copy Markdown
Contributor Author

@smirk-dev smirk-dev Mar 16, 2026

Choose a reason for hiding this comment

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

I've updated the push.test response schema — the type annotation is now SuccessResult<{ tokensCount: number }>['body'] (consistent with the push.token pattern), and the schema is tightened to additionalProperties: false throughout. For push.get, since the response wraps IMessage and IPushNotificationConfig — both complex core types , I've used $ref: '#/components/schemas/IMessage' and $ref: '#/components/schemas/IPushNotificationConfig' as Typia reference properties rather than inlining the full object shapes. does that work?

Copy link
Copy Markdown
Contributor

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

Choose a reason for hiding this comment

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

how about this issue? why still unsolve

}),
);
400: validateBadRequestErrorResponse,
401: validateUnauthorizedErrorResponse,
},
},
async function action() {
const { id } = this.queryParams;

const receiver = await Users.findOneById(this.userId);
if (!receiver) {
throw new Error('error-user-not-found');
}

const message = await Messages.findOneById(params.id);
const message = await Messages.findOneById(id);
if (!message) {
throw new Error('error-message-not-found');
}
Expand All @@ -258,23 +274,34 @@ API.v1.addRoute(

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

API.v1.addRoute(
'push.info',
{ authRequired: true },
{
async get() {
)
.get(
'push.info',
{
authRequired: true,
response: {
200: ajv.compile<{ pushGatewayEnabled: boolean; defaultPushGateway: boolean; success: true }>({
type: 'object',
properties: {
pushGatewayEnabled: { type: 'boolean' },
defaultPushGateway: { type: 'boolean' },
success: { type: 'boolean', enum: [true] },
},
required: ['pushGatewayEnabled', 'defaultPushGateway', 'success'],
additionalProperties: false,
}),
401: validateUnauthorizedErrorResponse,
},
},
async function action() {
const defaultGateway = (await Settings.findOneById('Push_gateway', { projection: { packageValue: 1 } }))?.packageValue;
const defaultPushGateway = settings.get('Push_gateway') === defaultGateway;
return API.v1.success({
pushGatewayEnabled: settings.get('Push_enable'),
pushGatewayEnabled: settings.get<boolean>('Push_enable'),
defaultPushGateway,
});
},
},
);
);

const pushTestEndpoints = API.v1.post(
'push.test',
Expand Down
2 changes: 2 additions & 0 deletions packages/rest-typings/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,5 +257,7 @@ export * from './v1/cloud';
export * from './v1/banners';
export * from './default';

export * from './v1/push';

// Export the ajv instance for use in other packages
export * from './v1/Ajv';