Merge pull request #218 from Telegram-Mini-Apps/feature/tests

Feature/tests

.changeset/silly-falcons-jam.md

@@ -0,0 +1,5 @@
+---
+"@tma.js/init-data-node": minor
+---
+
+Export "parse" function.

apps/docs/packages/node/tma-js-init-data-node.md

@@ -29,7 +29,7 @@ yarn add @tma.js/init-data-node
 ## Parsing
 
 You can learn more about parsing utilities in [@tma.js/sdk](../typescript/tma-js-sdk/init-data/about#parsing)
-documentation.
+documentation. This package re-exports the `parseInitData` function as `parse`.
 
 ## Validation
 

package.json

@@ -25,7 +25,7 @@
     "@vitest/ui": "^0.34.6",
     "commitizen": "^4.3.0",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.54.0",
+    "eslint": "^8.56.0",
     "happy-dom": "^12.5.0",
     "prettier": "^2.5.1",
     "tslib": "^2.6.0",

packages/build-utils/src/createVitestConfig.ts

@@ -11,7 +11,7 @@ export function createVitestConfig(options: Options = {}): InlineConfig {
     coverage,
   } = options;
   const config: InlineConfig = {
-    include: ['tests/**/*.ts'],
+    include: ['src/**/__tests__/**/*.ts'],
   };
 
   if (environment) {
@@ -23,7 +23,10 @@ export function createVitestConfig(options: Options = {}): InlineConfig {
       enabled: true,
       provider: 'v8',
       include: ['src/**/*.ts'],
-      exclude: ['src/**/index.ts'],
+      exclude: [
+        'src/**/index.ts',
+        'src/**/__tests__/**/*',
+      ],
       ...coverage,
     };
   }

packages/eslint-config-custom/base.js

@@ -11,4 +11,5 @@ module.exports = {
     'import',
   ],
   rules: require('./rules'),
+  ignorePatterns: ['**/__tests__/*'],
 };

packages/init-data-node/package.json

@@ -38,18 +38,21 @@
   },
   "scripts": {
     "test": "vitest --run",
-    "lint": "eslint src/**/*",
+    "lint": "eslint src",
     "lint:fix": "pnpm run lint --fix",
     "typecheck": "tsc --noEmit",
     "build": "vite build"
   },
   "devDependencies": {
     "@types/node": "^16.0.0",
-    "tsconfig": "workspace:*",
+    "build-utils": "workspace:*",
     "eslint-config-custom": "workspace:*",
-    "build-utils": "workspace:*"
+    "tsconfig": "workspace:*"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@tma.js/sdk": "workspace:^"
   }
 }

packages/init-data-node/src/__tests__/validate.ts

@@ -0,0 +1,43 @@
+import { URLSearchParams } from 'node:url';
+
+import { expect, it } from 'vitest';
+
+import { validate } from '../validate.js';
+
+const sp = 'query_id=AAHdF6IQAAAAAN0XohDhrOrc&user=%7B%22id%22%3A279058397%2C%22first_name%22%3A%22Vladislav%22%2C%22last_name%22%3A%22Kibenko%22%2C%22username%22%3A%22vdkfrost%22%2C%22language_code%22%3A%22ru%22%2C%22is_premium%22%3Atrue%7D&auth_date=1662771648&hash=c501b71e775f74ce10e377dea85a7ea24ecd640b223ea86dfe453e0eaed2e2b2';
+const secretToken = '5768337691:AAH5YkoiEuPk8-FZa32hStHTqXiLPtAEhx8';
+
+it('should throw missing hash error in case, it is not in search params', () => {
+  expect(() => validate('auth_date=1', secretToken))
+    .toThrowError('"hash" is empty or not found');
+});
+
+it('should throw an error on case, auth_date is not passed, equal to 0 or does not represent integer', () => {
+  expect(() => validate('auth_date=0&hash=HHH', secretToken))
+    .toThrowError('"auth_date" is empty or not found');
+  expect(() => validate('hash=HHH', secretToken))
+    .toThrowError('"auth_date" is empty or not found');
+  expect(() => validate('auth_date=AAA&hash=HHH', secretToken))
+    .toThrowError('"auth_date" should present integer');
+});
+
+it('should throw an error in case, parameters are expired', () => {
+  expect(() => validate(sp, secretToken, {
+    expiresIn: 1,
+  })).toThrowError('Init data expired');
+});
+
+it('should throw an error in case, sign is invalid', () => {
+  expect(() => validate(sp, `${secretToken}A`, {
+    expiresIn: 0,
+  })).toThrowError('Signature is invalid');
+});
+
+it('should correctly validate parameters in case, they are valid', () => {
+  expect(() => validate(sp, secretToken, { expiresIn: 0 })).not.toThrow();
+  expect(() => validate(new URLSearchParams(sp), secretToken, { expiresIn: 0 })).not.toThrow();
+});
+
+it('should throw an error in case, expiration time is not passed, parameters were created more than 1 day ago and already expired', () => {
+  expect(() => validate(sp, secretToken)).toThrow('Init data expired');
+});

packages/init-data-node/src/index.ts

@@ -1 +1,2 @@
-export * from './validation.js';
+export { parse } from './parse.js';
+export { validate, type ValidateOptions } from './validate.js';

packages/init-data-node/src/parse.ts

@@ -0,0 +1,3 @@
+import { parseInitData } from '@tma.js/sdk';
+
+export { parseInitData as parse };

packages/init-data-node/tsconfig.json

@@ -3,6 +3,9 @@
   "include": [
     "src"
   ],
+  "exclude": [
+    "src/**/__tests__"
+  ],
   "references": [
     {
       "path": "./tsconfig.node.json"

packages/sdk-react/package.json

@@ -37,7 +37,7 @@
     }
   },
   "scripts": {
-    "lint": "eslint src/**/*",
+    "lint": "eslint src",
     "lint:fix": "pnpm run lint --fix",
     "typecheck": "tsc --noEmit",
     "build": "vite build"

packages/sdk-react/src/DisplayGate.tsx

@@ -23,7 +23,7 @@ export interface DisplayGateProps extends PropsWithChildren {
 function render(Component: ReactNode | ComponentType): ReactNode;
 function render<T extends object>(Component: ReactNode | ComponentType<T>, props: T): ReactNode;
 function render(Component: ReactNode | ComponentType, props = {}): ReactNode {
-  return typeof Component === 'function' ? <Component {...props}/> : Component;
+  return typeof Component === 'function' ? <Component {...props} /> : Component;
 }
 
 /**
@@ -34,9 +34,10 @@ function render(Component: ReactNode | ComponentType, props = {}): ReactNode {
 export function DisplayGate(props: DisplayGateProps): ReactNode {
   const { loading, initResult, error } = useSDKContext();
 
-  return initResult
-    ? props.children
-    : error
-      ? render(props.error, { error })
-      : render(loading ? props.loading : props.initial);
-}
+  if (initResult) {
+    return props.children;
+  }
+  return error
+    ? render(props.error, { error })
+    : render(loading ? props.loading : props.initial);
+}

packages/sdk-solid/package.json

@@ -37,7 +37,7 @@
     }
   },
   "scripts": {
-    "lint": "eslint src/**/*",
+    "lint": "eslint src",
     "lint:fix": "pnpm run lint --fix",
     "typecheck": "tsc --noEmit",
     "build": "vite build"

packages/sdk-solid/src/DisplayGate.tsx

@@ -1,9 +1,9 @@
 import {
-  Match,
-  Switch,
   type Component,
-  type ParentProps,
   type JSX,
+  Match,
+  type ParentProps,
+  Switch,
 } from 'solid-js';
 
 import { useSDKContext } from './provider/index.js';
@@ -53,4 +53,4 @@ export function DisplayGate(props: DisplayGateProps) {
       </Match>
     </Switch>
   );
-}
+}

packages/sdk-solid/src/index.ts

@@ -25,7 +25,7 @@ export {
 } from './provider/index.js';
 export {
   DisplayGate,
-  type DisplayGateProps
+  type DisplayGateProps,
 } from './DisplayGate.js';
 export type {
   InitOptions,

packages/sdk/package.json

@@ -38,7 +38,7 @@
   },
   "scripts": {
     "test": "vitest --run",
-    "lint": "eslint src/**/*",
+    "lint": "eslint src",
     "lint:fix": "pnpm run lint --fix",
     "typecheck": "tsc --noEmit -p tsconfig.build.json",
     "build": "pnpm run build:default && pnpm run build:iife",

packages/sdk/tests/globals.ts → packages/sdk/src/__tests__/globals.ts

@@ -5,7 +5,7 @@ import {
   setDebug,
   setTargetOrigin,
   targetOrigin,
-} from '~/globals.js';
+} from '../globals';
 
 afterEach(() => {
   vi.restoreAllMocks();

packages/sdk/tests/back-button/BackButton.ts → packages/sdk/src/back-button/__tests__/BackButton.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it, vi } from 'vitest';
 
-import { BackButton } from '~/back-button/index.js';
+import { BackButton } from '../BackButton';
 
 describe('hide', () => {
   it('should call "web_app_setup_back_button" method with "is_visible" equal to false', () => {
@@ -126,4 +126,4 @@ describe('supports', () => {
       expect(backButton3.supports('hide')).toBe(true);
     });
   });
-});
+});

packages/sdk/tests/bridge/request.ts → packages/sdk/src/bridge/__tests__/request.ts

@@ -11,14 +11,14 @@ import {
   afterAll,
 } from 'vitest';
 
-import { request, type PostEvent } from '~/bridge/index.js';
-import { postEvent as globalPostEvent } from '~/bridge/methods/postEvent.js';
-import { createWindow } from '~test-utils/createWindow.js';
-import { dispatchWindowMessageEvent } from '~test-utils/dispatchWindowMessageEvent.js';
+import { request } from '../request';
+import { type PostEvent, postEvent as globalPostEvent } from '../methods/postEvent';
+import { createWindow } from '../../../test-utils/createWindow';
+import { dispatchWindowMessageEvent } from '../../../test-utils/dispatchWindowMessageEvent';
 
-vi.mock('~/bridge/methods/postEvent.js', async () => {
+vi.mock('../methods/postEvent.js', async () => {
   const { postEvent: actualPostEvent } = await vi
-    .importActual('../../src/bridge/methods/postEvent.js') as { postEvent: PostEvent };
+    .importActual('../methods/postEvent.js') as { postEvent: PostEvent };
 
   return {
     postEvent: vi.fn(actualPostEvent),

packages/sdk/tests/bridge/env/hasExternalNotify.ts → packages/sdk/src/bridge/env/__tests__/hasExternalNotify.ts

@@ -1,6 +1,6 @@
 import { expect, it } from 'vitest';
 
-import { hasExternalNotify } from '~/bridge/index.js';
+import { hasExternalNotify } from '../hasExternalNotify.js';
 
 it('should return true if passed object contains path property "external.notify" and "notify" is a function property.', () => {
   expect(hasExternalNotify({})).toBe(false);
@@ -12,4 +12,4 @@ it('should return true if passed object contains path property "external.notify"
       },
     },
   })).toBe(true);
-});
+});

packages/sdk/tests/bridge/env/hasWebviewProxy.ts → packages/sdk/src/bridge/env/__tests__/hasWebviewProxy.ts

@@ -1,6 +1,6 @@
 import { expect, it } from 'vitest';
 
-import { hasWebviewProxy } from '~/bridge/index.js';
+import { hasWebviewProxy } from '../hasWebviewProxy.js';
 
 it('should return true if passed object contains path property "TelegramWebviewProxy.postEvent" and "postEvent" is a function property.', () => {
   expect(hasWebviewProxy({})).toBe(false);
@@ -12,4 +12,4 @@ it('should return true if passed object contains path property "TelegramWebviewP
       },
     },
   })).toBe(true);
-});
+});

packages/sdk/tests/bridge/env/isIframe.ts → packages/sdk/src/bridge/env/__tests__/isIframe.ts

@@ -1,6 +1,6 @@
 import { afterAll, afterEach, expect, it, vi } from 'vitest';
 
-import { isIframe } from '~/bridge/index.js';
+import { isIframe } from '../isIframe.js';
 
 const windowSpy = vi.spyOn(window, 'window', 'get');
 
@@ -27,4 +27,4 @@ it('should return true in case window.self getter threw an error', () => {
     },
   }) as any);
   expect(isIframe()).toBe(true);
-});
+});

packages/sdk/tests/bridge/events/createEmitter.ts → packages/sdk/src/bridge/events/__tests__/createEmitter.ts

@@ -1,9 +1,9 @@
-import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 
-import { createWindow, type WindowSpy } from '~test-utils/createWindow.js';
-import { dispatchWindowMessageEvent } from '~test-utils/dispatchWindowMessageEvent.js';
-import { createEmitter } from '~/bridge/events/createEmitter.js';
-import type { MiniAppsEventParams, MiniAppsEventName } from '~/bridge/index.js';
+import { createWindow, type WindowSpy } from '../../../../test-utils/createWindow';
+import { dispatchWindowMessageEvent } from '../../../../test-utils/dispatchWindowMessageEvent';
+import { createEmitter } from '../createEmitter';
+import type { MiniAppsEventName, MiniAppsEventParams } from '../events';
 
 type TestCase<E extends MiniAppsEventName> =
   | [input: any, expected: MiniAppsEventParams<E>]

packages/sdk/tests/bridge/events/off.ts → packages/sdk/src/bridge/events/__tests__/off.ts

@@ -1,8 +1,9 @@
-import { expect, vi, beforeEach, afterEach, it } from 'vitest';
+import { afterEach, beforeEach, expect, it, vi } from 'vitest';
 
-import { on, off } from '~/bridge/index.js';
-import { createWindow, type WindowSpy } from '~test-utils/createWindow.js';
-import { dispatchWindowMessageEvent } from '~test-utils/dispatchWindowMessageEvent.js';
+import { createWindow, type WindowSpy } from '../../../../test-utils/createWindow';
+import { dispatchWindowMessageEvent } from '../../../../test-utils/dispatchWindowMessageEvent';
+import { off } from '../off';
+import { on } from '../on';
 
 let windowSpy: WindowSpy;
 

packages/sdk/tests/bridge/events/on.ts → packages/sdk/src/bridge/events/__tests__/on.ts

@@ -1,8 +1,8 @@
-import { expect, it, vi, afterEach, beforeEach } from 'vitest';
+import { afterEach, beforeEach, expect, it, vi } from 'vitest';
 
-import { on } from '~/bridge/index.js';
-import { createWindow, type WindowSpy } from '~test-utils/createWindow.js';
-import { dispatchWindowMessageEvent } from '~test-utils/dispatchWindowMessageEvent.js';
+import { createWindow, type WindowSpy } from '../../../../test-utils/createWindow';
+import { dispatchWindowMessageEvent } from '../../../../test-utils/dispatchWindowMessageEvent';
+import { on } from '../on';
 
 let windowSpy: WindowSpy;