Refactor API interfaces (#185)

- Move logging to command level.
- Simplify and unify interfaces for `appstore` package.
- Move sinf replication from "Download" API to "ReplicateSinf" API.
- Handle retries and command specific logic in the command level.
- Rename "Info" API to "AccountInfo".

.github/workflows/release.yml

@@ -23,6 +23,7 @@ jobs:
         with:
           go-version: '1.19.3'
           cache: true
+      - run: go generate github.com/majd/ipatool/...
       - run: go test -v github.com/majd/ipatool/...
   build:
     name: Build

.github/workflows/unit-tests.yml

@@ -15,4 +15,5 @@ jobs:
         with:
           go-version: '1.19.3'
           cache: true
+      - run: go generate github.com/majd/ipatool/...
       - run: go test -v github.com/majd/ipatool/...

.gitignore

@@ -2,4 +2,5 @@
 .AppleDouble
 .LSOverride
 .vscode/
-.idea/
+.idea/
+**/*_mock.go

README.md

@@ -129,9 +129,10 @@ The tool can be compiled using the Go toolchain.
 $ go build -o ipatool
 ```
 
-Unit tests can be executed with the following command.
+Unit tests can be executed with the following commands.
 
 ```shell
+$ go generate github.com/majd/ipatool/...
 $ go test -v github.com/majd/ipatool/...
 ```
 

cmd/auth.go

@@ -1,15 +1,20 @@
 package cmd
 
 import (
+	"bufio"
+	"errors"
+	"fmt"
 	"github.com/99designs/keyring"
+	"github.com/avast/retry-go"
 	"github.com/majd/ipatool/pkg/appstore"
-	"github.com/majd/ipatool/pkg/log"
-	"github.com/pkg/errors"
+	"github.com/majd/ipatool/pkg/util"
 	"github.com/spf13/cobra"
+	"golang.org/x/term"
+	"os"
+	"strings"
+	"time"
 )
 
-var keychainPassphrase string
-
 func authCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "auth",
@@ -28,6 +33,19 @@ func authCmd() *cobra.Command {
 }
 
 func loginCmd() *cobra.Command {
+	promptForAuthCode := func() (string, error) {
+		reader := bufio.NewReader(os.Stdin)
+		authCode, err := reader.ReadString('\n')
+		if err != nil {
+			return "", err
+		}
+
+		authCode = strings.Trim(authCode, "\n")
+		authCode = strings.Trim(authCode, "\r")
+
+		return authCode, nil
+	}
+
 	var email string
 	var password string
 	var authCode string
@@ -36,29 +54,72 @@ func loginCmd() *cobra.Command {
 		Use:   "login",
 		Short: "Login to the App Store",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			store, err := newAppStore(cmd, keychainPassphrase)
-			if err != nil {
-				return errors.Wrap(err, "failed to create appstore client")
+			interactive := cmd.Context().Value("interactive").(bool)
+
+			if password == "" && !interactive {
+				return errors.New("password is required when not running in interactive mode; use the \"--password\" flag")
 			}
 
-			logger := cmd.Context().Value("logger").(log.Logger)
-			out, err := store.Login(email, password, authCode)
-			if err != nil {
-				if err == appstore.ErrAuthCodeRequired {
-					logger.Log().Msg("2FA code is required; run the command again and supply a code using the `--auth-code` flag")
-					return nil
-				}
+			if password == "" && interactive {
+				dependencies.Logger.Log().Msg("enter password:")
 
-				return err
+				bytes, err := term.ReadPassword(int(os.Stdin.Fd()))
+				if err != nil {
+					return fmt.Errorf("failed to read password: %w", err)
+				}
+				password = string(bytes)
 			}
 
-			logger.Log().
-				Str("name", out.Name).
-				Str("email", out.Email).
-				Bool("success", true).
-				Send()
+			var lastErr error
 
-			return nil
+			return retry.Do(func() error {
+				if errors.Is(lastErr, appstore.ErrAuthCodeRequired) && interactive {
+					dependencies.Logger.Log().Msg("enter 2FA code:")
+
+					var err error
+					authCode, err = promptForAuthCode()
+					if err != nil {
+						return fmt.Errorf("failed to read auth code: %w", err)
+					}
+				}
+
+				dependencies.Logger.Verbose().
+					Str("password", password).
+					Str("email", email).
+					Str("authCode", util.IfEmpty(authCode, "<nil>")).
+					Msg("logging in")
+
+				output, err := dependencies.AppStore.Login(appstore.LoginInput{
+					Email:    email,
+					Password: password,
+					AuthCode: authCode,
+				})
+				if err != nil {
+					if errors.Is(err, appstore.ErrAuthCodeRequired) && !interactive {
+						dependencies.Logger.Log().Msg("2FA code is required; run the command again and supply a code using the `--auth-code` flag")
+						return nil
+					}
+
+					return err
+				}
+
+				dependencies.Logger.Log().
+					Str("name", output.Account.Name).
+					Str("email", output.Account.Email).
+					Bool("success", true).
+					Send()
+
+				return nil
+			},
+				retry.LastErrorOnly(true),
+				retry.DelayType(retry.FixedDelay),
+				retry.Delay(time.Millisecond),
+				retry.Attempts(2),
+				retry.RetryIf(func(err error) bool {
+					lastErr = err
+					return errors.Is(err, appstore.ErrAuthCodeRequired)
+				}),
+			)
 		},
 	}
 
@@ -76,20 +137,14 @@ func infoCmd() *cobra.Command {
 		Use:   "info",
 		Short: "Show current account info",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			appstore, err := newAppStore(cmd, keychainPassphrase)
-			if err != nil {
-				return errors.Wrap(err, "failed to create appstore client")
-			}
-
-			out, err := appstore.Info()
+			output, err := dependencies.AppStore.AccountInfo()
 			if err != nil {
 				return err
 			}
 
-			logger := cmd.Context().Value("logger").(log.Logger)
-			logger.Log().
-				Str("name", out.Name).
-				Str("email", out.Email).
+			dependencies.Logger.Log().
+				Str("name", output.Account.Name).
+				Str("email", output.Account.Email).
 				Bool("success", true).
 				Send()
 
@@ -103,19 +158,12 @@ func revokeCmd() *cobra.Command {
 		Use:   "revoke",
 		Short: "Revoke your App Store credentials",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			appstore, err := newAppStore(cmd, keychainPassphrase)
-			if err != nil {
-				return errors.Wrap(err, "failed to create appstore client")
-			}
-
-			err = appstore.Revoke()
+			err := dependencies.AppStore.Revoke()
 			if err != nil {
 				return err
 			}
 
-			logger := cmd.Context().Value("logger").(log.Logger)
-			logger.Log().Bool("success", true).Send()
-
+			dependencies.Logger.Log().Bool("success", true).Send()
 			return nil
 		},
 	}