ti2 1.0.115 → 1.0.118

package/README.md

@@ -56,6 +56,7 @@ Plugins are the connectores to other systems and/or features you intent to use;
 |searchAvailability|✓|✓|✓|✓|✓|✓|
 |searchQuote|✓|✓|✓|✓|✓|✓|
 |createBooking|✓|✓|✓|✓|✓|✓|
+|confirmBooking|✓|✓|✓|✓|✓|✓|
 |cancelBooking|✓|✓|✓|✓|✓|✓|
 |searchProductsForItinerary|||||||||✓|
 |searchAvailabilityForItinerary|||||||||✓|

package/__tests__/cache.js

@@ -15,6 +15,70 @@ describe('cache', () => {
   });
 
 
+  describe('saveIfNotExists', () => {
+    it('should only save the first value for a key', async () => {
+      const key = 'lock:test';
+      testKeys.push(key);
+
+      const firstSaved = await cache.saveIfNotExists({
+        pluginName: testPluginName,
+        key,
+        value: { owner: 'first' },
+        ttl: 60,
+      });
+      const secondSaved = await cache.saveIfNotExists({
+        pluginName: testPluginName,
+        key,
+        value: { owner: 'second' },
+        ttl: 60,
+      });
+
+      expect(firstSaved).toBe(true);
+      expect(secondSaved).toBe(false);
+      expect(await cache.get({ pluginName: testPluginName, key })).toEqual({ owner: 'first' });
+    });
+  });
+
+  describe('owner-token helpers', () => {
+    it('should only renew and drop a key when the expected value still owns it', async () => {
+      const key = 'owner-lock:test';
+      testKeys.push(key);
+
+      await cache.save({ pluginName: testPluginName, key, value: 'owner-a', ttl: 1 });
+
+      const renewedByWrongOwner = await cache.expireIfValue({
+        pluginName: testPluginName,
+        key,
+        value: 'owner-b',
+        ttl: 60,
+      });
+      const renewedByOwner = await cache.expireIfValue({
+        pluginName: testPluginName,
+        key,
+        value: 'owner-a',
+        ttl: 60,
+      });
+      const droppedByWrongOwner = await cache.dropIfValue({
+        pluginName: testPluginName,
+        key,
+        value: 'owner-b',
+      });
+
+      expect(renewedByWrongOwner).toBe(false);
+      expect(renewedByOwner).toBe(true);
+      expect(droppedByWrongOwner).toBe(false);
+      expect(await cache.get({ pluginName: testPluginName, key })).toBe('owner-a');
+
+      const droppedByOwner = await cache.dropIfValue({
+        pluginName: testPluginName,
+        key,
+        value: 'owner-a',
+      });
+      expect(droppedByOwner).toBe(true);
+      expect(await cache.get({ pluginName: testPluginName, key })).toBeFalsy();
+    });
+  });
+
   describe('scan', () => {
     it('should return keys matching the pattern without plugin prefix', async () => {
       // Save some test keys

package/api.yml

@@ -358,6 +358,39 @@ components:
           type: object
           allOf:     # Combines the BasicErrorModel and the inline model
             - $ref: '#/components/schemas/bookingDetail'
+    bookingDetailsForConfirm:
+      type: object
+      additionalProperties: true
+      description: Booking identifier; provide bookingId, id, ref, or reference
+      properties:
+        bookingId:
+          type: string
+        id:
+          type: string
+        ref:
+          type: string
+        reference:
+          type: string
+    confirmBookingReturn:
+      type: object
+      additionalProperties: true
+      properties:
+        confirmBookingReply:
+          type: object
+        booking:
+          type: object
+          properties:
+            ref:
+              type: string
+            id:
+              type: string
+            status:
+              type: string
+            serviceLines:
+              type: array
+              items:
+                type: object
+                additionalProperties: true
     packageSearchQuery:
       type: object
       additionalProperties: true
@@ -1815,6 +1848,85 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/cancellationReturn'
+  /bookings/{appKey}/{userId}/confirm:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Confirms a quote as a booking
+      operationId: confirmBooking
+      parameters:
+        - name: appKey
+          in: path
+          description: app to confirm the booking for, defaults to first token
+          required: true
+          example: 'travelgate-hotelx'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: Booking identifier to confirm
+        required:  true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/bookingDetailsForConfirm'
+      responses:
+        '200':
+          description: Booking confirmation details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/confirmBookingReturn'
+  /bookings/{appKey}/{userId}/{hint}/confirm:
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - bookings
+      summary: Confirms a quote as a booking for a specific hint
+      operationId: confirmBooking
+      parameters:
+        - name: appKey
+          in: path
+          description: app to confirm the booking for
+          required: true
+          example: 'travelgate'
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: the user/company that the appKey belongs to
+          required: true
+          schema:
+            type: string
+        - name: hint
+          in: path
+          description: a specific token hint to be used
+          required: true
+          example: 'travelgate-australia'
+          schema:
+            type: string
+      requestBody:
+        description: Booking identifier to confirm
+        required:  true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/bookingDetailsForConfirm'
+      responses:
+        '200':
+          description: Booking confirmation details
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/confirmBookingReturn'
   /packages/{appKey}/{userId}/search:
     post:
       security:

package/cache.js

@@ -5,6 +5,23 @@ const REDIS_URL = process.env.REDIS_URL || 'redis://redis:6379';
 const cache = new Redis(`${REDIS_URL}/2`);
 const defaultTTL = 60 * 60; // 1 hour
 
+const normalizeKey = ({
+  key: keyParam,
+  fn,
+  fnParams,
+  useFunctionFallback = false,
+}) => {
+  if (useFunctionFallback && !keyParam) {
+    return hash({ fn, fnParams });
+  }
+  if (typeof keyParam !== 'string') {
+    return hash(keyParam);
+  }
+  return keyParam;
+};
+
+const buildKey = ({ pluginName, ...args }) => `${pluginName}:${normalizeKey(args)}`;
+
 const save = async ({
   pluginName,
   key: keyParam,
@@ -12,12 +29,7 @@ const save = async ({
   skipTTL,
   ttl = defaultTTL,
 }) => {
-  const key = `${pluginName}:${(() => {
-    if (typeof keyParam !== 'string') {
-      return hash(keyParam);
-    }
-    return keyParam;
-  })()}`;
+  const key = buildKey({ pluginName, key: keyParam });
   // console.log('saving key', key);
   await cache.set(key, JSON.stringify(value));
   if (!skipTTL) {
@@ -25,16 +37,55 @@ const save = async ({
   }
 };
 
+const saveIfNotExists = async ({
+  pluginName,
+  key: keyParam,
+  value,
+  ttl = defaultTTL,
+}) => {
+  const key = buildKey({ pluginName, key: keyParam });
+  const result = await cache.set(key, JSON.stringify(value), 'EX', ttl, 'NX');
+  return result === 'OK';
+};
+
+const expireIfValue = async ({
+  pluginName,
+  key: keyParam,
+  value,
+  ttl = defaultTTL,
+}) => {
+  const key = buildKey({ pluginName, key: keyParam });
+  const expectedValue = JSON.stringify(value);
+  const result = await cache.eval(`
+    if redis.call('get', KEYS[1]) == ARGV[1] then
+      return redis.call('expire', KEYS[1], ARGV[2])
+    end
+    return 0
+  `, 1, key, expectedValue, ttl);
+  return result === 1;
+};
+
+const dropIfValue = async ({
+  pluginName,
+  key: keyParam,
+  value,
+}) => {
+  const key = buildKey({ pluginName, key: keyParam });
+  const expectedValue = JSON.stringify(value);
+  const result = await cache.eval(`
+    if redis.call('get', KEYS[1]) == ARGV[1] then
+      return redis.call('del', KEYS[1])
+    end
+    return 0
+  `, 1, key, expectedValue);
+  return result === 1;
+};
+
 const get = async ({
   pluginName,
   key: keyParam,
 }) => {
-  const key = `${pluginName}:${(() => {
-    if (typeof keyParam !== 'string') {
-      return hash(keyParam);
-    }
-    return keyParam;
-  })()}`;
+  const key = buildKey({ pluginName, key: keyParam });
   const storeVal = await cache.get(key);
   if (!storeVal) return storeVal;
   return JSON.parse(storeVal);
@@ -48,15 +99,7 @@ const getOrExec = async ({
   fnParams,
   forceRefresh,
 }) => {
-  const key = (() => {
-    if (!keyParam) {
-      return hash({ fn, fnParams });
-    }
-    if (typeof keyParam !== 'string') {
-      return hash(keyParam);
-    }
-    return keyParam;
-  })();
+  const key = normalizeKey({ key: keyParam, fn, fnParams, useFunctionFallback: true });
   let value;
   if (!forceRefresh) {
     value = await get({ pluginName, key });
@@ -78,15 +121,13 @@ const drop = async ({
   fn,
   fnParams,
 }) => {
-  const key = `${pluginName}:${(() => {
-    if (!keyParam) {
-      return hash({ fn, fnParams });
-    }
-    if (typeof keyParam !== 'string') {
-      return hash(keyParam);
-    }
-    return keyParam;
-  })()}`;
+  const key = buildKey({
+    pluginName,
+    key: keyParam,
+    fn,
+    fnParams,
+    useFunctionFallback: true,
+  });
   // console.log('dropping key', key);
   await cache.del(key);
 };
@@ -116,6 +157,9 @@ const scan = ({
 module.exports = {
   cache,
   save,
+  saveIfNotExists,
+  expireIfValue,
+  dropIfValue,
   getOrExec,
   drop,
   get,