Feature/expiry helpers (#408)

* adding expiry helpers for cache invalidation

* dont forget to write tests

* adding unit test for getExpiryDateTimeFromNow

* adding unit test for has expired

Author: just-at-uber

client/constants.js

@@ -76,6 +76,8 @@ export const NOTIFICATION_TYPE_SUCCESS = 'success';
 export const NOTIFICATION_TYPE_WARNING = 'warning';
 export const NOTIFICATION_TIMEOUT = 5000;
 
+export const ONE_HOUR_IN_MILLISECONDS = 60 * 60 * 1000;
+
 export const TIME_FORMAT_12 = 'TIME_FORMAT_12';
 export const TIME_FORMAT_24 = 'TIME_FORMAT_24';
 export const TIME_FORMAT_OPTIONS = [

client/helpers/get-expiry-date-time-from-now.js

@@ -0,0 +1,30 @@
+// Copyright (c) 2021 Uber Technologies Inc.
+//
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+import moment from 'moment';
+import { ONE_HOUR_IN_MILLISECONDS } from '../constants';
+
+const getExpiryDateTimeFromNow = (time = ONE_HOUR_IN_MILLISECONDS) =>
+  moment()
+    .add(ONE_HOUR_IN_MILLISECONDS)
+    .toISOString();
+
+export default getExpiryDateTimeFromNow;

client/helpers/get-expiry-date-time-from-now.spec.js

@@ -0,0 +1,39 @@
+// Copyright (c) 2021 Uber Technologies Inc.
+//
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+import MockDate from 'mockdate';
+import getExpiryDateTimeFromNow from './get-expiry-date-time-from-now';
+
+describe('getExpiryDateTimeFromNow', () => {
+  beforeEach(() => {
+    MockDate.set(new Date('2020-01-01T00:00:00.000Z'));
+  });
+
+  afterEach(() => {
+    MockDate.reset();
+  });
+
+  it('should return a date 1 hour in the future', () => {
+    const output = getExpiryDateTimeFromNow();
+
+    expect(output).toEqual('2020-01-01T01:00:00.000Z');
+  });
+});

client/helpers/has-expired.js

@@ -0,0 +1,32 @@
+// Copyright (c) 2021 Uber Technologies Inc.
+//
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+import moment from 'moment';
+
+const hasExpired = expiryDateTime => {
+  if (!expiryDateTime) {
+    return true;
+  }
+
+  return moment().isAfter(expiryDateTime);
+};
+
+export default hasExpired;

client/helpers/has-expired.spec.js

@@ -0,0 +1,57 @@
+// Copyright (c) 2021 Uber Technologies Inc.
+//
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+import MockDate from 'mockdate';
+import hasExpired from './has-expired';
+
+describe('hasExpired', () => {
+  beforeEach(() => {
+    MockDate.set(new Date('2020-01-01T00:00:00.000Z'));
+  });
+
+  afterEach(() => {
+    MockDate.reset();
+  });
+
+  describe('when expiryDateTime is not passed', () => {
+    it('should return true.', () => {
+      const output = hasExpired();
+
+      expect(output).toEqual(true);
+    });
+  });
+
+  describe('when expiryDateTime is in the past', () => {
+    it('should return true.', () => {
+      const output = hasExpired(new Date('2019-12-30T00:00:00.000Z'));
+
+      expect(output).toEqual(true);
+    });
+  });
+
+  describe('when expiryDateTime is in the future', () => {
+    it('should return false.', () => {
+      const output = hasExpired(new Date('2020-01-01T01:00:00.000Z'));
+
+      expect(output).toEqual(false);
+    });
+  });
+});

client/helpers/index.js

@@ -27,12 +27,14 @@ export { default as getEnvironment } from './get-environment';
 export { default as getEnvironmentList } from './get-environment-list';
 export { default as getEnvironmentLocation } from './get-environment-location';
 export { default as getErrorMessage } from './get-error-message';
+export { default as getExpiryDateTimeFromNow } from './get-expiry-date-time-from-now';
 export { default as getJsonStringObject } from './get-json-string-object';
 export { default as getKeyValuePairs } from './get-key-value-pairs';
 export { default as getLatestNewsItems } from './get-latest-news-items';
 export { default as getQueryStringFromObject } from './get-query-string-from-object';
 export { default as getStartTimeIsoString } from './get-start-time-iso-string';
 export { default as getStringElipsis } from './get-string-elipsis';
+export { default as hasExpired } from './has-expired';
 export { default as injectMomentDurationFormat } from './inject-moment-duration-format';
 export { default as jsonTryParse } from './json-try-parse';
 export { default as mapDomainDescription } from './map-domain-description';