Refactor metaToJsonProperty to accept AJV keywords

[iqbaldjulfri]

We need to add additional attributes (AJV keywords) from PropertyDefinition so they will be written to openapi.json and we can use it as validation. Currently, only type, description, items (for arrays), and $ref are written (and a hard-coded format: 'date-time' for Date instances).

issue #2684

See also #1624

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

• npm test passes on your machine
• New tests added or existing tests modified to cover all changes
• Code conforms with the style guide
• API Documentation in code was updated
• Documentation in /docs/site was updated
• Affected artifact templates in packages/cli were updated
• Affected example projects in examples/* were updated

[jannyHou]

@iqbaldjulfri Thank you for creating PR to preserve the property metadata in the JSON schema!

I left a comment regarding the blacklist of properties get removed. Please take a look thanks.

[raymondfeng]

@iqbaldjulfri Please fix the CI failures per instructions at https://loopback.io/doc/en/lb4/submitting_a_pr.html.

[iqbaldjulfri]

@raymondfeng All CI errors fixed, I need to force push to change the earlier commit message.

[bajtos]

Thank you @iqbaldjulfri for the pull request. Please read the discussion in #1624 and #1872 to learn about the wider context of property validations.

TL;DR summary: validation rules that are implemented at JSON/OpenAPI level and not enforced at ORM/database level should be nested under a new property jsonSchema. Cross-posting from #1624 (comment):

{
  type: string,
  minLength: 10,
  // the LDL extension: jsonSchema
  jsonSchema: {
    // JSON-Schema constraints follow
    format: 'email'
  }
}

[iqbaldjulfri]

@bajtos thank you for the insight on the bigger picture of this problem. I've refactored the code to use jsonSchema as you suggested. With this we can leverage ajv validations in the OpenAPI layer.

[bajtos]

Lovely, I find the new code much simpler and more elegant ❤️

Please address my comment below and squash all commits into a single one, using a descriptive commit message - see https://loopback.io/doc/en/contrib/code-contrib-lb4.html#commit-message-guidelines.

In case you are not familiar with git history manipulation, you can learn the git commands here: https://loopback.io/doc/en/lb4/submitting_a_pr.html#6-rebasing

[bajtos]

This statement is way too long to my taste, it also combines two parts of a test (act + assert) into a single line, which can make the test more difficult to understand. Let's split this into two statements please.

const schema = metaToJsonProperty({
  // ...
});

expect(schema).to.eql({
  // ...
});

[jannyHou]

👍 The solution that adds a nested property jsonSchema LGTM

[iqbaldjulfri]

@bajtos, all done. I've implemented your suggestion for the unit test and squashed them into a single commit.

PS: Thank you guys for everything. This is my very first contribution to open source project and I'm very grateful to have you guiding a newcomer like me. Cheers!

[bajtos]

Landed. 🎉 Thank you @iqbaldjulfri for the contribution! ❤️

Thank you guys for everything. This is my very first contribution to open source project and I'm very grateful to have you guiding a newcomer like me.

You are very welcome 😄