luckyframework/lucky_cli

Log section for test on generated apps isn't very useful

Open

#863 opened on May 3, 2024

View on GitHub
 (0 comments) (1 reaction) (0 assignees)HTML (49 forks)auto 404
hacktoberfest

Repository metrics

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

Description

When you generate a new app, you get this section in your config/log.cr file

https://github.com/luckyframework/lucky_cli/blob/8344b2749c8cadc560312a4cfc6499275815377c/src/web_app_skeleton/config/log.cr.ecr#L3-L11

This used to be very helpful because back in the day when specs would run, you had a full HTTP server that booted, and you could tail this file to watch the logs and see what was going on. However, that's not the case anymore because booting an HTTP server on spec run is expensive and slow.

This leads to an issue where you run your specs, and you get a 500 error in an action, and tailing this log just looks like this

image

We need to figure out how we can rework this so your queries and errors and everything can go to this file and not STDOUT to the terminal. You should be able to tail this file while running specs and get good information as to what queries your spec is running and what exceptions or errors you're hitting.

Contributor guide

Research direction
Investigate the current logging setup in config/log.cr.ecr, understand how to configure the Logger in Crystal to write to a file instead of STDOUT, and ensure that queries and errors are captured during spec runs. Consider using a different logging backend or adding a spec helper to redirect logs.
Tech stack
None
Domain
backend
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.
1-3 hours
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
CrystalGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75