feat: Deprecate LiveQuery `fields` option in favor of `keys` for semantic consistency #8388

dblythy · 2023-01-16T14:10:17Z

New Pull Request Checklist

I am not disclosing a vulnerability.
I am creating this PR in reference to an issue.

Issue Description

Live Query uses "fields" to select keys, instead of "keys", like the rest of Parse Server

Closes: #8389

Approach

TODOs before merging

Add tests

parse-github-assistant · 2023-01-16T14:10:19Z

I will reformat the title to use the proper commit message syntax.

parse-github-assistant · 2023-01-16T14:10:22Z

Thanks for opening this pull request!

🎉 We are excited about your hands-on contribution!

mtrezza · 2023-01-16T15:26:05Z

Shouldn't this be renamed to select for consistency with the Parse Query terminology?

dblythy · 2023-01-16T15:53:47Z

According to the REST API the operator that restricts keys is "keys"

keys | Restrict the fields returned by the query

mtrezza · 2023-01-16T19:37:55Z

So in the SDKs it's called select and in REST it's called keys? If so, in the sense of unification, what should we call it here?

dblythy · 2023-01-17T00:21:49Z

In RestQuery it is defined as RestOptions.keys, so I think keys is consistent with how Parse Server behaves.

codecov · 2023-01-17T00:39:05Z

Codecov Report

Base: 94.16% // Head: 93.88% // Decreases project coverage by -0.28% ⚠️

Coverage data is based on head (eb35fe5) compared to base (f5bfe45).
Patch coverage: 100.00% of modified lines in pull request are covered.

❗ Current head eb35fe5 differs from pull request most recent head 296940d. Consider uploading reports for the commit 296940d to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##            alpha    #8388      +/-   ##
==========================================
- Coverage   94.16%   93.88%   -0.28%     
==========================================
  Files         182      182              
  Lines       14398    14400       +2     
==========================================
- Hits        13558    13520      -38     
- Misses        840      880      +40

Impacted Files	Coverage Δ
src/LiveQuery/RequestSchema.js	`100.00% <ø> (ø)`
src/LiveQuery/Client.js	`100.00% <100.00%> (ø)`
src/LiveQuery/ParseLiveQueryServer.js	`95.77% <100.00%> (-0.20%)`	⬇️
src/Adapters/Cache/RedisCacheAdapter.js	`17.39% <0.00%> (-73.92%)`	⬇️
src/LiveQuery/ParseCloudCodePublisher.js	`84.21% <0.00%> (-15.79%)`	⬇️
src/ParseServer.js	`92.17% <0.00%> (-0.44%)`	⬇️
src/RestWrite.js	`94.61% <0.00%> (-0.15%)`	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

src/LiveQuery/RequestSchema.js

cbaker6 · 2023-01-20T15:15:36Z

@dblythy Do you need to add keys here as well? I see you added watch. I haven't verified how this is used on the server, just following the pattern. From a LiveQuery client, an update can definitely happen with keys and watch:

parse-server/src/LiveQuery/RequestSchema.js

Lines 119 to 134 in 49a54c2

    
           fields: { 
        
             type: 'array', 
        
             items: { 
        
               type: 'string', 
        
             }, 
        
             minItems: 1, 
        
             uniqueItems: true, 
        
           }, 
        
           watch: { 
        
             type: 'array', 
        
             items: { 
        
               type: 'string', 
        
             }, 
        
             minItems: 1, 
        
             uniqueItems: true, 
        
           },

dblythy · 2023-01-21T00:34:39Z

I think it's good now @cbaker6

src/LiveQuery/ParseLiveQueryServer.js

src/LiveQuery/RequestSchema.js

DEPRECATIONS.md

Signed-off-by: Manuel <5673677+mtrezza@users.noreply.github.com>

mtrezza

Looks good, waiting for CI to pass...

# [6.0.0-alpha.33](6.0.0-alpha.32...6.0.0-alpha.33) (2023-02-17) ### Features * Deprecate LiveQuery `fields` option in favor of `keys` for semantic consistency ([#8388](#8388)) ([a49e323](a49e323))

parseplatformorg · 2023-02-17T12:26:09Z

🎉 This change has been released in version 6.0.0-alpha.33

# [6.1.0-beta.1](6.0.0...6.1.0-beta.1) (2023-03-02) ### Bug Fixes * Security upgrade jsonwebtoken to 9.0.0 ([#8420](#8420)) ([f5bfe45](f5bfe45)) ### Features * Add option `schemaCacheTtl` for schema cache pulling as alternative to `enableSchemaHooks` ([#8436](#8436)) ([b3b76de](b3b76de)) * Add Parse Server option `resetPasswordSuccessOnInvalidEmail` to choose success or error response on password reset with invalid email ([#7551](#7551)) ([e5d610e](e5d610e)) * Deprecate LiveQuery `fields` option in favor of `keys` for semantic consistency ([#8388](#8388)) ([a49e323](a49e323))

parseplatformorg · 2023-03-02T10:55:04Z

🎉 This change has been released in version 6.1.0-beta.1

# [6.1.0-alpha.1](6.0.0...6.1.0-alpha.1) (2023-03-03) ### Bug Fixes * Security upgrade jsonwebtoken to 9.0.0 ([#8420](#8420)) ([f5bfe45](f5bfe45)) ### Features * Add option `schemaCacheTtl` for schema cache pulling as alternative to `enableSchemaHooks` ([#8436](#8436)) ([b3b76de](b3b76de)) * Add Parse Server option `resetPasswordSuccessOnInvalidEmail` to choose success or error response on password reset with invalid email ([#7551](#7551)) ([e5d610e](e5d610e)) * Deprecate LiveQuery `fields` option in favor of `keys` for semantic consistency ([#8388](#8388)) ([a49e323](a49e323)) * Export `AuthAdapter` to make it available for extension with custom authentication adapters ([#8443](#8443)) ([40c1961](40c1961))

parseplatformorg · 2023-03-03T16:53:51Z

🎉 This change has been released in version 6.1.0-alpha.1

# [6.1.0](6.0.0...6.1.0) (2023-05-01) ### Bug Fixes * LiveQuery can return incorrectly formatted date ([#8456](#8456)) ([4ce135a](4ce135a)) * Nested date is incorrectly decoded as empty object `{}` when fetching a Parse Object ([#8446](#8446)) ([22d2446](22d2446)) * Parameters missing in `afterFind` trigger of authentication adapters ([#8458](#8458)) ([ce34747](ce34747)) * Rate limiting across multiple servers via Redis not working ([#8469](#8469)) ([d9e347d](d9e347d)) * Security upgrade jsonwebtoken to 9.0.0 ([#8420](#8420)) ([f5bfe45](f5bfe45)) ### Features * Add `afterFind` trigger to authentication adapters ([#8444](#8444)) ([c793bb8](c793bb8)) * Add option `schemaCacheTtl` for schema cache pulling as alternative to `enableSchemaHooks` ([#8436](#8436)) ([b3b76de](b3b76de)) * Add Parse Server option `resetPasswordSuccessOnInvalidEmail` to choose success or error response on password reset with invalid email ([#7551](#7551)) ([e5d610e](e5d610e)) * Add rate limiting across multiple servers via Redis ([#8394](#8394)) ([34833e4](34833e4)) * Allow multiple origins for header `Access-Control-Allow-Origin` ([#8517](#8517)) ([4f15539](4f15539)) * Deprecate LiveQuery `fields` option in favor of `keys` for semantic consistency ([#8388](#8388)) ([a49e323](a49e323)) * Export `AuthAdapter` to make it available for extension with custom authentication adapters ([#8443](#8443)) ([40c1961](40c1961))

parseplatformorg · 2023-05-01T21:52:40Z

🎉 This change has been released in version 6.1.0

commit 1506273 Author: semantic-release-bot <semantic-release-bot@martynus.net> Date: Sat May 20 23:24:03 2023 +0000 chore(release): 6.2.0 [skip ci] # [6.2.0](parse-community/parse-server@6.1.0...6.2.0) (2023-05-20) ### Features * Add new Parse Server option `fileUpload.fileExtensions` to restrict file upload by file extension; this fixes a security vulnerability in which a phishing attack could be performed using an uploaded HTML file; by default the new option only allows file extensions matching the regex pattern `^[^hH][^tT][^mM][^lL]?$`, which excludes HTML files; if your app currently depends on uploading files with HTML file extensions then this may be a breaking change and you could allow HTML file upload by setting the option to `['.*']` ([parse-community#8538](parse-community#8538)) ([a318e7b](parse-community@a318e7b)) commit a318e7b Author: Manuel <5673677+mtrezza@users.noreply.github.com> Date: Sun May 21 01:23:00 2023 +0200 feat: Add new Parse Server option `fileUpload.fileExtensions` to restrict file upload by file extension; this fixes a security vulnerability in which a phishing attack could be performed using an uploaded HTML file; by default the new option only allows file extensions matching the regex pattern `^[^hH][^tT][^mM][^lL]?$`, which excludes HTML files; if your app currently depends on uploading files with HTML file extensions then this may be a breaking change and you could allow HTML file upload by setting the option to `['.*']` (parse-community#8538) commit 832702d Author: semantic-release-bot <semantic-release-bot@martynus.net> Date: Mon May 1 21:50:23 2023 +0000 chore(release): 6.1.0 [skip ci] # [6.1.0](parse-community/parse-server@6.0.0...6.1.0) (2023-05-01) ### Bug Fixes * LiveQuery can return incorrectly formatted date ([parse-community#8456](parse-community#8456)) ([4ce135a](parse-community@4ce135a)) * Nested date is incorrectly decoded as empty object `{}` when fetching a Parse Object ([parse-community#8446](parse-community#8446)) ([22d2446](parse-community@22d2446)) * Parameters missing in `afterFind` trigger of authentication adapters ([parse-community#8458](parse-community#8458)) ([ce34747](parse-community@ce34747)) * Rate limiting across multiple servers via Redis not working ([parse-community#8469](parse-community#8469)) ([d9e347d](parse-community@d9e347d)) * Security upgrade jsonwebtoken to 9.0.0 ([parse-community#8420](parse-community#8420)) ([f5bfe45](parse-community@f5bfe45)) ### Features * Add `afterFind` trigger to authentication adapters ([parse-community#8444](parse-community#8444)) ([c793bb8](parse-community@c793bb8)) * Add option `schemaCacheTtl` for schema cache pulling as alternative to `enableSchemaHooks` ([parse-community#8436](parse-community#8436)) ([b3b76de](parse-community@b3b76de)) * Add Parse Server option `resetPasswordSuccessOnInvalidEmail` to choose success or error response on password reset with invalid email ([parse-community#7551](parse-community#7551)) ([e5d610e](parse-community@e5d610e)) * Add rate limiting across multiple servers via Redis ([parse-community#8394](parse-community#8394)) ([34833e4](parse-community@34833e4)) * Allow multiple origins for header `Access-Control-Allow-Origin` ([parse-community#8517](parse-community#8517)) ([4f15539](parse-community@4f15539)) * Deprecate LiveQuery `fields` option in favor of `keys` for semantic consistency ([parse-community#8388](parse-community#8388)) ([a49e323](parse-community@a49e323)) * Export `AuthAdapter` to make it available for extension with custom authentication adapters ([parse-community#8443](parse-community#8443)) ([40c1961](parse-community@40c1961)) commit 18b63d1 Merge: f7eee19 f59d46c Author: Manuel <5673677+mtrezza@users.noreply.github.com> Date: Mon May 1 23:49:22 2023 +0200 build: Release (parse-community#8526)

fix: rename LiveQuery fields option to keys

ccf3416

parse-github-assistant bot changed the title ~~fix: rename LiveQuery fields option to keys~~ fix: Rename LiveQuery fields option to keys Jan 16, 2023

dblythy added 2 commits January 17, 2023 01:41

wip

c18e7a4

add deps

18a2e73

Update ParseLiveQueryServer.js

ee6ca47

dblythy requested a review from a team January 17, 2023 02:12

cbaker6 reviewed Jan 18, 2023

View reviewed changes

src/LiveQuery/RequestSchema.js Show resolved Hide resolved

Update RequestSchema.js

49a54c2

dblythy mentioned this pull request Jan 20, 2023

fix: Switch LiveQuery listen to watch netreconlab/Parse-Swift#48

Merged

3 tasks

dblythy added 2 commits January 21, 2023 11:34

Update RequestSchema.js

af9d16b

Merge branch 'alpha' into select-keys

c21257f

cbaker6 reviewed Jan 21, 2023

View reviewed changes

src/LiveQuery/ParseLiveQueryServer.js Outdated Show resolved Hide resolved

src/LiveQuery/ParseLiveQueryServer.js Show resolved Hide resolved

src/LiveQuery/RequestSchema.js Show resolved Hide resolved

dblythy and others added 3 commits January 25, 2023 18:24

Update ParseLiveQueryServer.js

8cc4160

Merge branch 'alpha' into select-keys

8cfa016

Merge branch 'alpha' into select-keys

1f32a0f

mtrezza changed the title ~~fix: Rename LiveQuery fields option to keys~~ feat: Rename LiveQuery fields option to keys for semantic consistency Feb 16, 2023

mtrezza changed the title ~~feat: Rename LiveQuery fields option to keys for semantic consistency~~ feat: Deprecate LiveQuery fields option in favor of keys for semantic consistency Feb 16, 2023

mtrezza reviewed Feb 16, 2023

View reviewed changes

DEPRECATIONS.md Outdated Show resolved Hide resolved

Update DEPRECATIONS.md

296940d

Signed-off-by: Manuel <5673677+mtrezza@users.noreply.github.com>

mtrezza approved these changes Feb 16, 2023

View reviewed changes

mtrezza merged commit a49e323 into parse-community:alpha Feb 17, 2023

parseplatformorg added the state:released-alpha Released as alpha version label Feb 17, 2023

parseplatformorg added the state:released-beta Released as beta version label Mar 2, 2023

dblythy deleted the select-keys branch March 3, 2023 17:41

parseplatformorg added the state:released Released as stable version label May 1, 2023

mtrezza mentioned this pull request Oct 9, 2023

Deprecate current pages implementation #7625

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Deprecate LiveQuery `fields` option in favor of `keys` for semantic consistency #8388

feat: Deprecate LiveQuery `fields` option in favor of `keys` for semantic consistency #8388

dblythy commented Jan 16, 2023 •

edited

Loading

parse-github-assistant bot commented Jan 16, 2023

parse-github-assistant bot commented Jan 16, 2023 •

edited

Loading

mtrezza commented Jan 16, 2023 •

edited

Loading

dblythy commented Jan 16, 2023

mtrezza commented Jan 16, 2023

dblythy commented Jan 17, 2023

codecov bot commented Jan 17, 2023 •

edited

Loading

cbaker6 commented Jan 20, 2023 •

edited

Loading

dblythy commented Jan 21, 2023

mtrezza left a comment

parseplatformorg commented Feb 17, 2023

parseplatformorg commented Mar 2, 2023

parseplatformorg commented Mar 3, 2023

parseplatformorg commented May 1, 2023

feat: Deprecate LiveQuery fields option in favor of keys for semantic consistency #8388

feat: Deprecate LiveQuery fields option in favor of keys for semantic consistency #8388

Conversation

dblythy commented Jan 16, 2023 • edited Loading

New Pull Request Checklist

Issue Description

Approach

TODOs before merging

parse-github-assistant bot commented Jan 16, 2023

parse-github-assistant bot commented Jan 16, 2023 • edited Loading

Thanks for opening this pull request!

mtrezza commented Jan 16, 2023 • edited Loading

dblythy commented Jan 16, 2023

mtrezza commented Jan 16, 2023

dblythy commented Jan 17, 2023

codecov bot commented Jan 17, 2023 • edited Loading

Codecov Report

cbaker6 commented Jan 20, 2023 • edited Loading

dblythy commented Jan 21, 2023

mtrezza left a comment

Choose a reason for hiding this comment

parseplatformorg commented Feb 17, 2023

parseplatformorg commented Mar 2, 2023

parseplatformorg commented Mar 3, 2023

parseplatformorg commented May 1, 2023

feat: Deprecate LiveQuery `fields` option in favor of `keys` for semantic consistency #8388

feat: Deprecate LiveQuery `fields` option in favor of `keys` for semantic consistency #8388

dblythy commented Jan 16, 2023 •

edited

Loading

parse-github-assistant bot commented Jan 16, 2023 •

edited

Loading

mtrezza commented Jan 16, 2023 •

edited

Loading

codecov bot commented Jan 17, 2023 •

edited

Loading

cbaker6 commented Jan 20, 2023 •

edited

Loading