@contrail/flexplm 1.7.7-alpha.d153eea → 1.7.7-alpha.e66ae52

package/lib/util/flexplm-connect.js

@@ -4,19 +4,6 @@ exports.FlexPLMConnect = void 0;
 const app_framework_1 = require("@contrail/app-framework");
 // Module-level on purpose: a new FlexPLMConnect is constructed for every event. Declaring for Session reusing use case.
 const sessionCache = new Map();
-// Upper bound so users/option combinations that are never requested again cannot accumulate cookies forever.
-const MAX_CACHED_SESSIONS = 100;
-const pruneSessionCache = () => {
-    const now = Date.now();
-    for (const [key, session] of sessionCache) {
-        if (session.expiresAt <= now)
-            sessionCache.delete(key);
-    }
-    // Still full: drop the oldest entries (Map keeps insertion order).
-    while (sessionCache.size >= MAX_CACHED_SESSIONS) {
-        sessionCache.delete(sessionCache.keys().next().value);
-    }
-};
 // In-flight cold session acquisitions per key, so concurrent events share one FlexPLM session instead of each creating their own.
 const inFlightAcquisitions = new Map();
 const DEFAULT_SESSION_COOKIE_NAME = 'JSESSIONID';
@@ -157,11 +144,7 @@ class FlexPLMConnect {
     }
     storeSession(cookie) {
         // sliding expiry: Windchill's session timeout is also sliding
-        const key = this.getSessionKey();
-        // delete first so a refreshed entry moves to the newest position (oldest-first eviction then acts as LRU)
-        sessionCache.delete(key);
-        pruneSessionCache();
-        sessionCache.set(key, { cookie, expiresAt: Date.now() + this.sessionOptions.ttlMs });
+        sessionCache.set(this.getSessionKey(), { cookie, expiresAt: Date.now() + this.sessionOptions.ttlMs });
     }
     clearSession() {
         sessionCache.delete(this.getSessionKey());
@@ -243,7 +226,7 @@ class FlexPLMConnect {
             await wait;
         if (getNewSession) {
             const current = this.getCachedSession();
-            if (rejectedCookie === undefined || !current || current === rejectedCookie)
+            if (!current || current === rejectedCookie)
                 this.clearSession();
         }
         const cached = this.getCachedSession();

package/lib/util/flexplm-connect.spec.js

@@ -156,7 +156,7 @@ describe('FlexPLMConnect session reuse', () => {
         expect(callHeaders(1).Cookie).toBe('JSESSIONID=abc.tomcat1');
         expect(callHeaders(1).CSRF_NONCE).toBe('n1');
     });
-    it('should reuse the cached session on the next event (new FlexPLMConnect instance)', async () => {
+    it('reuses the cached session on the next event (new FlexPLMConnect instance)', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=abc.tomcat1; Path=/'])) // event 1 GET
@@ -168,7 +168,7 @@ describe('FlexPLMConnect session reuse', () => {
         expect(callHeaders(2).Cookie).toBe('JSESSIONID=abc.tomcat1'); // GET reuses it
         expect(callHeaders(3).Cookie).toBe('JSESSIONID=abc.tomcat1'); // POST reuses it
     });
-    it('should replace the cached session when Windchill answers the GET with a new Set-Cookie', async () => {
+    it('replaces the cached session when Windchill answers the GET with a new Set-Cookie', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=old.tomcat1; Path=/']))
@@ -185,7 +185,7 @@ describe('FlexPLMConnect session reuse', () => {
         expect(callHeaders(3).Cookie).toBe('JSESSIONID=new.tomcat1'); // POST uses the replacement
         expect(callHeaders(4).Cookie).toBe('JSESSIONID=new.tomcat1'); // event 3 GET sends the replacement
     });
-    it('should retry once with a new session when the POST is rejected with 403', async () => {
+    it('retries once with a new session when the POST is rejected with 403', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=old.tomcat1; Path=/'])) // GET
@@ -199,7 +199,7 @@ describe('FlexPLMConnect session reuse', () => {
         expect(result.status).toBe(200);
         expect(result.data).toEqual({ ok: true });
     });
-    it('should also retry on 401', async () => {
+    it('also retries on 401', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=old.tomcat1']))
@@ -209,7 +209,7 @@ describe('FlexPLMConnect session reuse', () => {
         await new flexplm_connect_1.FlexPLMConnect(sessionConfig(u)).sendToFlexPLM(payload);
         expect(fetchMock()).toHaveBeenCalledTimes(4);
     });
-    it('should not loop: a second 403 after the retry is surfaced as an error', async () => {
+    it('does not loop: a second 403 after the retry is surfaced as an error', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=old.tomcat1']))
@@ -220,7 +220,7 @@ describe('FlexPLMConnect session reuse', () => {
             .rejects.toThrow('Error sending data to FlexPLM:status: 403');
         expect(fetchMock()).toHaveBeenCalledTimes(4);
     });
-    it('should not retry on non-auth errors such as 500 (event may already be processed)', async () => {
+    it('does not retry on non-auth errors such as 500 (event may already be processed)', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=abc.tomcat1']))
@@ -229,7 +229,7 @@ describe('FlexPLMConnect session reuse', () => {
             .rejects.toThrow('Error sending data to FlexPLM:status: 500');
         expect(fetchMock()).toHaveBeenCalledTimes(2);
     });
-    it('should retry the csrf GET without a cookie when the cached session is rejected there', async () => {
+    it('retries the csrf GET without a cookie when the cached session is rejected there', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=old.tomcat1'])) // event 1 GET
@@ -243,7 +243,7 @@ describe('FlexPLMConnect session reuse', () => {
         expect(callHeaders(3).Cookie).toBeUndefined();
         expect(callHeaders(4).Cookie).toBe('JSESSIONID=new.tomcat1');
     });
-    it('should expire the cached session after ttlSeconds', async () => {
+    it('expires the cached session after ttlSeconds', async () => {
         const u = uniqueUser();
         const realNow = Date.now();
         const nowSpy = jest.spyOn(Date, 'now').mockReturnValue(realNow);
@@ -260,7 +260,7 @@ describe('FlexPLMConnect session reuse', () => {
         expect(callHeaders(3).Cookie).toBe('JSESSIONID=def.tomcat1');
         nowSpy.mockRestore();
     });
-    it('should use the last JSESSIONID when several Set-Cookie lines are returned', async () => {
+    it('uses the last JSESSIONID when several Set-Cookie lines are returned', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=first.tomcat1; Path=/', 'OTHER=x; Path=/', 'JSESSIONID=second.tomcat1; Path=/']))
@@ -268,7 +268,7 @@ describe('FlexPLMConnect session reuse', () => {
         await new flexplm_connect_1.FlexPLMConnect(sessionConfig(u)).sendToFlexPLM(payload);
         expect(callHeaders(1).Cookie).toBe('JSESSIONID=second.tomcat1');
     });
-    it('should fall back to headers.get("set-cookie") when getSetCookie is not available', async () => {
+    it('falls back to headers.get("set-cookie") when getSetCookie is not available', async () => {
         const u = uniqueUser();
         const legacy = {
             status: 200,
@@ -280,7 +280,7 @@ describe('FlexPLMConnect session reuse', () => {
         await new flexplm_connect_1.FlexPLMConnect(sessionConfig(u)).sendToFlexPLM(payload);
         expect(callHeaders(1).Cookie).toBe('JSESSIONID=legacy.tomcat1');
     });
-    it('should honour a custom cookieName', async () => {
+    it('honours a custom cookieName', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['MYSESSION=zzz; Path=/', 'JSESSIONID=ignored; Path=/']))
@@ -288,7 +288,7 @@ describe('FlexPLMConnect session reuse', () => {
         await new flexplm_connect_1.FlexPLMConnect(sessionConfig(u, { enabled: true, cookieName: 'MYSESSION' })).sendToFlexPLM(payload);
         expect(callHeaders(1).Cookie).toBe('MYSESSION=zzz');
     });
-    it('should accept enabled as the string "true"', async () => {
+    it('accepts enabled as the string "true"', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=abc.tomcat1']))
@@ -296,39 +296,7 @@ describe('FlexPLMConnect session reuse', () => {
         await new flexplm_connect_1.FlexPLMConnect(sessionConfig(u, { enabled: 'true' })).sendToFlexPLM(payload);
         expect(callHeaders(1).Cookie).toBe('JSESSIONID=abc.tomcat1');
     });
-    it('should evict expired sessions of other users when a new session is stored', async () => {
-        const userA = uniqueUser();
-        const userB = uniqueUser();
-        const realNow = Date.now();
-        const nowSpy = jest.spyOn(Date, 'now').mockReturnValue(realNow);
-        fetchMock()
-            .mockResolvedValueOnce(resp(200, ['JSESSIONID=a.tomcat1'])) // A GET
-            .mockResolvedValueOnce(resp(200, [], {})) // A POST
-            .mockResolvedValueOnce(resp(200, ['JSESSIONID=b.tomcat1'])) // B GET
-            .mockResolvedValueOnce(resp(200, [], {})) // B POST
-            .mockResolvedValueOnce(resp(200, ['JSESSIONID=a2.tomcat1'])) // A GET again
-            .mockResolvedValueOnce(resp(200, [], {}));
-        const cfg = (u) => sessionConfig(u, { enabled: true, ttlSeconds: 1 });
-        await new flexplm_connect_1.FlexPLMConnect(cfg(userA)).sendToFlexPLM(payload);
-        nowSpy.mockReturnValue(realNow + 2000); // A has expired
-        await new flexplm_connect_1.FlexPLMConnect(cfg(userB)).sendToFlexPLM(payload); // storing B sweeps A
-        nowSpy.mockReturnValue(realNow); // rewind: only a swept A has no entry left
-        await new flexplm_connect_1.FlexPLMConnect(cfg(userA)).sendToFlexPLM(payload);
-        expect(callHeaders(4).Cookie).toBeUndefined();
-        nowSpy.mockRestore();
-    });
-    it('should not hold more than the maximum number of cached sessions', async () => {
-        const first = uniqueUser();
-        fetchMock().mockImplementation(async () => resp(200, ['JSESSIONID=s.tomcat1']));
-        await new flexplm_connect_1.FlexPLMConnect(sessionConfig(first)).sendToFlexPLM(payload);
-        for (let i = 0; i < 100; i++) {
-            await new flexplm_connect_1.FlexPLMConnect(sessionConfig(uniqueUser())).sendToFlexPLM(payload);
-        }
-        fetchMock().mockClear();
-        await new flexplm_connect_1.FlexPLMConnect(sessionConfig(first)).sendToFlexPLM(payload);
-        expect(callHeaders(0).Cookie).toBeUndefined(); // oldest entry was evicted
-    });
-    it('should keep separate sessions per user', async () => {
+    it('keeps separate sessions per user', async () => {
         const a = uniqueUser();
         const b = uniqueUser();
         fetchMock()
@@ -341,7 +309,7 @@ describe('FlexPLMConnect session reuse', () => {
         expect(callHeaders(2).Cookie).toBeUndefined(); // user b must not see user a's cookie
         expect(callHeaders(3).Cookie).toBe('JSESSIONID=bbb.tomcat1');
     });
-    it('should never log the cookie value', async () => {
+    it('never logs the cookie value', async () => {
         const isInfoOn = jest.spyOn(app_framework_1.Logger, 'isInfoOn').mockReturnValue(true);
         const info = jest.spyOn(console, 'info').mockImplementation();
         const u = uniqueUser();
@@ -372,11 +340,11 @@ describe('FlexPLMConnect session reuse', () => {
             ['a comma separated string', '401, 403'],
             ['garbage (falls back to 401/403)', 'abc'],
             ['an empty array (falls back to 401/403)', []],
-        ])('should not throw and still retry on 403 when retryStatuses is %s', async (_label, retryStatuses) => {
+        ])('retryStatuses given as %s does not throw and still retries on 403', async (_label, retryStatuses) => {
             await rejectedOnceThenOk(uniqueUser(), { retryStatuses });
             expect(fetchMock()).toHaveBeenCalledTimes(4);
         });
-        it.each([['abc'], [0], [-5]])('should fall back to the 900s default when ttlSeconds is invalid (%p)', async (ttlSeconds) => {
+        it.each([['abc'], [0], [-5]])('invalid ttlSeconds (%p) falls back to the 900s default', async (ttlSeconds) => {
             const u = uniqueUser();
             const realNow = Date.now();
             const nowSpy = jest.spyOn(Date, 'now').mockReturnValue(realNow);
@@ -392,7 +360,7 @@ describe('FlexPLMConnect session reuse', () => {
             expect(callHeaders(2).Cookie).toBe('JSESSIONID=abc.tomcat1');
             nowSpy.mockRestore();
         });
-        it('should fall back to JSESSIONID when cookieName is blank', async () => {
+        it('a blank cookieName falls back to JSESSIONID', async () => {
             const u = uniqueUser();
             fetchMock()
                 .mockResolvedValueOnce(resp(200, ['JSESSIONID=abc.tomcat1']))
@@ -505,7 +473,7 @@ describe('FlexPLMConnect session reuse', () => {
         });
     });
     describe('cookie names containing regex metacharacters', () => {
-        it('should extract a cookie whose name contains "+"', async () => {
+        it('extracts a cookie whose name contains "+"', async () => {
             const u = uniqueUser();
             fetchMock()
                 .mockResolvedValueOnce(resp(200, ['SID+=abc; Path=/']))
@@ -513,7 +481,7 @@ describe('FlexPLMConnect session reuse', () => {
             await new flexplm_connect_1.FlexPLMConnect(sessionConfig(u, { enabled: true, cookieName: 'SID+' })).sendToFlexPLM(payload);
             expect(callHeaders(1).Cookie).toBe('SID+=abc');
         });
-        it('should treat "." literally and not match a look-alike cookie', async () => {
+        it('treats "." literally and does not match a look-alike cookie', async () => {
             const u = uniqueUser();
             fetchMock()
                 .mockResolvedValueOnce(resp(200, ['AxB=wrong; Path=/']))
@@ -525,7 +493,7 @@ describe('FlexPLMConnect session reuse', () => {
     describe('concurrent session acquisition', () => {
         const flush = () => new Promise(r => setImmediate(r));
         const isColdGet = (call) => call[1].method === 'GET' && !call[1].headers.Cookie;
-        it('should share one session across concurrent events on a cold cache', async () => {
+        it('shares one session across concurrent events on a cold cache', async () => {
             const u = uniqueUser();
             let release;
             const gate = new Promise(r => { release = r; });
@@ -544,7 +512,7 @@ describe('FlexPLMConnect session reuse', () => {
             expect(fetchMock().mock.calls.filter(isColdGet)).toHaveLength(1);
             results.forEach(r => expect(r.sessionCookie).toBe('abc.tomcat1'));
         });
-        it('should not make a waiter inherit the failure of the first acquisition', async () => {
+        it('a waiter does not inherit the failure of the first acquisition', async () => {
             const u = uniqueUser();
             let release;
             const gate = new Promise(r => { release = r; });
@@ -559,7 +527,7 @@ describe('FlexPLMConnect session reuse', () => {
             expect(await firstResult).toBeInstanceOf(Error);
             expect((await second).sessionCookie).toBe('abc.tomcat1');
         });
-        it('should create only one replacement session for parallel events rejected with 403', async () => {
+        it('parallel events rejected with 403 create only one replacement session', async () => {
             const u = uniqueUser();
             fetchMock().mockResolvedValueOnce(resp(200, ['JSESSIONID=old.tomcat1']));
             await new flexplm_connect_1.FlexPLMConnect(sessionConfig(u)).getCSRF(); // prime the cache with the old session
@@ -579,7 +547,7 @@ describe('FlexPLMConnect session reuse', () => {
 });
 describe('FlexPLMConnect session reuse - feature disabled (default)', () => {
     const payload = { id: '123' };
-    it('should send no Cookie header and make exactly one GET + one POST', async () => {
+    it('sends no Cookie header and makes exactly one GET + one POST', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=abc.tomcat1'])) // Set-Cookie present but must be ignored
@@ -593,7 +561,7 @@ describe('FlexPLMConnect session reuse - feature disabled (default)', () => {
             expect(callHeaders(i).Cookie).toBeUndefined();
         }
     });
-    it('should not retry on 403 (behaves exactly as before)', async () => {
+    it('does not retry on 403 (behaves exactly as before)', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200))
@@ -602,7 +570,7 @@ describe('FlexPLMConnect session reuse - feature disabled (default)', () => {
             .rejects.toThrow('Error sending data to FlexPLM:status: 403');
         expect(fetchMock()).toHaveBeenCalledTimes(2);
     });
-    it('should behave the same as not configured when enabled is false', async () => {
+    it('explicit enabled:false behaves the same as not configured', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=abc.tomcat1']))
@@ -612,7 +580,7 @@ describe('FlexPLMConnect session reuse - feature disabled (default)', () => {
     });
 });
 describe('FlexPLMConnect.getRequest session reuse', () => {
-    it('should send the cached cookie on image/GET requests', async () => {
+    it('sends the cached cookie on image/GET requests', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=abc.tomcat1'])) // csrf GET primes the cache
@@ -623,7 +591,7 @@ describe('FlexPLMConnect.getRequest session reuse', () => {
         await connect.getRequest();
         expect(callHeaders(2).Cookie).toBe('JSESSIONID=abc.tomcat1');
     });
-    it('should retry once without the cookie when the cached session is rejected on getRequest', async () => {
+    it('retries once without the cookie when the cached session is rejected on getRequest', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=abc.tomcat1']))
@@ -636,7 +604,7 @@ describe('FlexPLMConnect.getRequest session reuse', () => {
         expect(callHeaders(2).Cookie).toBe('JSESSIONID=abc.tomcat1');
         expect(callHeaders(3).Cookie).toBeUndefined();
     });
-    it('should not re-store the rejected cookie when the retry issues no Set-Cookie', async () => {
+    it('does not re-store the rejected cookie when the retry issues no Set-Cookie', async () => {
         const u = uniqueUser();
         fetchMock()
             .mockResolvedValueOnce(resp(200, ['JSESSIONID=stale.tomcat1']))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.7.7-alpha.d153eea",
+  "version": "1.7.7-alpha.e66ae52",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",