IQSS / IQSS/dataverse-frontend

Improve debugging of the local dev environment to detect errors in containers startup and ensure proper bootstrapping

Open
#178 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Containers
Dominant language
TypeScript
Stars
31
Forks
26
Avg merge
4d 13h
Merged PRs (30d)
4

Description

Overview of the Feature Request

We have recently encountered issues in the execution of the development environment. Specifically regarding Solr, since it did not seem to have been configured correctly even though the Dataverse application was accessible.

When creating a dataset, we encountered the following error:

solr_error

Debugging the environment and its dependencies is currently not very accessible, since the run-env script executes the containers in detached mode and the container logs do not appear in the console.

It would also be good to improve in some way (This can potentially affect images and go out of frontend scope) the Dataverse health check to make sure that not only the application is healthy, but also its dependencies (Solr, Postgres, etc.). This way configbaker would finish when all containers are properly initialized (application + dependencies).

What inspired the request?

  • Recent issues reported about the dev-env environment

What existing behavior do you want changed?

  • Development environment

Any brand new behavior do you want to add to Dataverse?

N/A

Any open or closed issues related to this feature request?

Contributor guide

Open the contributing guide

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.

Research direction

Start by reading and running the run-env script to understand how containers are launched and why their logs are hidden. Trace how configbaker determines readiness, including the Dataverse application and dependencies such as Solr and Postgres. Done means startup failures are visible and bootstrapping waits until the required services are healthy.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgres, typescript
Domain
databases, devops, infrastructure
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.