added more tests; realigned the jest config (#15)

* added more tests; realigned the jest config * increased coverage for profile/index.ts * added tests for all functions in profile class * added tests for disputes class * removed extra comments and only * added ci.yml * added tests for Escrow class * added tests for platform and proposals * added tests for escrow services and utils * removed extra log * added specs for client main file and reviews
TalentLayer · Nov 25, 2023 · 2d6f059 · 2d6f059
1 parent 5dd9462
commit 2d6f059
Show file tree

Hide file tree

Showing 25 changed files with 1,262 additions and 72 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: ["develop"]
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  build:
+    name: Unit Tests
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Test
+        run: npm run test
diff --git a/package.json b/package.json
@@ -4,7 +4,8 @@
     "build": "turbo run build",
     "dev": "turbo run dev",
     "lint": "turbo run lint",
-    "format": "prettier --write \"**/*.{ts,tsx,md}\""
+    "format": "prettier --write \"**/*.{ts,tsx,md}\"",
+    "test": "turbo test"
   },
   "devDependencies": {
     "@types/jest": "^29.5.8",

diff --git a/packages/client/jest.config.js b/packages/client/jest.config.js
@@ -4,7 +4,7 @@ module.exports = {
   testEnvironment: 'node',
   rootDir: './',
   coverageDirectory: '<rootDir>/coverage',
-  collectCoverageFrom: ['<rootDir>/packages/client/src/**/*.ts'],
+  collectCoverageFrom: ['<rootDir>/src/**/*.ts'],
   testPathIgnorePatterns: ['<rootDir>/node_modules'],
   coverageReporters: ['json', 'lcov', 'html']
 };
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -12,7 +12,7 @@
     "prepare": "npm run build",
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "dev": "npm run build -- --watch",
-    "test": "jest --coverage"
+    "test": "jest --verbose --coverage"
   },
   "devDependencies": {
     "@turbo/gen": "^1.10.12",

diff --git a/packages/client/src/__mocks__/clientMocks.ts b/packages/client/src/__mocks__/clientMocks.ts
@@ -0,0 +1,105 @@
+import { getPaymentsByService, getProtocolAndPlatformsFees } from "../escrow/graphql/queries";
+import { getPlatformById, getPlatformsByOwner, getProtocolById } from "../platform/graphql/queries";
+import { getMintFees, getPaymentsForUser, getProfileByAddress, getProfileById, getProfiles, getUserTotalGains } from "../profile/graphql";
+import { getAllProposalsByServiceId, getAllProposalsByUser, getProposalById } from "../proposals/graphql";
+import { getReviewsByService } from "../reviews/graphql";
+import { getOne, getServices, searchServices } from "../services/graphql/queries";
+import { mockGraphQlMintFeesResponse, mockGraphQlProtocolByIdResponse, mockGraphQlUsersResponse, testAddress, testChainId, testGetProfilesResponse, testIpfsHash, testOwnerAddress, testPaymentsByServiceResponse, testPlatformId, testPlatformResponse, testPlatformResponseWithArbitrator, testPlatformsByOwnerResponse, testProposalId, testProposalIdWithDifferentRateToken, testProposalResponse, testProposalResponseWithDifferentRateToken, testProposalsByServiceId, testProposalsByUser, testProtocolAndPlatformResponse, testReviewsByService, testSearchServiceProps, testSearchServicesResponse, testServiceId, testServiceResponse, testUserId, testUserPaymentsResponse, testUserResponse, testUserTotalGainsResponse } from "./fixtures";
+
+export class MockGraphQLClient {
+    get = jest.fn(async (query: string) => {
+        if (query === getProfileByAddress(testAddress)) {
+            return mockGraphQlUsersResponse;
+        }
+
+        if (query === getMintFees()) {
+            return mockGraphQlMintFeesResponse
+        }
+
+        if (query === getProtocolById(1)) {
+            return mockGraphQlProtocolByIdResponse;
+        }
+
+        if (query === getProfileById(testUserId)) {
+            return testUserResponse;
+        }
+
+        if (query === getProfiles(1, 0, 'racoon')) {
+            return testGetProfilesResponse;
+        }
+
+        if (query === getPaymentsForUser(testUserId)) {
+            return testUserPaymentsResponse;
+        }
+
+        if (query === getUserTotalGains(testUserId)) {
+            return testUserTotalGainsResponse;
+        }
+
+        if (query === getPlatformById(testPlatformId.toString())) {
+            return testPlatformResponse;
+        }
+
+        if (query === getPlatformById("2")) {
+            return testPlatformResponseWithArbitrator;
+        }
+
+        if (query === getProposalById(testProposalId)) {
+            return testProposalResponse;
+        }
+
+        if (query === getProposalById(testProposalIdWithDifferentRateToken)) {
+            return testProposalResponseWithDifferentRateToken;
+        }
+
+        if (query === getProtocolAndPlatformsFees(testProposalResponse.data.proposal.service.platform.id, testProposalResponse.data.proposal.platform.id)) {
+            return testProtocolAndPlatformResponse;
+        }
+
+        if (query === getOne(testServiceId)) {
+            return testServiceResponse;
+        }
+
+        if (query === getPaymentsByService(testServiceId)) {
+            return testPaymentsByServiceResponse;
+        }
+
+        if (query === getPlatformsByOwner(testOwnerAddress)) {
+            return testPlatformsByOwnerResponse;
+        }
+
+        if (query === getAllProposalsByServiceId(testServiceId)) {
+            return testProposalsByServiceId;
+        }
+
+        if (query === getAllProposalsByUser(testUserId)) {
+            return testProposalsByUser;
+        }
+
+        if (query === searchServices(testSearchServiceProps) || query === getServices(testSearchServiceProps)) {
+            return testSearchServicesResponse;
+        }
+
+        if (query === getReviewsByService(testServiceId)) {
+            return testReviewsByService;
+        }
+
+        return { data: { "racoon": "bar" } };
+    })
+
+}
+
+export class MockViemClient {
+    writeContract = jest.fn(async () => testAddress)
+    chainId = 137;
+    readContract = jest.fn(async () => "randomData")
+    publicClient = {
+        readContract: jest.fn(async () => "randomData"),
+        waitForTransactionReceipt: jest.fn(async () => ({ status: 'success' }))
+    }
+
+}
+
+export class MockIPFSClient {
+    post = jest.fn().mockResolvedValue(testIpfsHash);
+}
diff --git a/packages/client/src/__mocks__/fixtures.ts b/packages/client/src/__mocks__/fixtures.ts
@@ -0,0 +1,118 @@
+import { ServiceStatusEnum } from "../services/enums";
+import { IProps } from "../services/types";
+
+export const testAddress = "0xRacoon";
+export const testName = 'racoon';
+export const testUserId = '2371';
+export const testChainId = 137;
+export const testUserResponse = {
+    data: {
+        user: {
+            id: '1',
+            address: '0x870b08a222f8eac75b6bf85988df7597c0ae20a9',
+            handle: 'talentlayer',
+            rating: '0',
+            delegates: [],
+            userStats: { numReceivedReviews: '0' },
+            updatedAt: '1680621215',
+            createdAt: '1680608213',
+            description: {
+                about: 'TalentLayer is composable, decentralized, open-source infrastructure for talent markets; allowing anyone to easily build interoperable gig marketplaces.',
+                role: 'buyer',
+                name: 'TalentLayer',
+                country: null,
+                headline: null,
+                id: 'QmeTSoJnRNZ6WNeVa5mQ2rkdfALjy4EdyLgTyYyq2AWDAn-1680621215',
+                image_url: null,
+                video_url: null,
+                title: 'Future of work builder',
+                timezone: null,
+                skills_raw: 'solidity,blockchain',
+                web3mailPreferences: null
+            }
+        }
+    }
+}
+export const testAbout = 'a helpful racoon here to help with tests';
+export const testPlatformId = 1;
+export const mockGraphQlUsersResponse = { data: { users: [{ name: testName }] } };
+export const mockGraphQlMintFeesResponse = {
+    data: {
+        protocols: [
+            {
+                userMintFee: '1000000000000000000',
+                shortHandlesMaxPrice: '200000000000000000000'
+            }
+        ]
+    }
+}
+
+
+export const mockGraphQlProtocolByIdResponse = {
+    data: {
+        protocol: {
+            id: '1',
+            userMintFee: '1000000000000000000',
+            platformMintFee: '0',
+            protocolEscrowFeeRate: 100,
+            totalMintFees: '12929000000000000000000',
+            minArbitrationFeeTimeout: '864000',
+            shortHandlesMaxPrice: '200000000000000000000',
+            minServiceCompletionPercentage: '30'
+        }
+    }
+}
+export const testIpfsHash = 'abcd';
+export const testCid = testIpfsHash;
+export const testProfileData = { name: testName, about: testAbout };
+export const testGetProfilesResponse = { "data": { "users": [{ "id": "11962", "address": "0x02289d0ebf8836e6f98af170b88b9f8eb889e2c6", "handle": "racoon", "userStats": { "numReceivedReviews": "0" }, "rating": "0" }] } }
+export const testUserTotalGainsResponse = { data: { user: { totalGains: [{ "id": "2371-0x2791bca1f2de4661ed88a30c99a7a9449aa84174", "totalGain": "850000000", "token": { "id": "0xracoon", "name": "USD Coin (PoS)", "symbol": "USDC", "decimals": "6" } }] } } }
+export const testUserPaymentsResponse = { data: { payments: [{ "id": "0x3eb5973863d712ce78dc757af04ca24a81d0376dbce604d002779475428e4a85-975", "rateToken": { "address": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174", "decimals": "6", "name": "USD Coin (PoS)", "symbol": "USDC" }, "amount": "850000000", "transactionHash": "0x3eb5973863d712ce78dc757af04ca24a81d0376dbce604d002779475428e4a85", "paymentType": "Release", "createdAt": "1699361940", "service": { "id": "75", "cid": "abcd" } }] } }
+
+export const testPlatformResponse = { "data": { "platform": { "id": "1", "address": "0xracoon", "name": "abcd", "createdAt": "1681454011", "updatedAt": "1681454011", "originServiceFeeRate": 0, "originValidatedProposalFeeRate": 0, "servicePostingFee": "0", "proposalPostingFee": "0", "arbitrator": "0x0000000000000000000000000000000000000000", "arbitratorExtraData": "0x00000000", "arbitrationFeeTimeout": "864000", "cid": null, "signer": "0xraqcoon", "description": null } } }
+
+export const testPlatformResponseWithArbitrator = { "data": { "platform": { "id": "1", "address": "0xracoon", "name": "abcd", "createdAt": "1681454011", "updatedAt": "1681454011", "originServiceFeeRate": 0, "originValidatedProposalFeeRate": 0, "servicePostingFee": "0", "proposalPostingFee": "0", "arbitrator": "0xracoon", "arbitratorExtraData": "0x00000000", "arbitrationFeeTimeout": "864000", "cid": null, "signer": "0xraqcoon", "description": null } } }
+export const testProposalId = '12-83';
+export const testProposalIdWithDifferentRateToken = '12-84';
+export const testProposalResponse = { "data": { "proposal": { "id": testProposalId, "seller": { "id": "83", "handle": "maartenvantwout", "address": "0x9c8ca52fa6f12fd7b70c6b6e9a2704149af676ea", "cid": "QmWm6biFCf1GwNj7u78ub7c1dgPDHphd285KzmtddYWQu9", "rating": "0", "userStats": { "numReceivedReviews": "0" } }, "platform": { "id": "1" }, "service": { "id": "12", "platform": { "id": "1" } }, "cid": "abcd", "rateToken": { "address": "0x0000000000000000000000000000000000000000" }, "rateAmount": "10000000000000000000", "description": { "about": "I would love to do this job", "video_url": null }, "status": "Validated", "expirationDate": "1685796297" } } };
+export const testProposalResponseWithDifferentRateToken = { "data": { "proposal": { "id": testProposalId, "seller": { "id": "83", "handle": "maartenvantwout", "address": "0x9c8ca52fa6f12fd7b70c6b6e9a2704149af676ea", "cid": "QmWm6biFCf1GwNj7u78ub7c1dgPDHphd285KzmtddYWQu9", "rating": "0", "userStats": { "numReceivedReviews": "0" } }, "platform": { "id": "1" }, "service": { "id": "12", "platform": { "id": "1" } }, "cid": "abcd", "rateToken": { "address": testAddress }, "rateAmount": "10000000000000000000", "description": { "about": "I would love to do this job", "video_url": null }, "status": "Validated", "expirationDate": "1685796297" } } }
+export const testProtocolAndPlatformResponse = { "data": { "protocols": [{ "protocolEscrowFeeRate": 100 }], "servicePlatform": { "originServiceFeeRate": 0 }, "proposalPlatform": { "originValidatedProposalFeeRate": 0 } } }
+export const testServiceId = '12'; // rest to 12 before comitting
+export const testAmount = BigInt('1000');
+export const testServiceResponse = { "data": { "service": { "id": "12", "status": "Finished", "createdAt": "1683203526", "cid": "QmdZhsfn1BhE3shW8TeR4f22MCG7nTWTtT55NkwH6McWfJ", "transaction": { "id": "2" }, "buyer": { "id": "11207", "handle": "0xrik", "address": "0x946f0711dfea25dc2ab60e6ff0df6dbda32ee6c6", "rating": "0", "userStats": { "numReceivedReviews": "0" } }, "seller": { "id": "83", "handle": "maartenvantwout" }, "proposals": [{ "id": "12-83" }], "validatedProposal": [{ "id": "12-83", "rateToken": { "address": "0x0000000000000000000000000000000000000000", "decimals": "18", "name": "Polygon", "symbol": "MATIC" }, "rateAmount": "10000000000000000000" }], "description": { "id": "QmdZhsfn1BhE3shW8TeR4f22MCG7nTWTtT55NkwH6McWfJ-1683203526", "title": "Create a logo", "video_url": null, "about": "Create a logo for our company", "startDate": null, "expectedEndDate": null, "rateAmount": "1000000000000000000", "rateToken": "0x0000000000000000000000000000000000000000", "keywords_raw": "ux/ui,3d graphic design software", "keywords": [] } } } };
+export const testSearchServicesResponse = { data: { "services": [{ "id": "12", "status": "Finished", "createdAt": "1683203526", "cid": "QmdZhsfn1BhE3shW8TeR4f22MCG7nTWTtT55NkwH6McWfJ", "transaction": { "id": "2" }, "buyer": { "id": "11207", "handle": "0xrik", "address": "0x946f0711dfea25dc2ab60e6ff0df6dbda32ee6c6", "rating": "0", "userStats": { "numReceivedReviews": "0" } }, "seller": { "id": "83", "handle": "maartenvantwout" }, "proposals": [{ "id": "12-83" }], "validatedProposal": [{ "id": "12-83", "rateToken": { "address": "0x0000000000000000000000000000000000000000", "decimals": "18", "name": "Polygon", "symbol": "MATIC" }, "rateAmount": "10000000000000000000" }], "description": { "id": "QmdZhsfn1BhE3shW8TeR4f22MCG7nTWTtT55NkwH6McWfJ-1683203526", "title": "Create a logo", "video_url": null, "about": "Create a logo for our company", "startDate": null, "expectedEndDate": null, "rateAmount": "1000000000000000000", "rateToken": "0x0000000000000000000000000000000000000000", "keywords_raw": "ux/ui,3d graphic design software", "keywords": [] } }] } }
+export const testServiceDetails = {
+    title: 'test title',
+    about: 'test about',
+    keywords: 'web3,racoon',
+    rateToken: testAddress,
+    rateAmount: testAmount.toString()
+}
+export const testPaymentsByServiceResponse = { "data": { "payments": [{ "id": "0xbae7cb57cef86c17a0ca0ca9af0f1b845912fe65448169f0a93a15e5e6dfae25-200", "amount": "10000000000000000000", "rateToken": { "address": "0x0000000000000000000000000000000000000000", "decimals": "18", "name": "Polygon", "symbol": "MATIC" }, "paymentType": "Release", "transactionHash": "0xbae7cb57cef86c17a0ca0ca9af0f1b845912fe65448169f0a93a15e5e6dfae25", "createdAt": "1683204479" }] } }
+export const testPlatformDetails = {
+    about: 'test data',
+    website: 'example.com',
+    video_url: 'example.com',
+    image_url: 'example.com'
+}
+
+export const testOwnerAddress = '0xOwnerAddress';
+export const testPlatformsByOwnerResponse = { "data": { "platforms": [{ "id": "1", "address": "0x4444444e2f8ccd0e323c959b02a93561b911f9b6", "name": "workx", "createdAt": "1681454011", "updatedAt": "1681454011", "originServiceFeeRate": 0, "originValidatedProposalFeeRate": 0, "servicePostingFee": "0", "proposalPostingFee": "0", "arbitrator": "0x0000000000000000000000000000000000000000", "arbitratorExtraData": "0x00000000", "arbitrationFeeTimeout": "864000", "cid": null, "signer": "0x4444444e2f8ccd0e323c959b02a93561b911f9b6", "description": null }] } }
+export const testProposalsByServiceId = { "data": { "proposals": [{ "id": testProposalId, "seller": { "id": "83", "handle": "maartenvantwout", "address": "0x9c8ca52fa6f12fd7b70c6b6e9a2704149af676ea", "cid": "QmWm6biFCf1GwNj7u78ub7c1dgPDHphd285KzmtddYWQu9", "rating": "0", "userStats": { "numReceivedReviews": "0" } }, "platform": { "id": "1" }, "service": { "id": "12", "platform": { "id": "1" } }, "cid": "abcd", "rateToken": { "address": "0x0000000000000000000000000000000000000000" }, "rateAmount": "10000000000000000000", "description": { "about": "I would love to do this job", "video_url": null }, "status": "Validated", "expirationDate": "1685796297" }] } }
+export const testProposalsByUser = { "data": { "proposals": [{ "id": testProposalId, "seller": { "id": "83", "handle": "maartenvantwout", "address": "0x9c8ca52fa6f12fd7b70c6b6e9a2704149af676ea", "cid": "QmWm6biFCf1GwNj7u78ub7c1dgPDHphd285KzmtddYWQu9", "rating": "0", "userStats": { "numReceivedReviews": "0" } }, "platform": { "id": "1" }, "service": { "id": "12", "platform": { "id": "1" } }, "cid": "abcd", "rateToken": { "address": "0x0000000000000000000000000000000000000000" }, "rateAmount": "10000000000000000000", "description": { "about": "I would love to do this job", "video_url": null }, "status": "Validated", "expirationDate": "1685796297" }] } }
+export const testProposalDetails = { about: 'test about', video_url: 'hello world' }
+export const testExpirationDate = '123456';
+export const testSignature = '';
+export const testSearchServiceProps: IProps = {
+    serviceStatus: ServiceStatusEnum.Opened
+}
+export const testMetaEvidenceCid = 'testMetaEvidenceCid';
+
+export const testReviewDetails = {
+    content: 'test content',
+    rating: 1
+}
+
+export const testReviewsByService = {
+    data: { "reviews": [{ "id": "2", "rating": "5", "createdAt": "1680027301", "service": { "id": "1", "status": "Finished" }, "to": { "id": "1", "handle": "thomas" }, "description": { "id": "QmRN1ZBFAkSXX34YBd6JrVaSNJWLmt7UVPXvTuXfH2dmUq-1680027301", "content": "Top :)" } }, { "id": "1", "rating": "5", "createdAt": "1680027235", "service": { "id": "1", "status": "Finished" }, "to": { "id": "2", "handle": "migmig" }, "description": { "id": "QmW612hUxvg1SigPA5Y3msuBEuXfLaH3axp22dr1kwCXp8-1680027235", "content": "Perfect!" } }] }
+}
diff --git a/packages/client/src/__tests__/talentLayerClient.spec.ts b/packages/client/src/__tests__/talentLayerClient.spec.ts
@@ -0,0 +1,65 @@
+
+import { ERC20 } from '../blockchain-bindings/erc20';
+import { Disputes } from '../disputes';
+import { Escrow } from '../escrow';
+import { TalentLayerClient } from '../index';
+import { Platform } from '../platform';
+import { Profile } from '../profile';
+import { Proposal } from '../proposals';
+import { Review } from '../reviews';
+import { Service } from '../services';
+import { testPlatformId } from '../__mocks__/fixtures';
+
+
+jest.mock('axios')
+jest.mock('ipfs-http-client', () => ({
+    create: jest.fn().mockImplementation(() => ({
+        add: jest.fn().mockResolvedValue({ path: '0xracoon' }), // Mocking the add method of IPFS client
+    })),
+}));
+
+describe('TalentLayerClient', () => {
+    let client: any;
+
+    beforeEach(() => {
+        Object.defineProperty(globalThis, 'window', {
+        });
+        const chainId = 137;
+        const ipfsConfig = {
+            clientId: 'abcd',
+            clientSecret: 'abcde',
+            baseUrl: 'www.example.com'
+        }
+        const viemConfig = {};
+        const platformID = testPlatformId;
+        const signatureApiUrl = 'www.example.com';
+        client = new TalentLayerClient({
+            chainId: chainId,
+            ipfsConfig: ipfsConfig,
+            platformId: testPlatformId,
+            signatureApiUrl: signatureApiUrl
+        })
+
+
+    })
+
+    describe('constructor', () => {
+        it('should be initialised successfully', async () => {
+            expect(client).toBeDefined()
+
+        })
+    })
+
+    describe('getters', () => {
+        it('should return all domain specific getters', async () => {
+            expect(client.platform).toBeInstanceOf(Platform)
+            expect(client.erc20).toBeInstanceOf(ERC20)
+            expect(client.proposal).toBeInstanceOf(Proposal)
+            expect(client.disputes).toBeInstanceOf(Disputes)
+            expect(client.service).toBeInstanceOf(Service)
+            expect(client.profile).toBeInstanceOf(Profile)
+            expect(client.escrow).toBeInstanceOf(Escrow)
+            expect(client.review).toBeInstanceOf(Review)
+        })
+    })
+});