Chore: Mocha testing configuration

.babelrc

@@ -1,5 +1,6 @@
 {
 	"presets": [
-		"@babel/preset-env"
+		"@babel/preset-env",
+		"@babel/preset-react"
 	]
 }

.eslintignore

@@ -18,5 +18,6 @@ imports/client/**/*
 !/.storybook/
 ee/server/services/dist/**
 !/.mocharc.js
+!/.mocharc.*.js
 !/client/.eslintrc.js
 !/ee/client/.eslintrc.js

.eslintrc

@@ -144,6 +144,16 @@
           "version": "detect"
         }
       }
+    },
+    {
+      "files": [
+        "**/*.tests.js",
+        "**/*.tests.ts",
+        "**/*.spec.ts"
+      ],
+      "env": {
+        "mocha": true
+      }
     }
   ]
 }

.github/workflows/build_and_test.yml

@@ -242,9 +242,15 @@ jobs:
       run: |
         npm install
 
+    - name: Unit Test (definitions)
+      run: npm run testunit-definition
+
     - name: Unit Test
       run: npm run testunit
 
+    - name: Unit Test (client)
+      run: npm run testunit-client
+
     - name: E2E Test
       env:
         TEST_MODE: "true"

.husky/pre-push

@@ -1,2 +1,3 @@
 meteor npm run lint && \
-meteor npm run testunit
+meteor npm run testunit && \
+meteor npm run testunit-client

mocha_end_to_end.opts.js → .mocharc.api.js

@@ -1,13 +1,11 @@
 'use strict';
 
+/**
+ * Mocha configuration for REST API integration tests.
+ */
+
 module.exports = {
-	require: [
-		'babel-mocha-es6-compiler',
-		'babel-polyfill',
-	],
-	reporter: 'spec',
-	ui: 'bdd',
-	extension: 'js,ts',
+	...require('./.mocharc.base.json'), // see https://github.com/mochajs/mocha/issues/3916
 	timeout: 10000,
 	bail: true,
 	file: 'tests/end-to-end/teardown.js',

.mocharc.base.json

@@ -0,0 +1,16 @@
+{
+	"ui": "bdd",
+	"reporter": "spec",
+	"extension": ["js", "ts", "tsx"],
+	"require": [
+		"@babel/register",
+		"regenerator-runtime/runtime",
+		"ts-node/register",
+		"./tests/setup/chaiPlugins.ts"
+	],
+	"watch-files": [
+		"./**/*.js",
+		"./**/*.ts",
+		"./**/*.tsx"
+	]
+}

.mocharc.client.js

@@ -0,0 +1,32 @@
+'use strict';
+
+/**
+ * Mocha configuration for client-side unit and integration tests.
+ */
+
+const base = require('./.mocharc.base.json');
+
+/**
+ * Mocha will run `ts-node` without doing type checking to speed-up the tests. It should be fine as `npm run typecheck`
+ * covers test files too.
+ */
+
+Object.assign(process.env, {
+	TS_NODE_FILES: true,
+	TS_NODE_TRANSPILE_ONLY: true,
+}, process.env);
+
+module.exports = {
+	...base, // see https://github.com/mochajs/mocha/issues/3916
+	require: [
+		...base.require,
+		'./tests/setup/registerWebApiMocks.ts',
+		'./tests/setup/cleanupTestingLibrary.ts',
+	],
+	exit: false,
+	slow: 200,
+	spec: [
+		'client/**/*.spec.ts',
+		'client/**/*.spec.tsx',
+	],
+};

.mocharc.definition.js

@@ -0,0 +1,29 @@
+'use strict';
+
+/**
+ * Mocha configuration for client-side unit and integration tests.
+ */
+
+const base = require('./.mocharc.base.json');
+
+/**
+ * Mocha will run `ts-node` without doing type checking to speed-up the tests. It should be fine as `npm run typecheck`
+ * covers test files too.
+ */
+
+Object.assign(process.env, {
+	TS_NODE_FILES: true,
+	TS_NODE_TRANSPILE_ONLY: true,
+}, process.env);
+
+module.exports = {
+	...base, // see https://github.com/mochajs/mocha/issues/3916
+	require: [
+		...base.require,
+	],
+	exit: false,
+	slow: 200,
+	spec: [
+		'definition/**/*.spec.ts',
+	],
+};

.mocharc.js

@@ -1,18 +1,28 @@
 'use strict';
 
+/**
+ * Mocha configuration for general unit tests.
+ */
+
+const base = require('./.mocharc.base.json');
+
+/**
+ * Mocha will run `ts-node` without doing type checking to speed-up the tests. It should be fine as `npm run typecheck`
+ * covers test files too.
+ */
+
+Object.assign(process.env, {
+	TS_NODE_FILES: true,
+	TS_NODE_TRANSPILE_ONLY: true,
+}, process.env);
+
 module.exports = {
-	require: [
-		'ts-node/register',
-		'@babel/register',
-	],
-	reporter: 'spec',
-	ui: 'bdd',
-	extension: ['js', 'ts'],
+	...base, // see https://github.com/mochajs/mocha/issues/3916
+	exit: true,
 	spec: [
+		'app/**/*.spec.ts',
 		'app/**/*.tests.js',
 		'app/**/*.tests.ts',
-		'app/**/*.spec.ts',
 		'server/**/*.tests.ts',
-		'client/**/*.spec.ts',
 	],
 };

app/api/server/api.d.ts

@@ -1,4 +1,118 @@
-import { APIClass } from '.';
+import { Endpoints } from '../../../definition/rest';
+import { Awaited } from '../../../definition/utils';
+import { IUser } from '../../../definition/IUser';
+
+
+export type ChangeTypeOfKeys<
+	T extends object,
+	Keys extends keyof T,
+	NewType
+> = {
+	[key in keyof T]: key extends Keys ? NewType : T[key]
+}
+
+type This = {
+	getPaginationItems(): ({
+		offset: number;
+		count: number;
+	});
+	parseJsonQuery(): ({
+		sort: Record<string, unknown>;
+		fields: Record<string, unknown>;
+		query: Record<string, unknown>;
+	});
+	readonly urlParams: Record<string, unknown>;
+	getUserFromParams(): IUser;
+}
+
+type ThisLoggedIn = {
+	readonly user: IUser;
+	readonly userId: string;
+}
+
+type ThisLoggedOut = {
+	readonly user: null;
+	readonly userId: null;
+}
+
+type EndpointWithExtraOptions<FN extends (this: any, ...args: any) => any, A> = WrappedFunction<FN> | ({ action: WrappedFunction<FN> } & (A extends true ? { twoFactorRequired: boolean } : {}));
+
+export type Methods<T, A = false> = {
+	[K in keyof T as `${Lowercase<string & K>}`]: T[K] extends (...args: any) => any ? EndpointWithExtraOptions<(this: This & (A extends true ? ThisLoggedIn : ThisLoggedOut) & Params<K, Parameters<T[K]>[0]>) => ReturnType<T[K]>, A> : never;
+};
+
+type Params<K, P> = K extends 'GET' ? { readonly queryParams: Partial<P> } : K extends 'POST' ? { readonly bodyParams: Partial<P> } : never;
+
+type SuccessResult<T = undefined> = {
+	statusCode: 200;
+	success: true;
+} & T extends (undefined) ? {} : { body: T }
+
+type UnauthorizedResult = {
+	statusCode: 403;
+	body: {
+		success: false;
+		error: string;
+	};
+}
+
+type FailureResult<T = undefined, ET = undefined, ST = undefined, E = undefined> = {
+	statusCode: 400;
+} & FailureBody<T, ET, ST, { success: false }>;
+
+type FailureBody<T, ET, ST, E> = Exclude<T, string> extends object ? { body: T & E } : {
+	body: E & { error: string } & E extends Error ? { details: string } : {} & ST extends undefined ? {} : { stack: string } & ET extends undefined ? {} : { errorType: string };
+}
+
+type Errors = FailureResult | FailureResult<object> | FailureResult<string, string, string, { error: string }> | UnauthorizedResult;
+
+type WrappedFunction<T extends (this: any, ...args: any) => any> = (this: ThisParameterType<T>, ...args: Parameters<T>) => ReturnTypes<T>;
+
+type ReturnTypes<T extends (this: any, ...args: any) => any> = PromisedOrNot<SuccessResult<ReturnType<T>> | PromisedOrNot<Errors>>;
+
+type PromisedOrNot<T> = Promise<T> | T;
+
+type Options = {
+	permissionsRequired?: string[];
+	twoFactorOptions?: unknown;
+	twoFactorRequired?: boolean;
+	authRequired?: boolean;
+}
+
+export type RestEndpoints<P extends keyof Endpoints, A = false> = Methods<Endpoints[P], A>;
+
+type ToLowerCaseKeys<T> = {
+	[K in keyof T as `${Lowercase<string & K>}`]: T[K];
+};
+type ToResultType<T> = {
+	[K in keyof T]: T[K] extends (...args: any) => any ? Awaited<ReturnTypes<T[K]>> : never;
+}
+export type ResultTypeEndpoints<P extends keyof Endpoints, A = false> = ToResultType<ToLowerCaseKeys<Endpoints[P]>>;
+
+declare class APIClass {
+	addRoute<P extends keyof Endpoints>(route: P, endpoints: RestEndpoints<P>): void;
+
+	addRoute<P extends keyof Endpoints, O extends Options>(route: P, options: O, endpoints: RestEndpoints<P, O['authRequired'] extends true ? true: false>): void;
+
+	unauthorized(msg?: string): UnauthorizedResult;
+
+	failure<ET = string | undefined, ST = string | undefined, E = Error | undefined>(result: string, errorType?: ET, stack?: ST, error?: E): FailureResult<string, ET, ST, E>;
+
+	failure(result: object): FailureResult<object>;
+
+	failure(): FailureResult;
+
+	success(): SuccessResult<void>;
+
+	success<T>(result: T): SuccessResult<T>;
+
+	defaultFieldsToExclude: {
+		joinCode: 0;
+		members: 0;
+		importIds: 0;
+		e2e: 0;
+	}
+}
 
 export declare const API: {
 	v1: APIClass;

app/api/server/api.js

@@ -403,7 +403,7 @@ export class APIClass extends Restivus {
 							api.processTwoFactor({ userId: this.userId, request: this.request, invocation, options: _options.twoFactorOptions, connection });
 						}
 
-						result = DDP._CurrentInvocation.withValue(invocation, () => originalAction.apply(this)) || API.v1.success();
+						result = DDP._CurrentInvocation.withValue(invocation, () => Promise.await(originalAction.apply(this))) || API.v1.success();
 
 						log.http({
 							status: result.statusCode,

app/api/server/helpers/getPaginationItems.js

@@ -10,7 +10,7 @@ API.helperMethods.set('getPaginationItems', function _getPaginationItems() {
 	const offset = this.queryParams.offset ? parseInt(this.queryParams.offset) : 0;
 	let count = defaultCount;
 
-	// Ensure count is an appropiate amount
+	// Ensure count is an appropriate amount
 	if (typeof this.queryParams.count !== 'undefined') {
 		count = parseInt(this.queryParams.count);
 	} else {