[feat] Introduce Foursquare cloud provider #2437

macrigiuseppe · 2023-11-12T15:38:30Z

This PR introduces a new FSQ Studio provider to be able to store and fetch maps from Foursquare Studio

ibgreen

Nicely done! Minor nits, feel free to ignore.

ibgreen · 2023-11-15T11:12:56Z

docs/api-reference/cloud-providers/cloud-provider.md

-    -   `props.name` **[string][28]** 
-    -   `props.displayName` **[string][28]** 
+-   `props` **[object][27]**
+    -   `props.name` **[string][28]**


What are those numbers in brackets? Look like link tags - in that case shouldn't those tags be defined below? Or maybe this is a different markdown dialect?

the tags are defined at the end of the file

kepler.gl/docs/api-reference/cloud-providers/cloud-provider.md

Line 261 in d975ea1

[27]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

ibgreen · 2023-11-15T11:14:50Z

examples/demo-app/src/cloud-providers/fsq-studio/fsq-studio-icon.js

+const style = {
+  background: 'black'
+};
+export default class UnfoldedIcon extends Component {


FoursquareIcon? (Nit: If we stop using default exports we won't be making such mistakes)

ibgreen · 2023-11-15T11:15:09Z

examples/demo-app/src/cloud-providers/fsq-studio/fsq-studio-icon.js

@@ -0,0 +1,41 @@
+import React, {Component} from 'react';


Should we just call this foursquare-icon.js

ibgreen · 2023-11-15T11:16:53Z

examples/demo-app/src/cloud-providers/fsq-studio/fsq-studio-provider.js

+const STUDIO_AUTH_AUDIENCE = 'https://foursquare.com/api/';
+const STUDIO_AUTH_SCOPE = 'openid profile email';
+
+const STUDIO_KEPLER_GL_IMPORT_SOURCE = 'kepler.gl-raw';


What does kepler.gl-raw mean? Is it a URL path, a parameter value, etc? Maybe add comment before this constant,

ibgreen · 2023-11-15T11:17:34Z

examples/demo-app/src/cloud-providers/fsq-studio/fsq-studio-provider.js

+  };
+}
+
+export default class FsqStudioProvider extends Provider {


I vote for FoursquareProvider

ibgreen · 2023-11-15T11:24:25Z

examples/demo-app/src/cloud-providers/index.js

+  FSQ_STUDIO_DOMAIN,
+  FSQ_STUDIO_API_URL,
+  FSQ_STUDIO_USER_MAPS_URL
+} = AUTH_TOKENS;


This is no longer just AUTH_TOKENS. To make the code easier to follow, maybe consider renaming to CLOUD_PROVIDERS_CONFIGURATION or similar?

yeah we can do that

ibgreen · 2023-11-15T11:25:15Z

examples/demo-app/webpack.config.js

@@ -69,7 +69,11 @@ const CONFIG = {
      'MapboxAccessToken',
      'DropboxClientId',
      'MapboxExportToken',
-      'CartoClientId'
+      'CartoClientId',
+      'FSQStudioClientId',


Again recommend just going with Foursquare.

Suggested change

'FSQStudioClientId',

'FoursquareClientId',

ibgreen · 2023-11-15T11:25:57Z

src/cloud-providers/src/provider.ts

@@ -133,10 +135,10 @@ export default class Provider {
  /**
   * This method is called to determine whether user already logged in to this provider
   * @public
-   * @returns true if a user already logged in
+   * @returns {Promise<string>} return the access token if a user already logged in


If we add types in typescript we should not add them to the TSDoc.

this is being used to generate docs: https://docs.kepler.gl/docs/api-reference/cloud-providers/cloud-provider#getaccesstoken

ibgreen · 2023-11-15T11:26:50Z

src/cloud-providers/src/provider.ts

@@ -253,8 +255,7 @@ export default class Provider {
   * }
   */
  async downloadMap(loadParams): Promise<{map: SavedMap; format: string}> {
-    // @ts-expect-error
-    return;
+    return Promise.reject('You must implement downloadMap');


Nit: In my opinion it is cleaner to just throw an error and the async function will convert that to a rejected promise.

yeah i can do that

ibgreen · 2023-11-15T11:27:34Z

test/browser/components/modals/save-map-modal.spec.js

@@ -1,5 +1,25 @@
+// Copyright (c) 2023 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy


Do we needs to add this?

If we do, can't we just add a one liner // Copyright (c) 2023 Uber Technologies, Inc., MIT license? That is what we do in other vis.gl frameworks.

Should this be a FSQ copyright? Or is the year wrong? I assume Uber didn't do anything with this code in 2023.

I guess this is an automatic license added by uber-licence. Should it be disabled?

this is part of the open source code. only files in the example folder should have the FSQ copyright

igorDykhta · 2023-11-15T16:44:48Z

test/browser/components/modals/save-map-modal.spec.js

@@ -1,5 +1,25 @@
+// Copyright (c) 2023 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy


I guess this is an automatic license added by uber-licence. Should it be disabled?

Signed-off-by: Giuseppe Macri <gmacri@foursquare.com>

macrigiuseppe changed the base branch from master to refactor_cloud_provider November 12, 2023 15:38

macrigiuseppe force-pushed the studio_provider branch from 1d9034e to 5608c0f Compare November 12, 2023 15:40

macrigiuseppe added the FSQ Studio Integration label Nov 12, 2023

macrigiuseppe force-pushed the refactor_cloud_provider branch from 661b928 to ca475f8 Compare November 15, 2023 04:36

macrigiuseppe requested review from igorDykhta, heshan0131, jwasilgeo and ibgreen November 15, 2023 04:38

ibgreen approved these changes Nov 15, 2023

View reviewed changes

igorDykhta approved these changes Nov 15, 2023

View reviewed changes

macrigiuseppe force-pushed the studio_provider branch 2 times, most recently from ac5eda6 to 868c90e Compare November 17, 2023 01:36

macrigiuseppe changed the title ~~[feat] Introduce FSQ Studio provider~~ [feat] Introduce Foursquare cloud provider Nov 17, 2023

delete-merged-branch bot deleted the branch master November 17, 2023 03:03

macrigiuseppe changed the base branch from refactor_cloud_provider to master November 17, 2023 03:14

macrigiuseppe force-pushed the studio_provider branch 4 times, most recently from 2b3ca6b to 7cdfe35 Compare November 17, 2023 14:51

[feat] Introduce Foursquare cloud provider

9bc24cd

Signed-off-by: Giuseppe Macri <gmacri@foursquare.com>

macrigiuseppe force-pushed the studio_provider branch from 7cdfe35 to 9bc24cd Compare November 18, 2023 21:36

remove uber copyright

663303e

Signed-off-by: Giuseppe Macri <gmacri@foursquare.com>

macrigiuseppe merged commit d60ef31 into master Nov 18, 2023
8 checks passed

delete-merged-branch bot deleted the studio_provider branch November 18, 2023 22:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feat] Introduce Foursquare cloud provider #2437

[feat] Introduce Foursquare cloud provider #2437

macrigiuseppe commented Nov 12, 2023

ibgreen left a comment

ibgreen Nov 15, 2023

macrigiuseppe Nov 17, 2023 •

edited

ibgreen Nov 15, 2023

ibgreen Nov 15, 2023

ibgreen Nov 15, 2023

ibgreen Nov 15, 2023

ibgreen Nov 15, 2023

macrigiuseppe Nov 17, 2023

ibgreen Nov 15, 2023

macrigiuseppe Nov 17, 2023 •

edited

ibgreen Nov 15, 2023

macrigiuseppe Nov 17, 2023 •

edited

ibgreen Nov 15, 2023

macrigiuseppe Nov 17, 2023

ibgreen Nov 15, 2023

igorDykhta Nov 15, 2023

macrigiuseppe Nov 17, 2023

igorDykhta Nov 15, 2023

[feat] Introduce Foursquare cloud provider #2437

[feat] Introduce Foursquare cloud provider #2437

Conversation

macrigiuseppe commented Nov 12, 2023

ibgreen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

macrigiuseppe Nov 17, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

macrigiuseppe Nov 17, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

macrigiuseppe Nov 17, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

macrigiuseppe Nov 17, 2023 •

edited

macrigiuseppe Nov 17, 2023 •

edited

macrigiuseppe Nov 17, 2023 •

edited