|
| 1 | +import{API}from"api/api"; |
| 2 | +import{DetailedError}from"api/errors"; |
| 3 | +import{checkAuthorization}from"api/queries/authCheck"; |
| 4 | +importtype{ |
| 5 | +DynamicParametersRequest, |
| 6 | +DynamicParametersResponse, |
| 7 | +WorkspaceBuildParameter, |
| 8 | +}from"api/typesGenerated"; |
| 9 | +import{ErrorAlert}from"components/Alert/ErrorAlert"; |
| 10 | +import{Button}from"components/Button/Button"; |
| 11 | +import{EmptyState}from"components/EmptyState/EmptyState"; |
| 12 | +import{FeatureStageBadge}from"components/FeatureStageBadge/FeatureStageBadge"; |
| 13 | +import{Link}from"components/Link/Link"; |
| 14 | +import{Loader}from"components/Loader/Loader"; |
| 15 | +importtype{FC}from"react"; |
| 16 | +import{ |
| 17 | +useCallback, |
| 18 | +useContext, |
| 19 | +useEffect, |
| 20 | +useMemo, |
| 21 | +useRef, |
| 22 | +useState, |
| 23 | +}from"react"; |
| 24 | +import{Helmet}from"react-helmet-async"; |
| 25 | +import{useMutation,useQuery}from"react-query"; |
| 26 | +import{useNavigate}from"react-router-dom"; |
| 27 | +import{docs}from"utils/docs"; |
| 28 | +import{pageTitle}from"utils/page"; |
| 29 | +import{ |
| 30 | +typeWorkspacePermissions, |
| 31 | +workspaceChecks, |
| 32 | +}from"../../../modules/workspaces/permissions"; |
| 33 | +import{ExperimentalFormContext}from"../../CreateWorkspacePage/ExperimentalFormContext"; |
| 34 | +import{useWorkspaceSettings}from"../WorkspaceSettingsLayout"; |
| 35 | +import{WorkspaceParametersPageViewExperimental}from"./WorkspaceParametersPageViewExperimental"; |
| 36 | + |
| 37 | +constWorkspaceParametersPageExperimental:FC=()=>{ |
| 38 | +constworkspace=useWorkspaceSettings(); |
| 39 | +constnavigate=useNavigate(); |
| 40 | +constexperimentalFormContext=useContext(ExperimentalFormContext); |
| 41 | + |
| 42 | +const[currentResponse,setCurrentResponse]= |
| 43 | +useState<DynamicParametersResponse|null>(null); |
| 44 | +const[wsResponseId,setWSResponseId]=useState<number>(-1); |
| 45 | +constws=useRef<WebSocket|null>(null); |
| 46 | +const[wsError,setWsError]=useState<Error|null>(null); |
| 47 | + |
| 48 | +constonMessage=useCallback((response:DynamicParametersResponse)=>{ |
| 49 | +setCurrentResponse((prev)=>{ |
| 50 | +if(prev?.id===response.id){ |
| 51 | +returnprev; |
| 52 | +} |
| 53 | +returnresponse; |
| 54 | +}); |
| 55 | +},[]); |
| 56 | + |
| 57 | +useEffect(()=>{ |
| 58 | +if(!workspace.latest_build.template_version_id)return; |
| 59 | + |
| 60 | +constsocket=API.templateVersionDynamicParameters( |
| 61 | +workspace.owner_id, |
| 62 | +workspace.latest_build.template_version_id, |
| 63 | +{ |
| 64 | +onMessage, |
| 65 | +onError:(error)=>{ |
| 66 | +setWsError(error); |
| 67 | +}, |
| 68 | +onClose:()=>{ |
| 69 | +if(ws.current===socket){ |
| 70 | +setWsError( |
| 71 | +newDetailedError( |
| 72 | +"Websocket connection for dynamic parameters unexpectedly closed.", |
| 73 | +"Refresh the page to reset the form.", |
| 74 | +), |
| 75 | +); |
| 76 | +} |
| 77 | +}, |
| 78 | +}, |
| 79 | +); |
| 80 | + |
| 81 | +ws.current=socket; |
| 82 | + |
| 83 | +return()=>{ |
| 84 | +socket.close(); |
| 85 | +}; |
| 86 | +},[ |
| 87 | +workspace.owner_id, |
| 88 | +workspace.latest_build.template_version_id, |
| 89 | +onMessage, |
| 90 | +]); |
| 91 | + |
| 92 | +constsendMessage=useCallback((formValues:Record<string,string>)=>{ |
| 93 | +setWSResponseId((prevId)=>{ |
| 94 | +constrequest:DynamicParametersRequest={ |
| 95 | +id:prevId+1, |
| 96 | +inputs:formValues, |
| 97 | +}; |
| 98 | +if(ws.current&&ws.current.readyState===WebSocket.OPEN){ |
| 99 | +ws.current.send(JSON.stringify(request)); |
| 100 | +returnprevId+1; |
| 101 | +} |
| 102 | +returnprevId; |
| 103 | +}); |
| 104 | +},[]); |
| 105 | + |
| 106 | +constupdateParameters=useMutation({ |
| 107 | +mutationFn:(buildParameters:WorkspaceBuildParameter[])=> |
| 108 | +API.postWorkspaceBuild(workspace.id,{ |
| 109 | +transition:"start", |
| 110 | +rich_parameter_values:buildParameters, |
| 111 | +}), |
| 112 | +onSuccess:()=>{ |
| 113 | +navigate(`/@${workspace.owner_name}/${workspace.name}`); |
| 114 | +}, |
| 115 | +}); |
| 116 | + |
| 117 | +constchecks=workspace ?workspaceChecks(workspace) :{}; |
| 118 | +constpermissionsQuery=useQuery({ |
| 119 | +...checkAuthorization({ checks}), |
| 120 | +enabled:workspace!==undefined, |
| 121 | +}); |
| 122 | +constpermissions=permissionsQuery.dataasWorkspacePermissions|undefined; |
| 123 | +constcanChangeVersions=Boolean(permissions?.updateWorkspaceVersion); |
| 124 | + |
| 125 | +consthandleSubmit=(values:{ |
| 126 | +rich_parameter_values:WorkspaceBuildParameter[]; |
| 127 | +})=>{ |
| 128 | +if(!currentResponse||!currentResponse.parameters){ |
| 129 | +return; |
| 130 | +} |
| 131 | + |
| 132 | +// Only submit mutable parameters |
| 133 | +constonlyMutableValues=currentResponse.parameters |
| 134 | +.filter((p)=>p.mutable) |
| 135 | +.map((p)=>{ |
| 136 | +constvalue=values.rich_parameter_values.find( |
| 137 | +(v)=>v.name===p.name, |
| 138 | +); |
| 139 | +if(!value){ |
| 140 | +thrownewError(`Missing value for parameter${p.name}`); |
| 141 | +} |
| 142 | +returnvalue; |
| 143 | +}); |
| 144 | + |
| 145 | +updateParameters.mutate(onlyMutableValues); |
| 146 | +}; |
| 147 | + |
| 148 | +constsortedParams=useMemo(()=>{ |
| 149 | +if(!currentResponse?.parameters){ |
| 150 | +return[]; |
| 151 | +} |
| 152 | +return[...currentResponse.parameters].sort((a,b)=>a.order-b.order); |
| 153 | +},[currentResponse?.parameters]); |
| 154 | + |
| 155 | +consterror=wsError||updateParameters.error; |
| 156 | + |
| 157 | +if( |
| 158 | +!currentResponse|| |
| 159 | +(ws.current&&ws.current.readyState===WebSocket.CONNECTING) |
| 160 | +){ |
| 161 | +return<Loader/>; |
| 162 | +} |
| 163 | + |
| 164 | +return( |
| 165 | +<divclassName="flex flex-col gap-6 max-w-screen-md mx-auto"> |
| 166 | +<Helmet> |
| 167 | +<title>{pageTitle(workspace.name,"Parameters")}</title> |
| 168 | +</Helmet> |
| 169 | + |
| 170 | +<headerclassName="flex flex-col items-start gap-2"> |
| 171 | +<spanclassName="flex flex-row items-center gap-2"> |
| 172 | +<h1className="text-3xl m-0">Workspace parameters</h1> |
| 173 | +<FeatureStageBadgecontentType={"beta"}/> |
| 174 | +</span> |
| 175 | +{experimentalFormContext&&( |
| 176 | +<Button |
| 177 | +size="sm" |
| 178 | +variant="outline" |
| 179 | +onClick={experimentalFormContext.toggleOptedOut} |
| 180 | +> |
| 181 | +Go back to the classic workspace parameters view |
| 182 | +</Button> |
| 183 | +)} |
| 184 | +</header> |
| 185 | + |
| 186 | +{Boolean(error)&&<ErrorAlerterror={error}/>} |
| 187 | + |
| 188 | +{sortedParams.length>0 ?( |
| 189 | +<WorkspaceParametersPageViewExperimental |
| 190 | +workspace={workspace} |
| 191 | +canChangeVersions={canChangeVersions} |
| 192 | +parameters={sortedParams} |
| 193 | +diagnostics={currentResponse.diagnostics} |
| 194 | +isSubmitting={updateParameters.isLoading} |
| 195 | +onSubmit={handleSubmit} |
| 196 | +onCancel={()=> |
| 197 | +navigate(`/@${workspace.owner_name}/${workspace.name}`) |
| 198 | +} |
| 199 | +sendMessage={sendMessage} |
| 200 | +/> |
| 201 | +) :( |
| 202 | +<EmptyState |
| 203 | +className="border border-border border-solid rounded-md" |
| 204 | +message="This workspace has no parameters" |
| 205 | +cta={ |
| 206 | +<Link |
| 207 | +href={docs("/admin/templates/extending-templates/parameters")} |
| 208 | +> |
| 209 | +Learn more about parameters |
| 210 | +</Link> |
| 211 | +} |
| 212 | +/> |
| 213 | +)} |
| 214 | +</div> |
| 215 | +); |
| 216 | +}; |
| 217 | + |
| 218 | +exportdefaultWorkspaceParametersPageExperimental; |