feat: let's get to 100% unit-test coverage (coinbase#256)

.changeset/olive-fishes-happen.md

@@ -0,0 +1,5 @@
+---
+'@coinbase/onchainkit': minor
+---
+
+- **feat**: 100% unit-test coverage. By @zizzamia #256

README.md

@@ -1,8 +1,8 @@
 <p align="center">
   <a href="https://onchainkit.xyz">
     <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="./site/docs/public/logo/v0-10.png">
-      <img alt="OnchainKit logo vibes" src="./site/docs/public/logo/v0-10.png" width="auto">
+      <source media="(prefers-color-scheme: dark)" srcset="./site/docs/public/logo/v0-11.png">
+      <img alt="OnchainKit logo vibes" src="./site/docs/public/logo/v0-11.png" width="auto">
     </picture>
   </a>
 </p>

jest.config.js

@@ -1,10 +1,10 @@
 module.exports = {
   coverageThreshold: {
     global: {
-      branches: 94.8,
-      functions: 93,
-      lines: 95.5,
-      statements: 95.3,
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100,
     },
   },
   modulePathIgnorePatterns: ['<rootDir>/framegear/'],

src/frame/getFrameMessage.test.ts

@@ -1,22 +1,45 @@
-import { mockNeynarResponse } from './mock';
 import { getFrameMessage } from './getFrameMessage';
 import { getMockFrameRequest } from './getMockFrameRequest';
-import { neynarBulkUserLookup } from '../utils/neynar/user/neynarUserFunctions';
+import { neynarBulkUserLookup } from '../utils/neynar/user/neynarBulkUserLookup';
 import { FrameRequest } from './types';
-import { neynarFrameValidation } from '../utils/neynar/frame/neynarFrameFunctions';
+import { neynarFrameValidation } from '../utils/neynar/frame/neynarFrameValidation';
 
-jest.mock('../utils/neynar/user/neynarUserFunctions', () => {
+jest.mock('../utils/neynar/user/neynarBulkUserLookup', () => {
   return {
     neynarBulkUserLookup: jest.fn(),
   };
 });
 
-jest.mock('../utils/neynar/frame/neynarFrameFunctions', () => {
+jest.mock('../utils/neynar/frame/neynarFrameValidation', () => {
   return {
     neynarFrameValidation: jest.fn(),
   };
 });
 
+function mockNeynarResponse(
+  fid: number,
+  addresses: string[] | undefined,
+  lookupMock: jest.Mock,
+  frameValidationMock: jest.Mock = jest.fn(),
+) {
+  const neynarResponse = {
+    users: [
+      {
+        verifications: addresses,
+      },
+    ],
+  };
+  lookupMock.mockResolvedValue(neynarResponse);
+
+  frameValidationMock.mockResolvedValue({
+    valid: true,
+    interactor: {
+      fid,
+      verified_accounts: addresses,
+    },
+  });
+}
+
 describe('getFrameValidatedMessage', () => {
   it('should return undefined if the message is invalid', async () => {
     const result = await getFrameMessage({

src/frame/getFrameMessage.ts

@@ -2,7 +2,7 @@ import { FrameRequest, FrameValidationResponse, MockFrameRequest } from './types
 import {
   NEYNAR_DEFAULT_API_KEY,
   neynarFrameValidation,
-} from '../utils/neynar/frame/neynarFrameFunctions';
+} from '../utils/neynar/frame/neynarFrameValidation';
 
 type FrameMessageOptions =
   | {

src/identity/easSupportedChains.test.ts

@@ -0,0 +1,26 @@
+import { base, baseSepolia, optimism, zora } from 'viem/chains';
+import { getChainEASGraphQLAPI } from './easSupportedChains';
+
+describe('easSupportedChains', () => {
+  describe('getChainEASGraphQLAPI', () => {
+    it('should return Base Chain EAS GraphQL API', async () => {
+      const chainEASGraphQLAPI = getChainEASGraphQLAPI(base);
+      expect(chainEASGraphQLAPI).toEqual('https://base.easscan.org/graphql');
+    });
+
+    it('should return Base Sepolia Chain EAS GraphQL API', async () => {
+      const chainEASGraphQLAPI = getChainEASGraphQLAPI(baseSepolia);
+      expect(chainEASGraphQLAPI).toEqual('https://base-sepolia.easscan.org/graphql');
+    });
+
+    it('should return Optimism Chain EAS GraphQL API', async () => {
+      const chainEASGraphQLAPI = getChainEASGraphQLAPI(optimism);
+      expect(chainEASGraphQLAPI).toEqual('https://optimism.easscan.org/graphql');
+    });
+
+    it('should return empty string when Chain EAS GraphQL API is not present', async () => {
+      const chainEASGraphQLAPI = getChainEASGraphQLAPI(zora);
+      expect(chainEASGraphQLAPI).toEqual('');
+    });
+  });
+});

src/utils/easAttestation.ts → src/identity/easSupportedChains.ts

@@ -1,5 +1,5 @@
 import type { Chain } from 'viem';
-import { EASChainDefinition } from '../identity/types';
+import { EASChainDefinition } from './types';
 import { easChainBase } from '../definitions/base';
 import { easChainOptimism } from '../definitions/optimism';
 import { easChainBaseSepolia } from '../definitions/baseSepolia';

src/identity/getEASAttestations.test.ts

@@ -4,7 +4,7 @@
 
 import { getEASAttestationsByFilter } from '../queries/easAttestations';
 import { getEASAttestations } from './getEASAttestations';
-import { easSupportedChains } from '../utils/easAttestation';
+import { easSupportedChains } from '../identity/easSupportedChains';
 import { base, opBNBTestnet } from 'viem/chains';
 import { GetEASAttestationsOptions } from './types';
 

src/identity/getEASAttestations.ts

@@ -1,5 +1,5 @@
 import { getEASAttestationsByFilter } from '../queries/easAttestations';
-import { isChainSupported, easSupportedChains } from '../utils/easAttestation';
+import { isChainSupported, easSupportedChains } from './easSupportedChains';
 import { EASAttestation, GetEASAttestationsOptions } from './types';
 import type { Address, Chain } from 'viem';
 

src/identity/getSlicedAddress.ts

@@ -1,9 +1,6 @@
 /**
- * getSlicedAddress returns the first 5 and last 4 characters of an address.
+ * Returns the first 5 and last 4 characters of an address.
  */
-export const getSlicedAddress = (address: `0x${string}` | undefined) => {
-  if (!address) {
-    return '';
-  }
+export const getSlicedAddress = (address: `0x${string}`) => {
   return `${address.slice(0, 5)}...${address.slice(-4)}`;
 };

src/identity/hooks/useAvatar.ts

@@ -17,9 +17,12 @@ type UseNameQueryOptions = {
   cacheTime?: number;
 };
 
+/**
+ * Gets an ensName and resolves the Avatar
+ */
 export const useAvatar = ({ ensName }: UseNameOptions, queryOptions?: UseNameQueryOptions) => {
   const { enabled = true, cacheTime } = queryOptions ?? {};
-  const ensActionKey = `ens-avatar-${ensName}` ?? '';
+  const ensActionKey = `ens-avatar-${ensName}`;
   return useQuery<GetEnsAvatarReturnType>({
     queryKey: ['useAvatar', ensActionKey],
     queryFn: async () => {

src/network/createEasGraphQLClient.test.ts

@@ -0,0 +1,9 @@
+import { base } from 'viem/chains';
+import { createEasGraphQLClient } from './createEasGraphQLClient';
+
+describe('createEasGraphQLClient', () => {
+  it('should return a easGraphqlClient', () => {
+    const easGraphqlClient = createEasGraphQLClient(base);
+    expect(easGraphqlClient.requestConfig).toEqual({});
+  });
+});

src/network/easGraphQL.ts → src/network/createEasGraphQLClient.ts

@@ -1,6 +1,6 @@
 import { GraphQLClient } from 'graphql-request';
 import type { Chain } from 'viem';
-import { getChainEASGraphQLAPI } from '../utils/easAttestation'; // Adjust the import path as needed
+import { getChainEASGraphQLAPI } from '../identity/easSupportedChains';
 
 export function createEasGraphQLClient(chain: Chain): GraphQLClient {
   const endpoint = getChainEASGraphQLAPI(chain);

src/queries/easAttestations.test.ts

@@ -4,10 +4,10 @@ import {
   getEASAttestationsByFilter,
   easAttestationQuery,
 } from './easAttestations';
-import { createEasGraphQLClient } from '../network/easGraphQL';
+import { createEasGraphQLClient } from '../network/createEasGraphQLClient';
 import { base } from 'viem/chains';
 
-jest.mock('../network/easGraphQL');
+jest.mock('../network/createEasGraphQLClient');
 
 describe('EAS Attestation Service', () => {
   const mockAddress = '0xdbf03b407c01e7cd3cbea99509d93f8dddc8c6fb';

src/queries/easAttestations.ts

@@ -2,7 +2,7 @@ import { gql } from 'graphql-request';
 import type { Address, Chain } from 'viem';
 import { getAddress } from 'viem';
 import { EASSchemaUid, EASAttestation } from '../identity/types';
-import { createEasGraphQLClient } from '../network/easGraphQL';
+import { createEasGraphQLClient } from '../network/createEasGraphQLClient';
 
 /**
  * Type representing the filter options used for querying EAS Attestations.

src/utils/neynar/frame/neynarFrameFunctions.test.ts → src/utils/neynar/frame/neynarFrameValidation.test.ts

@@ -1,5 +1,5 @@
 import { FetchError } from '../exceptions/FetchError';
-import { neynarFrameValidation } from './neynarFrameFunctions';
+import { neynarFrameValidation } from './neynarFrameValidation';
 
 describe('neynar frame functions', () => {
   let fetchMock = jest.fn();

src/utils/neynar/frame/neynarFrameFunctions.ts → src/utils/neynar/frame/neynarFrameValidation.ts

@@ -1,5 +1,5 @@
 import { FrameValidationData } from '../../../frame/types';
-import { convertToNeynarResponseModel } from './neynarFrameModels';
+import { convertToNeynarResponseModel } from './convertToNeynarResponseModel';
 import { postDataToNeynar } from '../postDataToNeynar';
 
 export const NEYNAR_DEFAULT_API_KEY = 'NEYNAR_ONCHAIN_KIT';

src/utils/neynar/getDataFromNeynar.test.ts

@@ -0,0 +1,33 @@
+import { version } from '../../version';
+import { NEYNAR_DEFAULT_API_KEY } from './frame/neynarFrameValidation';
+import { getDataFromNeynar } from './getDataFromNeynar';
+
+describe('getDataFromNeynar', () => {
+  let fetchMock = jest.fn();
+  let status = 200;
+
+  beforeEach(() => {
+    status = 200;
+    global.fetch = jest.fn(() =>
+      Promise.resolve({
+        status,
+        json: fetchMock,
+      }),
+    ) as jest.Mock;
+  });
+
+  it('should call fetch correctly', async () => {
+    const apiURLMock = 'https://api.neynar.com/v2/amazing-api';
+    await getDataFromNeynar(apiURLMock);
+    expect(global.fetch).toHaveBeenCalledWith(apiURLMock, {
+      method: 'GET',
+      url: apiURLMock,
+      headers: {
+        accept: 'application/json',
+        api_key: NEYNAR_DEFAULT_API_KEY,
+        'content-type': 'application/json',
+        onchainkit_version: version,
+      },
+    });
+  });
+});

src/utils/neynar/getDataFormNeynar.ts → src/utils/neynar/getDataFromNeynar.ts

@@ -1,6 +1,6 @@
 import { version } from '../../version';
 import { FetchError } from './exceptions/FetchError';
-import { NEYNAR_DEFAULT_API_KEY } from './frame/neynarFrameFunctions';
+import { NEYNAR_DEFAULT_API_KEY } from './frame/neynarFrameValidation';
 
 export async function getDataFromNeynar(url: string, apiKey: string = NEYNAR_DEFAULT_API_KEY) {
   const options = {

src/utils/neynar/neynar.integ.ts

@@ -1,5 +1,5 @@
-import { neynarBulkUserLookup } from './user/neynarUserFunctions';
-import { neynarFrameValidation } from './frame/neynarFrameFunctions';
+import { neynarBulkUserLookup } from './user/neynarBulkUserLookup';
+import { neynarFrameValidation } from './frame/neynarFrameValidation';
 import { getCustodyAddressForFidNeynar } from './user/getCustodyAddressForFidNeynar';
 import { getVerifiedAddressesForFidNeynar } from './user/getVerifiedAddressesForFidNeynar';
 

src/utils/neynar/postDataToNeynar.test.ts

@@ -0,0 +1,35 @@
+import { version } from '../../version';
+import { NEYNAR_DEFAULT_API_KEY } from './frame/neynarFrameValidation';
+import { postDataToNeynar } from './postDataToNeynar';
+
+describe('postDataToNeynar', () => {
+  let fetchMock = jest.fn();
+  let status = 200;
+
+  beforeEach(() => {
+    status = 200;
+    global.fetch = jest.fn(() =>
+      Promise.resolve({
+        status,
+        json: fetchMock,
+      }),
+    ) as jest.Mock;
+  });
+
+  it('should call fetch correctly', async () => {
+    const mockURL = 'https://api.neynar.com/v2/amazing-api';
+    const mockData = {};
+    await postDataToNeynar(mockURL, NEYNAR_DEFAULT_API_KEY, mockData);
+    expect(global.fetch).toHaveBeenCalledWith(mockURL, {
+      method: 'POST',
+      url: mockURL,
+      headers: {
+        accept: 'application/json',
+        api_key: NEYNAR_DEFAULT_API_KEY,
+        'content-type': 'application/json',
+        onchainkit_version: version,
+      },
+      body: JSON.stringify(mockData),
+    });
+  });
+});

src/utils/neynar/postDataToNeynar.ts

@@ -1,12 +1,7 @@
 import { version } from '../../version';
 import { FetchError } from './exceptions/FetchError';
-import { NEYNAR_DEFAULT_API_KEY } from './frame/neynarFrameFunctions';
 
-export async function postDataToNeynar(
-  url: string,
-  apiKey: string = NEYNAR_DEFAULT_API_KEY,
-  data: any,
-) {
+export async function postDataToNeynar(url: string, apiKey: string, data: any) {
   const options = {
     method: 'POST',
     url: url,