feat: add local dev setup script #1237

zivkovicmilos · 2023-10-11T15:22:06Z

Description

This PR introduces a bash script and simple Makefile to control local development.
It starts a node instance, along with the appropriate backup / restore processes.

Parent task: #1131

Docker equivalent: #1238

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests
Added new benchmarks to generated graphs, if any. More info here.

moul · 2023-10-11T18:35:27Z

misc/dev/dev.sh

+# - start the backup service for transactions
+(
+  echo "Starting Gno node..."
+  gnoland start


note for later: add the --in-memory if it exists, or create a tempdir?

moul · 2023-10-11T18:37:50Z

misc/dev/dev.sh

+) &
+(
+  # Sleep the restore until the node is fully loaded up
+  sleep $DELAY


Having a fast method to check readiness would be convenient. Today, @gfanton informed me about an event checker created by @thehowl in a pull request. It would be great to have a CLI option to call this.

moul · 2023-10-11T18:38:33Z

misc/dev/dev.sh

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+


note for later: add a --watch option to automatically reload based on FS changes.

moul · 2023-10-11T18:39:32Z

In relation to #1201, we're discussing the possibility of implementing a feature like git <subcommand>. This feature would search for the presence of git-subcommand in the $PATH. The goal is to create a set of helper tools that can be developed in bash, go, or any other suitable language.

zivkovicmilos · 2023-11-01T16:46:27Z

@moul

I've updated this PR to include heavy feedback from @gfanton.
The flow for the script is the following:

run the local node instance, save transactions that occurred into a backup file (that is wiped on every loop)
before the next loop, save the txs from the previous loop (to keep a historical reference)
on node start, feed in the historical transactions to the freshly created node

Please note there are no genesis transactions at play apart from the examples folder that is preloaded on every node directory creation, and the historical transactions that are being "replayed" as genesis transactions

gfanton

lgtm, just a minor comment

misc/loop/Makefile

moul · 2023-11-06T14:43:28Z

misc/loop/tools.go

+
+import (
+	_ "github.com/gnolang/gno/gno.land/cmd/gnoland"
+	_ "github.com/gnolang/tx-archive/cmd"


what's the current status on considering to move tx-archive in this repo?

I am completely fine with moving the archiver to the monorepo, along with our gnolang/faucet.

Do you want me to open a PR that migrates it?

Are there good reasons to keep our repo by itself? We could try keeping the Dockerfile in a different repo and leave the main parts and libraries here.

If we make our 'gno' repo depend on another, and that one also depends on 'gno', it might cause problems with versions not matching up and make it harder to manage when we update things.

I don't think we lose anything by merging it into the monorepo - given that we keep the go.mod of the original repo that we migrate (just to keep imports separate, and not bloat the main gno go.mod), and retain some ability to do releases on this repo, which shouldn't be too tricky

What do you think @ajnavarro @gfanton ?

misc/loop/run_loop.sh

Co-authored-by: Guilhem Fanton <8671905+gfanton@users.noreply.github.com>

## Description This PR introduces a bash script and simple Makefile to control local development. It starts a node instance, along with the appropriate backup / restore processes. Parent task: gnolang#1131 Docker equivalent: gnolang#1238 <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details> --------- Co-authored-by: Guilhem Fanton <8671905+gfanton@users.noreply.github.com>

Add local dev script

ac47301

zivkovicmilos self-assigned this Oct 11, 2023

zivkovicmilos requested a review from moul October 11, 2023 16:35

moul reviewed Oct 11, 2023

View reviewed changes

moul mentioned this pull request Oct 11, 2023

Repo structure and binaries' improvements #1201

Open

zivkovicmilos added 3 commits October 27, 2023 16:36

Merge branch 'master' into feat/add-local-script

d52352c

Merge branch 'master' into feat/add-local-script

6858642

Modify local loop script

fe01215

zivkovicmilos marked this pull request as ready for review November 1, 2023 16:42

zivkovicmilos requested a review from a team as a code owner November 1, 2023 16:42

zivkovicmilos added 2 commits November 1, 2023 12:43

Change module name for loop

f7a86d8

Change makefile recipe name

519db1f

zivkovicmilos requested a review from gfanton November 1, 2023 16:44

zivkovicmilos requested review from moul and ajnavarro November 1, 2023 16:48

gfanton approved these changes Nov 2, 2023

View reviewed changes

misc/loop/Makefile Outdated Show resolved Hide resolved

moul reviewed Nov 6, 2023

View reviewed changes

misc/loop/run_loop.sh Show resolved Hide resolved

moul reviewed Nov 6, 2023

View reviewed changes

misc/loop/run_loop.sh Outdated Show resolved Hide resolved

zivkovicmilos and others added 3 commits November 7, 2023 15:34

Update misc/loop/Makefile

861463e

Co-authored-by: Guilhem Fanton <8671905+gfanton@users.noreply.github.com>

Add comment to loop script

d3ba529

Simplify teardown

33b86d0

zivkovicmilos requested a review from moul November 7, 2023 14:47

moul approved these changes Nov 12, 2023

View reviewed changes

moul merged commit b1a53c0 into gnolang:master Nov 12, 2023
5 checks passed

zivkovicmilos deleted the feat/add-local-script branch November 12, 2023 18:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add local dev setup script #1237

feat: add local dev setup script #1237

zivkovicmilos commented Oct 11, 2023 •

edited

moul Oct 11, 2023

moul Oct 11, 2023

moul Oct 11, 2023

moul commented Oct 11, 2023

zivkovicmilos commented Nov 1, 2023

gfanton left a comment

moul Nov 6, 2023 •

edited

zivkovicmilos Nov 7, 2023

moul Nov 8, 2023

zivkovicmilos Nov 9, 2023

feat: add local dev setup script #1237

feat: add local dev setup script #1237

Conversation

zivkovicmilos commented Oct 11, 2023 • edited

Description

moul Oct 11, 2023

Choose a reason for hiding this comment

moul Oct 11, 2023

Choose a reason for hiding this comment

moul Oct 11, 2023

Choose a reason for hiding this comment

moul commented Oct 11, 2023

zivkovicmilos commented Nov 1, 2023

gfanton left a comment

Choose a reason for hiding this comment

moul Nov 6, 2023 • edited

Choose a reason for hiding this comment

zivkovicmilos Nov 7, 2023

Choose a reason for hiding this comment

moul Nov 8, 2023

Choose a reason for hiding this comment

zivkovicmilos Nov 9, 2023

Choose a reason for hiding this comment

zivkovicmilos commented Oct 11, 2023 •

edited

moul Nov 6, 2023 •

edited