Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SchemaOptions definition not properly added #7805

Closed
4 tasks done
mtrezza opened this issue Feb 12, 2022 · 9 comments · Fixed by #7917
Closed
4 tasks done

SchemaOptions definition not properly added #7805

mtrezza opened this issue Feb 12, 2022 · 9 comments · Fixed by #7917
Labels
type:docs Only change in the docs or README

Comments

@mtrezza
Copy link
Member

mtrezza commented Feb 12, 2022

New Issue Checklist

Issue Description

The Parse Server options SchemaOptions which were added in #7418 were not properly added to the definition file.

The SchemaOptions are defined in /src/Options/Definitions.js, but when re-building the options with npm run definitions, the options are removed.

Steps to reproduce

  1. Run npm run definitions

Actual Outcome

Schema options are removed from /src/Options/Definitions.js.

Expected Outcome

Schema options should be properly re-built.

Environment

Server

  • Parse Server version: 5.0.0-alpha.24
@parse-github-assistant
Copy link

parse-github-assistant bot commented Feb 12, 2022

Thanks for opening this issue!

  • 🚀 You can help us to fix this issue faster by opening a pull request with a failing test. See our Contribution Guide for how to make a pull request, or read our New Contributor's Guide if this is your first time contributing.

@mtrezza mtrezza added the type:ci CI related issue label Feb 12, 2022
@mtrezza mtrezza pinned this issue Feb 12, 2022
@mtrezza
Copy link
Member Author

mtrezza commented Feb 12, 2022

@sadortun @Moumouls could you take a look?

@mtrezza mtrezza unpinned this issue Feb 12, 2022
@mtrezza mtrezza changed the title Schema server option definition not properly added SchemaOptions definition not properly added Feb 12, 2022
@mtrezza mtrezza added type:docs Only change in the docs or README and removed type:ci CI related issue labels Mar 18, 2022
@dblythy
Copy link
Member

dblythy commented Mar 19, 2022

What do you think about having npm run definitions ran / checked by the CI?

@mtrezza
Copy link
Member Author

mtrezza commented Mar 19, 2022

What do you mean by "checked by the CI"?

@dblythy
Copy link
Member

dblythy commented Mar 19, 2022

Well I’m assuming here that a contributor thought that they had to manually edit the Definitions.js file (even though it says “ Do not manually), instead of adding to index.js. I think it would be good to possibly have a CI check to make sure npm run definitions matches the committed Definitions.js file, so we can be sure no manual editing has been applied.

@mtrezza
Copy link
Member Author

mtrezza commented Mar 19, 2022

Got it, I think we could simply generate the definitions file again and compare the result with what's been committed. Or do you have a different idea?

@Moumouls
Copy link
Member

Moumouls commented Apr 3, 2022

The source of the problem is simply related to the fact that the definitions were added manually to the auto-generated file

@mtrezza
Copy link
Member Author

mtrezza commented Apr 3, 2022

Thanks for fixing this, the discussion was about how to prevent that in the future. Generating the definitions file and comparing it to the current definitions seems an easy check for the CI. I opened #7918 so we close this issue with your fix.

@mtrezza mtrezza linked a pull request Apr 3, 2022 that will close this issue
3 tasks
@mtrezza
Copy link
Member Author

mtrezza commented Apr 3, 2022

Closed via #7917

@mtrezza mtrezza closed this as completed Apr 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs Only change in the docs or README
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants