Rule description and descriptionHtml are incorrectly assertNonNull().

Open Beginner friendly
#260 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
api, backend

Research direction

Start at the Rule class constructor and trace the subreddit.getRules() entry point, focusing on the shown assertions for description and descriptionHtml. Reproduce the case with a subreddit rule lacking descriptions and confirm that getRules() succeeds while other required rule fields remain validated.

Written by the indexing model from the issue text.

Description

In old Reddit it is possible to create rules without descriptions. However, the Rule class constructor asserts description and descriptionHtml as non-null. This causes calls to subreddit.getRules() to fail for subreddits with rules lacking descriptions.

        assertNonNull(shortName, 'Subreddit rule is missing shortName');
        assertNonNull(description, 'Subreddit rule is missing description');
        assertNonNull(priority, 'Subreddit rule is missing priority');
        assertNonNull(createdUtc, 'Subreddit rule is missing createdUtc');
        assertNonNull(descriptionHtml, 'Subreddit rule is missing descriptionHtml');
Dominant language
TypeScript
Stars
210
Forks
88
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from reddit/devvit

All issues in reddit/devvit

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.