process unexpected response from solidityscan

blockscout · Aug 8, 2024 · 403355d · 403355d
1 parent cec56f1
commit 403355d
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 31 deletions.
diff --git a/types/api/contract.ts b/types/api/contract.ts
@@ -104,29 +104,32 @@ export interface SmartContractVerificationError {
   name?: Array<string>;
 }
 
+// it's an external API proxy, we can't guarantee the responce types
 export type SolidityscanReport = {
-  scan_report: {
-    contractname: string;
-    scan_status: string;
-    scan_summary: {
-      issue_severity_distribution: {
-        critical: number;
-        gas: number;
-        high: number;
-        informational: number;
-        low: number;
-        medium: number;
-      };
-      lines_analyzed_count: number;
-      scan_time_taken: number;
-      score: string;
-      score_v2: string;
-      threat_score: string;
+  scan_report?: {
+    contractname?: string;
+    scan_status?: string;
+    scan_summary?: {
+      issue_severity_distribution?: SolidityscanReportSeverityDistribution;
+      lines_analyzed_count?: number;
+      scan_time_taken?: number;
+      score?: string;
+      score_v2?: string;
+      threat_score?: string;
     };
-    scanner_reference_url: string;
+    scanner_reference_url?: string;
   };
 }
 
+export type SolidityscanReportSeverityDistribution = {
+  critical?: number;
+  gas?: number;
+  high?: number;
+  informational?: number;
+  low?: number;
+  medium?: number;
+};
+
 type SmartContractSecurityAudit = {
   audit_company_name: string;
   audit_publish_date: string;

diff --git a/types/client/marketplace.ts b/types/client/marketplace.ts
@@ -1,4 +1,4 @@
-import type { SolidityscanReport } from 'types/api/contract';
+import type { SolidityscanReport, SolidityscanReportSeverityDistribution } from 'types/api/contract';
 
 export type MarketplaceAppPreview = {
   id: string;
@@ -54,7 +54,7 @@ export type MarketplaceAppSecurityReport = {
     solidityScanContractsNumber: number;
     securityScore: number;
     totalIssues?: number;
-    issueSeverityDistribution: SolidityscanReport['scan_report']['scan_summary']['issue_severity_distribution'];
+    issueSeverityDistribution: SolidityscanReportSeverityDistribution;
   };
   contractsData: Array<{
     address: string;

diff --git a/ui/address/SolidityscanReport.tsx b/ui/address/SolidityscanReport.tsx
@@ -29,13 +29,17 @@ const SolidityscanReport = ({ hash }: Props) => {
     },
   });
 
-  const score = Number(data?.scan_report.scan_summary.score_v2);
+  if (isError || !data?.scan_report?.scan_summary) {
+    return null;
+  }
+
+  const score = Number(data.scan_report.scan_summary.score_v2);
 
-  if (isError || !score) {
+  if (!score) {
     return null;
   }
 
-  const vulnerabilities = data?.scan_report.scan_summary.issue_severity_distribution;
+  const vulnerabilities = data.scan_report.scan_summary.issue_severity_distribution;
   const vulnerabilitiesCounts = vulnerabilities ? Object.values(vulnerabilities) : [];
   const vulnerabilitiesCount = vulnerabilitiesCounts.reduce((acc, val) => acc + val, 0);
 

diff --git a/ui/marketplace/ContractListModal.tsx b/ui/marketplace/ContractListModal.tsx
@@ -42,7 +42,7 @@ const ContractListModal = ({ onClose, onBack, type, contracts }: Props) => {
         return contracts
           .filter((contract) => Boolean(contract.solidityScanReport))
           .sort((a, b) =>
-            (parseFloat(b.solidityScanReport?.scan_summary.score_v2 ?? '0')) - (parseFloat(a.solidityScanReport?.scan_summary.score_v2 ?? '0')),
+            (parseFloat(b.solidityScanReport?.scan_summary?.score_v2 ?? '0')) - (parseFloat(a.solidityScanReport?.scan_summary?.score_v2 ?? '0')),
           );
       case ContractListTypes.VERIFIED:
         return contracts.filter((contract) => contract.isVerified);

diff --git a/ui/marketplace/ContractSecurityReport.tsx b/ui/marketplace/ContractSecurityReport.tsx
@@ -27,7 +27,7 @@ const ContractSecurityReport = ({ securityReport }: Props) => {
     onToggle();
   }, [ onToggle ]);
 
-  if (!securityReport) {
+  if (!securityReport?.scan_summary?.score_v2) {
     return null;
   }
 

diff --git a/ui/shared/solidityscanReport/SolidityscanReportDetails.tsx b/ui/shared/solidityscanReport/SolidityscanReportDetails.tsx
@@ -1,10 +1,10 @@
 import { Box, Flex, Text, Grid, useColorModeValue, chakra } from '@chakra-ui/react';
 import React from 'react';
 
-import type { SolidityscanReport } from 'types/api/contract';
+import type { SolidityscanReportSeverityDistribution } from 'types/api/contract';
 
 type DistributionItem = {
-  id: keyof SolidityscanReport['scan_report']['scan_summary']['issue_severity_distribution'];
+  id: keyof SolidityscanReportSeverityDistribution;
   name: string;
   color: string;
 }
@@ -19,29 +19,34 @@ const DISTRIBUTION_ITEMS: Array<DistributionItem> = [
 ];
 
 interface Props {
-  vulnerabilities: SolidityscanReport['scan_report']['scan_summary']['issue_severity_distribution'];
+  vulnerabilities: SolidityscanReportSeverityDistribution;
   vulnerabilitiesCount: number;
 }
 
 type ItemProps = {
   item: DistributionItem;
-  vulnerabilities: SolidityscanReport['scan_report']['scan_summary']['issue_severity_distribution'];
+  vulnerabilities: SolidityscanReportSeverityDistribution;
   vulnerabilitiesCount: number;
 }
 
 const SolidityScanReportItem = ({ item, vulnerabilities, vulnerabilitiesCount }: ItemProps) => {
   const bgBar = useColorModeValue('blackAlpha.50', 'whiteAlpha.50');
   const yetAnotherGrayColor = useColorModeValue('gray.400', 'gray.500');
+  const vulnerability = vulnerabilities[item.id];
+
+  if (vulnerability === undefined) {
+    return null;
+  }
 
   return (
     <>
       <Box w={ 3 } h={ 3 } bg={ item.color } borderRadius="6px" mr={ 2 }></Box>
       <Flex justifyContent="space-between" mr={ 3 }>
         <Text>{ item.name }</Text>
-        <Text color={ vulnerabilities[item.id] > 0 ? 'text' : yetAnotherGrayColor }>{ vulnerabilities[item.id] }</Text>
+        <Text color={ vulnerability > 0 ? 'text' : yetAnotherGrayColor }>{ vulnerabilities[item.id] }</Text>
       </Flex>
       <Box bg={ bgBar } h="10px" borderRadius="8px">
-        <Box bg={ item.color } w={ vulnerabilities[item.id] / vulnerabilitiesCount } h="10px" borderRadius="8px"/>
+        <Box bg={ item.color } w={ vulnerability / vulnerabilitiesCount } h="10px" borderRadius="8px"/>
       </Box>
     </>
   );