status-im/nim-taskpools

Spurious warning: cannot raise 'AssertionDefect' [XCannotRaiseY]

Open

#27 opened on Jan 3, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Nim (6 forks)auto 404
good first issue

Repository metrics

Stars
 (121 stars)
PR merge metrics
 (PR metrics pending)

Description

See: https://forum.nim-lang.org/t/9774

https://github.com/status-im/nim-taskpools/blob/89d693d3ffc9e53aa470a9a05166e4f2b58d282a/taskpools/channels_spsc_single.nim#L34

The precondition can in fact raise AssertionDefect https://github.com/status-im/nim-taskpools/blob/89d693d/taskpools/instrumentation/contracts.nim#L91 unless when code is compiled without assertions (danger for example).

An easy fix would be to push that hint off

Contributor guide

Research direction
Inspect the precondition in contracts.nim and the warning in channels spsc single.nim. Consider suppressing the warning with a pragma or adjusting the code to avoid the raise.
Tech stack
None
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Nim
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80