@ibm-aspera/sdk 0.2.2

package/tests/client.spec.ts

@@ -0,0 +1,52 @@
+import {mockFetch} from './mocks';
+import {httpClient, getRpcServerUrl} from '../src/helpers/client/http-client';
+
+let id = 0;
+
+const getHeaders = () => {
+  return {
+    'content-type': 'application/json',
+  };
+};
+
+const getMethod = () => {
+  return 'POST';
+};
+
+const getBody = (method: string, params: any = {}) => {
+  return JSON.stringify({
+    jsonrpc: '2.0',
+    id,
+    method,
+    params,
+  });
+};
+
+const getExpectedRequest = (method: string, params: any = {}) => {
+  id++;
+
+  return {
+    method: getMethod(),
+    headers: getHeaders(),
+    body: getBody(method, params),
+  };
+};
+
+describe('request', () => {
+  beforeEach(() => {
+    (<any>global).fetch = mockFetch({});
+  });
+
+  const fakeData = {data: 'testing'};
+  const rpcServerURL = getRpcServerUrl();
+
+  test('POST with no params should call url with no params', () => {
+    httpClient.request('fake');
+    expect(fetch).toHaveBeenCalledWith(rpcServerURL, getExpectedRequest('fake'));
+  });
+
+  test('POST with params should call url with params', () => {
+    httpClient.request('fake', fakeData);
+    expect(fetch).toHaveBeenCalledWith(rpcServerURL, getExpectedRequest('fake', fakeData));
+  });
+});

package/tests/core.spec.ts

@@ -0,0 +1,13 @@
+import {mockFetch} from './mocks';
+import {init} from '../src';
+
+describe('initHttpGateway', () => {
+  beforeEach(() => {
+    (<any>global).fetch = mockFetch({});
+  });
+
+  test('calls default URL', async () => {
+    init({appId: 'fake'}).catch(() => {});
+    // expect(fetch).toBeCalled();
+  });
+});

package/tests/helpers.spec.ts

@@ -0,0 +1,124 @@
+import {JSONRPCErrorException} from 'json-rpc-2.0';
+import {
+  errorLog,
+  generateErrorBody,
+  generatePromiseObjects,
+  isValidTransferSpec,
+  isValidURL
+} from '../src/helpers/helpers';
+import {TransferSpec} from '../src/models/models';
+
+describe('generatePromiseObjects', () => {
+
+  test('returns object containg promise, rejecter and resolver', () => {
+    const promiseItem = generatePromiseObjects();
+    expect(typeof promiseItem.promise.then).toBe('function');
+    expect(typeof promiseItem.resolver).toBe('function');
+    expect(typeof promiseItem.rejecter).toBe('function');
+  });
+});
+
+describe('errorLog', () => {
+
+  beforeEach(() => {
+    (<any>window).asperaSdkLogs = undefined;
+    jest.spyOn(global.console, 'warn');
+  });
+
+  test('with message and no debug data should store in array and console', () => {
+    const consoleWarnCall = jest.fn();
+    console.warn = consoleWarnCall;
+    const testMessage = 'Test message';
+    expect((<any>window).asperaSdkLogs).toBe(undefined);
+    errorLog(testMessage);
+    expect(console.warn).toBeCalled();
+    expect((<any>window).asperaSdkLogs[0].message).toBe(testMessage);
+    expect((<any>window).asperaSdkLogs[0].debugData).toBe(undefined);
+  });
+
+  test('with message and debug data should store in array and console', () => {
+    const testMessage = 'Test message';
+    expect((<any>window).asperaSdkLogs).toBe(undefined);
+    errorLog(testMessage, {error: true});
+    expect(console.warn).toBeCalled();
+    expect((<any>window).asperaSdkLogs[0].message).toBe(testMessage);
+    expect((<any>window).asperaSdkLogs[0].debugData.error).toBe(true);
+  });
+});
+
+describe('generateErrorBody', () => {
+
+  test('should return error object without debugData if nothing is passed', () => {
+    const errorResponse = generateErrorBody('testing');
+    expect(errorResponse.message).toBe('testing');
+    expect(errorResponse.error).toBe(true);
+    expect(errorResponse.debugData).toBe(undefined);
+  });
+
+  test('should return error object with debugData if data is passed', () => {
+    const errorTest = new JSONRPCErrorException('testing error body', -32002, {foo: 'bar'});
+    const errorResponse = generateErrorBody('testing', errorTest);
+    expect(errorResponse.message).toBe('testing');
+    expect(errorResponse.error).toBe(true);
+    expect(errorResponse.debugData.message).toBe('testing error body');
+    expect(errorResponse.debugData.code).toBe(-32002);
+    expect(errorResponse.debugData.data).toStrictEqual({foo: 'bar'});
+  });
+});
+
+describe('isValidTransferSpec', () => {
+  const transferSpec: TransferSpec = {
+    authentication: 'token',
+    paths: [
+      {
+        source: '/foo'
+      }
+    ],
+    direction: 'receive',
+    remote_host: 'localhost'
+  };
+  const invalidTransferSpecs: any[] = [
+    null,
+    undefined,
+    'transfer',
+    85
+  ];
+
+  test('should return true if valid transferSpec', () => {
+    expect(isValidTransferSpec(transferSpec)).toBe(true);
+  });
+
+  test('should return false if invalid transferSpec', () => {
+    invalidTransferSpecs.forEach(element => {
+      expect(isValidTransferSpec(element)).toBe(false);
+    });
+  });
+});
+
+describe('isValidURL', () => {
+  const validUrls = [
+    'http://www.aspera.us',
+    'https://www.aspera.us',
+    'https://aspera.us',
+    'https://aspera.us/aspera/sdk/latest.json',
+    'https://aspera.us///aspera/sdk',
+  ];
+  const invalidUrls = [
+    'aspera.us',
+    '/aspera/sdk',
+    'aspera',
+  ];
+
+  test('should return true if valid url', () => {
+    validUrls.forEach(url => {
+      expect(isValidURL(url)).toBe(true);
+    });
+  });
+
+  test('should return false if invalid url', () => {
+    invalidUrls.forEach(url => {
+      expect(isValidURL(url)).toBe(false);
+    });
+  });
+});
+

package/tests/http.spec.ts

@@ -0,0 +1,14 @@
+import {apiGet} from '../src/helpers/http';
+import {mockFetch} from './mocks';
+
+describe('apiGet', () => {
+
+  beforeEach(() => {
+    (<any>global).fetch = mockFetch({});
+  });
+
+  test('GET should call url', () => {
+    apiGet('aspera.us');
+    expect(fetch).toHaveBeenCalledWith('aspera.us', {headers: {'Content-Type': 'application/json'}});
+  });
+});

package/tests/installer.spec.ts

@@ -0,0 +1,135 @@
+import {getInstallerInfo} from '../src/app/installer';
+import {installerUrl} from '../src/constants/constants';
+import {mockFetch} from './mocks';
+
+describe('getInstallerInfo', () => {
+  const defaultHeaders = {headers: {'Content-Type': 'application/json'}};
+
+  beforeEach(() => {
+    const response = {
+      entries: [
+        {
+          'version': '1.2.0',
+          'platform': 'macos',
+          'type': 'dmg',
+          'arch': 'universal',
+          'url': 'https://d3gcli72yxqn2z.cloudfront.net/downloads/desktop/macos/1.2.0/stable/universal/ibm-aspera-sdk_1.2.0_macos.dmg'
+        },
+        {
+          'version': '1.2.0',
+          'platform': 'windows',
+          'type': 'msi',
+          'arch': 'x64',
+          'url': 'https://d3gcli72yxqn2z.cloudfront.net/downloads/desktop/windows/1.2.0/stable/x64/ibm-aspera-sdk_1.2.0.msi'
+        },
+        {
+          'version': '1.1.9',
+          'platform': 'linux',
+          'type': 'rpm',
+          'arch': 'x64',
+          'url': 'https://d3gcli72yxqn2z.cloudfront.net/downloads/desktop/linux/1.1.9/stable/x64/ibm-aspera-sdk_1.1.9.rpm'
+        },
+        {
+          'version': '1.1.9',
+          'platform': 'linux',
+          'type': 'appimage',
+          'arch': 'x64',
+          'url': 'https://d3gcli72yxqn2z.cloudfront.net/downloads/desktop/linux/1.1.9/stable/x64/ibm-aspera-sdk_1.1.9.AppImage'
+        }
+      ]
+    };
+    (<any>global).fetch = mockFetch(response);
+    console.warn = jest.fn();
+  });
+
+  test('called with no options fetches from Amazon CloudFront by default', () => {
+    getInstallerInfo().catch(() => {});
+    expect(fetch).toHaveBeenCalledWith(`${installerUrl}/latest.json`, defaultHeaders);
+  });
+
+  test('called with no options returns results for specific platform', async () => {
+    Object.defineProperty(window.navigator, 'userAgent', {value : 'Macintosh'});
+    const exp = [
+      {
+        'version': '1.2.0',
+        'platform': 'macos',
+        'type': 'dmg',
+        'arch': 'universal',
+        'url': 'https://d3gcli72yxqn2z.cloudfront.net/downloads/desktop/macos/1.2.0/stable/universal/ibm-aspera-sdk_1.2.0_macos.dmg'
+      }
+    ];
+    const data = await getInstallerInfo();
+    expect(data.entries).toEqual(exp);
+  });
+
+  test('called with all returns results for all platforms', async () => {
+    const data = await getInstallerInfo({all: true});
+    expect(data.entries.length).toBe(4);
+  });
+
+  test('called with endpoint', () => {
+    getInstallerInfo({endpoint: 'https://aspera.us/aspera/sdk'}).catch(() => {});
+    expect(fetch).toHaveBeenCalledWith('https://aspera.us/aspera/sdk/latest.json', defaultHeaders);
+  });
+
+  test('called with endpoint with trailing json file', () => {
+    getInstallerInfo({endpoint: 'https://aspera.us/aspera/sdk/latest.json'}).catch(() => {});
+    expect(fetch).toHaveBeenCalledWith('https://aspera.us/aspera/sdk/latest.json', defaultHeaders);
+  });
+
+  test('called with endpoint returns URLs relative to endpoint', async () => {
+    const response = {
+      entries: [
+        {
+          'version': '1.2.0',
+          'platform': 'macos',
+          'type': 'dmg',
+          'arch': 'universal',
+          'url': 'downloads/ibm-aspera-sdk_1.2.0_macos.dmg'
+        },
+        {
+          'version': '1.2.0',
+          'platform': 'windows',
+          'type': 'msi',
+          'arch': 'x64',
+          'url': 'downloads/ibm-aspera-sdk_1.2.0.msi'
+        },
+        {
+          'version': '1.1.9',
+          'platform': 'linux',
+          'type': 'rpm',
+          'arch': 'x64',
+          'url': 'downloads/ibm-aspera-sdk_1.1.9.rpm'
+        },
+        {
+          'version': '1.1.9',
+          'platform': 'linux',
+          'type': 'appimage',
+          'arch': 'x64',
+          'url': 'downloads/ibm-aspera-sdk_1.1.9.AppImage'
+        }
+      ]
+    };
+    (<any>global).fetch = mockFetch(response);
+    const data = await getInstallerInfo({endpoint: 'https://aspera.us/aspera/sdk', all: true});
+    for (const entry of data.entries) {
+      expect(entry.url.startsWith('https://aspera.us/aspera/sdk/downloads/ibm-aspera-sdk')).toBe(true);
+    }
+  });
+
+  test('called with invalid endpoint rejects', () => {
+    const response = {
+      entries: [
+        {
+          'version': '1.2.0',
+          'platform': 'macos',
+          'type': 'dmg',
+          'arch': 'universal',
+          'url': 'downloads/ibm-aspera-sdk_1.2.0_macos.dmg'
+        }
+      ]
+    };
+    (<any>global).fetch = mockFetch(response);
+    return expect(getInstallerInfo({endpoint: 'aspera.us'})).rejects.toMatchObject({error: true});
+  });
+});

package/tests/mocks.ts

@@ -0,0 +1,11 @@
+export const mockFetch = (data: any) =>  {
+  const returnPromise = new Promise(resolver => {
+    resolver(data);
+  });
+  return jest.fn().mockImplementation(() => {
+    return Promise.resolve({
+      ok: true,
+      json:() => returnPromise.catch(() => {}),
+    });
+  });
+};

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist/js",
+    "noImplicitAny": true,
+    "module": "es6",
+    "target": "es5",
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+  }
+}

package/tsconfig.module.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "lib": ["es2017", "es7", "es6", "dom"],
+    "declaration": true,
+    "outDir": "dist/commonjs",
+    "esModuleInterop": true
+  },
+  "exclude": [
+    "node_modules",
+    "dist",
+    "tests"
+  ]
+}

package/typedoc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  mode: 'file',
+  out: 'docs',
+  theme: 'default',
+  ignoreCompilerErrors: true,
+  excludePrivate: false,
+  excludeNotExported: true,
+  target: 'ES6',
+  moduleResolution: 'node',
+  preserveConstEnums: 'true',
+  stripInternal: 'true',
+  suppressExcessPropertyErrors: 'true',
+  suppressImplicitAnyIndexErrors: 'true',
+  module: 'commonjs',
+  name: 'IBM Aspera JavaScript Library',
+  hideGenerator: true
+};

package/webpack.config.js

@@ -0,0 +1,53 @@
+const path = require('path');
+const webpack = require('webpack');
+
+const packageFile = require('./package.json');
+let version = '';
+
+if (packageFile.version) {
+  version = `v${packageFile.version}`;
+}
+
+const banner = `IBM Aspera SDK ${version}\nLicensed Materials – Property of IBM\n© Copyright IBM Corp. 2024\nU.S. Government Users Restricted Rights: Use, duplication or disclosure restricted by\nGSA ADP Schedule Contract with IBM Corp.`;
+
+module.exports = {
+  entry: './src/index.ts',
+  devtool: 'source-map',
+  output: {
+    path: path.resolve(__dirname, 'dist/js'),
+    filename: 'aspera-sdk.js'
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js', '.json']
+  },
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: ['ts-loader'],
+        exclude: /node_modules/
+      }
+    ]
+  },
+  devServer: {
+    server: {
+      type: 'https',
+    },
+    open: true,
+    static: [
+      {
+        publicPath: '/',
+        directory: './src',
+      },
+      {
+        publicPath: '/aspera-sdk-js/docs',
+        directory: './dist/js/docs',
+      },
+    ],
+    host: 'js-sdk.aspera.us',
+    port: 4205
+  },
+  plugins: [
+    new webpack.BannerPlugin(banner)
+  ]
+};