api_user.go

package apstra

import (
	"context"
	"fmt"
	"net/http"
)

const (
	apiUrlUserLogin  = "/api/user/login"
	apiUrlUserLogout = "/api/user/logout"
)

// userLoginRequest token to the apiUrlUserLogin API endpoint
type userLoginRequest struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

// userLoginResponse token returned by the apiUrlUserLogin API endpoint
type userLoginResponse struct {
	Token string   `json:"token"`
	Id    ObjectId `json:"id"`
}

func (o *Client) startTaskMonitor() {
	if o.tmQuit == nil {
		o.tmQuit = make(chan struct{})
		o.Log(2, "starting task monitor")
		newTaskMonitor(o).start()
		o.Log(2, "task monitor started")
	}
}

func (o *Client) stopTaskMonitor() {
	if o.tmQuit != nil {
		close(o.tmQuit)
		o.tmQuit = nil
		o.Log(2, "task monitor close requested")
	}
}

func (o *Client) login(ctx context.Context) error {
	response := &userLoginResponse{}
	err := o.talkToApstra(ctx, &talkToApstraIn{
		method: http.MethodPost,
		urlStr: apiUrlUserLogin,
		apiInput: &userLoginRequest{
			Username: o.cfg.User,
			Password: o.cfg.Pass,
		},
		doNotLogin:  true,
		apiResponse: response,
	})
	if err != nil {
		return fmt.Errorf("error talking to AOS in Login - %w", err)
	}

	// stash auth token in client's default set of apstra http httpHeaders
	// and start the tasskMonitor (these go together)
	o.lock(mutexKeyHttpHeaders)
	o.httpHeaders[apstraAuthHeader] = response.Token
	o.unlock(mutexKeyHttpHeaders)

	o.id = response.Id
	o.startTaskMonitor()
	return nil
}

func (o *Client) logout(ctx context.Context) error {
	o.Log(1, "client logging out")
	// presence of an auth token is proxy for both
	// - "logged in" state and
	// - operation of a task monitor routine
	o.lock(mutexKeyHttpHeaders)
	if _, tokenFound := o.httpHeaders[apstraAuthHeader]; !tokenFound {
		o.unlock(mutexKeyHttpHeaders)
		return nil
	}
	o.unlock(mutexKeyHttpHeaders)

	defer func() {
		o.Log(1, "deleting auth token")
		o.lock(mutexKeyHttpHeaders)
		delete(o.httpHeaders, apstraAuthHeader)
		o.unlock(mutexKeyHttpHeaders)
		o.Log(1, "shutting down the task monitor")
		o.stopTaskMonitor()
	}()

	err := o.talkToApstra(ctx, &talkToApstraIn{
		method:     http.MethodPost,
		urlStr:     apiUrlUserLogout,
		doNotLogin: true,
	})
	if err != nil {
		return fmt.Errorf("error calling '%s' - %w", apiUrlUserLogout, err)
	}
	return nil
}