Skip to content

test: adding type-level test for chat.postMessage POST bodyParams returning correct type #36456

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

Draft
ahmed-n-abdeltwab wants to merge 5 commits into
base: develop
Choose a base branch
from
Draft

test: adding type-level test for chat.postMessage POST bodyParams returning correct type #36456

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
00e3794
test: add scenario for the chat postmessage
ahmed-n-abdeltwab Jul 17, 2025
6e26b0d
chore: try GET method gets defrent result
ahmed-n-abdeltwab Jul 17, 2025
8e9a325
Merge branch 'develop' into test/typed-this-definition
cardoso Jul 21, 2025
5b57f89
fix: Correct path format and update type assertions in chat.postMessa…
ahmed-n-abdeltwab Jul 22, 2025
89dd5c8
fix: Update IChatPostMessageBody to include optional attachments and …
ahmed-n-abdeltwab Jul 22, 2025
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
73 changes: 73 additions & 0 deletions apps/meteor/app/api/server/definition.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
import type { IUser } from '@rocket.chat/core-typings';
import type { ValidateFunction } from 'ajv';

import type { TypedThis, TypedOptions, Action, InnerAction } from './definition';

// --- Utilities ---
type IsTypeEqual<A, B> = (<T>() => T extends A ? 1 : 2) extends <T>() => T extends B ? 1 : 2 ? true : false;
type ExtractThis<T> = T extends (this: infer U, ...args: any[]) => any ? U : never;
type Mutable<T> = { -readonly [K in keyof T]: T[K] };

// --- Scenario: POST /v1/chat.postMessage ---
interface IChatPostMessageBody {
channal: string;
text: string;
attachments?: Array<{
text: string;
color?: string;
image_url?: string;
}>;
}
type ChatPostMessageBodyValidator = ValidateFunction<IChatPostMessageBody>;

type ChatPostMessageOptions = TypedOptions & {
body: ChatPostMessageBodyValidator;
authRequired: true;
};

type Post = 'POST';
type Path = '/v1/chat.postMessage';
type Options = ChatPostMessageOptions;

// --- Expected ActionThis shape (single source of truth) ---
type ExpectedActionThis = {
route: string;
readonly requestIp: string;
urlParams: never;
readonly response: Response;
readonly queryParams: Record<string, string>;
readonly bodyParams: ChatPostMessageBodyValidator;
readonly request: Request;
readonly queryOperations: never;
parseJsonQuery: () => Promise<{
sort: Record<string, 1 | -1>;
fields: Record<string, 0 | 1>;
query: Record<string, unknown>;
}>;
readonly connection: {
token: string;
id: string;
close: () => void;
clientAddress: string;
httpHeaders: Record<string, any>;
};
user: IUser;
userId: string;
readonly token: string;
};

// --- Type-level assertions ---
type ChatPostMessageThis = TypedThis<Options, Path>;
type TestChatPostMessageBodyParams = IsTypeEqual<ChatPostMessageThis['bodyParams'], IChatPostMessageBody>;
true satisfies TestChatPostMessageBodyParams;

type ActionType = Action<Post, Path, Options>;
type ActionThisType = ExtractThis<Exclude<ActionType, undefined>>;
type TestActionBodyParams = IsTypeEqual<ActionThisType['bodyParams'], ExpectedActionThis['bodyParams']>;
true satisfies TestActionBodyParams;

type InnerActionType = InnerAction<Post, Path, Options>;
type ExpectedInnerActionThis = Mutable<ExpectedActionThis>;
type InnerActionThisType = ExtractThis<Exclude<InnerActionType, undefined>>;
type TestInnerActionBodyParams = IsTypeEqual<InnerActionThisType['bodyParams'], ExpectedInnerActionThis['bodyParams']>;
true satisfies TestInnerActionBodyParams;
Loading