feat: add secureUploadsExpireThreshold option

uploadcare · May 24, 2024 · 0d9205d · 0d9205d
1 parent 0574d8b
commit 0d9205d
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 12 deletions.
diff --git a/abstract/SecureUploadsManager.js b/abstract/SecureUploadsManager.js
@@ -38,7 +38,10 @@ export class SecureUploadsManager {
     }
 
     if (secureUploadsSignatureResolver) {
-      if (!this._secureToken || isSecureTokenExpired(this._secureToken)) {
+      if (
+        !this._secureToken ||
+        isSecureTokenExpired(this._secureToken, { threshold: this._block.cfg.secureUploadsExpireThreshold })
+      ) {
         if (!this._secureToken) {
           this._debugPrint('Secure signature is not set yet.');
         } else {
@@ -53,6 +56,10 @@ export class SecureUploadsManager {
             console.error('Secure signature resolver returned an invalid result:', result);
           } else {
             this._debugPrint('Secure signature resolved:', result);
+            this._debugPrint(
+              'Secure signature will expire in',
+              new Date(Number(result.secureExpire) * 1000).toISOString(),
+            );
             this._secureToken = result;
           }
         } catch (err) {

diff --git a/abstract/UploaderBlock.js b/abstract/UploaderBlock.js
@@ -831,7 +831,7 @@ export class UploaderBlock extends ActivityBlock {
   async getUploadClientOptions() {
     /** @type {SecureUploadsManager} */
     const secureUploadsManager = this.$['*secureUploadsManager'];
-    const secureToken = await secureUploadsManager.getSecureToken();
+    const secureToken = await secureUploadsManager.getSecureToken().catch(() => null);
 
     let options = {
       store: this.cfg.store,

diff --git a/blocks/Config/initialConfig.js b/blocks/Config/initialConfig.js
@@ -60,6 +60,7 @@ export const initialConfig = {
   metadata: null,
   localeName: 'en',
   localeDefinitionOverride: null,
+  secureUploadsExpireThreshold: 10 * 60 * 1000,
   secureUploadsSignatureResolver: null,
   secureDeliveryProxyUrlResolver: null,
   iconHrefResolver: null,

diff --git a/blocks/Config/normalizeConfigValue.js b/blocks/Config/normalizeConfigValue.js
@@ -133,6 +133,7 @@ const mapping = {
   localeName: asString,
 
   metadata: asMetadata,
+  secureUploadsExpireThreshold: asNumber,
   localeDefinitionOverride: /** @type {typeof asObject<import('../../types').LocaleDefinitionOverride>} */ (asObject),
   secureUploadsSignatureResolver:
     /** @type {typeof asFunction<import('../../types').SecureUploadsSignatureResolver>} */ (asFunction),

diff --git a/types/exported.d.ts b/types/exported.d.ts
@@ -60,7 +60,8 @@ export type ConfigType = {
   userAgentIntegration: string;
   debug: boolean;
   localeName: string;
-
+  secureUploadsExpireThreshold: number; 
+
   // Complex types
   metadata: Metadata | MetadataCallback | null;
   localeDefinitionOverride: LocaleDefinitionOverride | null;

diff --git a/utils/isSecureTokenExpired.js b/utils/isSecureTokenExpired.js
@@ -6,9 +6,9 @@ const msToUnixTimestamp = (ms) => Math.floor(ms / 1000);
  * but will expire in the next 10 seconds, it will return false.
  *
  * @param {import('../types').SecureUploadsSignatureAndExpire} secureToken
- * @param {{ threshold?: number }} [options]
+ * @param {{ threshold?: number }} options
  */
-export const isSecureTokenExpired = (secureToken, { threshold } = { threshold: 10 * 1000 }) => {
+export const isSecureTokenExpired = (secureToken, { threshold }) => {
   const { secureExpire } = secureToken;
   const nowUnix = msToUnixTimestamp(Date.now());
   const expireUnix = Number(secureExpire);

diff --git a/utils/isSecureTokenExpired.test.js b/utils/isSecureTokenExpired.test.js
@@ -3,6 +3,7 @@ import { expect } from '@esm-bundle/chai';
 import * as sinon from 'sinon';
 
 const DATE_NOW = 60 * 1000;
+const THRESHOLD = 10 * 1000;
 
 describe('isSecureTokenExpired', () => {
   let clock;
@@ -15,18 +16,18 @@ describe('isSecureTokenExpired', () => {
   });
 
   it('should return true if the token is expired', () => {
-    expect(isSecureTokenExpired({ secureExpire: '0', secureSignature: '' })).to.equal(true);
-    expect(isSecureTokenExpired({ secureExpire: '59', secureSignature: '' })).to.equal(true);
+    expect(isSecureTokenExpired({ secureExpire: '0', secureSignature: '' }, { threshold: THRESHOLD })).to.equal(true);
+    expect(isSecureTokenExpired({ secureExpire: '59', secureSignature: '' }, { threshold: THRESHOLD })).to.equal(true);
   });
 
   it('should return true if the token will expire in the next 10 seconds', () => {
-    expect(isSecureTokenExpired({ secureExpire: '60', secureSignature: '' })).to.equal(true);
-    expect(isSecureTokenExpired({ secureExpire: '61', secureSignature: '' })).to.equal(true);
-    expect(isSecureTokenExpired({ secureExpire: '70', secureSignature: '' })).to.equal(true);
+    expect(isSecureTokenExpired({ secureExpire: '60', secureSignature: '' }, { threshold: THRESHOLD })).to.equal(true);
+    expect(isSecureTokenExpired({ secureExpire: '61', secureSignature: '' }, { threshold: THRESHOLD })).to.equal(true);
+    expect(isSecureTokenExpired({ secureExpire: '70', secureSignature: '' }, { threshold: THRESHOLD })).to.equal(true);
   });
 
   it("should return false if the token is not expired and won't expire in next 10 seconds", () => {
-    expect(isSecureTokenExpired({ secureExpire: '71', secureSignature: '' })).to.equal(false);
-    expect(isSecureTokenExpired({ secureExpire: '80', secureSignature: '' })).to.equal(false);
+    expect(isSecureTokenExpired({ secureExpire: '71', secureSignature: '' }, { threshold: THRESHOLD })).to.equal(false);
+    expect(isSecureTokenExpired({ secureExpire: '80', secureSignature: '' }, { threshold: THRESHOLD })).to.equal(false);
   });
 });