Chore: add Ajv JSON Schema to api/v1 #25601

felipe-rod123 · 2022-05-23T12:16:16Z

Proposed changes (including videos or screenshots)

This pull request adds Ajv JSON Schema validation to apps/meteor/app/api/server/v1/ and packages/rest-typings/src/v1/, where needed.

Issue(s)

Steps to test or reproduce

Further comments

ggazzo

put some Prop at the end of types and functions assertions

…ema-to-api/v1

… into chore/add-json-schema-to-api/v1

…ema-to-api/v1

…at/Rocket.Chat into chore/add-json-schema-to-api/v1

packages/rest-typings/src/index.ts

pierre-lehnen-rc · 2022-06-03T16:29:04Z

packages/rest-typings/src/v1/voip.ts

@@ -8,72 +8,536 @@ import type {
 	IVoipExtensionWithAgentInfo,
 	IManagementServerConnectionStatus,
 	IRegistrationInfo,
-	VoipClientEvents,
+	// VoipClientEvents,


Suggested change

// VoipClientEvents,

.yarnrc.yml

apps/meteor/client/components/Omnichannel/hooks/useDepartmentsList.ts

KevLehman · 2022-06-03T15:39:30Z

apps/meteor/package.json

@@ -28,7 +28,7 @@
 		"obj:dev": "TEST_MODE=true yarn dev",
 		"stylelint": "stylelint \"app/**/*.css\" \"client/**/*.css\" \"app/**/*.less\" \"client/**/*.less\" \"ee/**/*.less\"",
 		"stylelint:fix": "stylelint --fix \"app/**/*.css\" \"client/**/*.css\" \"app/**/*.less\" \"client/**/*.less\" \"ee/**/*.less\"",
-		"typecheck": "cross-env NODE_OPTIONS=\"--max-old-space-size=4092\" tsc --noEmit --skipLibCheck",
+		"typecheck": "cross-env NODE_OPTIONS=\"--max-old-space-size=8184\" tsc --noEmit --skipLibCheck",


KevLehman · 2022-06-03T16:16:35Z

packages/rest-typings/src/v1/banners.ts

+	type: 'object',
+	properties: {
+		platform: {
+			type: 'string',


Since bannerPlatform is an enum, maybe you can use the enum key here?

Suggested change

type: 'string',

enum: ['1', '2'],

KevLehman · 2022-06-03T16:31:52Z

packages/rest-typings/src/v1/chat.ts

@@ -1,76 +1,462 @@
 import type { IMessage, IRoom, ReadReceipt } from '@rocket.chat/core-typings';
+import Ajv from 'ajv';


This may be a bit picky, but would be great to have a separate file for the AJV schemas, otherwise these definition files would be really huge (and a bit messy, depending on who sees it) 👀
(Was thinking on moving these defs to the end of the file, but there's an eslint rule we use to prevent that i think)

KevLehman · 2022-06-03T16:37:29Z

packages/rest-typings/src/v1/cloud.ts

+		},
+		resend: {
+			type: 'string',
+			nullable: true,


Maybe this prop can be in optionalProperties key? 👀

KevLehman · 2022-06-03T17:25:04Z

packages/rest-typings/src/v1/omnichannel.ts

+	additionalProperties: false,
+};
+
+export const isLivechatDepartmentDepartmentIdAgentsPOSTProps = ajv.compile<LivechatDepartmentDepartmentIdAgentsPOST>(


This kind of types would become more common, would be good to define an "standard" for it, like GETLivechatDepartmentIdAgents and POSTLivechatDepartmentIdAgents, prefixing the method to all typedefs

KevLehman · 2022-06-03T17:28:20Z

packages/rest-typings/src/v1/omnichannel.ts

+			nullable: true,
+		},
+	},
+	required: [],


I believe required can be omitted when no prop is required

packages/rest-typings/src/v1/users.ts

Co-authored-by: Pierre Lehnen <[email protected]>

…message-body * 'develop' of github.com:RocketChat/Rocket.Chat: [IMPROVE] Refactor + unit tests for federation-v2 (#25680) [FIX] user status Offline misnamed as Invisible in Custom Status edit dropdown menu (#24796) Chore: Messages raw model rewrite to ts (#25761) Chore: migrate katex to ts (#25501) Chore: AutoTranslate contextualBar rewrite (#25751) Chore: Replace AnnouncementModal in favor of GenericModal (#25752) Chore: Keyboard shortcuts contextualBar rewrite (#25753) Chore: Prune Messages contextualBar rewrite (#25757) Chore: add Ajv JSON Schema to api/v1 (#25601) Update package.json (#25755) Update CODEOWNERS Chore: remove duplicated NotFoundPage.js (#25749)

* origin/develop: (45 commits) [FIX] Thread Message Preview (#25709) [FIX] Bump meteor-node-stubs to version 1.2.3 (#25669) [IMPROVE] Refactor + unit tests for federation-v2 (#25680) [FIX] user status Offline misnamed as Invisible in Custom Status edit dropdown menu (#24796) Chore: Messages raw model rewrite to ts (#25761) Chore: migrate katex to ts (#25501) Chore: AutoTranslate contextualBar rewrite (#25751) Chore: Replace AnnouncementModal in favor of GenericModal (#25752) Chore: Keyboard shortcuts contextualBar rewrite (#25753) Chore: Prune Messages contextualBar rewrite (#25757) Chore: add Ajv JSON Schema to api/v1 (#25601) Update package.json (#25755) Update CODEOWNERS Chore: remove duplicated NotFoundPage.js (#25749) Chore: command's endpoints (#25630) Chore: Fix incorrect checksum for agenda package (cause of breaking develop builds) (#25741) Chore: Remove duplicate checksumBehavior key from yarn file (#25730) [FIX] Custom emoji reaction size (#25393) Chore: Test for department screen (#25696) Chore: Taking out Blaze from routes with `MainLayout` (#25697) ...

* origin/develop: (26 commits) [FIX] Thread Message Preview (#25709) [FIX] Bump meteor-node-stubs to version 1.2.3 (#25669) [IMPROVE] Refactor + unit tests for federation-v2 (#25680) [FIX] user status Offline misnamed as Invisible in Custom Status edit dropdown menu (#24796) Chore: Messages raw model rewrite to ts (#25761) Chore: migrate katex to ts (#25501) Chore: AutoTranslate contextualBar rewrite (#25751) Chore: Replace AnnouncementModal in favor of GenericModal (#25752) Chore: Keyboard shortcuts contextualBar rewrite (#25753) Chore: Prune Messages contextualBar rewrite (#25757) Chore: add Ajv JSON Schema to api/v1 (#25601) Update package.json (#25755) Update CODEOWNERS Chore: remove duplicated NotFoundPage.js (#25749) Chore: command's endpoints (#25630) Chore: Fix incorrect checksum for agenda package (cause of breaking develop builds) (#25741) Chore: Remove duplicate checksumBehavior key from yarn file (#25730) [FIX] Custom emoji reaction size (#25393) Chore: Test for department screen (#25696) Chore: Taking out Blaze from routes with `MainLayout` (#25697) ...

chore: add Ajv to banners.ts (work in progress)

c7f4ac5

felipe-rod123 requested a review from a team as a code owner May 23, 2022 12:16

ggazzo requested changes May 24, 2022

View reviewed changes

felipe-rod123 added 8 commits May 25, 2022 07:42

fix banners.ts and chat.ts JSON Schemas

ae1de99

add cloud.ts and directory.ts json schemas

3019f40

add more schemas

ec2000a

add invites, ldap, licenses.ts json schemas

bb6c62d

fix omnichannel.ts json schema (work in progress)

c187396

fix more omnichannel.ts json schemas (work in progress)

8f93798

chore: remove JSONSchemaType (work in progress)

b4d7745

add JSON Schema to more files

1f83338

felipe-rod123 requested a review from a team as a code owner May 30, 2022 11:42

felipe-rod123 force-pushed the chore/add-json-schema-to-api/v1 branch from 2b778ef to 8f93798 Compare May 30, 2022 11:44

ggazzo added 3 commits May 30, 2022 09:01

Merge remote-tracking branch 'origin/develop' into chore/add-json-sch…

b6c39b7

…ema-to-api/v1

lint

b360fb3

Merge remote-tracking branch 'origin/develop' into chore/add-json-sch…

830f53a

…ema-to-api/v1

ggazzo force-pushed the chore/add-json-schema-to-api/v1 branch from 8378b50 to 830f53a Compare June 1, 2022 13:37

felipe-rod123 and others added 10 commits June 1, 2022 10:44

Merge remote-tracking branch 'origin/chore/add-json-schema-to-api/v1'…

669531e

… into chore/add-json-schema-to-api/v1

add compile types to Ajv (work in progress)

f21aa9a

add more Ajv compile types

3ba3bf5

add voip.ts endpoint validations

cbe65a9

Merge branch 'develop' into chore/add-json-schema-to-api/v1

4f571e7

Merge remote-tracking branch 'origin/develop' into chore/add-json-sch…

dd9015e

…ema-to-api/v1

Merge branch 'chore/add-json-schema-to-api/v1' of github.com:RocketCh…

a8ed0ec

…at/Rocket.Chat into chore/add-json-schema-to-api/v1

Lint

48c8c16

Fix '/im.history' test

25eeb05

fix ominchannel departments

cfdecd9

pierre-lehnen-rc self-requested a review June 3, 2022 16:13

pierre-lehnen-rc requested changes Jun 3, 2022

View reviewed changes

pierre-lehnen-rc reviewed Jun 3, 2022

View reviewed changes

.yarnrc.yml Outdated Show resolved Hide resolved

KevLehman reviewed Jun 3, 2022

View reviewed changes

ggazzo and others added 2 commits June 3, 2022 16:10

Apply suggestions from code review

5096876

Co-authored-by: Pierre Lehnen <[email protected]>

Fix review

f8287c2

pierre-lehnen-rc approved these changes Jun 3, 2022

View reviewed changes

ggazzo merged commit 0b1073e into develop Jun 3, 2022

ggazzo deleted the chore/add-json-schema-to-api/v1 branch June 3, 2022 20:57

murtaza98 mentioned this pull request Jul 21, 2022

Release 5.0.0 #26333

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chore: add Ajv JSON Schema to api/v1 #25601

Chore: add Ajv JSON Schema to api/v1 #25601

felipe-rod123 commented May 23, 2022

ggazzo left a comment

pierre-lehnen-rc Jun 3, 2022

KevLehman Jun 3, 2022

KevLehman Jun 3, 2022

KevLehman Jun 3, 2022

KevLehman Jun 3, 2022

KevLehman Jun 3, 2022

KevLehman Jun 3, 2022

		@@ -1,76 +1,462 @@
		import type { IMessage, IRoom, ReadReceipt } from '@rocket.chat/core-typings';
		import Ajv from 'ajv';

Chore: add Ajv JSON Schema to api/v1 #25601

Chore: add Ajv JSON Schema to api/v1 #25601

Conversation

felipe-rod123 commented May 23, 2022

Proposed changes (including videos or screenshots)

Issue(s)

Steps to test or reproduce

Further comments

ggazzo left a comment

Choose a reason for hiding this comment

pierre-lehnen-rc Jun 3, 2022

Choose a reason for hiding this comment

KevLehman Jun 3, 2022

Choose a reason for hiding this comment

KevLehman Jun 3, 2022

Choose a reason for hiding this comment

KevLehman Jun 3, 2022

Choose a reason for hiding this comment

KevLehman Jun 3, 2022

Choose a reason for hiding this comment

KevLehman Jun 3, 2022

Choose a reason for hiding this comment

KevLehman Jun 3, 2022

Choose a reason for hiding this comment