Merge pull request #22 from apivideo/add-origin-headers

feat: add origin headers

Author: olivier-lando

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.0.11] - 2022-07-06
+- Add origin headers
+- 
 ## [1.0.10] - 2022-06-29
 - Retry even if the server is not responding.
 - Add possibility to define a custom retry policy.

dist/index.js

@@ -30,10 +30,18 @@ export declare type VideoUploadResponse = {
     };
 };
 declare type RetryStrategy = (retryCount: number, error: VideoUploadError) => number | null;
+interface Origin {
+    name: string;
+    version: string;
+}
 export interface CommonOptions {
     apiHost?: string;
     retries?: number;
     retryStrategy?: RetryStrategy;
+    origin?: {
+        application?: Origin;
+        sdk?: Origin;
+    };
 }
 export interface WithUploadToken {
     uploadToken: string;
@@ -85,5 +93,6 @@ export declare abstract class AbstractUploader<T> {
     doRefreshToken(): Promise<void>;
     private createXhrPromise;
     private withRetrier;
+    private static validateOrigin;
 }
 export {};

dist/src/abstract-uploader.d.ts

@@ -1,6 +1,6 @@
 {
   "name": "@api.video/video-uploader",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "api.video video uploader",
   "repository": {
     "type": "git",

package.json

@@ -33,10 +33,19 @@ export declare type VideoUploadResponse = {
 
 type RetryStrategy = (retryCount: number, error: VideoUploadError) => number | null;
 
+interface Origin {
+    name: string;
+    version: string;
+}
+
 export interface CommonOptions {
     apiHost?: string;
     retries?: number;
     retryStrategy?: RetryStrategy;
+    origin?: {
+        application?: Origin;
+        sdk?: Origin;
+    };
 }
 
 export interface WithUploadToken {
@@ -130,6 +139,17 @@ export abstract class AbstractUploader<T> {
         this.headers["AV-Origin-Client"] = "typescript-uploader:" + PACKAGE_VERSION;
         this.retries = options.retries || DEFAULT_RETRIES;
         this.retryStrategy = options.retryStrategy || DEFAULT_RETRY_STRATEGY(this.retries);
+
+        if (options.origin) {
+            if (options.origin.application) {
+                AbstractUploader.validateOrigin("application", options.origin.application);
+                this.headers["AV-Origin-App"] = `${options.origin.application.name}:${options.origin.application.version}`;
+            }
+            if (options.origin.sdk) {
+                AbstractUploader.validateOrigin("sdk", options.origin.sdk);
+                this.headers["AV-Origin-Sdk"] = `${options.origin.sdk.name}:${options.origin.sdk.version}`;
+            }
+        }
     }
 
     public onProgress(cb: (e: T) => void) {
@@ -195,7 +215,9 @@ export abstract class AbstractUploader<T> {
         return new Promise((resolve, reject) => {
             const xhr = new window.XMLHttpRequest();
             xhr.open("POST", `https://${this.apiHost}/auth/refresh`);
-
+            for (const headerName of Object.keys(this.headers)) {
+                if(headerName !== "Authorization") xhr.setRequestHeader(headerName, this.headers[headerName]);
+            }
             xhr.onreadystatechange = (_) => {
                 if (xhr.readyState === 4 && xhr.status >= 400) {
                     reject(this.parseErrorResponse(xhr));
@@ -286,4 +308,23 @@ export abstract class AbstractUploader<T> {
             }
         });
     }
+
+    private static validateOrigin(type: string, origin: Origin) {
+        if (!origin.name) {
+            throw new Error(`${type} name is required`);
+        }
+        if (!origin.version) {
+            throw new Error(`${type} version is required`);
+        }
+        if (!/^[\w-]{1,50}$/.test(origin.name)) {
+            throw new Error(
+                `Invalid ${type} name value. Allowed characters: A-Z, a-z, 0-9, '-', '_'. Max length: 50.`
+            );
+        }
+        if (!/^\d{1,3}(\.\d{1,3}(\.\d{1,3})?)?$/.test(origin.version)) {
+            throw new Error(
+                `Invalid ${type} version value. The version should match the xxx[.yyy][.zzz] pattern.`
+            );
+        }
+    }
 }

src/abstract-uploader.ts

@@ -1,7 +1,5 @@
 import { expect } from 'chai';
-import { ProgressiveUploader, ProgressiveUploadProgressEvent } from '../src/index';
-import mock from 'xhr-mock';
-import { DEFAULT_RETRY_STRATEGY } from '../src/abstract-uploader';
+import { AbstractUploader, DEFAULT_RETRY_STRATEGY } from '../src/abstract-uploader';
 
 describe('Default retrier', () => {
     const retrier = DEFAULT_RETRY_STRATEGY(10);
@@ -16,4 +14,16 @@ describe('Default retrier', () => {
         expect(retrier(8, { status: 502, raw: "" })).to.be.equal(144200);
         expect(retrier(8, { raw: "" })).to.be.equal(144200);
     });
+});
+
+describe('Origin header validation', () => {
+    const validateOrigin = (AbstractUploader as any).validateOrigin as (name: string, origin: { name?: string, version?: string }) => void;
+    it('should properly validate name', () => {
+        expect(() => validateOrigin("test", { version: "aa" })).to.throw("test name is required");
+        expect(() => validateOrigin("test", { name:"frf ds", version: "aa" })).to.throw("Invalid test name value. Allowed characters: A-Z, a-z, 0-9, '-', '_'. Max length: 50.");
+    });
+    it('should properly validate version', () => {
+        expect(() => validateOrigin("test", { name: "aa" })).to.throw("test version is required");
+        expect(() => validateOrigin("test", { name:"name", version: "a b" })).to.throw("Invalid test version value. The version should match the xxx[.yyy][.zzz] pattern.");
+    });
 });

test/abstract-uploader.ts

@@ -20,7 +20,7 @@ describe('Instanciation', () => {
         expect(() => new VideoUploader({
             uploadToken: "aa",
             file: new File([""], ""),
-            chunkSize: 1024*1024*1
+            chunkSize: 1024 * 1024 * 1
         })).to.throw("Invalid chunk size. Minimal allowed value: 5MB, maximum allowed value: 128MB.");
     });
 });
@@ -35,7 +35,7 @@ describe('Content-range', () => {
         const uploader = new VideoUploader({
             file: new File([new ArrayBuffer(17000000)], "filename"),
             uploadToken,
-            chunkSize: 5*1024*1024,
+            chunkSize: 5 * 1024 * 1024,
         });
 
         const expectedRanges = [
@@ -86,6 +86,45 @@ describe('Access token auth', () => {
 });
 
 
+describe('Origin headers', () => {
+    beforeEach(() => mock.setup());
+    afterEach(() => mock.teardown());
+
+    it('token value is correct', (done) => {
+        const accessToken = "1234";
+        const videoId = "9876";
+
+        const uploader = new VideoUploader({
+            file: new File([new ArrayBuffer(200)], "filename"),
+            accessToken,
+            videoId,
+            origin: {
+                application: {
+                    name: "application-name",
+                    version: "1.0.0"
+                },
+                sdk: {
+                    name: "sdk-name",
+                    version: "2.0.0"
+                }
+            }
+        });
+
+        mock.post(`https://ws.api.video/videos/${videoId}/source`, (req, res) => {
+            expect(req.header("av-origin-app")).to.be.eq("application-name:1.0.0");
+            expect(req.header("av-origin-sdk")).to.be.eq(`sdk-name:2.0.0`);
+            return res.status(201).body("{}");
+        });
+
+        uploader.upload().then(() => {
+            done();
+        });
+
+    });
+});
+
+
+
 describe('Refresh token', () => {
     beforeEach(() => mock.setup());
     afterEach(() => mock.teardown());
@@ -110,7 +149,7 @@ describe('Refresh token', () => {
             sourceCalls++;
             expect(req.header("content-range")).to.be.eq("part 1/1");
 
-            if(sourceCalls === 1) {
+            if (sourceCalls === 1) {
                 expect(req.header("authorization")).to.be.eq(`Bearer ${accessToken1}`);
                 return res.status(401).body("{}");
             }
@@ -172,7 +211,7 @@ describe('Progress listener', () => {
             file: new File([new ArrayBuffer(6000000)], "filename"),
             accessToken: "1234",
             videoId,
-            chunkSize: 5*1024*1024
+            chunkSize: 5 * 1024 * 1024
         });
 
         mock.post(`https://ws.api.video/videos/${videoId}/source`, (req, res) => res.status(201).body("{}"));
@@ -184,7 +223,7 @@ describe('Progress listener', () => {
                 ...lastUploadProgressEvent,
                 totalBytes: 6000000,
                 chunksCount: 2,
-                chunksBytes: 5*1024*1024,
+                chunksBytes: 5 * 1024 * 1024,
                 currentChunk: 2,
             });
             done();
@@ -228,7 +267,7 @@ describe('Errors & retries', () => {
         const uploader = new VideoUploader({
             file: new File([new ArrayBuffer(6000000)], "filename"),
             uploadToken,
-            chunkSize: 5*1024*1024,
+            chunkSize: 5 * 1024 * 1024,
             retryStrategy: (retryCount, error) => retryCount > 3 ? null : 10,
         });