Refractor codeforces codebase. (#27)

* Add NewPage functionality.

(cherry picked from commit 2bfac50)

* Complete refractoring.

* Fix infinite loop.

* More changes.

Check if page redirected and return error.
Fix formatting errors in getSubmissions.

* Improve tests.

Author: infalmo

.gitignore

@@ -15,3 +15,5 @@
 vendor/
 
 .env
+
+tmp/

codeforces/codeforces.go

@@ -2,7 +2,10 @@ package codeforces
 
 import (
 	"fmt"
+	"os"
+	"path/filepath"
 	"regexp"
+	"strconv"
 	"strings"
 
 	"github.com/cp-tools/cpt-lib/v2/util"
@@ -20,6 +23,10 @@ type (
 		Class   string
 		Group   string
 	}
+
+	page struct {
+		*rod.Page
+	}
 )
 
 // Class type of contest.
@@ -31,8 +38,7 @@ const (
 
 // Errors returned by library.
 var (
-	ErrInvalidSpecifier   = fmt.Errorf("invalid specifier data")
-	errInvalidCredentials = fmt.Errorf("invalid login credentials")
+	ErrInvalidSpecifier = fmt.Errorf("invalid specifier data")
 )
 
 var (
@@ -42,14 +48,6 @@ var (
 	Browser *rod.Browser
 )
 
-// Start initiates the automated browser to use.
-func Start(headless bool, userDataDir, bin string) error {
-	bs, err := util.NewBrowser(headless, userDataDir, bin)
-	Browser = bs
-
-	return err
-}
-
 func (arg Args) String() (str string) {
 	if arg == (Args{}) {
 		return ""
@@ -66,9 +64,20 @@ func (arg Args) String() (str string) {
 	return strings.Join(strings.Fields(str), " ")
 }
 
-// loginPage returns link to login page.
-func loginPage() string {
-	return fmt.Sprintf("%v/enter", hostURL)
+// Start initiates the automated browser to use.
+func Start(headless bool, userDataDir, bin string) error {
+	cacheDir, _ := os.UserCacheDir()
+	cacheDir = filepath.Join(cacheDir, "cp-tools", "cpt-lib")
+
+	return StartWithCacheDir(headless, userDataDir, bin, cacheDir)
+}
+
+// StartWithCacheDir is the same as Start, only allows to set cacheDir to use.
+func StartWithCacheDir(headless bool, userDataDir, bin, cacheDir string) error {
+	bs, err := util.NewBrowser(headless, userDataDir, bin, cacheDir)
+	Browser = bs
+
+	return err
 }
 
 // Parse passed in specifier string to new Args struct.
@@ -121,75 +130,24 @@ func Parse(str string) (Args, error) {
 				Class:   result["class"],
 				Group:   result["group"],
 			}
-			arg.setContestClass()
+
+			// Set contest class.
+			switch {
+			case arg.Class != "":
+				break
+			case len(arg.Group) == 10:
+				arg.Class = ClassGroup
+			default:
+				switch val, _ := strconv.Atoi(arg.Contest); {
+				case val <= 1e5:
+					arg.Class = ClassContest
+				default:
+					arg.Class = ClassGym
+				}
+			}
+
 			return arg, nil
 		}
 	}
 	return Args{}, ErrInvalidSpecifier
 }
-
-// login tries logging into codeforces using credentials passed.
-// Checks if any active session exists before logging in.
-//
-// If login is successful, returns user handle of logged in session.
-// Otherwise, if login fails, returns ErrInvalidCredentials.
-//
-// By default, option 'remember me' is checked, ensuring the session
-// has expiry period of one month from date of last login.
-func login(usr, passwd string) (string, error) {
-	link := loginPage()
-	page, msg, err := loadPage(link, selCSSFooter)
-	if err != nil {
-		return "", err
-	}
-	defer page.Close()
-
-	if msg != "" {
-		// there shouldn't be any notification
-		return "", fmt.Errorf(msg)
-	}
-
-	// check if current user sesion is logged in
-	if elm := page.MustElements(selCSSHandle).First(); elm != nil {
-		return clean(elm.MustText()), nil
-	}
-	// otherwise, login
-
-	// check if username/password are valid
-	if usr == "" || passwd == "" {
-		return "", errInvalidCredentials
-	}
-
-	page.MustElement("#handleOrEmail").Input(usr)
-	page.MustElement("#password").Input(passwd)
-	if page.MustElement("#remember").MustProperty("checked").Bool() == false {
-		page.MustElement("#remember").MustClick()
-	}
-	page.MustElement(".submit").MustClick()
-
-	page.MustElement(selCSSError, selCSSHandle)
-	if elm := page.MustElements(selCSSHandle); !elm.Empty() {
-		return clean(elm.First().MustText()), nil
-	}
-
-	return "", errInvalidCredentials
-}
-
-func logout() error {
-	page, msg, err := loadPage(hostURL, selCSSFooter)
-	if err != nil {
-		return err
-	}
-	defer page.Close()
-
-	if msg != "" {
-		return fmt.Errorf(msg)
-	}
-
-	if page.MustHasR("a", "Logout") {
-		page.MustElementR("a", "Logout").MustClick()
-		// page gives a notification on logout
-		page.Element(selCSSNotif)
-	}
-	return nil
-}

codeforces/codeforces_test.go

@@ -9,6 +9,40 @@ import (
 	"github.com/joho/godotenv"
 )
 
+func login(usr, passwd string) (string, error) {
+	p, err := loadPage(fmt.Sprintf("%v/enter", hostURL))
+	if err != nil {
+		return "", err
+	}
+	defer p.Close()
+
+	if _, err := p.Race().Element(`#jGrowl .message`).Handle(handleErrMsg).
+		Element(`#footer`).Do(); err != nil {
+		return "", err
+	}
+
+	// Check if current user sesion is logged in.
+	if elm := p.MustElements(`#header a[href^="/profile/"]`).First(); elm != nil {
+		return elm.MustText(), nil
+	}
+
+	// Otherwise, login.
+	p.MustElement("#handleOrEmail").Input(usr)
+	p.MustElement("#password").Input(passwd)
+	if p.MustElement("#remember").MustProperty("checked").Bool() == false {
+		p.MustElement("#remember").MustClick()
+	}
+	p.MustElement(".submit").MustClick().WaitInvisible()
+
+	elm, err := p.Race().Element(`.error`).Handle(handleErrMsg).
+		Element(`#header a[href^="/profile/"]`).Do()
+	if err != nil {
+		return "", err
+	}
+
+	return elm.MustText(), nil
+}
+
 func getLoginCredentials() (string, string) {
 	// setup login access to use
 	usr := os.Getenv("CODEFORCES_USERNAME")
@@ -22,19 +56,76 @@ func TestMain(m *testing.M) {
 
 	_, browserHeadless := os.LookupEnv("BROWSER_HEADLESS")
 	browserBin := os.Getenv("BROWSER_BINARY")
-	Start(browserHeadless, "", browserBin)
+	if err := StartWithCacheDir(browserHeadless, "", browserBin, "tmp"); err != nil {
+		fmt.Println("Failed to start browser:", err)
+		os.Exit(1)
+	}
 
-	if _, err := login(getLoginCredentials()); err != nil {
+	if handle, err := login(getLoginCredentials()); err != nil {
 		fmt.Println("Login failed:", err)
 		Browser.Close()
 		os.Exit(1)
+	} else {
+		fmt.Println("Logged in user:", handle)
 	}
 	exitCode := m.Run()
 
 	Browser.Close()
+
 	os.Exit(exitCode)
 }
 
+func TestArgs_String(t *testing.T) {
+	tests := []struct {
+		name string
+		arg  Args
+		want string
+	}{
+		{
+			name: "Test #1",
+			arg:  Args{"1234", "", "contest", ""},
+			want: "1234 (contest)",
+		},
+		{
+			name: "Test #2",
+			arg:  Args{"1234", "b", "contest", ""},
+			want: "1234 b (contest)",
+		},
+		{
+			name: "Test #3",
+			arg:  Args{"100522", "", "gym", ""},
+			want: "100522 (gym)",
+		},
+		{
+			name: "Test #4",
+			arg:  Args{"100522", "f1", "gym", ""},
+			want: "100522 f1 (gym)",
+		},
+		{
+			name: "Test #5",
+			arg:  Args{"201468", "", "group", "Qvv4lz52cT"},
+			want: "201468 (group/Qvv4lz52cT)",
+		},
+		{
+			name: "Test #6",
+			arg:  Args{"201468", "c1", "group", "Qvv4lz52cT"},
+			want: "201468 c1 (group/Qvv4lz52cT)",
+		},
+		{
+			name: "Test #7",
+			arg:  Args{},
+			want: "",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := tt.arg.String(); got != tt.want {
+				t.Errorf("Args.String() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
 func TestParse(t *testing.T) {
 	type args struct {
 		str string
@@ -161,98 +252,3 @@ func TestParse(t *testing.T) {
 		})
 	}
 }
-
-func TestArgs_String(t *testing.T) {
-	tests := []struct {
-		name string
-		arg  Args
-		want string
-	}{
-		{
-			name: "Test #1",
-			arg:  Args{"1234", "", "contest", ""},
-			want: "1234 (contest)",
-		},
-		{
-			name: "Test #2",
-			arg:  Args{"1234", "b", "contest", ""},
-			want: "1234 b (contest)",
-		},
-		{
-			name: "Test #3",
-			arg:  Args{"100522", "", "gym", ""},
-			want: "100522 (gym)",
-		},
-		{
-			name: "Test #4",
-			arg:  Args{"100522", "f1", "gym", ""},
-			want: "100522 f1 (gym)",
-		},
-		{
-			name: "Test #5",
-			arg:  Args{"201468", "", "group", "Qvv4lz52cT"},
-			want: "201468 (group/Qvv4lz52cT)",
-		},
-		{
-			name: "Test #6",
-			arg:  Args{"201468", "c1", "group", "Qvv4lz52cT"},
-			want: "201468 c1 (group/Qvv4lz52cT)",
-		},
-		{
-			name: "Test #7",
-			arg:  Args{},
-			want: "",
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if got := tt.arg.String(); got != tt.want {
-				t.Errorf("Args.String() = %v, want %v", got, tt.want)
-			}
-		})
-	}
-}
-
-func Test_login(t *testing.T) {
-	logout()
-
-	type args struct {
-		usr    string
-		passwd string
-	}
-	tests := []struct {
-		name    string
-		args    args
-		want    string
-		wantErr bool
-	}{
-		{
-			name:    "Test #1",
-			args:    args{"cp-tools", "PleaseTryAgain"},
-			want:    "",
-			wantErr: true,
-		},
-		{
-			name:    "Test #2",
-			args:    args{"", ""},
-			want:    "",
-			wantErr: true,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			got, err := login(tt.args.usr, tt.args.passwd)
-			if (err != nil) != tt.wantErr {
-				t.Errorf("login() error = %v, wantErr %v", err, tt.wantErr)
-				return
-			}
-			if got != tt.want {
-				t.Errorf("login() = %v, want %v", got, tt.want)
-			}
-		})
-	}
-
-	// hope nothing goes wrong.
-	logout()
-	login(getLoginCredentials())
-}