fix: Handle missing decorator for model

tachyonicbytes commented 1 year ago

What type of PR is this? (check all applicable)

[ ] Refactor
[ ] Feature
[x] Bug Fix
[ ] Optimization
[ ] Documentation Update

Description

Solves #343. Return a more descriptive error message when the @TigrisSearchIndex decorator is not set.

Related Tickets & Documents

Related Issue #343
Closes #343

Added/updated tests?

[x] Yes
[ ] No, and this is why: please replace this line with details on why tests have not been included
[ ] I need help with writing tests

Is this change backwards compatible?

[x] Yes
[ ] No, and this is why: please replace this line with details on why?

Does it require updates to Tigris docs?

[ ] Yes, and here is the link: please create an issue in tigris-docs repo and replace this text as tigrisdata/tigris-docs#123
[x] No

Checklist

[x] npm run build - builds successfully
[x] npm run test - tests passing
[x] npm run lint - no lint errors

[optional] Are there any post deployment tasks we need to perform?

/claim #343

reviewpad[bot] commented 1 year ago

Thank you @tachyonicbytes for this first contribution!

reviewpad[bot] commented 1 year ago

Reviewpad Report

:bangbang: Errors

Unconventional commit detected: '#343 Handle missing decorator for model' (9a8b5a3f3f6d1cf9d6617eb03e92166cc249678a)

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.02 :tada:

Comparison is base (9d845b4) 90.24% compared to head (9a8b5a3) 90.26%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #364 +/- ## ========================================== + Coverage 90.24% 90.26% +0.02% ========================================== Files 29 29 Lines 5595 5608 +13 Branches 657 661 +4 ========================================== + Hits 5049 5062 +13 Misses 545 545 Partials 1 1 ``` | [Impacted Files](https://app.codecov.io/gh/tigrisdata/tigris-client-ts/pull/364?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tigrisdata) | Coverage Δ | | |---|---|---| | [src/schema/decorated-schema-processor.ts](https://app.codecov.io/gh/tigrisdata/tigris-client-ts/pull/364?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tigrisdata#diff-c3JjL3NjaGVtYS9kZWNvcmF0ZWQtc2NoZW1hLXByb2Nlc3Nvci50cw==) | `100.00% <100.00%> (ø)` | | | [src/search/search.ts](https://app.codecov.io/gh/tigrisdata/tigris-client-ts/pull/364?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tigrisdata#diff-c3JjL3NlYXJjaC9zZWFyY2gudHM=) | `97.79% <100.00%> (+0.17%)` | :arrow_up: |

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