mirror of
https://github.com/fleetdm/fleet
synced 2026-04-21 13:37:30 +00:00
## For #26229 – Part 1

- This PR contains the core abstractions, routes, API updates, and types
for GitOps mode in the UI. Since this work will touch essentially every
part of the Fleet UI, it is ripe for merge conflicts. To mitigate such
conflicts, I'll be merging this work in a number of iterative PRs. ~To
effectively gate any of this work from showing until it is all merged to
`main`, [this commit](feedbb2d4c) hides
the settings section that allows enabling/disabling this setting,
effectively feature flagging the entire thing. In the last of these
iterative PRs, that commit will be reverted to engage the entire
feature. For testing purposes, reviewers can `git revert
feedbb2d4c25ec2e304e1f18d409cee62f6752ed` locally~ The new settings
section for this feature is feature flagged until all PRs are merged -
to show the setting section while testing, run `ALLOW_GITOPS_MODE=true
NODE_ENV=development yarn run webpack --progress --watch` in place of
`make generate-dev`
- Changes file will be added and feature flag removed in the last PR
- [x] Settings page with routing, form, API integration (hidden until
last PR)
- [x] Activities
- [x] Navbar indicator
- Apply GOM conditional UI to:
- [x] Manage enroll secret modal: .5
- Controls >
- [x] Scripts:
- Setup experience >
- [x] Install software > Select software modal
- [x] OS Settings >
- [x] Custom settings
- [x] Disk encryption
- [x] OS Updates
2/18/25, added to this PR:
- [x] Controls > Setup experience > Run script
- [x] Software >
- [x] Manage automations modal
- [x] Add software >
- [x] App Store (VPP)
- [x] Custom package
- [x] Queries
- [x] Manage
- [x] Automations modal
- [x] New
- [x] Edit
- [x] Policies
- [x] Manage
- [x] New
- [x] Edit
- Manage automations
- [x] Calendar events
- [x] Manual QA for all new/changed functionality
---------
Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
217 lines
7 KiB
TypeScript
217 lines
7 KiB
TypeScript
import React, { useState, useEffect, useContext } from "react";
|
||
|
||
import { AppContext } from "context/app";
|
||
|
||
import Modal from "components/Modal";
|
||
import Button from "components/buttons/Button";
|
||
import InfoBanner from "components/InfoBanner/InfoBanner";
|
||
import CustomLink from "components/CustomLink/CustomLink";
|
||
import Checkbox from "components/forms/fields/Checkbox/Checkbox";
|
||
import QueryFrequencyIndicator from "components/QueryFrequencyIndicator/QueryFrequencyIndicator";
|
||
import LogDestinationIndicator from "components/LogDestinationIndicator/LogDestinationIndicator";
|
||
|
||
import { ISchedulableQuery } from "interfaces/schedulable_query";
|
||
import TooltipTruncatedText from "components/TooltipTruncatedText";
|
||
import { CONTACT_FLEET_LINK } from "utilities/constants";
|
||
import GitOpsModeTooltipWrapper from "components/GitOpsModeTooltipWrapper";
|
||
|
||
interface IManageQueryAutomationsModalProps {
|
||
isUpdatingAutomations: boolean;
|
||
onSubmit: (formData: any) => void; // TODO
|
||
onCancel: () => void;
|
||
isShowingPreviewDataModal: boolean;
|
||
togglePreviewDataModal: () => void;
|
||
availableQueries?: ISchedulableQuery[];
|
||
automatedQueryIds: number[];
|
||
logDestination: string;
|
||
}
|
||
|
||
interface ICheckedQuery {
|
||
name?: string;
|
||
id: number;
|
||
isChecked: boolean;
|
||
interval: number;
|
||
}
|
||
|
||
const useCheckboxListStateManagement = (
|
||
allQueries: ISchedulableQuery[],
|
||
automatedQueryIds: number[] | undefined
|
||
) => {
|
||
const [queryItems, setQueryItems] = useState<ICheckedQuery[]>(() => {
|
||
return allQueries.map(({ name, id, interval }) => ({
|
||
name,
|
||
id,
|
||
isChecked: !!automatedQueryIds?.includes(id),
|
||
interval,
|
||
}));
|
||
});
|
||
|
||
const updateQueryItems = (queryId: number) => {
|
||
setQueryItems((prevItems) =>
|
||
prevItems.map((query) =>
|
||
query.id !== queryId ? query : { ...query, isChecked: !query.isChecked }
|
||
)
|
||
);
|
||
};
|
||
|
||
return { queryItems, updateQueryItems };
|
||
};
|
||
|
||
const baseClass = "manage-query-automations-modal";
|
||
|
||
const ManageQueryAutomationsModal = ({
|
||
isUpdatingAutomations,
|
||
automatedQueryIds,
|
||
onSubmit,
|
||
onCancel,
|
||
isShowingPreviewDataModal,
|
||
togglePreviewDataModal,
|
||
availableQueries,
|
||
logDestination,
|
||
}: IManageQueryAutomationsModalProps): JSX.Element => {
|
||
// TODO: Error handling, if any
|
||
// const [errors, setErrors] = useState<{ [key: string]: string }>({});
|
||
|
||
const gomEnabled = useContext(AppContext).config?.gitops.gitops_mode_enabled;
|
||
|
||
// Client side sort queries alphabetically
|
||
const sortedAvailableQueries =
|
||
availableQueries?.sort((a, b) =>
|
||
a.name.toLowerCase().localeCompare(b.name.toLowerCase())
|
||
) || [];
|
||
|
||
const { queryItems, updateQueryItems } = useCheckboxListStateManagement(
|
||
sortedAvailableQueries,
|
||
automatedQueryIds || []
|
||
);
|
||
|
||
const onSubmitQueryAutomations = (
|
||
evt: React.MouseEvent<HTMLFormElement> | KeyboardEvent
|
||
) => {
|
||
evt.preventDefault();
|
||
|
||
const newQueryIds: number[] = [];
|
||
queryItems?.forEach((p) => p.isChecked && newQueryIds.push(p.id));
|
||
|
||
onSubmit(newQueryIds);
|
||
};
|
||
|
||
useEffect(() => {
|
||
const listener = (event: KeyboardEvent) => {
|
||
if (event.code === "Enter" || event.code === "NumpadEnter") {
|
||
event.preventDefault();
|
||
onSubmit(event);
|
||
}
|
||
};
|
||
document.addEventListener("keydown", listener);
|
||
return () => {
|
||
document.removeEventListener("keydown", listener);
|
||
};
|
||
});
|
||
|
||
return (
|
||
<Modal
|
||
title="Manage automations"
|
||
onExit={onCancel}
|
||
className={baseClass}
|
||
width="large"
|
||
isHidden={isShowingPreviewDataModal}
|
||
>
|
||
<div className={`${baseClass} form`}>
|
||
<div className={`${baseClass}__heading`}>
|
||
Query automations let you send data to your log destination on a
|
||
schedule. Data is sent according to a query’s frequency.
|
||
</div>
|
||
{availableQueries?.length ? (
|
||
<div className={`${baseClass}__select form-field`}>
|
||
<div className="form-field__label">
|
||
Choose which queries will send data:
|
||
</div>
|
||
<div className={`${baseClass}__checkboxes`}>
|
||
{queryItems &&
|
||
queryItems.map((queryItem) => {
|
||
const { isChecked, name, id, interval } = queryItem;
|
||
return (
|
||
<div key={id} className={`${baseClass}__query-item`}>
|
||
<Checkbox
|
||
value={isChecked}
|
||
name={name}
|
||
onChange={() => {
|
||
updateQueryItems(id);
|
||
// !isChecked &&
|
||
// setErrors((errs) => omit(errs, "queryItems"));
|
||
}}
|
||
disabled={gomEnabled}
|
||
>
|
||
<TooltipTruncatedText value={name} />
|
||
</Checkbox>
|
||
<QueryFrequencyIndicator
|
||
frequency={interval}
|
||
checked={isChecked}
|
||
/>
|
||
</div>
|
||
);
|
||
})}
|
||
</div>
|
||
</div>
|
||
) : (
|
||
<div className={`${baseClass}__no-queries`}>
|
||
<b>You have no queries.</b>
|
||
<p>Add a query to turn on automations.</p>
|
||
</div>
|
||
)}
|
||
<div className={`${baseClass}__log-destination form-field`}>
|
||
<div className="form-field__label">Log destination:</div>
|
||
<div className={`${baseClass}__selection`}>
|
||
<LogDestinationIndicator logDestination={logDestination} />
|
||
</div>
|
||
<div className={`${baseClass}__configure form-field__help-text`}>
|
||
Users with the admin role can
|
||
<CustomLink
|
||
url="https://fleetdm.com/docs/using-fleet/log-destinations"
|
||
text="configure a different log destination"
|
||
newTab
|
||
/>
|
||
</div>
|
||
</div>
|
||
<InfoBanner className={`${baseClass}__supported-platforms`}>
|
||
<p>Automations currently run on macOS, Windows, and Linux hosts.</p>
|
||
<p>
|
||
Interested in query automations for your Chromebooks?
|
||
<CustomLink url={CONTACT_FLEET_LINK} text="Let us know" newTab />
|
||
</p>
|
||
</InfoBanner>
|
||
<Button
|
||
type="button"
|
||
variant="text-link"
|
||
onClick={togglePreviewDataModal}
|
||
className={`${baseClass}__preview-data`}
|
||
>
|
||
Preview data
|
||
</Button>
|
||
<div className="modal-cta-wrap">
|
||
<GitOpsModeTooltipWrapper
|
||
tipOffset={6}
|
||
renderChildren={(dC) => (
|
||
<Button
|
||
type="submit"
|
||
variant="brand"
|
||
onClick={onSubmitQueryAutomations}
|
||
className="save-loading"
|
||
isLoading={isUpdatingAutomations}
|
||
disabled={dC}
|
||
>
|
||
Save
|
||
</Button>
|
||
)}
|
||
/>
|
||
<Button onClick={onCancel} variant="inverse">
|
||
Cancel
|
||
</Button>
|
||
</div>
|
||
</div>
|
||
</Modal>
|
||
);
|
||
};
|
||
|
||
export default ManageQueryAutomationsModal;
|