Skip to content

UI: Update Controls > Scripts to use a side nav and new Batch progress section, add new progress bar component#31750

Merged
sgress454 merged 32 commits into
28390-frontend-featurefrom
31224-scripts-side-nav-and-batch-progress
Aug 11, 2025
Merged

UI: Update Controls > Scripts to use a side nav and new Batch progress section, add new progress bar component#31750
sgress454 merged 32 commits into
28390-frontend-featurefrom
31224-scripts-side-nav-and-batch-progress

Conversation

@jacobshandling
Copy link
Copy Markdown
Contributor

@jacobshandling jacobshandling commented Aug 8, 2025

#31224 and #31225

Summary

  • New Features

    • Introduced a modular Scripts management area with side navigation, including a "Script Library" and "Batch Progress" views.
    • Added a progress bar component with visual segments and Storybook/test coverage.
    • Implemented paginated batch execution summaries with status tabs, progress visualization, and detailed modal views.
    • Added new utility functions and endpoints to support script batch operations.
  • Improvements

    • Enhanced type safety and prop definitions for navigation and card components.
    • Improved documentation and comments for better clarity.
    • Updated routing to support section-based navigation within the Scripts area.
  • Bug Fixes

    • Corrected and unified types across hosts, scripts, and related components for batch status and summaries.

Controls > Scripts > Batch progress

ezgif-80a97182cccb3b

empty states

Progress bar component:

Screenshot 2025-08-08 at 5 13 12 PM
  • Changes file added for user-visible changes in changes/
  • Added/updated automated tests
  • QA'd all new/changed functionality manually

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 8, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This update introduces a major refactor and feature expansion for script management in the frontend. It adds new components for script batch progress, updates type safety, introduces paginated API support for script batches, and modularizes navigation for scripts and OS settings. Several new utility functions, styles, and Storybook/test files are included. Existing types and API calls are updated or versioned to support these changes.

Changes

Cohort / File(s) Change Summary
Script batch progress feature
frontend/pages/ManageControlsPage/Scripts/cards/ScriptBatchProgress/ScriptBatchProgress.tsx, frontend/pages/ManageControlsPage/Scripts/cards/ScriptBatchProgress/_styles.scss, frontend/components/ProgressBar/ProgressBar.tsx, frontend/components/ProgressBar/ProgressBar.stories.tsx, frontend/components/ProgressBar/ProgressBar.tests.tsx, frontend/components/ProgressBar/_styles.scss, frontend/components/ProgressBar/index.ts
Added a new script batch progress UI with tabs for batch statuses, progress bar component, styles, Storybook stories, and tests.
Script batch summary and status types
frontend/interfaces/script.ts, frontend/services/entities/scripts.ts, frontend/services/entities/common.ts, frontend/__mocks__/scriptMock.ts
Introduced and updated types for script batch statuses, responses, host counts (V1/V2), and pagination meta. Added mock data and type guards.
Script batch API and helpers
frontend/services/entities/scripts.ts, frontend/utilities/endpoints.ts, frontend/utilities/helpers.tsx
Added new API method for paginated batch summaries, new endpoint constant, and a date-time helper function.
Script batch summary consumers
frontend/pages/DashboardPage/cards/ActivityFeed/components/ScriptBatchSummaryModal/ScriptBatchSummaryModal.tsx, frontend/pages/DashboardPage/cards/ActivityFeed/components/ScriptBatchStatusTable/ScriptBatchStatusTable.tsx, frontend/pages/DashboardPage/cards/ActivityFeed/components/ScriptBatchStatusTable/ScriptBatchStatusTableConfig.tsx, frontend/pages/hosts/ManageHostsPage/ManageHostsPage.tsx, frontend/pages/hosts/ManageHostsPage/components/HostsFilterBlock/HostsFilterBlock.tsx, frontend/services/entities/hosts.ts
Updated components and services to use new or versioned script batch types and props. Improved type safety in batch summary and status table consumers.
Script library and navigation modularization
frontend/pages/ManageControlsPage/Scripts/Scripts.tsx, frontend/pages/ManageControlsPage/Scripts/ScriptsNavItems.tsx, frontend/pages/ManageControlsPage/Scripts/cards/ScriptLibrary/ScriptLibrary.tsx, frontend/router/index.tsx, frontend/router/paths.ts
Refactored Scripts page to modular card-based navigation with a new side nav, library, and batch progress cards. Added new routes and path constants for scripts sections.
OS settings navigation and typing
frontend/pages/ManageControlsPage/OSSettings/OSSettingsNavItems.tsx, frontend/pages/ManageControlsPage/OSSettings/cards/CustomSettings/CustomSettings.tsx, frontend/pages/ManageControlsPage/OSSettings/cards/DiskEncryption/DiskEncryption.tsx
Improved type safety and modularity for OS settings navigation and card props. Unified common props and updated component signatures.
SideNav generic improvements
frontend/pages/admin/components/SideNav/SideNav.tsx
Made SideNav generic for improved type flexibility. Updated prop and interface types.
Component and prop enhancements
frontend/components/HumanTimeDiffWithDateTip/HumanTimeDiffWithDateTip.tsx, frontend/components/PaginatedList/PaginatedList.tsx, frontend/hooks/useTeamIdParam.ts
Enhanced component props for flexibility and added clarifying comments. No logic changes.

Sequence Diagram(s)

Script batch progress tab interaction and data flow

sequenceDiagram
    participant User
    participant ScriptBatchProgress
    participant Router
    participant API
    participant Modal

    User->>ScriptBatchProgress: Selects tab (status)
    ScriptBatchProgress->>Router: Updates URL query param "status"
    ScriptBatchProgress->>API: Fetch batch summaries (status, teamId, page)
    API-->>ScriptBatchProgress: Returns batch summaries data
    ScriptBatchProgress->>User: Renders batch list and progress bars
    User->>ScriptBatchProgress: Clicks batch row
    ScriptBatchProgress->>Modal: Opens batch summary modal
Loading

Script library pagination and modal flow

sequenceDiagram
    participant User
    participant ScriptLibrary
    participant API
    participant Modal

    User->>ScriptLibrary: Navigates to page N
    ScriptLibrary->>API: Fetch scripts (page N, teamId)
    API-->>ScriptLibrary: Returns scripts data
    ScriptLibrary->>User: Renders script list
    User->>ScriptLibrary: Clicks script row
    ScriptLibrary->>Modal: Opens edit/delete modal
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~40 minutes

This review involves several new features, significant refactoring, type and API changes, and new test and Storybook files. The complexity comes from the introduction of new UI patterns, API versioning, and modular navigation, requiring careful attention to type correctness and integration points.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 31224-scripts-side-nav-and-batch-progress

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@codecov
Copy link
Copy Markdown

codecov Bot commented Aug 8, 2025

Codecov Report

❌ Patch coverage is 78.74016% with 27 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (28390-frontend-feature@373b811). Learn more about missing BASE report.

Files with missing lines Patch % Lines
.../cards/ScriptBatchProgress/ScriptBatchProgress.tsx 71.79% 22 Missing ⚠️
...criptBatchSummaryModal/ScriptBatchSummaryModal.tsx 0.00% 4 Missing ⚠️
frontend/services/entities/scripts.ts 75.00% 1 Missing ⚠️
Additional details and impacted files
@@                    Coverage Diff                    @@
##             28390-frontend-feature   #31750   +/-   ##
=========================================================
  Coverage                          ?   63.72%           
=========================================================
  Files                             ?     1964           
  Lines                             ?   191321           
  Branches                          ?     6229           
=========================================================
  Hits                              ?   121924           
  Misses                            ?    59850           
  Partials                          ?     9547           
Flag Coverage Δ
frontend 50.75% <78.74%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

});

// it("Renders each tab with appropriate scripts list", async () => {
// mockServer.use(teamBatchSummariesHandler);
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sgress454 this test is almost working, but MSW is for some reason not successfully intercepting the GET here. Once that's worked out the remaining 2 tab cases shouldn't be much trouble

@sgress454 sgress454 changed the title UI: Update Controls > Scripts to use a side nav and new Batch progress section, ass new progress bar component UI: Update Controls > Scripts to use a side nav and new Batch progress section, add new progress bar component Aug 11, 2025
@sgress454 sgress454 merged commit eb9ec38 into 28390-frontend-feature Aug 11, 2025
12 checks passed
@sgress454 sgress454 deleted the 31224-scripts-side-nav-and-batch-progress branch August 11, 2025 18:05
@sgress454 sgress454 mentioned this pull request Aug 13, 2025
4 tasks
sgress454 added a commit that referenced this pull request Aug 14, 2025
# Details

This PR merges the feature branch for the scheduled scripts UI into
main. This includes the following previously-approved PRs:

* #31750
* #31604
* #31797


# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [X] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files)
for more information.

## Testing

- [X] Added/updated automated tests
- [X] Where appropriate, [automated tests simulate multiple hosts and
test for host
isolation](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/patterns-backend.md#unit-testing)
(updates to one hosts's records do not affect another)

- [X] QA'd all new/changed functionality manually

---------

Co-authored-by: jacobshandling <61553566+jacobshandling@users.noreply.github.com>
Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
BCTBB pushed a commit that referenced this pull request Aug 19, 2025
# Details

This PR merges the feature branch for the scheduled scripts UI into
main. This includes the following previously-approved PRs:

* #31750
* #31604
* #31797


# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [X] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files)
for more information.

## Testing

- [X] Added/updated automated tests
- [X] Where appropriate, [automated tests simulate multiple hosts and
test for host
isolation](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/patterns-backend.md#unit-testing)
(updates to one hosts's records do not affect another)

- [X] QA'd all new/changed functionality manually

---------

Co-authored-by: jacobshandling <61553566+jacobshandling@users.noreply.github.com>
Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
@coderabbitai coderabbitai Bot mentioned this pull request Aug 28, 2025
3 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Apr 27, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

UI: New progress bar component UI: Break Controls > Scripts into dual sidenav sections, implement new Batch Progress section

2 participants