Merge pull request #44 from multinet-app/s3ff

Reconfigure to enable file uploading using S3 File Field

Author: eagw

package.json

@@ -25,6 +25,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "axios": "^0.21.1",
+    "django-s3-file-field": "^0.1.2",
     "ts-jest": "^26.5.4"
   },
   "devDependencies": {

src/axios.ts

@@ -1,9 +1,11 @@
 import axios, { AxiosInstance, AxiosPromise, AxiosRequestConfig, AxiosResponse } from 'axios';
+import S3FileFieldClient, { S3FileFieldProgress, S3FileFieldProgressState } from 'django-s3-file-field';
 
 import {
   CreateGraphOptionsSpec,
   TableMetadata,
-  FileUploadOptionsSpec,
+  TableUploadOptionsSpec,
+  NetworkUploadOptionsSpec,
   EdgesSpec,
   EdgesOptionsSpec,
   Graph,
@@ -51,10 +53,11 @@ export interface MultinetAxiosInstance extends AxiosInstance {
   createWorkspace(workspace: string): AxiosPromise<string>;
   deleteWorkspace(workspace: string): AxiosPromise<string>;
   renameWorkspace(workspace: string, name: string): AxiosPromise<any>;
-  uploadTable(workspace: string, table: string, options: FileUploadOptionsSpec, config?: AxiosRequestConfig): AxiosPromise<Array<{}>>;
+  uploadTable(workspace: string, table: string, options: TableUploadOptionsSpec, config?: AxiosRequestConfig): AxiosPromise<Array<{}>>;
   downloadTable(workspace: string, table: string): AxiosPromise<any>;
   deleteTable(workspace: string, table: string): AxiosPromise<string>;
   tableMetadata(workspace: string, table: string): AxiosPromise<TableMetadata>;
+  uploadNetwork(workspace: string, network: string, options: NetworkUploadOptionsSpec, config?: AxiosRequestConfig): AxiosPromise<Array<{}>>;
   createGraph(workspace: string, graph: string, options: CreateGraphOptionsSpec): AxiosPromise<CreateGraphOptionsSpec>;
   deleteGraph(workspace: string, graph: string): AxiosPromise<string>;
   aql(workspace: string, query: string): AxiosPromise<any[]>;
@@ -144,38 +147,20 @@ export function multinetAxiosInstance(config: AxiosRequestConfig): MultinetAxios
     });
   };
 
-  Proto.uploadTable = async function(workspace: string, table: string, options: FileUploadOptionsSpec, cfg?: AxiosRequestConfig): Promise<AxiosResponse<Array<{}>>> {
-    const headers = cfg ? cfg.headers : undefined;
-    const params = cfg ? cfg.params : undefined;
-    const { type, data, key, overwrite, columnTypes } = options;
-
-    let text;
-
-    if (typeof data === 'string') {
-      text = data;
-    } else {
-      text = await fileToText(data);
-    }
-
-    let metadata;
-    if (columnTypes) {
-      const columns = Object.keys(columnTypes).map((column) => ({
-        key: column,
-        type: columnTypes[column],
-      }));
-
-      metadata = { columns };
-    }
-
-    return this.post(`/${type}/${workspace}/${table}`, text, {
-      ...cfg,
-      headers: { ...headers, 'Content-Type': 'text/plain' },
-      params: {
-        ...params,
-        key: key || undefined,
-        overwrite: overwrite || undefined,
-        metadata: metadata || undefined,
-      },
+  Proto.uploadTable = async function(workspace: string, table: string, options: TableUploadOptionsSpec): Promise<AxiosResponse<Array<{}>>> {
+    const { data, edgeTable, columnTypes } = options;
+    const s3ffClient = new S3FileFieldClient({
+      baseUrl: `${this.defaults.baseURL}/s3-upload/`,
+      apiConfig: this.defaults,
+    });
+    
+    const fieldValue = await s3ffClient.uploadFile(data, 'api.Upload.blob');
+
+    return this.post(`/workspaces/${workspace}/uploads/csv/`, {
+      field_value: fieldValue.value,
+      edge: edgeTable,
+      table_name: table,
+      columns: columnTypes
     });
   };
 
@@ -191,6 +176,21 @@ export function multinetAxiosInstance(config: AxiosRequestConfig): MultinetAxios
     return this.get(`/workspaces/${workspace}/tables/${table}/metadata`);
   };
 
+  Proto.uploadNetwork = async function(workspace: string, network: string, options: NetworkUploadOptionsSpec): Promise<AxiosResponse<Array<{}>>> {
+    const { type, data } = options;
+    const s3ffClient = new S3FileFieldClient({
+      baseUrl: `${this.defaults.baseURL}/s3-upload/`,
+      apiConfig: this.defaults,
+    });
+
+    const fieldValue = await s3ffClient.uploadFile(data, 'api.Upload.blob');
+
+    return this.post(`/workspaces/${workspace}/uploads/${type}/`, {
+      field_value: fieldValue.value,
+      network_name: network
+    });
+  };
+
   Proto.createGraph = function(workspace: string, graph: string, options: CreateGraphOptionsSpec): AxiosPromise<CreateGraphOptionsSpec> {
     return this.post(`/workspaces/${workspace}/networks/`, {
       name: graph,

src/index.ts

@@ -1,7 +1,5 @@
 import { multinetAxiosInstance, MultinetAxiosInstance } from './axios';
 
-import axios, { AxiosRequestConfig } from 'axios';
-
 export interface Paginated<T> {
   count: number,
   next: string | null,
@@ -82,8 +80,16 @@ export type TableUploadType = 'csv';
 export type GraphUploadType = 'nested_json' | 'newick' | 'd3_json';
 export type UploadType = TableUploadType | GraphUploadType;
 
+export function validTableUploadType(type: string): type is TableUploadType {
+  return type === 'csv';
+}
+
+export function validGraphUploadType(type: string): type is GraphUploadType {
+  return ['nested_json', 'newick', 'd3_json'].includes(type);
+}
+
 export function validUploadType(type: string): type is UploadType {
-  return ['csv', 'nested_json', 'newick', 'd3_json'].includes(type);
+  return validTableUploadType(type) || validGraphUploadType(type);
 }
 
 export type Direction = 'all' | 'incoming' | 'outgoing';
@@ -119,16 +125,19 @@ export interface TableMetadata {
   };
 }
 
-export interface FileUploadOptionsSpec {
-  type: UploadType;
-  data: string | File;
-  key?: string;
-  overwrite?: boolean;
+export interface TableUploadOptionsSpec {
+  data: File;
+  edgeTable: boolean;
   columnTypes?: {
     [key: string]: ColumnType;
   };
 }
 
+export interface NetworkUploadOptionsSpec {
+  data: File;
+  type: GraphUploadType;
+}
+
 export interface CreateGraphOptionsSpec {
   edgeTable: string;
 }
@@ -211,10 +220,8 @@ class MultinetAPI {
     return (await this.axios.renameWorkspace(workspace, name)).data;
   }
 
-  public async uploadTable(
-    workspace: string, table: string, options: FileUploadOptionsSpec, config?: AxiosRequestConfig
-  ): Promise<Array<{}>> {
-    return (await this.axios.uploadTable(workspace, table, options, config)).data;
+  public async uploadTable(workspace: string, table: string, options: TableUploadOptionsSpec): Promise<Array<{}>> {
+    return (await this.axios.uploadTable(workspace, table, options)).data;
   }
 
   public async downloadTable(workspace: string, table: string): Promise<any> {
@@ -239,6 +246,10 @@ class MultinetAPI {
     return types;
   }
 
+  public async uploadNetwork(workspace: string, network: string, options: NetworkUploadOptionsSpec): Promise<Array<{}>> {
+    return (await this.axios.uploadNetwork(workspace, network, options)).data;
+  }
+
   public async createGraph(workspace: string, graph: string, options: CreateGraphOptionsSpec): Promise<CreateGraphOptionsSpec> {
     return (await this.axios.createGraph(workspace, graph, options)).data;
   }

yarn.lock

@@ -1185,6 +1185,13 @@ diff@^4.0.1:
   resolved "https://registry.yarnpkg.com/diff/-/diff-4.0.2.tgz#60f3aecb89d5fae520c11aa19efc2bb982aade7d"
   integrity sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==
 
+django-s3-file-field@^0.1.2:
+  version "0.1.2"
+  resolved "https://registry.yarnpkg.com/django-s3-file-field/-/django-s3-file-field-0.1.2.tgz#eeee3c4fcc9debca1c07f800d175fd8e559c076f"
+  integrity sha512-zo0YYIZCvH7efYFBKM44VtQLofLCe286dez7HnxB/gUTdbFfV0Zp9lBc+tQ9YVbpyJMLrCaVWvRqR7dkJUAVwg==
+  dependencies:
+    axios "^0.21.1"
+
 domexception@^2.0.1:
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/domexception/-/domexception-2.0.1.tgz#fb44aefba793e1574b0af6aed2801d057529f304"