Add Endpoints to view and edit Cloud Functions in dashboard #6983

dblythy · 2020-11-01T16:41:35Z

This PR closes the oldest issue here #895, and allows developers to see their cloud endpoints in the dashboard. Also related to 81, 532, #6752.

A small update to the Dashboard will be required.

This also attempts to find dependancies from the entry point, so that configurations with one cloud file that imports other files via require(), still show in the dashboard.

In my config, my main entry point is main2.js, with the content:

require('./functions/_User.js');
require('./functions/2FA.js');
require("./functions/Admin.js");

Here's how that looks in the dashboard with the PR:

And clicking on each of those links opens the file as:

Let me know what you think!

codecov · 2020-11-01T16:48:49Z

Codecov Report

Merging #6983 (1db9c75) into master (08b2ea4) will decrease coverage by 0.00%.
The diff coverage is 94.54%.

@@            Coverage Diff             @@
##           master    #6983      +/-   ##
==========================================
- Coverage   93.93%   93.92%   -0.01%     
==========================================
  Files         169      169              
  Lines       12547    12602      +55     
==========================================
+ Hits        11786    11837      +51     
- Misses        761      765       +4

Impacted Files	Coverage Δ
src/Options/index.js	`100.00% <ø> (ø)`
src/Routers/FeaturesRouter.js	`100.00% <ø> (ø)`
src/Routers/CloudCodeRouter.js	`96.59% <94.44%> (-3.41%)`	⬇️
src/Options/Definitions.js	`100.00% <100.00%> (ø)`
src/Adapters/Files/GridFSBucketAdapter.js	`79.50% <0.00%> (-0.82%)`	⬇️

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 08b2ea4...1db9c75. Read the comment docs.

mtrezza · 2020-11-01T16:58:25Z

This is another great feature addition.

Considering that this feature is rather extensive and involves multiple PRs / repos, could you please open an issue in which we can have a meta discussion about the approach? The benefit of meta discussions in issues rather than PRs is they usually enjoy better visibility which leads to a more engaged discussion, especially when members of existing threads are re-engaged. Alternatively, you could pick up an existing issue thread which seems most recent / appropriate.

Even though we have the luxury that you already provided the complete PR (👏), a proper meta discussion provides a structured approach to introduce and evaluate this feature.

dblythy · 2020-11-01T17:05:33Z

Considering that this feature involves multiple PRs / repos, could you please open an issue in which we can have a meta discussion about the approach?

No worries. I can do that. Would you rather a new issue or continue the discussion of the existing issue? Sorry for diving into these PRs without discussing first. It pains my OCD to see 86 open issues with many being "up for grabs" for 4+ years.

mtrezza · 2020-11-01T17:19:31Z

Would you rather a new issue or continue the discussion of the existing issue?

Maybe you want to use the existing issue #895 as it already references related issues and doesn't already have a long discussion that for example goes about a completely different approach.

It pains my OCD to see 86 open issues with many being "up for grabs" for 4+ years.

I can assure you that your recent PRs and feature introductions are very appreciated by the community. Practically, it is most important that there is an actual PR to discuss, which you even provide as the first step, so your ambitious approach is much appreciated. 🙂

dblythy · 2020-11-02T03:27:08Z

I have also added another endpoint that allows writing cloud files, which I think is pretty cool.

The inbuilt code editor in the dashboard decent, so I thought why not utilise it.

Although I'm pretty sure editing cloud files will still require a restart of the server? Maybe we could look at building that in.

I'm also not a react or web developer so UI might need some work.

Moumouls

It seems that the implementation do not support multi parse server deployment, so this can result in huge inconsistency issue in prod environment ? Otherwise in local dev env the implementation looks good.

May be the way to support multi parse server deployment is to save a string version of the cloud function and then perform an equality check. Then before running the cloud function we need to perform a request to ensure that the latest version is loaded.

src/Routers/CloudCodeRouter.js

dblythy · 2020-12-15T17:17:49Z

Good point and thanks for the review @Moumouls. I’m not sure how this handles multiple servers to be honest, most of the related code was already there, I just made the endpoints available. I’ll have a look at multi-server.

A problem with the editing feature is also that the server will need to restart for changes to take affect.

Moumouls · 2020-12-15T17:39:46Z

@dblythy i just pass this PR to draft since it needs some adjustments before getting everything working perfectly !

For restart may be you can try something like listed here: nodejs/help#923

ghost · 2021-02-04T07:47:14Z

Danger run resulted in 1 warning; to find out more, see the checks page.

Generated by 🚫 dangerJS

dblythy · 2021-02-04T07:56:38Z

@Moumouls I have added the following server parameters:

dashboardOptions: {
        cloudFileView: true, // fine to use on multi-instance
        cloudFileEdit: true, // local / single instance only
}

If this approach is ok, I will update the dashboard PR so that it only allows editing if cloudFileEdit is true.

dblythy · 2021-03-03T03:46:16Z

@mtrezza do we have any appetite for having this for the next Parse Server version (even if we strip out cloudFileEdit for now?). It would be good to be able to work it in with a dashboard release too.

mtrezza · 2021-03-03T11:12:20Z

Sure! I'm all for it, the sooner features are released, the sooner we get feedback for them.

kaanselhep · 2021-05-10T05:39:59Z

Looks like the 2 warnings that appear are for writing tests for the lines such as:
throw new Parse.Error(Parse.Error.INTERNAL_SERVER_ERROR, 'No data to save.');

DiegoBM · 2021-05-18T22:15:07Z

When should we expect this to be merged on the main branch, if there is any ETA?

dblythy · 2021-05-19T02:13:41Z

When should we expect this to be merged on the main branch, if there is any ETA?

It's up to the core team 😊

Moumouls · 2021-05-19T07:47:54Z

@dblythy here just about the multi server support, did you add some code or some warning somewhere on the dashboard. A new developer could not understand why his app in node cluster could fall into inconsistent state (outdated code on other instances).

Also here we need an another warning/block API if parse is used into a docker image (if i remember with process.env we can detect if parse run into a Docker container), why ? because if the container is restarted and the container do not have some volume mapped ALL MODIFICATIONS will be LOST.

May be you can add some documentation about limitations on the config js, then some automatic JS doc will be generated 👍

This is a nice feature (low code developers will love it) but we need to ensure that a developer know risks about using it.

(sorry for my late comment 🙂 )

mtrezza · 2021-05-19T11:20:08Z

When should we expect this to be merged on the main branch, if there is any ETA?

It's up to the core team 😊

@dblythy From that I assume the PR is ready for review. I have added some conceptual notes to the high level discussion that we should look into. The conclusions there may require adjustments in this PR or even make the feature itself obsolete.

Anyone who is waiting for this feature to become available, please feel free to join the discussion in #895. It would be interesting to hear why this feature is even desired over using the usual IDE toolset.

dblythy · 2021-05-27T13:55:27Z

After a discussion between @mtrezza and I, we have agreed that cloud file viewing and editing isn't necessary with Parse Server, and encourages bad practices. Here's why:

Before with parse.com, the only way you could manage your Parse Cloud was through Parse.com's dashboard. However, as you need to run a clone of the Parse Server Example repo to use Parse Server, having the cloud file editing via the dashboard is reinventing the wheel. We want users to become familiar with industry standard IDE's, and we'd never be able to keep the dashboard's IDE to the same standard. Plus, editing cloud code on a live server without running CI checks isn't good practices.

If you have comments or suggestions for why you'd want this feature, please comment at #895. If you need any tips as to how to set up a CI/CD pipeline, please join the discussion.

Moumouls · 2021-05-27T14:37:00Z

yes @dblythy this feature was a little bit touchy, and also could push some developers in wrong direction, since this feature could sugges to bypass a standard CI/CD development pattern.

From the beginning, i was not really comfortable with the cloud edition approach.

From my side i would like to say sorry may be for your precious time wasted here. I should have expressed my reservations earlier.

mtrezza · 2021-05-27T15:36:21Z

From my side i would like to say sorry may be for your precious time wasted here.

As general note, I would just like to highlight this as another example why high-level discussions in issues (rather than mixed-level discussions in PRs) are the way to go. Especially when a feature has already been developed and it seems straightforward to just submit a PR, it is in the contributors own interests to initiate a high-level discussion to receive feedback about general viability - separately from the low-level feedback about a specific implementation in a PR. This is already reflected in the PR template, but we could make sure to explicitly mention this in our contribution guide.

DiegoBM · 2021-06-02T20:12:50Z

May I ask what will be the purpose of the functions panel in the future then? Or is it meant to be removed?

Could anyone please describe what would be the ideal flow/process to deploy functions to Parse? Or point to a link where that is explained? Some sort of tutorial would come handy. Thank you in advance

mtrezza · 2021-06-02T22:10:45Z

May I ask what will be the purpose of the functions panel in the future then? Or is it meant to be removed?

I don't think there is a "Functions" panel currently visible in the dashboard. The dashboard code still may contain artifacts of previous functionality here and there.

Could anyone please describe what would be the ideal flow/process to deploy functions to Parse? Or point to a link where that is explained?

"Ideal" depends on what works for you. You can do an online search for "continuous deployment" to find sophisticated examples of efficient code deployment. There is nothing specific about Parse Server when it comes to deployment pipeline. For general help with your deployment pipeline I suggest you ask for help in DevOps SE or the Parse Community Forum.

DanielRub · 2022-03-29T08:55:29Z

I think it should work the same way as AWS lambda functions. :

changes should be taken into account without reloading the server,
Any bug introduced in a cloud function should not affect the overall system. It should only affect the function itself.
Before saving changes, some checks can be applied for the user to get some visibilty on abvious bugs.

Just Trying to put myself in the user shoes.

dblythy added 2 commits November 2, 2020 03:25

Initial Commit

ca7cec8

Update CloudCodeRouter.js

6309d47

dblythy mentioned this pull request Nov 1, 2020

Update getPath on Cloud Code parse-community/parse-dashboard#1613

Closed

dblythy mentioned this pull request Nov 1, 2020

Add endpoints to support Cloud Code viewer in dashboard. #895

Closed

Allow saving cloud files from Dashboard

0ca8e36

dblythy changed the title ~~Add Endpoints to view Cloud Functions in dashboard~~ Add Endpoints to view and edit Cloud Functions in dashboard Nov 2, 2020

Moumouls reviewed Dec 15, 2020

View reviewed changes

src/Routers/CloudCodeRouter.js Show resolved Hide resolved

Moumouls closed this Dec 15, 2020

Moumouls reopened this Dec 15, 2020

Moumouls marked this pull request as draft December 15, 2020 17:39

disable by default

35ae973

dblythy added 2 commits February 4, 2021 18:49

Merge branch 'master' into CloudDashboard

7da6fbc

run definitions

190349e

dblythy marked this pull request as ready for review February 4, 2021 07:55

dblythy added 5 commits February 4, 2021 18:58

Update CloudCodeRouter.js

8c04fe6

Update Definitions.js

ed0322b

Update docs.js

897e81b

Update index.js

d4780cd

Update Definitions.js

1db9c75

dblythy mentioned this pull request Mar 3, 2021

[Snyk] Security upgrade jwks-rsa from 1.12.0 to 1.12.1 #7112

Merged

kaanselhep approved these changes May 10, 2021

View reviewed changes

dblythy closed this May 27, 2021

mtrezza mentioned this pull request May 27, 2021

Default pull request template parse-community/.github#6

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Endpoints to view and edit Cloud Functions in dashboard #6983

Add Endpoints to view and edit Cloud Functions in dashboard #6983

dblythy commented Nov 1, 2020 •

edited

Loading

codecov bot commented Nov 1, 2020 •

edited

Loading

mtrezza commented Nov 1, 2020 •

edited

Loading

dblythy commented Nov 1, 2020

mtrezza commented Nov 1, 2020 •

edited

Loading

dblythy commented Nov 2, 2020 •

edited

Loading

Moumouls left a comment

dblythy commented Dec 15, 2020

Moumouls commented Dec 15, 2020 •

edited

Loading

ghost commented Feb 4, 2021 •

edited by ghost

Loading

dblythy commented Feb 4, 2021

dblythy commented Mar 3, 2021

mtrezza commented Mar 3, 2021 •

edited

Loading

kaanselhep commented May 10, 2021

DiegoBM commented May 18, 2021

dblythy commented May 19, 2021

Moumouls commented May 19, 2021 •

edited

Loading

mtrezza commented May 19, 2021 •

edited

Loading

dblythy commented May 27, 2021 •

edited

Loading

Moumouls commented May 27, 2021

mtrezza commented May 27, 2021 •

edited

Loading

DiegoBM commented Jun 2, 2021 •

edited

Loading

mtrezza commented Jun 2, 2021

DanielRub commented Mar 29, 2022

Add Endpoints to view and edit Cloud Functions in dashboard #6983

Add Endpoints to view and edit Cloud Functions in dashboard #6983

Conversation

dblythy commented Nov 1, 2020 • edited Loading

codecov bot commented Nov 1, 2020 • edited Loading

Codecov Report

mtrezza commented Nov 1, 2020 • edited Loading

dblythy commented Nov 1, 2020

mtrezza commented Nov 1, 2020 • edited Loading

dblythy commented Nov 2, 2020 • edited Loading

Moumouls left a comment

Choose a reason for hiding this comment

dblythy commented Dec 15, 2020

Moumouls commented Dec 15, 2020 • edited Loading

ghost commented Feb 4, 2021 • edited by ghost Loading

dblythy commented Feb 4, 2021

dblythy commented Mar 3, 2021

mtrezza commented Mar 3, 2021 • edited Loading

kaanselhep commented May 10, 2021

DiegoBM commented May 18, 2021

dblythy commented May 19, 2021

Moumouls commented May 19, 2021 • edited Loading

mtrezza commented May 19, 2021 • edited Loading

dblythy commented May 27, 2021 • edited Loading

Moumouls commented May 27, 2021

mtrezza commented May 27, 2021 • edited Loading

DiegoBM commented Jun 2, 2021 • edited Loading

mtrezza commented Jun 2, 2021

DanielRub commented Mar 29, 2022

dblythy commented Nov 1, 2020 •

edited

Loading

codecov bot commented Nov 1, 2020 •

edited

Loading

mtrezza commented Nov 1, 2020 •

edited

Loading

mtrezza commented Nov 1, 2020 •

edited

Loading

dblythy commented Nov 2, 2020 •

edited

Loading

Moumouls commented Dec 15, 2020 •

edited

Loading

ghost commented Feb 4, 2021 •

edited by ghost

Loading

mtrezza commented Mar 3, 2021 •

edited

Loading

Moumouls commented May 19, 2021 •

edited

Loading

mtrezza commented May 19, 2021 •

edited

Loading

dblythy commented May 27, 2021 •

edited

Loading

mtrezza commented May 27, 2021 •

edited

Loading

DiegoBM commented Jun 2, 2021 •

edited

Loading