Added 'withinPolygon' to query #3866

dplewis · 2017-05-27T02:27:18Z

This PR addresses issue #3290

My first PR any help would be great.

I don't know much about Postgres. Is there a guide to setup Postgres with parse server locally?

curl -X POST \
  -H "X-Parse-Application-Id: app-id-here" \
  -H "Content-Type: application/json" \
  -d '{
        "location": {
          "__type": "GeoPoint",
          "latitude": 1.5,
          "longitude": 1.5
        }
      }' \
http://localhost:1337/parse/classes/TestObject

curl -X GET \
-H "X-Parse-Application-Id: app-id-here" \
-H "Content-Type: application/json" \
  -G \
  --data-urlencode 'where={
        "location": {
          "$geoWithin": {
            "$polygon": [
              {
                "__type": "GeoPoint",
                "latitude": 1,
                "longitude": 1
              },
              {
                "__type": "GeoPoint",
                "latitude": 1,
                "longitude": 2
              },
              {
                "__type": "GeoPoint",
                "latitude": 2,
                "longitude": 2
              },
              {
                "__type": "GeoPoint",
                "latitude": 2,
                "longitude": 1
              }
            ]
          }
        }
      }' \
http://localhost:1337/parse/classes/TestObject

codecov · 2017-05-27T02:46:23Z

Codecov Report

Merging #3866 into master will increase coverage by 0.05%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #3866      +/-   ##
==========================================
+ Coverage   90.17%   90.22%   +0.05%     
==========================================
  Files         114      114              
  Lines        7550     7571      +21     
==========================================
+ Hits         6808     6831      +23     
+ Misses        742      740       -2

Impacted Files	Coverage Δ
src/Adapters/Storage/Mongo/MongoTransform.js	`83.33% <100%> (+0.35%)`	⬆️
...dapters/Storage/Postgres/PostgresStorageAdapter.js	`95.52% <100%> (+0.06%)`	⬆️
src/Adapters/Cache/InMemoryCache.js	`100% <0%> (+7.69%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aedaae1...7f50180. Read the comment docs.

flovilmart · 2017-05-27T14:12:52Z

Hi @dplewis Thanks for this PR! That'S great that you jump in on such requested feature!

Would you please add some unit tests to cover this feature?

The best location would be here where other geoPoints tests are run.

If you can add a tests that covers:

Bad input (malformed inputs, etc...)
Successfully fetches all objects that have points within the polygon, while excluding the ones outside.

Because the JS SDK doesn't have the within polygon yet, you should use request and craft the query directly as a REST request. You can find an example query request here
Thanks!

dplewis · 2017-05-27T18:01:11Z

Test have been added

flovilmart · 2017-05-27T18:14:30Z

Can we add a test with invalid points within the polygon array?

dplewis · 2017-05-27T19:41:31Z

Sorry for the late reply. I've added more tests

dplewis · 2017-05-27T19:42:48Z

Quick question when writing test do the test objects get deleted before and after the Unit Tests

flovilmart · 2017-05-27T19:53:21Z

Yes, the whole DB is cleaned up between tests

dplewis · 2017-05-27T20:00:24Z

Interesting at one point the test passed the first time but second and third, etc failed until I deleted all objects.

flovilmart · 2017-05-27T20:56:52Z

Seems that it's not properly supported on Postgres. Can you check the Travis logs?

dplewis · 2017-05-27T21:01:45Z

How do I go about running tests against Postgres

flovilmart · 2017-05-27T21:29:57Z

You can disable the Postgres test for now with it_exclude_db() (Check in other tests for the exact syntax)
Or to run the pg tests:

PARSE_SERVER_TEST_DB=postgres npm test

You'll need Postgres installed and configured (as in the .travis.yaml)

dplewis · 2017-05-27T22:33:21Z

I got the test to pass locally with postgres

dplewis · 2017-05-27T23:12:47Z

Can you create add testing Postgres to CONTRIBUTING.md?

I can try to help out on the Postgres Adapter.

flovilmart · 2017-05-28T14:42:51Z

Can you create add testing Postgres to CONTRIBUTING.md?

I'll work on the contributing guidelines :)

flovilmart · 2017-05-28T14:44:35Z

src/Adapters/Storage/Postgres/PostgresStorageAdapter.js

@@ -10,6 +10,7 @@ const PostgresDuplicateObjectError = '42710';
 const PostgresUniqueIndexViolationError = '23505';
 const PostgresTransactionAbortedError = '25P02';
 const logger = require('../../../logger');
+const _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };


does that come from transpired babel source? please remove :)

flovilmart · 2017-05-28T14:47:18Z

src/Adapters/Storage/Postgres/PostgresStorageAdapter.js

+        throw new Parse.Error(Parse.Error.INVALID_JSON, 'bad $geoWithin value');
+      }
+      const points = polygon.map((point) => {
+        if (!((typeof point === 'undefined' ? 'undefined' : _typeof(point)) === 'object' && point !== null && point.__type === 'GeoPoint')) {


doesn't seem to be something a human would write :)
can we replace with:

if (typeof point !== 'object' || point.__type !== 'GeoPoint') {

Good thing I'm not human

Sorry if I offended you, it looked like generated code

flovilmart · 2017-05-28T14:47:42Z

@dplewis just one small nit, otherwise it's looking awesome!

nit?

dplewis · 2017-05-28T17:15:05Z

Thanks, when can we update the SDKs?

Also theres a debug function in PostgresAdapter. How do I run that?

flovilmart · 2017-05-28T17:44:56Z

With PARSE_SERVER_LOG_LEVEL=debug

flovilmart · 2017-05-28T17:45:56Z

@dplewis we can update the SDK's anytime, on old parse-server versions that will just fail as unsupported queries, with next release, this should work nicely

madsb · 2017-05-30T08:18:19Z

Holy smokes, this looks awesome - can't wait to try it out. Thanks, @dplewis! 🙏🏼

otymartin · 2017-06-20T17:34:07Z

@dplewis will you be updating the iOS SDK with this aswell?

dplewis · 2017-06-20T17:39:07Z

@otymartin I'm working on it now should be there soon

montymxb · 2017-06-20T17:43:59Z

@dplewis nice to see this bumping along! Has the android sdk received this yet by chance?

otymartin · 2017-06-26T15:43:19Z

@dplewis nice thanks man

dplewis added 2 commits May 26, 2017 21:17

Added 'withinPolygon' to query

0d7d2bb

Merge branch 'master' into within-polygon

03b0d5b

flovilmart self-requested a review May 27, 2017 14:13

flovilmart added the GH Review: needs-revision label May 27, 2017

Unit test for withinPolygon

f9e935f

More Unit Test

4681892

withinPolygon fix for Postgres

7aaeedc

Merge branch 'master' into within-polygon

7a5703f

flovilmart reviewed May 28, 2017

View reviewed changes

flovilmart suggested changes May 28, 2017

View reviewed changes

Fix nit

7f50180

nit?

flovilmart approved these changes May 28, 2017

View reviewed changes

flovilmart merged commit c99fdea into parse-community:master May 28, 2017

dplewis deleted the within-polygon branch May 28, 2017 16:55

This was referenced May 30, 2017

Add Within Polygon to Query parse-community/parse-php-sdk#320

Merged

Added WithinPolygon to Query parse-community/Parse-SDK-JS#438

Merged

apersaud mentioned this pull request Jun 3, 2017

Add withinPolygon to Query modernistik/parse-stack#31

Closed

dplewis mentioned this pull request Jun 14, 2017

Rest Doc for Full Text Search and withinPolygon parse-community/docs#444

Merged

This was referenced Jun 20, 2017

Add withinPolygon to Query parse-community/Parse-SDK-iOS-OSX#1150

Merged

Add withinPolygon to Query parse-community/Parse-SDK-Android#684

Merged

dplewis mentioned this pull request Nov 15, 2017

Add 'withinPolygon' to ParseQuery #3290

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added 'withinPolygon' to query #3866

Added 'withinPolygon' to query #3866

dplewis commented May 27, 2017 •

edited

Loading

codecov bot commented May 27, 2017 •

edited

Loading

flovilmart commented May 27, 2017

dplewis commented May 27, 2017

flovilmart commented May 27, 2017 via email

dplewis commented May 27, 2017

dplewis commented May 27, 2017

flovilmart commented May 27, 2017

dplewis commented May 27, 2017

flovilmart commented May 27, 2017

dplewis commented May 27, 2017 •

edited

Loading

flovilmart commented May 27, 2017

dplewis commented May 27, 2017

dplewis commented May 27, 2017

flovilmart commented May 28, 2017

flovilmart May 28, 2017

flovilmart May 28, 2017

dplewis May 28, 2017

flovilmart May 28, 2017

flovilmart commented May 28, 2017

dplewis commented May 28, 2017

flovilmart commented May 28, 2017

flovilmart commented May 28, 2017

madsb commented May 30, 2017

otymartin commented Jun 20, 2017

dplewis commented Jun 20, 2017

montymxb commented Jun 20, 2017

otymartin commented Jun 26, 2017

Added 'withinPolygon' to query #3866

Added 'withinPolygon' to query #3866

Conversation

dplewis commented May 27, 2017 • edited Loading

codecov bot commented May 27, 2017 • edited Loading

Codecov Report

flovilmart commented May 27, 2017

dplewis commented May 27, 2017

flovilmart commented May 27, 2017 via email

dplewis commented May 27, 2017

dplewis commented May 27, 2017

flovilmart commented May 27, 2017

dplewis commented May 27, 2017

flovilmart commented May 27, 2017

dplewis commented May 27, 2017 • edited Loading

flovilmart commented May 27, 2017

dplewis commented May 27, 2017

dplewis commented May 27, 2017

flovilmart commented May 28, 2017

flovilmart May 28, 2017

Choose a reason for hiding this comment

flovilmart May 28, 2017

Choose a reason for hiding this comment

dplewis May 28, 2017

Choose a reason for hiding this comment

flovilmart May 28, 2017

Choose a reason for hiding this comment

flovilmart commented May 28, 2017

dplewis commented May 28, 2017

flovilmart commented May 28, 2017

flovilmart commented May 28, 2017

madsb commented May 30, 2017

otymartin commented Jun 20, 2017

dplewis commented Jun 20, 2017

montymxb commented Jun 20, 2017

otymartin commented Jun 26, 2017

dplewis commented May 27, 2017 •

edited

Loading

codecov bot commented May 27, 2017 •

edited

Loading

dplewis commented May 27, 2017 •

edited

Loading