feat: Allow `Parse.Object` pointers in Cloud Code arguments #8490

dblythy · 2023-03-30T05:27:55Z

Pull Request

Report security issues confidentially.
Any contribution is under this license.
Link this pull request to an issue.

Issue

In order to merge in parse-community/parse-dashboard#2409, we need a way to pass Parse Objects into cloud code. This PR allows for a Pointer to be passed through via:

Parse.Cloud.run("function", { object: obj.toPointer });

And then the pointer is accessible directly in cloud code via req.params.object. The pointer is unfetched, it's up to the developer to decide what to thereafter.

Note: obj.toPointer() has to be added for now until the JS SDK is updated to support this.

Closes: n/a

Approach

Tasks

Add tests
Add changes to documentation (guides, repository pages, code comments)
Add security check
Add new Parse Error codes to Parse JS SDK

This reverts commit 407825d.

This reverts commit 78c67d4.

parse-github-assistant · 2023-03-30T05:27:57Z

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

parse-github-assistant · 2023-03-30T05:28:00Z

Thanks for opening this pull request!

❌ Please link an issue that describes the reason for this pull request, otherwise your pull request will be closed. Make sure to write it as Closes: #123 in the PR description, so I can recognize it.

codecov · 2023-03-30T05:40:46Z

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.54 ⚠️

Comparison is base (fd6a007) 94.33% compared to head (2e7cea3) 93.79%.

❗ Current head 2e7cea3 differs from pull request most recent head a178883. Consider uploading reports for the commit a178883 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##            alpha    #8490      +/-   ##
==========================================
- Coverage   94.33%   93.79%   -0.54%     
==========================================
  Files         183      183              
  Lines       14574    14576       +2     
==========================================
- Hits        13748    13672      -76     
- Misses        826      904      +78

Impacted Files	Coverage Δ
src/Routers/FunctionsRouter.js	`94.36% <100.00%> (+0.16%)`	⬆️

... and 9 files with indirect coverage changes

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

mtrezza

Note: obj.toPointer() has to be added for now until the JS SDK is updated to support this.

What would the SDK have to support and how difficult would it be to add that support?
Is there any other use for this PR other than being a workaround? I.e. would that be removed again once the SDK supports sending Parse Objects?

mtrezza · 2023-05-21T09:12:25Z

@dblythy parse-community/parse-dashboard#2409 is a almost ready for merging. What are the limitations of the feature if this PR here is not merged, i.e. pointers are unsupported? Would the passed object just not contain pointers, or would the whole feature not work for object that contain pointers?

dblythy · 2023-05-22T03:51:33Z

Currently the JS SDK throws an error if trying to encode a Parse Object as a parameter in Parse.Cloud.run ("Parse Objects are not allowed here").

Once this feature is merged, the JS SDK will just need to convert Parse Objects to pointers instead of throwing.

The other thought is that the Parse Object is only a pointer in cloud code and will still need to be fetched - do you think this is the right approach? Or should it be prefetched (just like req.user)

mtrezza · 2023-05-22T14:48:27Z

Currently the JS SDK throws an error

So if only parse-community/parse-dashboard#2409 is merged, then if the obj has a pointer the script invocation will fail? It's basically a non-functional feature without these PRs.

Once this feature is merged, the JS SDK will just need to convert Parse Objects to pointers instead of throwing.

So this feature requires 3 PRs in total to work, in dashboard, server and js sdk?

Note: obj.toPointer() has to be added for now until the JS SDK is updated to support this.

I still don't get this, maybe it's just the phrasing. The "for now" sounds to me as if this PR was adding a temporary workaround that will be removed later. So my question is whether we can go straight for the proper solution so we don't need a temporary one.

Or should it be prefetched

I don't see any benefit in pre-fetching. If it's needed then the developer can fetch in code (same cost), and for those who don't need it it's an unnecessary cost.

dblythy · 2023-05-25T03:45:54Z

All this PR does is transforms a JSON representation of a pointer to a Parse.Pointer, so it can be fetched in cloud code.

The JS SDK currently does not support sending Parse Objects to Parse.Cloud.run (it says Objects not allowed).

There will need to be a PR to the JS SDK to transform Parse.Objects to the JSON representation of a pointer when using Parse.Cloud.run

mtrezza · 2023-05-25T11:23:49Z

Did we already have a definition of a JSON representation for a Parse.Pointer, or is that something you needed to invent?

dblythy · 2023-05-25T12:47:20Z

There is already a JSON representation of a pointer:

{
      __type: 'Pointer',
      className: ...,
      objectId: ...,
}

Just passing this to cloud code currently does nothing - it stays as JSON instead of being converted to a Parse.Pointer

mtrezza · 2023-05-25T12:49:19Z

Got it, so let's merge this once the CI passes.

mtrezza

Look good!

# [6.1.0-alpha.14](6.1.0-alpha.13...6.1.0-alpha.14) (2023-05-27) ### Bug Fixes * Unnecessary log entries by `extendSessionOnUse` ([#8562](#8562)) ([fd6a007](fd6a007)) ### Features * Allow `Parse.Object` pointers in Cloud Code arguments ([#8490](#8490)) ([28aeda3](28aeda3))

parseplatformorg · 2023-05-27T23:33:16Z

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

# [6.3.0-beta.1](6.2.0...6.3.0-beta.1) (2023-06-10) ### Bug Fixes * Cloud Code Trigger `afterSave` executes even if not set ([#8520](#8520)) ([afd0515](afd0515)) * GridFS file storage doesn't work with certain `enableSchemaHooks` settings ([#8467](#8467)) ([d4cda4b](d4cda4b)) * Inaccurate table total row count for PostgreSQL ([#8511](#8511)) ([0823a02](0823a02)) * LiveQuery server is not shut down properly when `handleShutdown` is called ([#8491](#8491)) ([967700b](967700b)) * Rate limit feature is incompatible with Node 14 ([#8578](#8578)) ([f911f2c](f911f2c)) * Unnecessary log entries by `extendSessionOnUse` ([#8562](#8562)) ([fd6a007](fd6a007)) ### Features * `extendSessionOnUse` to automatically renew Parse Sessions ([#8505](#8505)) ([6f885d3](6f885d3)) * Add new Parse Server option `preventSignupWithUnverifiedEmail` to prevent returning a user without session token on sign-up with unverified email address ([#8451](#8451)) ([82da308](82da308)) * Add option to change the log level of logs emitted by Cloud Functions ([#8530](#8530)) ([2caea31](2caea31)) * Add support for `$eq` query constraint in LiveQuery ([#8614](#8614)) ([656d673](656d673)) * Add zones for rate limiting by `ip`, `user`, `session`, `global` ([#8508](#8508)) ([03fba97](03fba97)) * Allow `Parse.Object` pointers in Cloud Code arguments ([#8490](#8490)) ([28aeda3](28aeda3)) ### Reverts * fix: Inaccurate table total row count for PostgreSQL ([6722110](6722110))

parseplatformorg · 2023-06-10T23:08:21Z

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

# [6.3.0-alpha.1](6.2.0...6.3.0-alpha.1) (2023-06-18) ### Bug Fixes * Cloud Code Trigger `afterSave` executes even if not set ([#8520](#8520)) ([afd0515](afd0515)) * GridFS file storage doesn't work with certain `enableSchemaHooks` settings ([#8467](#8467)) ([d4cda4b](d4cda4b)) * Inaccurate table total row count for PostgreSQL ([#8511](#8511)) ([0823a02](0823a02)) * LiveQuery server is not shut down properly when `handleShutdown` is called ([#8491](#8491)) ([967700b](967700b)) * Rate limit feature is incompatible with Node 14 ([#8578](#8578)) ([f911f2c](f911f2c)) * Unnecessary log entries by `extendSessionOnUse` ([#8562](#8562)) ([fd6a007](fd6a007)) ### Features * `extendSessionOnUse` to automatically renew Parse Sessions ([#8505](#8505)) ([6f885d3](6f885d3)) * Add new Parse Server option `preventSignupWithUnverifiedEmail` to prevent returning a user without session token on sign-up with unverified email address ([#8451](#8451)) ([82da308](82da308)) * Add option to change the log level of logs emitted by Cloud Functions ([#8530](#8530)) ([2caea31](2caea31)) * Add support for `$eq` query constraint in LiveQuery ([#8614](#8614)) ([656d673](656d673)) * Add zones for rate limiting by `ip`, `user`, `session`, `global` ([#8508](#8508)) ([03fba97](03fba97)) * Allow `Parse.Object` pointers in Cloud Code arguments ([#8490](#8490)) ([28aeda3](28aeda3)) ### Reverts * fix: Inaccurate table total row count for PostgreSQL ([6722110](6722110))

parseplatformorg · 2023-06-18T01:24:19Z

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

oallouch · 2023-06-18T16:34:58Z

Is this new feature in the docs ?

mtrezza · 2023-06-18T17:47:49Z

This will be reverted / amended, it's a breaking change. You will then find it in the API docs once it's stable released. #8634

# [6.3.0](6.2.2...6.3.0) (2023-09-16) ### Bug Fixes * Cloud Code Trigger `afterSave` executes even if not set ([#8520](#8520)) ([afd0515](afd0515)) * GridFS file storage doesn't work with certain `enableSchemaHooks` settings ([#8467](#8467)) ([d4cda4b](d4cda4b)) * Inaccurate table total row count for PostgreSQL ([#8511](#8511)) ([0823a02](0823a02)) * LiveQuery server is not shut down properly when `handleShutdown` is called ([#8491](#8491)) ([967700b](967700b)) * Rate limit feature is incompatible with Node 14 ([#8578](#8578)) ([f911f2c](f911f2c)) * Unnecessary log entries by `extendSessionOnUse` ([#8562](#8562)) ([fd6a007](fd6a007)) ### Features * `extendSessionOnUse` to automatically renew Parse Sessions ([#8505](#8505)) ([6f885d3](6f885d3)) * Add new Parse Server option `preventSignupWithUnverifiedEmail` to prevent returning a user without session token on sign-up with unverified email address ([#8451](#8451)) ([82da308](82da308)) * Add option to change the log level of logs emitted by Cloud Functions ([#8530](#8530)) ([2caea31](2caea31)) * Add support for `$eq` query constraint in LiveQuery ([#8614](#8614)) ([656d673](656d673)) * Add zones for rate limiting by `ip`, `user`, `session`, `global` ([#8508](#8508)) ([03fba97](03fba97)) * Allow `Parse.Object` pointers in Cloud Code arguments ([#8490](#8490)) ([28aeda3](28aeda3)) ### Reverts * fix: Inaccurate table total row count for PostgreSQL ([6722110](6722110))

parseplatformorg · 2023-09-16T01:12:27Z

🎉 This change has been released in version 6.3.0

dblythy added 5 commits March 30, 2023 13:18

fix: remove username from verification emails

78c67d4

tests

407825d

feat: allow Pointers in cloud code params

0c49a4a

Revert "tests"

c38a4a9

This reverts commit 407825d.

Revert "fix: remove username from verification emails"

80ab7b9

This reverts commit 78c67d4.

parse-github-assistant bot changed the title ~~feat: allow pointers in cloud code~~ feat: Allow pointers in cloud code Mar 30, 2023

dblythy requested a review from a team April 10, 2023 03:24

mtrezza reviewed Apr 10, 2023

View reviewed changes

Merge branch 'alpha' into allow-pointers

a7c6375

mtrezza mentioned this pull request May 21, 2023

feat: Add Cloud Function execution on Parse Object in data browser parse-community/parse-dashboard#2409

Merged

2 tasks

Merge branch 'alpha' into allow-pointers

8b1d7e7

Merge branch 'alpha' into allow-pointers

a178883

mtrezza changed the title ~~feat: Allow pointers in cloud code~~ feat: Allow Parse.Object pointers in Cloud Code arguments May 25, 2023

mtrezza changed the title ~~feat: Allow Parse.Object pointers in Cloud Code arguments~~ feat: Allow Parse.Object pointers in Cloud Code arguments May 25, 2023

mtrezza approved these changes May 25, 2023

View reviewed changes

mtrezza merged commit 28aeda3 into parse-community:alpha May 25, 2023

parseplatformorg added the state:released-alpha Released as alpha version label May 27, 2023

parseplatformorg added the state:released-beta Released as beta version label Jun 10, 2023

dblythy deleted the allow-pointers branch June 11, 2023 13:29

mtrezza mentioned this pull request Jun 11, 2023

Add option to convert Parse.Pointer in Cloud Function payload #8634

Closed

4 tasks

dblythy mentioned this pull request Jun 19, 2023

refactor: Add option to convert Parse.Object to instance in Cloud Function payload #8646

Merged

4 tasks

parseplatformorg added the state:released Released as stable version label Sep 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Allow `Parse.Object` pointers in Cloud Code arguments #8490

feat: Allow `Parse.Object` pointers in Cloud Code arguments #8490

dblythy commented Mar 30, 2023

parse-github-assistant bot commented Mar 30, 2023

parse-github-assistant bot commented Mar 30, 2023 •

edited

Loading

codecov bot commented Mar 30, 2023 •

edited

Loading

mtrezza left a comment

mtrezza commented May 21, 2023

dblythy commented May 22, 2023

mtrezza commented May 22, 2023 •

edited

Loading

dblythy commented May 25, 2023

mtrezza commented May 25, 2023 •

edited

Loading

dblythy commented May 25, 2023

mtrezza commented May 25, 2023

mtrezza left a comment

parseplatformorg commented May 27, 2023

parseplatformorg commented Jun 10, 2023

parseplatformorg commented Jun 18, 2023

oallouch commented Jun 18, 2023

mtrezza commented Jun 18, 2023 •

edited

Loading

parseplatformorg commented Sep 16, 2023

feat: Allow Parse.Object pointers in Cloud Code arguments #8490

feat: Allow Parse.Object pointers in Cloud Code arguments #8490

Conversation

dblythy commented Mar 30, 2023

Pull Request

Issue

Approach

Tasks

parse-github-assistant bot commented Mar 30, 2023

parse-github-assistant bot commented Mar 30, 2023 • edited Loading

Thanks for opening this pull request!

codecov bot commented Mar 30, 2023 • edited Loading

Codecov Report

mtrezza left a comment

Choose a reason for hiding this comment

mtrezza commented May 21, 2023

dblythy commented May 22, 2023

mtrezza commented May 22, 2023 • edited Loading

dblythy commented May 25, 2023

mtrezza commented May 25, 2023 • edited Loading

dblythy commented May 25, 2023

mtrezza commented May 25, 2023

mtrezza left a comment

Choose a reason for hiding this comment

parseplatformorg commented May 27, 2023

parseplatformorg commented Jun 10, 2023

parseplatformorg commented Jun 18, 2023

oallouch commented Jun 18, 2023

mtrezza commented Jun 18, 2023 • edited Loading

parseplatformorg commented Sep 16, 2023

feat: Allow `Parse.Object` pointers in Cloud Code arguments #8490

feat: Allow `Parse.Object` pointers in Cloud Code arguments #8490

parse-github-assistant bot commented Mar 30, 2023 •

edited

Loading

codecov bot commented Mar 30, 2023 •

edited

Loading

mtrezza commented May 22, 2023 •

edited

Loading

mtrezza commented May 25, 2023 •

edited

Loading

mtrezza commented Jun 18, 2023 •

edited

Loading