Refactor workspace cache service by Weiko · Pull Request #16208 · twentyhq/twenty

Weiko · 2025-12-01T09:19:27Z

Context

We've recently introduced a new workspace cache service which now acts as a cache access and local storage for all workspace related data, deprecating the individual specific services.

Better performance through multiple caching/fetching strategies
Consistent data access patterns across the codebase
Reduced redis queries through MGET/MSET/PIPELINE with multiple cache keys

packages/twenty-server/src/engine/workspace-cache/services/workspace-cache.service.ts

greptile-apps

_{74 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

...ne/metadata-modules/workspace-permissions-cache/workspace-roles-permissions-cache.service.ts

github-actions · 2025-12-01T09:30:47Z

🚀 Preview Environment Ready!

Your preview environment is available at: http://bore.pub:53705

This environment will automatically shut down when the PR is closed or after 5 hours.

Weiko · 2025-12-01T14:19:19Z

@greptileai trigger

greptile-apps · 2025-12-01T14:23:32Z

Greptile Overview

Greptile Summary

This PR successfully consolidates workspace-level caching into a unified WorkspaceCacheService, replacing individual cache services with a provider-based pattern. The refactor delivers significant architectural improvements through multiple caching layers (local 100ms, memoized 10s, Redis), batch operations (MGET/MSET/MDEL), and hash-based cache validation.

Key Improvements:

Reduced local cache TTL from 30s to 100ms for faster invalidation while maintaining performance through memoization
Added strongly-typed cache keys with proper TypeScript inference
Implemented batch Redis operations via pipelining for improved performance
Simplified individual cache services by 50-70% LOC through provider pattern
Fixed previously flagged bug in workspace-roles-permissions-cache.service.ts:138
Added comprehensive test coverage for new cache service

Migration Impact:

77 files changed with net -557 lines (1307 added, 1864 deleted)
All workspace-related cache services migrated to new pattern
Removed deprecated cache storage service and outdated test files
Module imports updated consistently across codebase

Confidence Score: 5/5

This PR is safe to merge with no critical issues found
The refactoring follows solid architectural patterns with comprehensive testing, proper type safety, and systematic migration across all affected services. The previously flagged bug has been fixed, and the implementation demonstrates good understanding of caching strategies with multiple layers of optimization.
No files require special attention

Important Files Changed

File Analysis

Filename	Score	Overview
packages/twenty-server/src/engine/workspace-cache/services/workspace-cache.service.ts	5/5	Core cache service refactored with improved type safety, reduced TTL from 30s to 100ms, added hash-based validation, and MGET/MSET for batch operations
packages/twenty-server/src/engine/workspace-cache/types/workspace-cache-key.type.ts	5/5	New type definitions providing strongly-typed cache keys with proper type inference and result mapping
packages/twenty-server/src/engine/metadata-modules/workspace-permissions-cache/workspace-roles-permissions-cache.service.ts	5/5	Migrated to new cache provider pattern, fixed loop assignment bug (line 138 now correctly outside inner loop)
packages/twenty-server/src/engine/workspace-cache/services/tests/workspace-cache.service.spec.ts	5/5	Comprehensive test suite covering cache initialization, TTL staleness, Redis interactions, invalidation, and multi-key operations
packages/twenty-server/src/engine/core-modules/cache-storage/services/cache-storage.service.ts	5/5	Added `mdel` and `mset` methods for batch Redis operations using pipelining
packages/twenty-server/src/engine/metadata-modules/workspace-feature-flags-map-cache/workspace-feature-flags-map-cache.service.ts	5/5	Simplified from 76 lines to 25 lines by extending WorkspaceCacheProvider and removing manual cache management

Sequence Diagram

sequenceDiagram
    participant Client as Service/Controller
    participant WCS as WorkspaceCacheService
    participant Local as Local Cache (Map)
    participant Memoizer as Promise Memoizer
    participant Redis as Redis (CacheStorageService)
    participant Provider as Cache Provider

    Client->>WCS: getOrRecompute(workspaceId, keys)
    WCS->>Memoizer: Check memoized result
    
    alt Result in Memoizer (< 10s)
        Memoizer-->>WCS: Return cached result
        WCS-->>Client: Return data
    else Not in Memoizer
        WCS->>Local: Check local cache (TTL 100ms)
        
        alt Fresh in Local Cache
            Local-->>WCS: Return fresh data
            WCS-->>Client: Return data
        else Stale in Local Cache
            WCS->>Redis: MGET hash keys
            Redis-->>WCS: Return hashes
            
            alt Hash matches local
                WCS->>Local: Update timestamp
                WCS-->>Client: Return local data
            else Hash mismatch or missing
                WCS->>Redis: MGET data keys
                Redis-->>WCS: Return data
                
                alt Data exists in Redis
                    WCS->>Local: Store with new hash
                    WCS-->>Client: Return Redis data
                else Data missing
                    WCS->>Provider: computeForCache(workspaceId)
                    Provider->>Provider: Query database
                    Provider-->>WCS: Return computed data
                    WCS->>Redis: MSET data + hash via pipeline
                    WCS->>Local: Store with hash
                    WCS->>Memoizer: Cache result
                    WCS-->>Client: Return computed data
                end
            end
        end
    end
    
    Note over Client,Provider: Invalidation Flow
    Client->>WCS: invalidateAndRecompute(workspaceId, keys)
    WCS->>Memoizer: clearKeys(prefix)
    WCS->>Redis: MDEL data + hash keys
    WCS->>Local: Delete entries
    WCS->>Provider: computeForCache(workspaceId)
    Provider-->>WCS: Fresh data
    WCS->>Redis: MSET data + hash
    WCS->>Local: Store with hash
    WCS-->>Client: Done

greptile-apps

_{77 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

charlesBochet · 2025-12-01T15:49:49Z

packages/twenty-server/src/engine/core-modules/cache-storage/services/cache-storage.service.ts

+      return;
+    }
+
+    if (this.isRedisCache()) {


this should move to the driver but OK given the current state of other method of cache-storage service

charlesBochet · 2025-12-01T15:51:09Z

...etadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service.ts


 import { ALL_FLAT_ENTITY_MAPS_PROPERTIES } from 'src/engine/metadata-modules/flat-entity/constant/all-flat-entity-maps-properties.constant';
 import { AllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/all-flat-entity-maps.type';
-import { WorkspaceFlatMapCacheRegistryService } from 'src/engine/workspace-flat-map-cache/services/workspace-flat-map-cache-registry.service';
-import { WorkspaceFlatMapCacheService } from 'src/engine/workspace-flat-map-cache/services/workspace-flat-map-cache.service';
+import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';

 @Injectable()
 export class WorkspaceManyOrAllFlatEntityMapsCacheService {


I guess we can get rid of this service?

Yes, I'm in favor of this as well but I'm leaving as it is for now to avoid conflict with prastoin work. @charlesBochet

...ne/metadata-modules/workspace-permissions-cache/workspace-roles-permissions-cache.service.ts

charlesBochet · 2025-12-01T15:54:47Z

packages/twenty-server/src/engine/twenty-orm/factories/workspace-datasource.factory.ts

+      'rolesPermissions',
+    ]);
+
+    const cachedFeatureFlagMapVersion = crypto


I'm a bit of surprise we have to compute this here, shouldn't it be the hashVersion directly?

it's for legacy only, the cache service does not expose those keys and they are needed for the legacy datasource so I'm recomputing them again here. (this won't be needed later though) @charlesBochet

charlesBochet · 2025-12-01T15:55:26Z

packages/twenty-server/src/engine/twenty-orm/storage/promise-memoizer.storage.ts

@@ -96,6 +96,12 @@ export class PromiseMemoizer<T> {
        await this.clearKey(cacheKey, onDelete);
      }
    }
+
+    for (const cacheKey of [...this.pending.keys()]) {


charlesBochet · 2025-12-01T15:56:10Z

packages/twenty-server/src/engine/workspace-cache/types/workspace-cache-key.type.ts

+import { type AllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/all-flat-entity-maps.type';
+import { type UserWorkspaceRoleMap } from 'src/engine/metadata-modules/workspace-permissions-cache/types/user-workspace-role-map.type';
+
+export const WORKSPACE_CACHE_KEYS_V2 = {


found it :p

charlesBochet · 2025-12-01T15:56:38Z

...migration-v2/workspace-migration-runner-v2/services/workspace-migration-runner-v2.service.ts

-            },
-          ),
-        ],
+        this.workspaceCacheService.invalidateAndRecompute(workspaceId, [


charlesBochet

Bravo!

twenty-eng-sync · 2025-12-01T16:08:31Z

Hey @Weiko! After you've done the QA of your Pull Request, you can mark it as done here. Thank you!

Weiko added 7 commits November 28, 2025 11:41

refactor workspace cache services

04b0e9f

refactor flat cache services

e2b4305

move feature flag cache to new cache

6707d92

fix import

26d51db

migrate permissions cache

5898356

Merge branch 'main' into c--refactor-workspace-cache-service

a14f4da

move role/role target to cache v2

4661c36

Weiko added the -PR: awaiting review label Dec 1, 2025

Weiko commented Dec 1, 2025

View reviewed changes

packages/twenty-server/src/engine/workspace-cache/services/workspace-cache.service.ts Outdated Show resolved Hide resolved

lint

4658d35

greptile-apps bot reviewed Dec 1, 2025

View reviewed changes

...ne/metadata-modules/workspace-permissions-cache/workspace-roles-permissions-cache.service.ts Outdated Show resolved Hide resolved

Weiko added 3 commits December 1, 2025 11:55

add missing mocks

43080bf

implement mdel

0b9ff2b

fix rare race condition in caching + fix mock

e12f6e1

twentyhq deleted a comment from greptile-apps bot Dec 1, 2025

greptile-apps bot reviewed Dec 1, 2025

View reviewed changes

Weiko requested a review from charlesBochet December 1, 2025 14:28

Weiko assigned charlesBochet Dec 1, 2025

charlesBochet assigned Weiko and unassigned charlesBochet Dec 1, 2025

charlesBochet reviewed Dec 1, 2025

View reviewed changes

...ne/metadata-modules/workspace-permissions-cache/workspace-roles-permissions-cache.service.ts Show resolved Hide resolved

charlesBochet reviewed Dec 1, 2025

View reviewed changes

charlesBochet approved these changes Dec 1, 2025

View reviewed changes

charlesBochet added -PR: ready to merge and removed -PR: awaiting review labels Dec 1, 2025

Weiko merged commit 1eb2e44 into main Dec 1, 2025
62 of 63 checks passed

Weiko deleted the c--refactor-workspace-cache-service branch December 1, 2025 16:08

Conversation

Weiko commented Dec 1, 2025

Context

Uh oh!

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Weiko commented Dec 1, 2025

Uh oh!

greptile-apps bot commented Dec 1, 2025

Greptile Overview

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Sequence Diagram

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

charlesBochet left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

twenty-eng-sync bot commented Dec 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions bot commented Dec 1, 2025 •

edited

Loading