Prepare commands and docs for v1.1.0 release #733

unnawut · 2019-01-24T14:42:54Z

Issue/Task Number: #684

Overview

This PR updates release tasks and docs in preparation for v1.1.0 release.

Changes

~~Remove asdf-specific .tool-versions~~
Split EWallet.ReleaseTasks into multiple modules separated by the main task
Add bin/ewallet config --migrate support
Add mix omg.config that has feature-parity with bin/wallet config
Add a generic upgrade docs
Add a v1.1.0 upgrade docs

Implementation Details

Turns out v1.0.0 -> v1.1.0 is quite a smooth ride since breaking changes were already crammed within v1.0.0.

The biggest change is the distillery release which renders mix commands unavailable on production builds, while itself is quite cumbersome to use in development environment.

This PR mainly adds documentations regarding upgrades, as well as attempting towards feature-parity (but not yet) between mix omg.* commands for dev environment and bin/ewallet for prod environment.

Usage

See upgrade instructions under Upgrade heading on the main README.md.

Commands:

Action	Dev	Prod
Print config instructions	`mix omg.config` or `mix omg.config -h`	`bin/ewallet config` or `bin/ewallet config -h`
Set a configuration	`mix omg.config key value`	`bin/ewallet config key value`
Migrate configurations	`mix omg.config --migrate`	`bin/ewallet config --migrate`

Impact

Nothing specific for this PR, but the command bin/ewallet config --migrate must be run during the upgrade from v1.0.0 to v1.1.0.

# Conflicts: # rel/commands/config.sh

T-Dnzt · 2019-01-25T04:17:25Z

README.md

@@ -41,6 +41,10 @@ For other platforms or for a more advanced setup, see also manual installation b

 -   [Bare metal installation](docs/setup/bare_metal.md)

+### Upgrade
+
+Upgrading to a newer version? See [Upgrading the eWallet Server](docs/setup/upgrading).


Maybe the eWallet server application?

I try to call it "OmiseGO eWallet Server" everywhere if possible.

and then there's the Suite...

Hence I'm going to create a new page called Glossary to discuss & pin this down for good.

@T-Dnzt @sirn I've just added a glossary section. Please check a98169a.

unnawut · 2019-01-25T04:28:01Z

@sirn I splitted ReleaseTasks into smaller ReleaseTasks.* modules.

And made a bit of changes to rel/commands/config.sh and rel/commands/seed.sh to do the bin/ewallet config --migrate.

Can you have a look?

sirn

Few comments here and there. Also can you run ShellCheck against all the shell scripts?

sirn · 2019-01-25T04:42:21Z

.gitignore

@@ -24,5 +24,8 @@ erl_crash.dump
 .elixir_ls
 Thumbs.db

+# asdf
+.tool-versions


Eh. Thought that this is supposed to be user-specific.

But using this to semi-enforce dev users to use the same tool versions is fine I guess. Removing.

This thing actually saved my life quite few times already since I run editor outside of my Docker VM which has different Elixir version than the one in omisego-images/docker-ewallet (and .tool-versions yell at me to install 1.6.5 which is nice…)

sirn · 2019-01-25T04:43:52Z

apps/ewallet/lib/ewallet/cli.ex

+    # Mix is not available with distillery releases.
+    # Link: https://github.com/elixir-lang/elixir/blob/v1.6.5/lib/mix/lib/mix/shell/io.ex#L54
+    answer = IO.gets(message <> " [Yn] ")
+    is_binary(answer) and String.trim(answer) in ["" | @yes_inputs]


Might worth to use EWallet.Helper.to_boolean instead as that one handle plenty of… weird cases.

sirn · 2019-01-25T04:45:47Z

apps/ewallet/lib/ewallet/release_tasks/config_migration.ex

+
+  def run(opts \\ []) do
+    # Make sure the settings seed has been run
+    _ = Seed.run_settings_no_stop()


Would prefer this to re-implement the seed apps initialization because it serves different purpose na.

sirn · 2019-01-25T04:53:43Z

rel/commands/config.sh


-KEY="$(printf "%s" "$1" | base64)"; shift
-VALUE="$(printf "%s" "$1" | base64)"; shift
+if [ $ACTION = migrate ]; then


I think the better way to implement this is to do:

run_migrate() { # exec ... } run_set() { # exec... } case "$ACTION" in set ) run_set;; migrate ) run_migrate;; * ) print_usage exit 1 esac

I try to use exit 1 for hard error (e.g. wrong arguments, etc.), and exit 2 for informative errors (printing usage, etc.) because it's pretty common to check for exit 1 for detecting errors.

sirn · 2019-01-25T04:56:48Z

rel/commands/config.sh

-KEY="$(printf "%s" "$1" | base64)"; shift
-VALUE="$(printf "%s" "$1" | base64)"; shift
+if [ $ACTION = migrate ]; then
+    $RELEASE_ROOT_DIR/bin/ewallet command Elixir.EWallet.ReleaseTasks.Seed run_settings &&


Why do you need && here? If you want to detect that the command ran successfully, better use:

if ! $RELEASE_ROOT_DIR/bin/ewallet command Elixir.EWallet.ReleaseTasks.Seed run_settings; then printf "The error occurred during seeding settings data.\\n" exit 1 fi

sirn · 2019-01-25T04:59:08Z

rel/commands/config.sh


-exec "$RELEASE_ROOT_DIR/bin/ewallet" command Elixir.EWallet.ReleaseTasks config_base64 "$KEY" "$VALUE"
+    if [ "$ASK_CONFIRM" = true ]; then
+        exec "$RELEASE_ROOT_DIR/bin/ewallet" command Elixir.EWallet.ReleaseTasks.ConfigMigration run_ask_confirm


Try to have only one exec at the end of execution because it can be confusing since exec is essentially the end of shell script. So here better do:

MIGRATION_FN = "run_ask_confirm" if [ "$ASK_CONFIRM" = true ]; then MIGRATION_FN = "run_skip_confirm" fi exec …

This reverts commit ae106d2.

… answer.

# Conflicts: # rel/commands/config.sh

…e task

unnawut · 2019-01-25T06:41:41Z

@sirn Updated. Please check again.

…tructions first

Unnawut added 24 commits January 24, 2019 20:08

Add upgrade instructions

1d31be2

Remove user-specific .tools-versions file created by asdf

ae106d2

Add license headers

7725622

Split release tasks into separate modules

9444da2

Add config migration

0aa0679

Use the release command instead of mix in upgrade docs

c45fc9e

Add --settings to release task's seed

7692b2d

Refactor release tasks to use unified puts functions

d6aace0

Start required applications that are missing from the release tasks

8c62840

Add ewallet config --migrate command

8c1b8fe

Fix missing originator for config migration

486b8ea

Add support for -y, --yes, --assume_yes to config release task

5caa35c

Fix release tasks failing silently when an unknown argument is given

36ffd72

Refactor IO puts functions into EWallet.CLI

fe73caf

Mirror bin/ewallet config into mix omg.config

0c1f41d

DEBUG=1 to show :debug log and above

c2842d2

Fix mix config --migrate stopped at seeding and not respecting --yes

e5eb0d3

Show mix task docs instead of invalid arguments message

b154449

Add -- shift to initdb and seed

32533f5

Update mix omg.config docs

de9a867

Minor upgrade notes improvements

3c30afe

Ain't no push without mix formatting

44058b0

Nope nope can't go without credo too

b9d1261

Add missing mix task shortdoc

e2d1d86

ghost assigned unnawut Jan 24, 2019

ghost added the s2/wip 🚧 label Jan 24, 2019

unnawut requested review from sirn, T-Dnzt and mederic-p January 24, 2019 14:43

unnawut added the s3/review 👀 label Jan 24, 2019

Merge branch 'v1.1' into 684-upgrade-path

1fc6737

# Conflicts: # rel/commands/config.sh

unnawut assigned sirn and T-Dnzt Jan 25, 2019

T-Dnzt approved these changes Jan 25, 2019

View reviewed changes

sirn suggested changes Jan 25, 2019

View reviewed changes

Unnawut added 14 commits January 25, 2019 12:05

Add a glossary for eWallet Suite and eWallet Server

a98169a

Revert "Remove user-specific .tools-versions file created by asdf"

02acea3

This reverts commit ae106d2.

Update EWallet.CLI.confirm?/1 to use Helper.to_boolean/1 to parse the…

932b204

… answer.

Refactor set/migration conditions in config.sh

d494b08

Decouple ReleaseTasks.ConfigMigration from ReleaseTasks.Seed

5db333d

Shellcheck

721d2c4

Merge branch 'v1.1' into 684-upgrade-path

547b1d8

# Conflicts: # rel/commands/config.sh

Remove seed from config.sh as it's already done as part of the releas…

b603d5e

…e task

Fix ask_confirm condition

3958f47

Add message during seed-migration dead air

7a2c701

Fix CLI.confirm?/1 not respecting the default value

5b6e4a9

Fix shell script styling

7bd157b

Remove default fallback for confirmed?/2, risky assumption

96bc0f0

Add some typespecs

daf47ac

Unnawut added 3 commits January 25, 2019 13:46

Mix formatting

e79bfdd

Fix missing use Mix.Task in mix omg.migrate.encryption

2d6a403

Add a bit of notice to v1.1.0 upgrade to perform the main upgrade ins…

0f579ef

…tructions first

unnawut added this to the v1.1 milestone Jan 25, 2019

sirn approved these changes Jan 28, 2019

View reviewed changes

unnawut merged commit 96d847f into v1.1 Jan 28, 2019

ghost removed the s3/review 👀 label Jan 28, 2019

unnawut deleted the 684-upgrade-path branch January 28, 2019 04:24

nebali mentioned this pull request Feb 19, 2019

eWallet Update 17 - February 04, 2019 buildOMG/comms#72

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prepare commands and docs for v1.1.0 release #733

Prepare commands and docs for v1.1.0 release #733

unnawut commented Jan 24, 2019 •

edited

T-Dnzt Jan 25, 2019

sirn Jan 25, 2019

unnawut Jan 25, 2019 •

edited

unnawut Jan 25, 2019

sirn Jan 25, 2019

unnawut commented Jan 25, 2019

sirn left a comment

sirn Jan 25, 2019

unnawut Jan 25, 2019

sirn Jan 25, 2019

sirn Jan 25, 2019

sirn Jan 25, 2019

sirn Jan 25, 2019

sirn Jan 25, 2019

sirn Jan 25, 2019

unnawut commented Jan 25, 2019

Prepare commands and docs for v1.1.0 release #733

Prepare commands and docs for v1.1.0 release #733

Conversation

unnawut commented Jan 24, 2019 • edited

Overview

Changes

Implementation Details

Usage

Impact

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unnawut Jan 25, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unnawut commented Jan 25, 2019

sirn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unnawut commented Jan 25, 2019

unnawut commented Jan 24, 2019 •

edited

unnawut Jan 25, 2019 •

edited