6938582864

Committed 21 Nov 2023 02:46AM UTC coverage: 37.599% (-0.03%) from 37.628%

Build # 6938582864

Build Type

Pull #2451

github

Committed by

web-flow

Commit Message

Merge 8c5186bd0 into 39494866b

Pull Request Pull Request #2451: Staging

Run Details

1753 of 7758 branches covered (0.0%)

Branch coverage included in aggregate %.

2 of 12 new or added lines in 2 files covered. (16.67%)

19 existing lines in 1 file now uncovered.

6573 of 14386 relevant lines covered (45.69%)

13.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

22.22

/src/cloud-providers/src/provider.ts

// Copyright (c) 2023 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

import Upload from './upload';
import {MapData, ExportFileOptions, Millisecond, SavedMap} from '@kepler.gl/types';
import {ComponentType} from 'react';

export type MapListItem = {
  id: string;
  title: string;
  description: string;
  loadParams: any;
  imageUrl?: string;
  updatedAt?: Millisecond;
  privateMap?: boolean;
};

export type CloudUser = {
  name: string;
  email: string;
  thumbnail?: string;
};

export type Thumbnail = {
  width: number;
  height: number;
};

export type ProviderProps = {
  name?: string;
  displayName?: string;
  icon?: ComponentType<IconProps>;
  thumbnail?: Thumbnail;
};

export interface IconProps {
  height?: string;
  width?: string;
}

const NAME = 'cloud-provider';
const DISPLAY_NAME = 'Cloud Provider';
const THUMBNAIL = {width: 300, height: 200};
const ICON = Upload;
export const KEPLER_FORMAT = 'keplergl';
export const FILE_CONFLICT_MSG = 'file_conflict';

/**
 * The default provider class
 * @param {object} props
 * @param {string} props.name
 * @param {string} props.displayName
 * @param {React.Component} props.icon - React element
 * @param {object} props.thumbnail - thumbnail size object
 * @param {number} props.thumbnail.width - thumbnail width in pixels
 * @param {number} props.thumbnail.height - thumbnail height in pixels
 * @public
 * @example
 *
 * const myProvider = new Provider({
 *  name: 'foo',
 *  displayName: 'Foo Storage'
 *  icon: Icon,
 *  thumbnail: {width: 300, height: 200}
 * })
 */
export default class Provider {
  name: string;
  displayName: string;
  icon: ComponentType<IconProps>;
  thumbnail: Thumbnail;
  isNew: boolean = false;

  constructor(props: ProviderProps) {
    this.name = props.name || NAME;
    this.displayName = props.displayName || DISPLAY_NAME;
    this.icon = props.icon || ICON;
    this.thumbnail = props.thumbnail || THUMBNAIL;
  }

  /**
   * Whether this provider support upload map to a private storage. If truthy, user will be displayed with the storage save icon on the top right of the side bar.
   * @returns
   * @public
   */
  hasPrivateStorage(): boolean {
    return true;
  }

  /**
   * Whether this provider support share map via a public url, if truthy, user will be displayed with a share map via url under the export map option on the top right of the side bar
   * @returns
   * @public
   */
  hasSharingUrl(): boolean {
    return false;
  }

  /**
   * This method is called after user share a map, to display the share url.
   * @param fullUrl - Whether to return the full url with domain, or just the location
   * @returns shareUrl
   * @public
   */
  getShareUrl(fullUrl: boolean = false): string {
    return '';
  }

  /**
   * This method is called by kepler.gl demo app to pushes a new location to history, becoming the current location.
   * @param fullURL - Whether to return the full url with domain, or just the location
   * @returns mapUrl
   * @public
   */
  getMapUrl(fullURL: boolean = true): string {
    return '';
  }

  /**
   * This method is called to determine whether user already logged in to this provider
   * @public
   * @returns {Promise<string>} return the access token if a user already logged in
   */
  async getAccessToken(): Promise<string | null> {
    return Promise.reject('You must implement getAccessToken');
  }

  /**
   * This method is called to get the user name of the current user. It will be displayed in the cloud provider tile.
   * @public
   * @deprecated please use getUser
   * @returns true if a user already logged in
   */
  getUserName(): string {
    return '';
  }

  /**
   * return a Promise with the user object
   */
  async getUser(): Promise<CloudUser | null> {
    return Promise.reject('You must implement getUser');
  }

  /**
   * This return a standard error that will trigger the overwrite map modal
   */
  getFileConflictError() {
    return new Error(FILE_CONFLICT_MSG);
  }

  /**
   * This method will be called when user click the login button in the cloud provider tile.
   * Upon login success and return the user Object {name, email, abbreviated}
   * @public
   */
  async login() {
    return Promise.reject(new Error('you must implement the `login` method'));
  }

  /**
   * This method will be called when user click the logout button under the cloud provider tile.
   * Upon login success
   * @public
   */
  async logout(): Promise<void> {
    return Promise.reject(new Error('you must implement the `logout` method'));
  }

  /**
   * This method will be called to upload map for saving and sharing. Kepler.gl will package map data, config, title, description and thumbnail for upload to storage.
   * With the option to overwrite already saved map, and upload as private or public map.
   *
   * @param {Object} param
   * @param {Object} param.mapData - the map object
   * @param {Object} param.mapData.map - {datasets. config, info: {title, description}}
   * @param {Blob} param.mapData.thumbnail - A thumbnail of current map. thumbnail size can be defined by provider by this.thumbnail
   * @param {object} [param.options]
   * @param {boolean} [param.options.overwrite] - whether user choose to overwrite already saved map under the same name
   * @param {boolean} [param.options.isPublic] - whether user wish to share the map with others. if isPublic is truthy, kepler will call this.getShareUrl() to display an URL they can share with others
   * @public
   */
  async uploadMap({
    mapData,
    options = {}
  }: {
    mapData: MapData;
    options: ExportFileOptions;
  }): Promise<MapListItem> {
    return Promise.reject('You must implement uploadMap');
  }

  /**
   * This method is called to get a list of maps saved by the current logged in user.
   * @returns visualizations an array of Viz objects
   * @public
   * @example
   *  async listMaps() {
   *    return [
   *      {
   *        id: 'a',
   *        title: 'My map',
   *        description: 'My first kepler map',
   *        imageUrl: 'http://',
   *        updatedAt: 1582677787000,
   *        privateMap: false,
   *        loadParams: {}
   *      }
   *    ];
   *  }
   */
  async listMaps(): Promise<MapListItem[]> {
    return [];
  }

  /**
   * This method will be called when user select a map to load from the storage map viewer
   * @param {*} loadParams - the loadParams property of each visualization object
   * @returns mapResponse - the map object containing dataset config info and format option
   * @public
   * @example
   * async downloadMap(loadParams) {
   *  const mockResponse = {
   *    map: {
   *      datasets: [],
   *      config: {},
   *      info: {
   *        app: 'kepler.gl',
   *        created_at: ''
   *        title: 'test map',
   *        description: 'Hello this is my test dropbox map'
   *      }
   *    },
   *    // pass csv here if your provider currently only support save / load file as csv
   *    format: 'keplergl'
   *  };
   *
   *  return downloadMap;
   * }
   */
  async downloadMap(loadParams): Promise<{map: SavedMap; format: string}> {
    return Promise.reject('You must implement downloadMap');
  }

  /**
   * @return {string} return the storage location url for the current provider
   * @public
   */
  getManagementUrl(): string {
    throw new Error('You must implement getManagementUrl');
  }

  /**
   * @typedef {Object} Viz
   * @property {string} id - An unique id
   * @property {string} title - The title of the map
   * @property {string} description - The description of the map
   * @property {string} imageUrl - The imageUrl of the map
   * @property {number} updatedAt - An epoch timestamp in milliseconds
   * @property {boolean} privateMap - Optional, whether if this map is private to the user, or can be accessed by others via URL
   * @property {*} loadParams - A property to be passed to `downloadMap`
   * @public
   */

  /**
   * The returned object of `downloadMap`. The response object should contain: datasets: [], config: {}, and info: {}
   * each dataset object should be {info: {id, label}, data: {...}}
   * to inform how kepler should process your data object, pass in `format`
   * @typedef {Object} MapResponse
   * @property {Object} map
   * @property {Array<Object>} map.datasets
   * @property {Object} map.config
   * @property {Object} map.info
   * @property {string} format - one of 'csv': csv file string, 'geojson': geojson object, 'row': row object, 'keplergl': datasets array saved using KeplerGlSchema.save
   * @public
   */
}

1	// Copyright (c) 2023 Uber Technologies, Inc.
2	//	9✔
3	// Permission is hereby granted, free of charge, to any person obtaining a copy
4	// of this software and associated documentation files (the "Software"), to deal	9✔
5	// in the Software without restriction, including without limitation the rights
6	// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7	// copies of the Software, and to permit persons to whom the Software is	9✔
8	// furnished to do so, subject to the following conditions:
9	//	9✔
10	// The above copyright notice and this permission notice shall be included in
11	// all copies or substantial portions of the Software.	9✔
12	//
13	// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR	9✔
14	// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15	// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE	9✔
16	// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17	// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,	9✔
18	// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19	// THE SOFTWARE.	18✔
20
21	import Upload from './upload';
22	import {MapData, ExportFileOptions, Millisecond, SavedMap} from '@kepler.gl/types';
23	import {ComponentType} from 'react';
24
25	export type MapListItem = {
26	id: string;
27	title: string;
28	description: string;
29	loadParams: any;
30	imageUrl?: string;
31	updatedAt?: Millisecond;
32	privateMap?: boolean;
33	};
34
35	export type CloudUser = {
36	name: string;
37	email: string;
38	thumbnail?: string;
39	};
40
41	export type Thumbnail = {
42	width: number;
43	height: number;
44	};
45
46	export type ProviderProps = {
47	name?: string;
48	displayName?: string;
49	icon?: ComponentType<IconProps>;
50	thumbnail?: Thumbnail;
51	};
52
53	export interface IconProps {
54	height?: string;
55	width?: string;
56	}
57
58	const NAME = 'cloud-provider';	9✔
59	const DISPLAY_NAME = 'Cloud Provider';	9✔
60	const THUMBNAIL = {width: 300, height: 200};	9✔
61	const ICON = Upload;	9✔
62	export const KEPLER_FORMAT = 'keplergl';	9✔
63	export const FILE_CONFLICT_MSG = 'file_conflict';
64
65	/**
66	* The default provider class
67	* @param {object} props
68	* @param {string} props.name
69	* @param {string} props.displayName
70	* @param {React.Component} props.icon - React element
71	* @param {object} props.thumbnail - thumbnail size object
72	* @param {number} props.thumbnail.width - thumbnail width in pixels
73	* @param {number} props.thumbnail.height - thumbnail height in pixels
74	* @public
75	* @example
76	*
77	* const myProvider = new Provider({
78	* name: 'foo',
79	* displayName: 'Foo Storage'
80	* icon: Icon,
81	* thumbnail: {width: 300, height: 200}
82	* })
83	*/
84	export default class Provider {
85	name: string;
86	displayName: string;
87	icon: ComponentType<IconProps>;
88	thumbnail: Thumbnail;
89	isNew: boolean = false;
90
91	constructor(props: ProviderProps) {	×
92	this.name = props.name \|\| NAME;	×
93	this.displayName = props.displayName \|\| DISPLAY_NAME;	×
94	this.icon = props.icon \|\| ICON;	×
95	this.thumbnail = props.thumbnail \|\| THUMBNAIL;
96	}
97
98	/**
99	* Whether this provider support upload map to a private storage. If truthy, user will be displayed with the storage save icon on the top right of the side bar.
100	* @returns
101	* @public
102	*/
103	hasPrivateStorage(): boolean {	×
104	return true;
105	}
106
107	/**
108	* Whether this provider support share map via a public url, if truthy, user will be displayed with a share map via url under the export map option on the top right of the side bar
109	* @returns
110	* @public
111	*/
112	hasSharingUrl(): boolean {	×
113	return false;
114	}
115
116	/**
117	* This method is called after user share a map, to display the share url.
118	* @param fullUrl - Whether to return the full url with domain, or just the location
119	* @returns shareUrl
120	* @public
121	*/
122	getShareUrl(fullUrl: boolean = false): string {	×
123	return '';
124	}
125
126	/**
127	* This method is called by kepler.gl demo app to pushes a new location to history, becoming the current location.
128	* @param fullURL - Whether to return the full url with domain, or just the location
129	* @returns mapUrl
130	* @public
131	*/
132	getMapUrl(fullURL: boolean = true): string {	×
133	return '';
134	}
135
136	/**
137	* This method is called to determine whether user already logged in to this provider
138	* @public
139	* @returns {Promise<string>} return the access token if a user already logged in
140	*/
NEW 141	async getAccessToken(): Promise<string \| null> {	×
142	return Promise.reject('You must implement getAccessToken');
143	}
144
145	/**
146	* This method is called to get the user name of the current user. It will be displayed in the cloud provider tile.
147	* @public
148	* @deprecated please use getUser
149	* @returns true if a user already logged in
150	*/
151	getUserName(): string {	×
152	return '';
153	}
154
155	/**
156	* return a Promise with the user object
157	*/
NEW 158	async getUser(): Promise<CloudUser \| null> {	×
159	return Promise.reject('You must implement getUser');
160	}
161
162	/**
163	* This return a standard error that will trigger the overwrite map modal
164	*/
165	getFileConflictError() {	×
166	return new Error(FILE_CONFLICT_MSG);
167	}
168
169	/**
170	* This method will be called when user click the login button in the cloud provider tile.
171	* Upon login success and return the user Object {name, email, abbreviated}
172	* @public
173	*/
174	async login() {	×
175	return Promise.reject(new Error('you must implement the `login` method'));
176	}
177
178	/**
179	* This method will be called when user click the logout button under the cloud provider tile.
180	* Upon login success
181	* @public
182	*/
183	async logout(): Promise<void> {	×
184	return Promise.reject(new Error('you must implement the `logout` method'));
185	}
186
187	/**
188	* This method will be called to upload map for saving and sharing. Kepler.gl will package map data, config, title, description and thumbnail for upload to storage.
189	* With the option to overwrite already saved map, and upload as private or public map.
190	*
191	* @param {Object} param
192	* @param {Object} param.mapData - the map object
193	* @param {Object} param.mapData.map - {datasets. config, info: {title, description}}
194	* @param {Blob} param.mapData.thumbnail - A thumbnail of current map. thumbnail size can be defined by provider by this.thumbnail
195	* @param {object} [param.options]
196	* @param {boolean} [param.options.overwrite] - whether user choose to overwrite already saved map under the same name
197	* @param {boolean} [param.options.isPublic] - whether user wish to share the map with others. if isPublic is truthy, kepler will call this.getShareUrl() to display an URL they can share with others
198	* @public
199	*/
200	async uploadMap({	×
201	mapData,	×
202	options = {}
203	}: {
204	mapData: MapData;
205	options: ExportFileOptions;
206	}): Promise<MapListItem> {
207	return Promise.reject('You must implement uploadMap');
208	}
209
210	/**
211	* This method is called to get a list of maps saved by the current logged in user.
212	* @returns visualizations an array of Viz objects
213	* @public
214	* @example
215	* async listMaps() {
216	* return [
217	* {
218	* id: 'a',
219	* title: 'My map',
220	* description: 'My first kepler map',
221	* imageUrl: 'http://',
222	* updatedAt: 1582677787000,
223	* privateMap: false,
224	* loadParams: {}
225	* }
226	* ];
227	* }
228	*/
229	async listMaps(): Promise<MapListItem[]> {	×
230	return [];
231	}
232
233	/**
234	* This method will be called when user select a map to load from the storage map viewer
235	* @param {*} loadParams - the loadParams property of each visualization object
236	* @returns mapResponse - the map object containing dataset config info and format option
237	* @public
238	* @example
239	* async downloadMap(loadParams) {
240	* const mockResponse = {
241	* map: {
242	* datasets: [],
243	* config: {},
244	* info: {
245	* app: 'kepler.gl',
246	* created_at: ''
247	* title: 'test map',
248	* description: 'Hello this is my test dropbox map'
249	* }
250	* },
251	* // pass csv here if your provider currently only support save / load file as csv
252	* format: 'keplergl'
253	* };
254	*
255	* return downloadMap;
256	* }
257	*/
258	async downloadMap(loadParams): Promise<{map: SavedMap; format: string}> {	×
259	return Promise.reject('You must implement downloadMap');
260	}
261
262	/**
263	* @return {string} return the storage location url for the current provider
264	* @public
265	*/
266	getManagementUrl(): string {	×
267	throw new Error('You must implement getManagementUrl');
268	}
269
270	/**
271	* @typedef {Object} Viz
272	* @property {string} id - An unique id
273	* @property {string} title - The title of the map
274	* @property {string} description - The description of the map
275	* @property {string} imageUrl - The imageUrl of the map
276	* @property {number} updatedAt - An epoch timestamp in milliseconds
277	* @property {boolean} privateMap - Optional, whether if this map is private to the user, or can be accessed by others via URL
278	* @property {*} loadParams - A property to be passed to `downloadMap`
279	* @public
280	*/
281
282	/**
283	* The returned object of `downloadMap`. The response object should contain: datasets: [], config: {}, and info: {}
284	* each dataset object should be {info: {id, label}, data: {...}}
285	* to inform how kepler should process your data object, pass in `format`
286	* @typedef {Object} MapResponse
287	* @property {Object} map
288	* @property {Array<Object>} map.datasets
289	* @property {Object} map.config
290	* @property {Object} map.info
291	* @property {string} format - one of 'csv': csv file string, 'geojson': geojson object, 'row': row object, 'keplergl': datasets array saved using KeplerGlSchema.save
292	* @public
293	*/
294	}

keplergl / kepler.gl / 6938582864

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous