Picolab/pico-engine

Possible improvement of an error message when ruleset doesn't have/share a query function

Open

#606 opened on Jun 3, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (10 forks)auto 404
UIbuggood first issue

Repository metrics

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

Description

When a sky query link is to a function which is not shared by a ruleset, the error message looks like:

{"error":"Error: Ruleset com.vcpnews.introspect does not have query function "channels""}

It ought to say "does not share" instead of have, in the case where the ruleset does have the function, but hasn't shared it.

The compiler doesn't allow sharing a function the ruleset doesn't have, so that case is taken care of there.

I'm suggesting two messages: the existing one for the case where the function doesn't exist in the ruleset, and the second one when it exists but isn't shared.

Contributor guide

Research direction
Find where the error message about missing query function is generated. Add a check to determine if the function exists but is not shared, then use a different error message accordingly.
Tech stack
typescript
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80