From da0867f9526f7361848dd4b9ab1d57a187732da1 Mon Sep 17 00:00:00 2001
From: Eric Peterson <ericpeterson@spotify.com>
Date: Fri, 12 Nov 2021 12:58:17 +0100
Subject: [PATCH] Account for legacy path casing in cache invalidation.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
---
 .../src/cache/cacheMiddleware.test.ts         |  4 +--
 .../src/service/DocsSynchronizer.test.ts      | 34 +++++++++++++++++--
 .../src/service/DocsSynchronizer.ts           | 10 +++++-
 3 files changed, 43 insertions(+), 5 deletions(-)

diff --git a/plugins/techdocs-backend/src/cache/cacheMiddleware.test.ts b/plugins/techdocs-backend/src/cache/cacheMiddleware.test.ts
index 4bd680e8c7..91e4b84222 100644
--- a/plugins/techdocs-backend/src/cache/cacheMiddleware.test.ts
+++ b/plugins/techdocs-backend/src/cache/cacheMiddleware.test.ts
@@ -46,12 +46,12 @@ describe('createCacheMiddleware', () => {
   let app: express.Express;
 
   beforeEach(async () => {
-    cache = ({
+    cache = {
       get: jest.fn().mockResolvedValue(undefined),
       set: jest.fn().mockResolvedValue(undefined),
       invalidate: jest.fn().mockResolvedValue(undefined),
       invalidateMultiple: jest.fn().mockResolvedValue(undefined),
-    } as unknown) as jest.Mocked<TechDocsCache>;
+    } as unknown as jest.Mocked<TechDocsCache>;
     const router = await createCacheMiddleware({
       logger: getVoidLogger(),
       cache,
diff --git a/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts b/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts
index 4089b08ef4..1eb8c8f56f 100644
--- a/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts
+++ b/plugins/techdocs-backend/src/service/DocsSynchronizer.test.ts
@@ -66,12 +66,12 @@ describe('DocsSynchronizer', () => {
     getBaseUrl: jest.fn(),
     getExternalBaseUrl: jest.fn(),
   };
-  const cache: jest.Mocked<TechDocsCache> = ({
+  const cache: jest.Mocked<TechDocsCache> = {
     get: jest.fn(),
     set: jest.fn(),
     invalidate: jest.fn(),
     invalidateMultiple: jest.fn(),
-  } as unknown) as jest.Mocked<TechDocsCache>;
+  } as unknown as jest.Mocked<TechDocsCache>;
 
   let docsSynchronizer: DocsSynchronizer;
   const mockResponseHandler: jest.Mocked<DocsSynchronizerSyncOpts> = {
@@ -270,6 +270,36 @@ describe('DocsSynchronizer', () => {
         entity,
       });
 
+      expect(mockResponseHandler.finish).toBeCalledWith({ updated: true });
+      expect(cache.invalidateMultiple).toHaveBeenCalledWith([
+        'default/component/test/index.html',
+      ]);
+    });
+
+    it('should invalidate expected files when source/cached metadata differ with legacy casing', async () => {
+      (shouldCheckForUpdate as jest.Mock).mockReturnValue(true);
+      (publisher.fetchTechDocsMetadata as jest.Mock).mockResolvedValue({
+        build_timestamp: 456,
+        files: ['index.html'],
+      });
+
+      const docsSynchronizerWithLegacy = new DocsSynchronizer({
+        publisher,
+        config: new ConfigReader({
+          techdocs: { legacyUseCaseSensitiveTripletPaths: true },
+        }),
+        logger: getVoidLogger(),
+        scmIntegrations: ScmIntegrations.fromConfig(new ConfigReader({})),
+        cache,
+      });
+
+      await docsSynchronizerWithLegacy.doCacheSync({
+        responseHandler: mockResponseHandler,
+        discovery,
+        token: undefined,
+        entity,
+      });
+
       expect(mockResponseHandler.finish).toBeCalledWith({ updated: true });
       expect(cache.invalidateMultiple).toHaveBeenCalledWith([
         'default/Component/test/index.html',
diff --git a/plugins/techdocs-backend/src/service/DocsSynchronizer.ts b/plugins/techdocs-backend/src/service/DocsSynchronizer.ts
index c6d198c41d..c7d5bf109a 100644
--- a/plugins/techdocs-backend/src/service/DocsSynchronizer.ts
+++ b/plugins/techdocs-backend/src/service/DocsSynchronizer.ts
@@ -180,7 +180,14 @@ export class DocsSynchronizer {
     const namespace = entity.metadata?.namespace || ENTITY_DEFAULT_NAMESPACE;
     const kind = entity.kind;
     const name = entity.metadata.name;
-    const entityTripletPath = `${namespace}/${kind}/${name}`;
+    const legacyPathCasing =
+      this.config.getOptionalBoolean(
+        'techdocs.legacyUseCaseSensitiveTripletPaths',
+      ) || false;
+    const tripletPath = `${namespace}/${kind}/${name}`;
+    const entityTripletPath = `${
+      legacyPathCasing ? tripletPath : tripletPath.toLocaleLowerCase()
+    }`;
     try {
       const [sourceMetadata, cachedMetadata] = await Promise.all([
         this.publisher.fetchTechDocsMetadata({ namespace, kind, name }),
@@ -211,6 +218,7 @@ export class DocsSynchronizer {
         finish({ updated: false });
       }
     } catch (e) {
+      assertError(e);
       // In case of error, log and allow the user to go about their business.
       this.logger.error(
         `Error syncing cache for ${entityTripletPath}: ${e.message}`,