Skip to content

[Integrate-2699] Enable cache refreshment for webapi dataset#2854

Open
hengxian-jiang wants to merge 4 commits into
developfrom
hengxian-jiang/enable_webapi_dataset_cache_update
Open

[Integrate-2699] Enable cache refreshment for webapi dataset#2854
hengxian-jiang wants to merge 4 commits into
developfrom
hengxian-jiang/enable_webapi_dataset_cache_update

Conversation

@hengxian-jiang

@hengxian-jiang hengxian-jiang commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

Merge Checklist

Please cross check this list if additions / modifications needs to be done on top of your core changes and tick them off. Reviewer can as well glance through and help the developer if something is missed out.

  • Automated Tests (Jasmine integration tests, Unit tests, and/or Performance tests)
  • Updated Manual tests / Demo Config
  • Documentation (Application guide, Admin guide, Markdown, Readme and/or Wiki)
  • Verified that local development environment is working with latest changes (integrated with latest develop branch)
  • following best practices in code review doc
Screenshot 2026-07-06 at 3 35 30 PM Screenshot 2026-07-06 at 1 01 01 PM

@hengxian-jiang hengxian-jiang linked an issue Jul 6, 2026 that may be closed by this pull request
@hengxian-jiang hengxian-jiang marked this pull request as ready for review July 6, 2026 05:59
@hengxian-jiang hengxian-jiang requested a review from SantanM as a code owner July 6, 2026 05:59
Copilot AI review requested due to automatic review settings July 6, 2026 05:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds end-to-end support (UI + backend) for manually refreshing the TrexSQL cache for webapi datasets, and surfaces cache status details in the System Admin dataset UI.

Changes:

  • Adds a new “Refresh cache” action in the System Admin dataset action selector, wired to a new RefreshCacheDialog.
  • Enhances Source Information to fetch and display cache status (last refreshed / building / no cache) for webapi datasets.
  • Adds backend support for POST /system-portal/dataset/:id/refresh-cache and GET /system-portal/dataset/:id/cache-status, including auth routing and Deno tests.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
plugins/ui/apps/portal/src/types/study.ts Extends action value union to include refresh-cache.
plugins/ui/apps/portal/src/plugins/SystemAdmin/StudyOverview/StudyOverview.tsx Wires the refresh-cache handler and dialog into Study Overview.
plugins/ui/apps/portal/src/plugins/SystemAdmin/StudyOverview/SourceInformationDialog/SourceInformationDialog.tsx Fetches and displays cache status for webapi datasets.
plugins/ui/apps/portal/src/plugins/SystemAdmin/StudyOverview/RefreshCacheDialog/RefreshCacheDialog.tsx New UI dialog to trigger cache refresh.
plugins/ui/apps/portal/src/plugins/SystemAdmin/StudyOverview/RefreshCacheDialog/RefreshCacheDialog.scss Styles for the new refresh-cache dialog.
plugins/ui/apps/portal/src/plugins/SystemAdmin/StudyOverview/ActionSelector/ActionSelector.tsx Adds the refresh-cache action option and dispatch handler.
plugins/ui/apps/portal/src/contexts/app-context/states/translation-state.ts Adds new i18n keys for refresh-cache UI and cache status text.
plugins/ui/apps/portal/src/constant.ts Enables refresh-cache action for webapi dataset type.
plugins/ui/apps/portal/src/axios/system-portal.ts Adds client calls for refresh-cache and cache-status endpoints.
plugins/ui/apps/portal/public/translations/zh.json Adds Chinese translations for new refresh/cache status strings.
plugins/ui/apps/portal/public/translations/de.json Adds German translations for new refresh/cache status strings.
plugins/functions/portal/src/webapi/webapi-source.service.ts Adds refreshCache method and passes through lastModified.
plugins/functions/portal/src/webapi/webapi-source.service.test.ts Adds Deno unit tests for cache status + refresh delegation.
plugins/functions/portal/src/webapi/webapi-source.api.ts Extends cache-status response typing with lastModified.
plugins/functions/portal/src/dataset/dataset.controller.ts Adds the refresh-cache endpoint (and existing cache-status route).
plugins/functions/package.json Adds route auth scope entries for refresh-cache and cache-status.

Comment thread plugins/functions/portal/src/dataset/dataset.controller.ts
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.

Enable update cache action on webAPI datasets

4 participants