refactor(cache): separate web-ui-settings cache from payload cache #632

fraxken · 2025-12-14T17:34:15Z

No description provided.

workspaces/cache/docs/AppCache.md

Update workspaces/cache/docs/AppCache.md Co-authored-by: PierreDemailly <[email protected]> Update workspaces/cache/docs/AppCache.md Co-authored-by: PierreDemailly <[email protected]> Update workspaces/cache/docs/AppCache.md Co-authored-by: PierreDemailly <[email protected]> Update workspaces/cache/docs/AppCache.md Co-authored-by: PierreDemailly <[email protected]>

Copilot

Pull request overview

This PR refactors the cache system to separate web UI settings from payload caching by introducing a generic FilePersistanceProvider class. The previous monolithic AppCache class handled both configuration and payload caching, which has now been split into specialized components.

Key changes:

Introduced FilePersistanceProvider<T> as a generic file-based caching abstraction using cacache
Moved payload-related caching logic to a dedicated AppCache.ts file
Implemented web UI settings caching using FilePersistanceProvider in the server's config module

Reviewed changes

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

Show a summary per file

File	Description
workspaces/cache/src/FilePersistanceProvider.ts	New generic file persistence provider with get/set/remove methods for cached data
workspaces/cache/src/AppCache.ts	Extracted AppCache class from index.ts, focusing on payload management
workspaces/cache/src/index.ts	Refactored to export both AppCache and FilePersistanceProvider via barrel exports
workspaces/server/src/config.ts	Refactored to use FilePersistanceProvider for web UI settings instead of AppCache
workspaces/server/src/cache.ts	Removed AppConfig export, simplified to only export cache instance
workspaces/server/src/endpoints/config.ts	Updated to use WebUISettings type instead of AppConfig
workspaces/server/src/index.ts	Added config module export for external access
workspaces/server/src/websocket/*.ts	Updated imports to reference AppCache from dist directory
workspaces/cache/test/FilePersistanceProvider.test.ts	New comprehensive test suite for FilePersistanceProvider
workspaces/server/test/config.test.ts	Updated to use FilePersistanceProvider instead of cacache directly
workspaces/server/test/httpServer.test.ts	Updated to use config module methods instead of direct cacache access
workspaces/cache/test/index.test.ts	Removed config-related test now covered in server tests
workspaces/cache/package.json	Updated test script to run all test files
workspaces/cache/docs/*.md	Added documentation for AppCache and FilePersistanceProvider
workspaces/cache/README.md	Updated to reference new documentation structure
src/commands/cache.js	Added config.setDefault() call when clearing cache

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-15T17:12:54Z

workspaces/server/src/websocket/index.ts

 import { match } from "ts-pattern";
 import type { Logger } from "pino";
-import type { AppCache } from "@nodesecure/cache";
+import type { AppCache } from "@nodesecure/cache/dist/AppCache.ts";


The import path references the compiled output directory (/dist/AppCache.ts) instead of using the package's main export. Consider importing from "@nodesecure/cache" directly, which would use the barrel export defined in the package's index.ts. This would make the imports more maintainable and follow standard package consumption patterns.

Suggested change

import type { AppCache } from "@nodesecure/cache/dist/AppCache.ts";

import type { AppCache } from "@nodesecure/cache";

Copilot · 2025-12-15T17:12:55Z

workspaces/server/src/websocket/commands/search.ts

 // Import Third-party Dependencies
 import * as scanner from "@nodesecure/scanner";
-import type { PayloadsList, AppCache } from "@nodesecure/cache";
+import type { PayloadsList, AppCache } from "@nodesecure/cache/dist/AppCache.ts";


The import path references the compiled output directory (/dist/AppCache.ts) instead of using the package's main export. Consider importing from "@nodesecure/cache" directly, which would use the barrel export defined in the package's index.ts. This would make the imports more maintainable and follow standard package consumption patterns.

Suggested change

import type { PayloadsList, AppCache } from "@nodesecure/cache/dist/AppCache.ts";

import type { PayloadsList, AppCache } from "@nodesecure/cache";

Copilot · 2025-12-15T17:12:55Z

workspaces/server/src/websocket/commands/remove.ts

@@ -1,5 +1,5 @@
 // Import Third-party Dependencies
-import type { PayloadsList } from "@nodesecure/cache";
+import type { PayloadsList } from "@nodesecure/cache/dist/AppCache.ts";


The import path references the compiled output directory (/dist/AppCache.ts) instead of using the package's main export. Consider importing from "@nodesecure/cache" directly, which would use the barrel export defined in the package's index.ts. This would make the imports more maintainable and follow standard package consumption patterns.

Suggested change

import type { PayloadsList } from "@nodesecure/cache/dist/AppCache.ts";

import type { PayloadsList } from "@nodesecure/cache";

Copilot · 2025-12-15T17:12:56Z

workspaces/cache/src/index.ts

-  }
-}
+export * from "./AppCache.ts";
+export * from "./FilePersistanceProvider.ts";


Spelling error: "Persistance" should be "Persistence". The filename should be "FilePersistenceProvider.ts" and the export should reference the corrected filename.

Suggested change

export * from "./FilePersistanceProvider.ts";

export * from "./FilePersistenceProvider.ts";

Copilot · 2025-12-15T17:12:56Z

workspaces/cache/test/FilePersistanceProvider.test.ts

+// Import Internal Dependencies
+import { FilePersistanceProvider } from "../src/FilePersistanceProvider.ts";
+
+describe("FilePersistanceProvider", () => {


Spelling error: "Persistance" should be "Persistence". Update test suite name to use the corrected class name.

Copilot · 2025-12-15T17:12:58Z

workspaces/server/src/config.ts

 import { warnings, type WarningName } from "@nodesecure/js-x-ray";
+import type { Flag } from "@nodesecure/flags";
+import {
+  FilePersistanceProvider


Spelling error: "Persistance" should be "Persistence". Update the import to use the corrected class name.

Copilot · 2025-12-15T17:12:58Z

workspaces/server/src/websocket/websocket.types.ts

 // Import Third-party Dependencies
 import type { WebSocket } from "ws";
-import type { AppCache, PayloadsList } from "@nodesecure/cache";
+import type { AppCache, PayloadsList } from "@nodesecure/cache/dist/AppCache.ts";


The import path references the compiled output directory (/dist/AppCache.ts) instead of using the package's main export. Consider importing from "@nodesecure/cache" directly, which would use the barrel export defined in the package's index.ts. This would make the imports more maintainable and follow standard package consumption patterns.

Suggested change

import type { AppCache, PayloadsList } from "@nodesecure/cache/dist/AppCache.ts";

import type { AppCache, PayloadsList } from "@nodesecure/cache";

Copilot · 2025-12-15T17:12:58Z

workspaces/cache/docs/FilePersistanceProvider.md

+## Interfaces
+
+```ts
+interface BasePersistanceProvider<T> {


Spelling error: "Persistance" should be "Persistence". Update the interface name in the documentation.

Suggested change

interface BasePersistanceProvider<T> {

interface BasePersistenceProvider<T> {

Copilot · 2025-12-15T17:12:59Z

workspaces/cache/README.md

-}
-```
+- [AppCache](./docs/AppCache.md)
+- [FilePersistanceProvider](./docs/FilePersistanceProvider.md)


Spelling error: "Persistance" should be "Persistence". Update the documentation link to use the corrected filename.

Suggested change

- [FilePersistanceProvider](./docs/FilePersistanceProvider.md)

- [FilePersistenceProvider](./docs/FilePersistenceProvider.md)

Copilot · 2025-12-15T17:12:59Z

workspaces/server/src/config.ts

-  }
-  catch (err: any) {
-    logger.error(`[config|get](error: ${err.message})`);
+export function getProvider(): FilePersistanceProvider<WebUISettings> {


Spelling error: "Persistance" should be "Persistence". Update the return type to use the corrected class name.

fraxken force-pushed the refactor-app-cache branch from 5b34bd0 to 4288324 Compare December 15, 2025 16:34

fraxken marked this pull request as ready for review December 15, 2025 16:34

fraxken requested review from PierreDemailly, clemgbld and Copilot December 15, 2025 16:34

PierreDemailly approved these changes Dec 15, 2025

View reviewed changes

workspaces/cache/docs/AppCache.md Outdated Show resolved Hide resolved

workspaces/cache/docs/AppCache.md Outdated Show resolved Hide resolved

workspaces/cache/docs/AppCache.md Outdated Show resolved Hide resolved

workspaces/cache/docs/AppCache.md Outdated Show resolved Hide resolved

fraxken force-pushed the refactor-app-cache branch from fc9e517 to 39b37be Compare December 15, 2025 17:01

Copilot started reviewing on behalf of fraxken December 15, 2025 17:05 View session

fraxken merged commit 96af191 into master Dec 15, 2025
13 checks passed

fraxken deleted the refactor-app-cache branch December 15, 2025 17:09

Copilot AI reviewed Dec 15, 2025

View reviewed changes

	import type { AppCache } from "@nodesecure/cache/dist/AppCache.ts";
	import type { AppCache } from "@nodesecure/cache";

	import type { PayloadsList, AppCache } from "@nodesecure/cache/dist/AppCache.ts";
	import type { PayloadsList, AppCache } from "@nodesecure/cache";

	import type { PayloadsList } from "@nodesecure/cache/dist/AppCache.ts";
	import type { PayloadsList } from "@nodesecure/cache";

	export * from "./FilePersistanceProvider.ts";
	export * from "./FilePersistenceProvider.ts";

	import type { AppCache, PayloadsList } from "@nodesecure/cache/dist/AppCache.ts";
	import type { AppCache, PayloadsList } from "@nodesecure/cache";

	interface BasePersistanceProvider<T> {
	interface BasePersistenceProvider<T> {

	- [FilePersistanceProvider](./docs/FilePersistanceProvider.md)
	- [FilePersistenceProvider](./docs/FilePersistenceProvider.md)

refactor(cache): separate web-ui-settings cache from payload cache #632

refactor(cache): separate web-ui-settings cache from payload cache #632

Uh oh!

Conversation

fraxken commented Dec 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants