refactor build status state

usecannon · Sep 15, 2024 · bf1b6e8 · bf1b6e8
1 parent 343cc79
commit bf1b6e8
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 23 deletions.
diff --git a/packages/website/src/features/Deploy/QueueFromGitOpsPage.tsx b/packages/website/src/features/Deploy/QueueFromGitOpsPage.tsx
@@ -270,9 +270,10 @@ function QueueFromGitOps() {
   );
 
   useEffect(() => {
-    if (!buildInfo.finishedBuilding) return;
-    uploadToPublishIpfs.writeToIpfsMutation.mutate();
-  }, [buildInfo.finishedBuilding]);
+    if (['success', 'error'].includes(buildInfo.buildStatus)) {
+      uploadToPublishIpfs.writeToIpfsMutation.mutate();
+    }
+  }, [buildInfo.buildStatus]);
 
   const refsInfo = useGitRefsList(gitUrl);
   const foundRef = refsInfo.refs?.find(
@@ -396,7 +397,7 @@ function QueueFromGitOps() {
     cannonPkgPreviousInfo.isFetching ||
     partialDeployInfo.isFetching ||
     cannonPkgVersionInfo.isFetching ||
-    buildInfo.isBuilding;
+    buildInfo.buildStatus === 'building';
 
   const handlePreviewTxnsClick = async () => {
     if (!isConnected) {
@@ -462,7 +463,7 @@ function QueueFromGitOps() {
     cannonPkgPreviousInfo.isFetching ||
     partialDeployInfo.isFetching ||
     cannonPkgVersionInfo.isFetching ||
-    buildInfo.isBuilding;
+    buildInfo.buildStatus === 'building';
 
   function PreviewButton(props: any) {
     return (
@@ -550,7 +551,7 @@ function QueueFromGitOps() {
       return <PreviewButton message="Fetching package info, please wait..." />;
     }
 
-    if (buildInfo.isBuilding) {
+    if (buildInfo.buildStatus === 'building') {
       return <PreviewButton message="Generating build info, please wait..." />;
     }
 
@@ -697,10 +698,10 @@ function QueueFromGitOps() {
 
           {renderAlertMessage()}
           <RenderPreviewButtonTooltip />
-          {buildInfo.buildStatus && (
+          {buildInfo.buildMessage && (
             <Alert mt="6" status="info" bg="gray.800">
               <Spinner mr={3} boxSize={4} />
-              <strong>{buildInfo.buildStatus}</strong>
+              <strong>{buildInfo.buildMessage}</strong>
             </Alert>
           )}
           {buildInfo.buildError && (

diff --git a/packages/website/src/features/Deploy/TransactionDetailsPage.tsx b/packages/website/src/features/Deploy/TransactionDetailsPage.tsx
@@ -449,9 +449,9 @@ function TransactionDetailsPage() {
                 <Card title="Verify Transactions">
                   {queuedWithGitOps && (
                     <Box>
-                      {buildInfo.buildStatus && (
+                      {buildInfo.buildMessage && (
                         <Text fontSize="sm" mb="2">
-                          {buildInfo.buildStatus}
+                          {buildInfo.buildMessage}
                         </Text>
                       )}
                       {buildInfo.buildError && (

diff --git a/packages/website/src/hooks/cannon.ts b/packages/website/src/hooks/cannon.ts
@@ -76,9 +76,8 @@ export function useCannonBuild(safe: SafeDefinition | null, def?: ChainDefinitio
   const { addLog } = useLogs();
   const settings = useStore((s) => s.settings);
 
-  const [finishedBuilding, setFinishedBuilding] = useState(false);
-  const [isBuilding, setIsBuilding] = useState(false);
-  const [buildStatus, setBuildStatus] = useState('');
+  const [buildMessage, setBuildMessage] = useState('');
+  const [buildStatus, setBuildStatus] = useState<'idle' | 'building' | 'success' | 'error'>('idle');
 
   const [buildResult, setBuildResult] = useState<{
     runtime: ChainBuilderRuntime;
@@ -103,7 +102,7 @@ export function useCannonBuild(safe: SafeDefinition | null, def?: ChainDefinitio
 
     const chain = getChainById(safe.chainId);
 
-    setBuildStatus('Creating fork...');
+    setBuildMessage('Creating fork...');
     // eslint-disable-next-line no-console
     console.log(`Creating fork with RPC: ${chain?.rpcUrls.default.http[0]}`);
     const fork = await createFork({
@@ -117,7 +116,7 @@ export function useCannonBuild(safe: SafeDefinition | null, def?: ChainDefinitio
 
     const ipfsLoader = new IPFSBrowserLoader(settings.ipfsApiUrl || externalLinks.IPFS_CANNON);
 
-    setBuildStatus('Loading deployment data...');
+    setBuildMessage('Loading deployment data...');
 
     addLog('info', `cannon.ts: upgrade from: ${prevDeploy?.def.name}:${prevDeploy?.def.version}`);
 
@@ -185,7 +184,7 @@ export function useCannonBuild(safe: SafeDefinition | null, def?: ChainDefinitio
           stepOutput.txns![txn].hash = '';
         }
 
-        setBuildStatus(`Building ${stepName}...`);
+        setBuildMessage(`Building ${stepName}...`);
 
         // a step that deploys a contract is a step that has no txns deployed but contract(s) deployed
         if (_.keys(stepOutput.txns).length === 0 && _.keys(stepOutput.contracts).length > 0) {
@@ -249,33 +248,31 @@ export function useCannonBuild(safe: SafeDefinition | null, def?: ChainDefinitio
   };
 
   return {
-    finishedBuilding,
-    isBuilding,
     buildStatus,
+    buildMessage,
     buildResult,
     buildError,
     buildSkippedSteps,
     doBuild() {
-      setFinishedBuilding(false);
       setBuildResult(null);
       setBuildError(null);
       setBuildSkippedSteps([]);
-      setIsBuilding(true);
+      setBuildStatus('building');
 
       buildFn()
         .then((res) => {
           setBuildResult(res);
+          setBuildStatus('success');
         })
         .catch((err) => {
           // eslint-disable-next-line no-console
           console.error(err);
           addLog('error', `cannon.ts: full build error ${err.toString()}`);
           setBuildError(err.toString());
+          setBuildStatus('error');
         })
         .finally(() => {
-          setFinishedBuilding(true);
-          setIsBuilding(false);
-          setBuildStatus('');
+          setBuildMessage('');
         });
     },
   };