src/services/common-service/common-resource-service.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import * as _ from "lodash";
   6 import { AxiosInstance, AxiosPromise } from "axios";
   7 import { Resource } from "src/models/resource";
   8 import * as uuid from "uuid/v4";
   9 import { ApiActions } from "~/services/api/api-actions";
  10
  11 export interface ListArguments {
  12     limit?: number;
  13     offset?: number;
  14     filters?: string;
  15     order?: string;
  16     select?: string[];
  17     distinct?: boolean;
  18     count?: string;
  19 }
  20
  21 export interface ListResults<T> {
  22     kind: string;
  23     offset: number;
  24     limit: number;
  25     items: T[];
  26     itemsAvailable: number;
  27 }
  28
  29 export interface Errors {
  30     errors: string[];
  31     errorToken: string;
  32 }
  33
  34 export enum CommonResourceServiceError {
  35     UNIQUE_VIOLATION = 'UniqueViolation',
  36     OWNERSHIP_CYCLE = 'OwnershipCycle',
  37     MODIFYING_CONTAINER_REQUEST_FINAL_STATE = 'ModifyingContainerRequestFinalState',
  38     UNKNOWN = 'Unknown',
  39     NONE = 'None'
  40 }
  41
  42 export class CommonResourceService<T extends Resource> {
  43
  44     static mapResponseKeys = (response: { data: any }) =>
  45         CommonResourceService.mapKeys(_.camelCase)(response.data)
  46
  47     static mapKeys = (mapFn: (key: string) => string) =>
  48         (value: any): any => {
  49             switch (true) {
  50                 case _.isPlainObject(value):
  51                     return Object
  52                         .keys(value)
  53                         .map(key => [key, mapFn(key)])
  54                         .reduce((newValue, [key, newKey]) => ({
  55                             ...newValue,
  56                             [newKey]: CommonResourceService.mapKeys(mapFn)(value[key])
  57                         }), {});
  58                 case _.isArray(value):
  59                     return value.map(CommonResourceService.mapKeys(mapFn));
  60                 default:
  61                     return value;
  62             }
  63         }
  64
  65     static defaultResponse<R>(promise: AxiosPromise<R>, actions: ApiActions): Promise<R> {
  66         const reqId = uuid();
  67         actions.progressFn(reqId, true);
  68         return promise
  69             .then(data => {
  70                 actions.progressFn(reqId, false);
  71                 return data;
  72             })
  73             .then(CommonResourceService.mapResponseKeys)
  74             .catch(({ response }) => {
  75                 actions.progressFn(reqId, false);
  76                 const errors = CommonResourceService.mapResponseKeys(response) as Errors;
  77                 actions.errorFn(reqId, errors);
  78                 throw errors;
  79             });
  80     }
  81
  82     static customResponse<R>(promise: AxiosPromise<R>, actions: ApiActions): Promise<R> {
  83         const reqId = uuid();
  84         actions.progressFn(reqId, true);
  85         return promise
  86             .then(data => {
  87                 actions.progressFn(reqId, false);
  88                 return data;
  89             })
  90             .then((response: { data: any }) => response.data);
  91     }
  92
  93
  94     protected serverApi: AxiosInstance;
  95     protected resourceType: string;
  96     protected actions: ApiActions;
  97
  98     constructor(serverApi: AxiosInstance, resourceType: string, actions: ApiActions) {
  99         this.serverApi = serverApi;
 100         this.resourceType = '/' + resourceType + '/';
 101         this.actions = actions;
 102     }
 103
 104     create(data?: Partial<T>) {
 105         return CommonResourceService.defaultResponse(
 106             this.serverApi
 107                 .post<T>(this.resourceType, data && CommonResourceService.mapKeys(_.snakeCase)(data)),
 108             this.actions
 109         );
 110     }
 111
 112     delete(uuid: string): Promise<T> {
 113         return CommonResourceService.defaultResponse(
 114             this.serverApi
 115                 .delete(this.resourceType + uuid),
 116             this.actions
 117         );
 118     }
 119
 120     get(uuid: string) {
 121         return CommonResourceService.defaultResponse(
 122             this.serverApi
 123                 .get<T>(this.resourceType + uuid),
 124             this.actions
 125         );
 126     }
 127
 128     list(args: ListArguments = {}): Promise<ListResults<T>> {
 129         const { filters, order, ...other } = args;
 130         const params = {
 131             ...other,
 132             filters: filters ? `[${filters}]` : undefined,
 133             order: order ? order : undefined
 134         };
 135         return CommonResourceService.defaultResponse(
 136             this.serverApi
 137                 .get(this.resourceType, {
 138                     params: CommonResourceService.mapKeys(_.snakeCase)(params)
 139                 }),
 140             this.actions
 141         );
 142     }
 143
 144     update(uuid: string, data: Partial<T>) {
 145         return CommonResourceService.defaultResponse(
 146             this.serverApi
 147                 .put<T>(this.resourceType + uuid, data && CommonResourceService.mapKeys(_.snakeCase)(data)),
 148             this.actions
 149         );
 150     }
 151 }
 152
 153 export const getCommonResourceServiceError = (errorResponse: any) => {
 154     if ('errors' in errorResponse && 'errorToken' in errorResponse) {
 155         const error = errorResponse.errors.join('');
 156         switch (true) {
 157             case /UniqueViolation/.test(error):
 158                 return CommonResourceServiceError.UNIQUE_VIOLATION;
 159             case /ownership cycle/.test(error):
 160                 return CommonResourceServiceError.OWNERSHIP_CYCLE;
 161             case /Mounts cannot be modified in state 'Final'/.test(error):
 162                 return CommonResourceServiceError.MODIFYING_CONTAINER_REQUEST_FINAL_STATE;
 163             default:
 164                 return CommonResourceServiceError.UNKNOWN;
 165         }
 166     }
 167     return CommonResourceServiceError.NONE;
 168 };
 169
 170