feat: add `Parse.Cloud.afterFind(Parse.File)` #7927

dblythy · 2022-04-06T08:32:10Z

New Pull Request Checklist

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

Issue Description

Currently, there are no triggers for file gets.

Approach

Adds preferred syntax Parse.Cloud.beforeSave(Parse.File)

The file triggers were made to have their own function names, which adds unnecessary complexity. This allows for Parse.Cloud.beforeSave(Parse.File), Parse.Cloud.afterSave(Parse.File), Parse.Cloud.beforeDelete(Parse.File), Parse.Cloud.afterDelete(Parse.File). In a future version, the current file triggers should be deleted.

Adds Parse.Cloud.beforeCreate(Parse.File)

This can only be used on Parse.File for the meantime, but in the future could be added to detect class creation. This triggers when a file is expanded, allowing mutation of the file url.

Adds Parse.Cloud.beforeFind

This allows a file trigger on the get request of a file. req.download can be set as well to allow file downloads.

TODOs before merging

Add tests
Add changes to documentation (guides, repository pages, in-code descriptions)
A changelog entry is created automatically using the pull request title (do not manually add a changelog entry)

…-community#7839)

## [5.2.1-alpha.1](parse-community/parse-server@5.2.0...5.2.1-alpha.1) (2022-03-26) ### Bug Fixes * return correct response when revert is used in beforeSave ([parse-community#7839](parse-community#7839)) ([f63fb2b](parse-community@f63fb2b))

… Cloud Function validation (parse-community#7892)

## [5.2.1-alpha.2](parse-community/parse-server@5.2.1-alpha.1...5.2.1-alpha.2) (2022-03-26) ### Performance Improvements * reduce database operations when using the constant parameter in Cloud Function validation ([parse-community#7892](parse-community#7892)) ([48bd512](parse-community@48bd512))

# [5.3.0-alpha.1](parse-community/parse-server@5.2.1-alpha.2...5.3.0-alpha.1) (2022-03-27) ### Features * add MongoDB 5.1 compatibility ([parse-community#7682](parse-community#7682)) ([90155cf](parse-community@90155cf))

…ommunity#7893)

# [5.3.0-alpha.2](parse-community/parse-server@5.3.0-alpha.1...5.3.0-alpha.2) (2022-03-27) ### Bug Fixes * security upgrade parse push adapter from 4.1.0 to 4.1.2 ([parse-community#7893](parse-community#7893)) ([ef56e98](parse-community@ef56e98))

# [5.3.0-alpha.3](parse-community/parse-server@5.3.0-alpha.2...5.3.0-alpha.3) (2022-03-27) ### Features * add MongoDB 5.2 support ([parse-community#7894](parse-community#7894)) ([6b4b358](parse-community@6b4b358))

…community#7911)

# [5.3.0-alpha.4](parse-community/parse-server@5.3.0-alpha.3...5.3.0-alpha.4) (2022-04-04) ### Bug Fixes * custom database options are not passed to MongoDB GridFS ([parse-community#7911](parse-community#7911)) ([a72b384](parse-community@a72b384))

parse-github-assistant · 2022-04-06T08:32:19Z

Thanks for opening this pull request!

🎉 We are excited about your hands-on contribution!

dblythy · 2022-04-06T08:34:34Z

This is still a bit of a proof of concept at this stage, more tests will need to be added prior to merge

mtrezza · 2022-04-07T10:21:46Z

DEPRECATIONS.md

@@ -8,6 +8,7 @@ The following is a list of deprecations, according to the [Deprecation Policy](h
 | DEPPS2 | Config option `directAccess` defaults to `true` | [#6636](https://github.com/parse-community/parse-server/pull/6636)   | 5.0.0 (2022)                    | 6.0.0 (2023)                    | deprecated            | -     |
 | DEPPS3 | Config option `enforcePrivateUsers` defaults to `true` | [#7319](https://github.com/parse-community/parse-server/pull/7319)   | 5.0.0 (2022)                    | 6.0.0 (2023)                    | deprecated            | -     |
 | DEPPS4 | Remove convenience method for http request `Parse.Cloud.httpRequest` | [#7589](https://github.com/parse-community/parse-server/pull/7589)   | 5.0.0 (2022)                    | 6.0.0 (2023)                    | deprecated            | -     |
+| DEPPS5 | Remove file triggers in preference of normal `Parse.Cloud` syntax `Parse.Cloud.beforeDelete(Parse.File` | [#7927](https://github.com/parse-community/parse-server/pull/7927)   |6.0.0 (2022)                    | 6.0.0 (2023)                    | deprecated            | -     |


The deprecation would happen in 6.0 (2023), removal in 7.0 (2024).

Typo, missing closing bracket.

Yes, as to my other PRs i'm not sure how to fill this table. How can an item's status be "Deprecated" if its planned Deprecation is Version 6?

mtrezza · 2022-04-07T10:26:15Z

This can only be used on Parse.File for the meantime, but in the future could be added to detect class creation.

I'd say the equivalent of Parse.File creation would be a Parse.Object creation, not a class creation. I can already imagine some use cases for that.

dblythy · 2022-04-07T13:19:10Z

I'd say the equivalent of Parse.File creation would be a Parse.Object creation

Well I think a Parse.Object creation can be covered by wild class beforeSave triggers. In any case, it's out of scope of this PR. I personally think how the other beforeCreate triggers are implemented should be up for its own discussion.

mtrezza · 2022-04-07T16:09:39Z

The naming discussion is part of this PR because you are introducing a new trigger type. We want to find a name that is universal enough to be applicable to classes in the future. So let's think a few steps ahead...

In my understanding, beforeCreate is different from a beforeSave, just as creating/instantiating an object is different from saving it.

We may also soon have an internal File class as was discussed related to a few features. The beforeCreate trigger won't be triggered when the File class is created, nor when a File object is saved. A developer would expect the same behavior when the trigger is applied to other classes.

Maybe we should remove / rephrase the assumption that the will be related to class creation from the PR description to not confuse future readers about this?

dblythy · 2022-04-07T16:30:19Z

Maybe the discussion for a beforeCreate trigger should happen elsewhere. I think it’s relevant to our discussions to have a trigger to mutate the file url. The name of that trigger might be better off with something else if you feel beforeCreate doesn’t represent its functions.

mtrezza · 2022-04-09T19:47:14Z

if you feel beforeCreate doesn’t represent its functions

The question is what would be "its function" when used with classes? I think beforeCreate is fine assuming that it can be used with classes for when an object is created, not for when a class is created. To know whether the new trigger name is well chosen in the sense that it can be repurposed for classes, we need to think ahead about what it could do when used with classes.

…#7921)

)

# [5.3.0-alpha.5](parse-community/parse-server@5.3.0-alpha.4...5.3.0-alpha.5) (2022-04-09) ### Bug Fixes * security upgrade moment from 2.29.1 to 2.29.2 ([parse-community#7931](parse-community#7931)) ([6b68593](parse-community@6b68593))

…ty#7934)

# [5.3.0-alpha.6](parse-community/parse-server@5.3.0-alpha.5...5.3.0-alpha.6) (2022-04-11) ### Bug Fixes * peer dependency mismatch for GraphQL dependencies ([parse-community#7934](parse-community#7934)) ([b7a1d76](parse-community@b7a1d76))

…munity#7932)

dblythy · 2022-05-02T02:56:56Z

Closing - will reopen later

dblythy · 2022-05-25T21:52:55Z

So you think beforeCreate should effectively be a beforeSave trigger but for !object.existed()? How would that affect the existing beforeSave trigger?

I also closed this and created #7966 to split it into smaller PRs. I will create a PR relating to this feature.

mtrezza · 2022-05-26T04:57:46Z

I would use beforeCreate to trigger when a Parse.Object instantiates.

new Parse.Object() -> beforeCreate, for example to set default properties of an object
Parse.Object.save() -> beforeSave, afterSave

You wrote:

This triggers when a file is expanded, allowing mutation of the file url.

What did you mean by "expanded"? What issue were you intending to solve with the beforeCreate(Parse.File) trigger?

mtrezza and others added 19 commits March 25, 2022 19:47

ci: fix node engine check (parse-community#7891)

9ef1968

fix: return correct response when revert is used in beforeSave (parse…

f63fb2b

…-community#7839)

perf: reduce database operations when using the constant parameter in…

48bd512

… Cloud Function validation (parse-community#7892)

feat: add MongoDB 5.1 compatibility (parse-community#7682)

90155cf

chore(release): 5.3.0-alpha.1 [skip ci]

499cead

# [5.3.0-alpha.1](parse-community/parse-server@5.2.1-alpha.2...5.3.0-alpha.1) (2022-03-27) ### Features * add MongoDB 5.1 compatibility ([parse-community#7682](parse-community#7682)) ([90155cf](parse-community@90155cf))

fix: security upgrade parse push adapter from 4.1.0 to 4.1.2 (parse-c…

ef56e98

…ommunity#7893)

feat: add MongoDB 5.2 support (parse-community#7894)

6b4b358

chore(release): 5.3.0-alpha.3 [skip ci]

75eca2d

# [5.3.0-alpha.3](parse-community/parse-server@5.3.0-alpha.2...5.3.0-alpha.3) (2022-03-27) ### Features * add MongoDB 5.2 support ([parse-community#7894](parse-community#7894)) ([6b4b358](parse-community@6b4b358))

refactor: upgrade mongodb from 4.3.1 to 4.4.1 (parse-community#7906)

132a3e0

ci: bump environment (parse-community#7907)

d74b6a3

refactor: add missing schema definitions (parse-community#7917)

2b0957c

fix: custom database options are not passed to MongoDB GridFS (parse-…

a72b384

…community#7911)

feat: add Parse.Cloud.afterFind(Parse.File)

2e79271

Update CloudCode.spec.js

7e6a945

Update Parse.Cloud.js

4b99c00

Update DEPRECATIONS.md

da78cf3

mtrezza requested changes Apr 7, 2022

View reviewed changes

snyk-bot and others added 2 commits April 9, 2022 22:00

refactor: upgrade @apollo/client from 3.5.8 to 3.5.9 (parse-community…

ef3680a

…#7921)

fix: security upgrade moment from 2.29.1 to 2.29.2 (parse-community#7931

6b68593

)

semantic-release-bot and others added 5 commits April 9, 2022 20:44

chore(release): 5.3.0-alpha.5 [skip ci]

e88fb72

# [5.3.0-alpha.5](parse-community/parse-server@5.3.0-alpha.4...5.3.0-alpha.5) (2022-04-09) ### Bug Fixes * security upgrade moment from 2.29.1 to 2.29.2 ([parse-community#7931](parse-community#7931)) ([6b68593](parse-community@6b68593))

fix: peer dependency mismatch for GraphQL dependencies (parse-communi…

b7a1d76

…ty#7934)

chore(release): 5.3.0-alpha.6 [skip ci]

34b8110

# [5.3.0-alpha.6](parse-community/parse-server@5.3.0-alpha.5...5.3.0-alpha.6) (2022-04-11) ### Bug Fixes * peer dependency mismatch for GraphQL dependencies ([parse-community#7934](parse-community#7934)) ([b7a1d76](parse-community@b7a1d76))

refactor: upgrade @graphql-tools/links from 8.2.2 to 8.2.4 (parse-com…

43ad5b3

…munity#7932)

Merge branch 'alpha' into file-triggers

d65a3bf

mtrezza force-pushed the alpha branch 2 times, most recently from 59215e6 to e6d7d8f Compare May 1, 2022 02:29

dblythy closed this May 2, 2022

mtrezza mentioned this pull request Oct 24, 2022

Restrict file download #8241

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `Parse.Cloud.afterFind(Parse.File)` #7927

feat: add `Parse.Cloud.afterFind(Parse.File)` #7927

dblythy commented Apr 6, 2022 •

edited

Loading

parse-github-assistant bot commented Apr 6, 2022 •

edited

Loading

dblythy commented Apr 6, 2022

mtrezza Apr 7, 2022 •

edited

Loading

dblythy Apr 7, 2022

mtrezza commented Apr 7, 2022 •

edited

Loading

dblythy commented Apr 7, 2022

mtrezza commented Apr 7, 2022 •

edited

Loading

dblythy commented Apr 7, 2022 •

edited

Loading

mtrezza commented Apr 9, 2022 •

edited

Loading

dblythy commented May 2, 2022

dblythy commented May 25, 2022 •

edited

Loading

mtrezza commented May 26, 2022 •

edited

Loading

feat: add Parse.Cloud.afterFind(Parse.File) #7927

feat: add Parse.Cloud.afterFind(Parse.File) #7927

Conversation

dblythy commented Apr 6, 2022 • edited Loading

New Pull Request Checklist

Issue Description

Approach

TODOs before merging

parse-github-assistant bot commented Apr 6, 2022 • edited Loading

Thanks for opening this pull request!

dblythy commented Apr 6, 2022

mtrezza Apr 7, 2022 • edited Loading

Choose a reason for hiding this comment

dblythy Apr 7, 2022

Choose a reason for hiding this comment

mtrezza commented Apr 7, 2022 • edited Loading

dblythy commented Apr 7, 2022

mtrezza commented Apr 7, 2022 • edited Loading

dblythy commented Apr 7, 2022 • edited Loading

mtrezza commented Apr 9, 2022 • edited Loading

dblythy commented May 2, 2022

dblythy commented May 25, 2022 • edited Loading

mtrezza commented May 26, 2022 • edited Loading

feat: add `Parse.Cloud.afterFind(Parse.File)` #7927

feat: add `Parse.Cloud.afterFind(Parse.File)` #7927

dblythy commented Apr 6, 2022 •

edited

Loading

parse-github-assistant bot commented Apr 6, 2022 •

edited

Loading

mtrezza Apr 7, 2022 •

edited

Loading

mtrezza commented Apr 7, 2022 •

edited

Loading

mtrezza commented Apr 7, 2022 •

edited

Loading

dblythy commented Apr 7, 2022 •

edited

Loading

mtrezza commented Apr 9, 2022 •

edited

Loading

dblythy commented May 25, 2022 •

edited

Loading

mtrezza commented May 26, 2022 •

edited

Loading