Skip to content

Commit

Permalink
Changes after environment reset
Browse files Browse the repository at this point in the history
Added Jest
Added services from RSN-12
Split .gitignore
  • Loading branch information
wzarek committed Apr 3, 2024
1 parent 615f28b commit 0ff6a92
Show file tree
Hide file tree
Showing 14 changed files with 2,400 additions and 818 deletions.
759 changes: 0 additions & 759 deletions .gitignore

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions Client/reasn-client/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ node_modules
# testing
coverage

# yarn
.yarn/*
!.yarn/cache
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/sdks
!.yarn/versions

# next.js
.next/
.swc/
Expand Down
206 changes: 206 additions & 0 deletions Client/reasn-client/jest.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,206 @@
/**
* For a detailed explanation regarding each configuration property, visit:
* https://jestjs.io/docs/configuration
*/

import type { JestConfigWithTsJest } from 'ts-jest'

const config: JestConfigWithTsJest = {
// All imported modules in your tests should be mocked automatically
// automock: false,

// Stop running tests after `n` failures
// bail: 0,

// The directory where Jest should store its cached dependency information
// cacheDirectory: "C:\\Users\\katan\\AppData\\Local\\Temp\\jest",

// Automatically clear mock calls, instances, contexts and results before every test
clearMocks: true,

// Indicates whether the coverage information should be collected while executing the test
// collectCoverage: false,

// An array of glob patterns indicating a set of files for which coverage information should be collected
// collectCoverageFrom: undefined,

// The directory where Jest should output its coverage files
// coverageDirectory: undefined,

// An array of regexp pattern strings used to skip coverage collection
// coveragePathIgnorePatterns: [
// "\\\\node_modules\\\\"
// ],

// Indicates which provider should be used to instrument code for coverage
coverageProvider: "v8",

// A list of reporter names that Jest uses when writing coverage reports
// coverageReporters: [
// "json",
// "text",
// "lcov",
// "clover"
// ],

// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: undefined,

// A path to a custom dependency extractor
// dependencyExtractor: undefined,

// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,

// The default configuration for fake timers
// fakeTimers: {
// "enableGlobally": false
// },

// Force coverage collection from ignored files using an array of glob patterns
// forceCoverageMatch: [],

// A path to a module which exports an async function that is triggered once before all test suites
// globalSetup: undefined,

// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: undefined,

// A set of global variables that need to be available in all test environments
// globals: {},

// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
// maxWorkers: "50%",

// An array of directory names to be searched recursively up from the requiring module's location
moduleDirectories: [
"node_modules"
],

// An array of file extensions your modules use
moduleFileExtensions: [
"js",
"mjs",
"cjs",
"jsx",
"ts",
"tsx",
"json",
"node"
],

// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
moduleNameMapper: {
"^@reasn/common/services/(.*)$": "<rootDir>/packages/common/services/$1",
"^@reasn/common/enums/(.*)$": "<rootDir>/packages/common/enums/$1",
"^@reasn/common/interfaces/(.*)$": "<rootDir>/packages/common/interfaces/$1",
"^@reasn/common/errors/(.*)$": "<rootDir>/packages/common/errors/$1",
},

// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],

// Activates notifications for test results
// notify: false,

// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",

// A preset that is used as a base for Jest's configuration
preset: "ts-jest",

// Run tests from one or more projects
// projects: undefined,

// Use this configuration option to add custom reporters to Jest
// reporters: undefined,

// Automatically reset mock state before every test
// resetMocks: false,

// Reset the module registry before running each individual test
// resetModules: false,

// A path to a custom resolver
// resolver: undefined,

// Automatically restore mock state and implementation before every test
// restoreMocks: false,

// The root directory that Jest should scan for tests and modules within
// rootDir: undefined,

// A list of paths to directories that Jest should use to search for files in
roots: [
"<rootDir>"
],

// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",

// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: [],

// A list of paths to modules that run some code to configure or set up the testing framework before each test
setupFilesAfterEnv: ['jest-fetch-mock'],

// The number of seconds after which a test is considered as slow and reported as such in the results.
// slowTestThreshold: 5,

// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],

// The test environment that will be used for testing
testEnvironment: "node",

// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},

// Adds a location field to test results
// testLocationInResults: false,

// The glob patterns Jest uses to detect test files
testMatch: [
"**/__tests__/**/*.[jt]s?(x)",
"**/?(*.)+(spec|test).[tj]s?(x)"
],

// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
testPathIgnorePatterns: [
"\\\\node_modules\\\\"
],

// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],

// This option allows the use of a custom results processor
// testResultsProcessor: undefined,

// This option allows use of a custom test runner
// testRunner: "jest-circus/runner",

// A map from regular expressions to paths to transformers
transform: {
"^.+\\.(ts|tsx)?$": "ts-jest"
},

// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
transformIgnorePatterns: [
"\\\\node_modules\\\\",
"\\.pnp\\.[^\\\\]+$"
],

// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,

// Indicates whether each individual test should be reported during the run
// verbose: undefined,

// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],

// Whether to use watchman for file crawling
// watchman: true,
};

export default config;
8 changes: 7 additions & 1 deletion Client/reasn-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,16 @@
"dev:mobile": "turbo run dev --filter=native --filter=@reasn/ui --filter=@reasn/typescript-config",
"build": "turbo run build",
"clean": "turbo run clean && rm -rf node_modules",
"format": "prettier --write \"**/*.{ts,tsx,js,jsx,json,md}\" --ignore-path .gitignore"
"format": "prettier --write \"**/*.{ts,tsx,js,jsx,json,md}\" --ignore-path .gitignore",
"test": "jest"
},
"devDependencies": {
"@types/jest": "^29.5.12",
"jest": "^29.7.0",
"jest-fetch-mock": "^3.0.3",
"prettier": "^3.1.1",
"ts-jest": "^29.1.2",
"ts-node": "^10.9.2",
"turbo": "latest"
},
"packageManager": "[email protected]",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
import { sendRequest } from '@reasn/common/services/apiServices';
import { getAuthDataFromSessionStorage } from '@reasn/common/services/authorizationServices';
import { AuthData } from "@reasn/common/interfaces/AuthData";
import { HttpMethod } from '@reasn/common/enums/serviceEnums';
import { describe, expect, it, jest, beforeEach } from '@jest/globals';
import fetch from 'cross-fetch';
import ApiConnectionError from '@reasn/common/errors/ApiConnectionError';
import ApiAuthorizationError from '@reasn/common/errors/ApiAuthorizationError';

jest.mock('cross-fetch');
jest.mock('@reasn/common/services/authorizationServices');

describe('sendRequest', () => {
beforeEach(() => {
(fetch as jest.Mock).mockClear();
(getAuthDataFromSessionStorage as jest.Mock).mockClear();
});

it('should return data when response is ok', async () => {
const mockData = { key: 'value' };
(fetch as jest.Mock).mockImplementationOnce(() => ({
ok: true,
json: () => Promise.resolve(mockData),
}));

const data = await sendRequest('http://example.com', HttpMethod.GET);

expect(data).toEqual(mockData);
});

it('should throw an API error when response is not ok', async () => {
const mockData = { message: 'Error message' };
(fetch as jest.Mock).mockImplementationOnce(() => ({
ok: false,
status: 500,
statusText: mockData.message,
json: () => Promise.resolve(mockData),
}));

await expect(sendRequest('http://example.com', HttpMethod.GET)).rejects.toThrow(ApiConnectionError);
});

it('should include auth token in headers when authRequired is true', async () => {
const mockData = { key: 'value' };
(fetch as jest.Mock).mockImplementationOnce(() => ({
ok: true,
json: () => Promise.resolve(mockData),
}));
(getAuthDataFromSessionStorage as jest.Mock).mockReturnValueOnce({ token: 'token' } as AuthData);

await sendRequest('http://example.com', HttpMethod.GET, {}, true);

expect(fetch).toHaveBeenCalledWith('http://example.com', {
method: HttpMethod.GET,
headers: { Authorization: 'Bearer token' },
});
});

it('should have correct fetch options', async () => {
const mockData = { key: 'value' };
(fetch as jest.Mock).mockImplementationOnce(() => ({
ok: true,
json: () => Promise.resolve(mockData),
}));

await sendRequest('http://example.com', HttpMethod.POST, { key: 'value' });

expect(fetch).toHaveBeenCalledWith('http://example.com', {
method: HttpMethod.POST,
headers: {},
body: JSON.stringify({ key: 'value' }),
});
});

it('should throw an AUTH error when authRequired is true and no auth data is found', async () => {
(getAuthDataFromSessionStorage as jest.Mock).mockReturnValueOnce(null);

await expect(sendRequest('http://example.com', HttpMethod.GET, {}, true)).rejects.toThrow(ApiAuthorizationError);
});
});
18 changes: 18 additions & 0 deletions Client/reasn-client/packages/common/enums/serviceEnums.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/**
* Enum representing HTTP methods.
*/
export enum HttpMethod {
GET = "GET",
POST = "POST",
DELETE = "DELETE",
PUT = "PUT"
}

/**
* Enum representing available user roles.
*/
export enum UserRole {
ADMIN = 'admin',
USER = 'user',
ORGANIZER = 'organizer'
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/**
* Represents an error that occurs when there is a problem with the authorization token when API service is used.
*/
class ApiAuthorizationError extends Error {
message: string

/**
* Creates a new instance of the ApiAuthorizationError class.
* @param message The error message.
*/
constructor(message: string) {
super(message)
this.message = message
this.name = 'ApiAuthorizationError'
}
}

export default ApiAuthorizationError
22 changes: 22 additions & 0 deletions Client/reasn-client/packages/common/errors/ApiConnectionError.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

/**
* Represents an error that occurs when there is a problem with the API connection.
*/
class ApiConnectionError extends Error {
statusCode: number
message: string

/**
* Creates a new instance of the ApiConnectionError class.
* @param statusCode The HTTP status code associated with the error.
* @param message The error message.
*/
constructor(statusCode: number, message: string) {
super(message)
this.statusCode = statusCode
this.message = message
this.name = 'ApiConnectionError'
}
}

export default ApiConnectionError
9 changes: 9 additions & 0 deletions Client/reasn-client/packages/common/interfaces/AuthData.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { UserRole } from "@reasn/common/enums/serviceEnums"

/**
* Represents the authentication data.
*/
export interface AuthData {
token: string
role: UserRole
}
Loading

0 comments on commit 0ff6a92

Please sign in to comment.