Improve datasource creation resilience to missing cache

twentyhq · Jul 27, 2024 · 5a1835e · 5a1835e
1 parent 0349d02
commit 5a1835e
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 35 deletions.
diff --git a/packages/twenty-server/src/engine/twenty-orm/factories/workspace-datasource.factory.ts b/packages/twenty-server/src/engine/twenty-orm/factories/workspace-datasource.factory.ts
@@ -28,13 +28,47 @@ export class WorkspaceDatasourceFactory {
     workspaceId: string,
     cacheVersion: string | null,
   ): Promise<WorkspaceDataSource> {
-    cacheVersion ??=
-      await this.workspaceCacheVersionService.getVersion(workspaceId);
+    const desiredCacheVersion =
+      cacheVersion ??
+      (await this.workspaceCacheVersionService.getVersion(workspaceId));
 
-    if (!cacheVersion) {
+    if (!desiredCacheVersion) {
       throw new Error('Cache version not found');
     }
 
+    const latestCacheVersion =
+      await this.workspaceCacheVersionService.getVersion(workspaceId);
+
+    if (latestCacheVersion !== desiredCacheVersion) {
+      throw new Error('Cache version mismatch');
+    }
+
+    let cachedObjectMetadataCollection =
+      await this.workspaceCacheStorageService.getObjectMetadataCollection(
+        workspaceId,
+      );
+
+    if (!cachedObjectMetadataCollection) {
+      const freshObjectMetadataCollection =
+        await this.objectMetadataRepository.find({
+          where: { workspaceId },
+          relations: [
+            'fields.object',
+            'fields',
+            'fields.fromRelationMetadata',
+            'fields.toRelationMetadata',
+            'fields.fromRelationMetadata.toObjectMetadata',
+          ],
+        });
+
+      await this.workspaceCacheStorageService.setObjectMetadataCollection(
+        workspaceId,
+        freshObjectMetadataCollection,
+      );
+
+      cachedObjectMetadataCollection = freshObjectMetadataCollection;
+    }
+
     const workspaceDataSource = await workspaceDataSourceCacheInstance.execute(
       `${workspaceId}-${cacheVersion}`,
       async () => {
@@ -47,38 +81,12 @@ export class WorkspaceDatasourceFactory {
           throw new Error('Data source metadata not found');
         }
 
-        const latestCacheVersion =
-          await this.workspaceCacheVersionService.getVersion(workspaceId);
-
-        if (latestCacheVersion !== cacheVersion) {
-          throw new Error('Cache version mismatch');
-        }
-
-        let objectMetadataCollection =
-          await this.workspaceCacheStorageService.getObjectMetadataCollection(
-            workspaceId,
-          );
-
-        if (!objectMetadataCollection) {
-          objectMetadataCollection = await this.objectMetadataRepository.find({
-            where: { workspaceId },
-            relations: [
-              'fields.object',
-              'fields',
-              'fields.fromRelationMetadata',
-              'fields.toRelationMetadata',
-              'fields.fromRelationMetadata.toObjectMetadata',
-            ],
-          });
-
-          await this.workspaceCacheStorageService.setObjectMetadataCollection(
-            workspaceId,
-            objectMetadataCollection,
-          );
+        if (!cachedObjectMetadataCollection) {
+          throw new Error('Object metadata collection not found');
         }
 
         const entities = await Promise.all(
-          objectMetadataCollection.map((objectMetadata) =>
+          cachedObjectMetadataCollection.map((objectMetadata) =>
             this.entitySchemaFactory.create(workspaceId, objectMetadata),
           ),
         );

diff --git a/packages/twenty-server/src/engine/twenty-orm/repository/workspace.repository.ts b/packages/twenty-server/src/engine/twenty-orm/repository/workspace.repository.ts
@@ -634,7 +634,7 @@ export class WorkspaceRepository<
         );
 
       throw new Error(
-        `Object metadata for object "${objectMetadataName}" is missing` +
+        `Object metadata for object "${objectMetadataName}" is missing ` +
           `in workspace "${this.internalContext.workspaceId}" ` +
           `with object metadata collection length: ${objectMetadataCollection?.length}`,
       );

diff --git a/packages/twenty-server/src/engine/workspace-cache-storage/workspace-cache-storage.service.ts b/packages/twenty-server/src/engine/workspace-cache-storage/workspace-cache-storage.service.ts
@@ -1,4 +1,4 @@
-import { Injectable } from '@nestjs/common';
+import { Injectable, Logger } from '@nestjs/common';
 
 import { CacheStorageService } from 'src/engine/integrations/cache-storage/cache-storage.service';
 import { InjectCacheStorage } from 'src/engine/integrations/cache-storage/decorators/cache-storage.decorator';
@@ -8,6 +8,8 @@ import { WorkspaceCacheVersionService } from 'src/engine/metadata-modules/worksp
 
 @Injectable()
 export class WorkspaceCacheStorageService {
+  private readonly logger = new Logger(WorkspaceCacheStorageService.name);
+
   constructor(
     @InjectCacheStorage(CacheStorageNamespace.WorkspaceSchema)
     private readonly workspaceSchemaCache: CacheStorageService,
@@ -24,7 +26,11 @@ export class WorkspaceCacheStorageService {
       await this.workspaceCacheVersionService.getVersion(workspaceId);
 
     if (!latestVersion || currentVersion !== latestVersion) {
-      // Invalidate cache if version mismatch is detected
+      // Invalidate cache if version mismatch is detected"
+      this.logger.log(
+        `Cache version mismatch detected for workspace ${workspaceId}. Current version: ${currentVersion}. Latest version: ${latestVersion}. Invalidating cache...`,
+      );
+
       await this.invalidateCache(workspaceId);
 
       // If the latest version is not found, increment the version