Skip to content

Extract the LUA download button into its own component #802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
grzella wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Extract the LUA download button into its own component #802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions src/ui/components/LuaDownloadButton/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
import { Button } from '@mui/material';
import { FunctionComponent, useEffect } from 'react';
import { useLazyQuery } from '@apollo/client/react';
import { SxProps, Theme } from '@mui/system';
import { useTranslation } from 'react-i18next';
import {
FirmwareSource,
FirmwareVersionDataInput,
LuaScriptDocument,
} from '../../gql/generated/types';
import { DownloadFileRequestBody, IpcRequest } from '../../../ipc';
import GitRepository from '../../models/GitRepository';
import ShowAlerts from '../ShowAlerts';

const styles: Record<string, SxProps<Theme>> = {
button: {
marginRight: 2,
},
};

interface LuaDownloadButtonProps {
hasLuaScript: boolean;
firmwareVersionData: FirmwareVersionDataInput | null;
gitRepository: GitRepository;
showErrors?: boolean;
}

const LuaDownloadButton: FunctionComponent<LuaDownloadButtonProps> = ({
hasLuaScript,
firmwareVersionData,
gitRepository,
showErrors = false,
}) => {
const { t } = useTranslation();

const [
fetchLuaScript,
{ data: luaScriptResponse, error: luaScriptResponseError },
] = useLazyQuery(LuaScriptDocument);

useEffect(() => {
if (firmwareVersionData && hasLuaScript) {
fetchLuaScript({
variables: {
source: firmwareVersionData.source as FirmwareSource,
gitBranch: firmwareVersionData.gitBranch!,
gitTag: firmwareVersionData.gitTag!,
gitCommit: firmwareVersionData.gitCommit!,
localPath: firmwareVersionData.localPath!,
gitPullRequest: firmwareVersionData.gitPullRequest,
gitRepository: {
url: gitRepository.url,
owner: gitRepository.owner,
repositoryName: gitRepository.repositoryName,
rawRepoUrl: gitRepository.rawRepoUrl,
srcFolder: gitRepository.srcFolder,
hardwareArtifactUrl: gitRepository.hardwareArtifactUrl,
},
},
});
}
}, [gitRepository, firmwareVersionData, fetchLuaScript, hasLuaScript]);

return (
<>
{hasLuaScript
&& luaScriptResponse
&& luaScriptResponse.luaScript.fileLocation
&& luaScriptResponse.luaScript.fileLocation.length > 0 && (
<Button
sx={styles.button}
color="primary"
size="large"
variant="contained"
onClick={() => {
const downloadFileRequestBody: DownloadFileRequestBody = {
url: luaScriptResponse?.luaScript.fileLocation ?? '',
};
window.electron.ipcRenderer.sendMessage(
IpcRequest.DownloadFile,
downloadFileRequestBody,
);
}}
>
{t('ConfiguratorView.DownloadLUAScript')}
</Button>
)}
{hasLuaScript && showErrors && (
<ShowAlerts severity="error" messages={luaScriptResponseError} />
)}
</>
);
};

export default LuaDownloadButton;
80 changes: 14 additions & 66 deletions src/ui/views/ConfiguratorView/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,11 @@ import {
UserDefineKind,
AvailableFirmwareTargetsDocument,
BuildFlashFirmwareDocument,
LuaScriptDocument,
TargetDeviceOptionsDocument,
} from '../../gql/generated/types';
import Loader from '../../components/Loader';
import LuaDownloadButton from '../../components/LuaDownloadButton';
import {
DownloadFileRequestBody,
IpcRequest,
OpenFileLocationRequestBody,
SaveFileRequestBody,
Expand Down Expand Up @@ -469,34 +468,6 @@ const ConfiguratorView: FunctionComponent<ConfiguratorViewProps> = (props) => {
return deviceType === DeviceType.ExpressLRS && isTX;
}, [deviceType, isTX]);

const [
fetchLuaScript,
{ data: luaScriptResponse, error: luaScriptResponseError },
] = useLazyQuery(LuaScriptDocument);

useEffect(() => {
if (firmwareVersionData && isTX && hasLuaScript) {
fetchLuaScript({
variables: {
source: firmwareVersionData.source as FirmwareSource,
gitBranch: firmwareVersionData.gitBranch!,
gitTag: firmwareVersionData.gitTag!,
gitCommit: firmwareVersionData.gitCommit!,
localPath: firmwareVersionData.localPath!,
gitPullRequest: firmwareVersionData.gitPullRequest,
gitRepository: {
url: gitRepository.url,
owner: gitRepository.owner,
repositoryName: gitRepository.repositoryName,
rawRepoUrl: gitRepository.rawRepoUrl,
srcFolder: gitRepository.srcFolder,
hardwareArtifactUrl: gitRepository.hardwareArtifactUrl,
},
},
});
}
}, [gitRepository, firmwareVersionData, fetchLuaScript, isTX, hasLuaScript]);

/*
Display Electron.js confirmation dialog if user wants to shutdown the app
when build is in progress.
Expand Down Expand Up @@ -818,36 +789,6 @@ const ConfiguratorView: FunctionComponent<ConfiguratorViewProps> = (props) => {
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [selectedDevice, deviceTargets]);

const luaDownloadButton = () => {
if (
hasLuaScript
&& luaScriptResponse
&& luaScriptResponse.luaScript.fileLocation
&& luaScriptResponse.luaScript.fileLocation.length > 0
) {
return (
<Button
sx={styles.button}
color="primary"
size="large"
variant="contained"
onClick={() => {
const downloadFileRequestBody: DownloadFileRequestBody = {
url: luaScriptResponse?.luaScript.fileLocation ?? '',
};
window.electron.ipcRenderer.sendMessage(
IpcRequest.DownloadFile,
downloadFileRequestBody,
);
}}
>
{t('ConfiguratorView.DownloadLUAScript')}
</Button>
);
}
return null;
};

const handleDeviceSelectErrorDialogClose = useCallback(() => {
setDeviceSelectErrorDialogOpen(false);
}, []);
Expand Down Expand Up @@ -919,11 +860,12 @@ const ConfiguratorView: FunctionComponent<ConfiguratorViewProps> = (props) => {
/>
)}
<Loader loading={loadingTargets} />
{!loadingTargets && luaDownloadButton()}
{hasLuaScript && (
<ShowAlerts
severity="error"
messages={luaScriptResponseError}
{!loadingTargets && (
<LuaDownloadButton
hasLuaScript={hasLuaScript}
firmwareVersionData={firmwareVersionData}
gitRepository={gitRepository}
showErrors
/>
)}
<ShowAlerts severity="error" messages={targetsResponseError} />
Expand Down Expand Up @@ -1268,7 +1210,13 @@ const ConfiguratorView: FunctionComponent<ConfiguratorViewProps> = (props) => {
</Button>
)}

{response?.buildFlashFirmware.success && luaDownloadButton()}
{response?.buildFlashFirmware.success && (
<LuaDownloadButton
hasLuaScript={hasLuaScript}
firmwareVersionData={firmwareVersionData}
gitRepository={gitRepository}
/>
)}
</CardContent>
</>
)}
Expand Down
Loading