Polish the login flow #11
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,111 +6,196 @@ import ( | |
| "io/ioutil" | ||
| "os" | ||
| "path" | ||
| "path/filepath" | ||
| "strings" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/auth0/auth0-cli/internal/display" | ||
| "gopkg.in/auth0.v5/management" | ||
| ) | ||
|
|
||
| // config defines the exact set of tenants, access tokens, which only exists | ||
| // for a particular user's machine. | ||
| type config struct { | ||
|
Comment on lines
+18
to
+20
There was a problem hiding this comment. In retrospect |
||
| DefaultTenant string `json:"default_tenant"` | ||
| Tenants map[string]tenant `json:"tenants"` | ||
| } | ||
|
|
||
| // tenant is the cli's concept of an auth0 tenant. The fields are tailor fit | ||
| // specifically for interacting with the management API. | ||
| type tenant struct { | ||
| Name string `json:"name"` | ||
| Domain string `json:"domain"` | ||
| AccessToken string `json:"access_token,omitempty"` | ||
| ExpiresAt time.Time `json:"expires_at"` | ||
|
There was a problem hiding this comment. We're not using ExpiresAt yet -- but eventually we can use it to determine when to re-trigger a new login. There was a problem hiding this comment. Created a backlog item so we don't lose track https://auth0team.atlassian.net/browse/A0CLI-9 |
||
| } | ||
|
|
||
| // cli provides all the foundational things for all the commands in the CLI, | ||
| // specifically: | ||
| // | ||
| // 1. A management API instance (e.g. go-auth0/auth0) | ||
| // 2. A renderer (which provides ansi, coloring, etc). | ||
| // | ||
| // In addition, it stores a reference to all the flags passed, e.g.: | ||
| // | ||
| // 1. --format | ||
| // 2. --tenant | ||
| // 3. --verbose | ||
| // | ||
| type cli struct { | ||
| // core primitives exposed to command builders. | ||
| api *management.Management | ||
| renderer *display.Renderer | ||
|
|
||
| // set of flags which are user specified. | ||
| verbose bool | ||
| tenant string | ||
| format string | ||
|
|
||
| // config state management. | ||
| initOnce sync.Once | ||
| errOnce error | ||
| path string | ||
| config config | ||
| } | ||
|
|
||
| // isLoggedIn encodes the domain logic for determining whether or not we're | ||
| // logged in. This might check our config storage, or just in memory. | ||
| func (c *cli) isLoggedIn() bool { | ||
| // No need to check errors for initializing context. | ||
| _ = c.init() | ||
|
|
||
| return c.tenant != "" | ||
| } | ||
|
|
||
| // setup will try to initialize the config context, as well as figure out if | ||
| // there's a readily available tenant. A management API SDK instance is initialized IFF: | ||
| // | ||
| // 1. A tenant is found. | ||
| // 2. The tenant has an access token. | ||
| func (c *cli) setup() error { | ||
| if err := c.init(); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| t, err := c.getTenant() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if t.AccessToken != "" { | ||
| c.api, err = management.New(t.Domain, | ||
| management.WithStaticToken(t.AccessToken), | ||
| management.WithDebug(c.verbose)) | ||
| } | ||
|
Comment on lines
-50
to
91
There was a problem hiding this comment. Originally we had an if else for M2M or a static token. Given that we've made device flow work already, we can remove this until we decide we need it. |
||
|
|
||
| return err | ||
| } | ||
|
|
||
| // getTenant fetches the default tenant configured (or the tenant specified via | ||
| // the --tenant flag). | ||
| func (c *cli) getTenant() (tenant, error) { | ||
| if err := c.init(); err != nil { | ||
| return tenant{}, err | ||
| } | ||
|
|
||
| t, ok := c.config.Tenants[c.tenant] | ||
| if !ok { | ||
| return tenant{}, fmt.Errorf("Unable to find tenant: %s", c.tenant) | ||
| } | ||
|
|
||
| return t, nil | ||
| } | ||
|
|
||
| // addTenant assigns an existing, or new tenant. This is expected to be called | ||
| // after a login has completed. | ||
| func (c *cli) addTenant(ten tenant) error { | ||
| // init will fail here with a `no tenant found` error if we're logging | ||
| // in for the first time and that's expected. | ||
| _ = c.init() | ||
|
|
||
| // If there's no existing DefaultTenant yet, might as well set the | ||
| // first successfully logged in tenant during onboarding. | ||
| if c.config.DefaultTenant == "" { | ||
| c.config.DefaultTenant = ten.Name | ||
| } | ||
|
|
||
| // If we're dealing with an empty file, we'll need to initialize this | ||
| // map. | ||
| if c.config.Tenants == nil { | ||
| c.config.Tenants = map[string]tenant{} | ||
| } | ||
|
|
||
| c.config.Tenants[ten.Name] = ten | ||
|
|
||
| dir := filepath.Dir(c.path) | ||
| if _, err := os.Stat(dir); os.IsNotExist(err) { | ||
| if err := os.MkdirAll(dir, 0700); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| buf, err := json.MarshalIndent(c.config, "", " ") | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := ioutil.WriteFile(c.path, buf, 0600); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (c *cli) init() error { | ||
| c.initOnce.Do(func() { | ||
| // Initialize the context -- e.g. the configuration | ||
| // information, tenants, etc. | ||
| if c.errOnce = c.initContext(); c.errOnce != nil { | ||
| return | ||
| } | ||
| c.renderer.Tenant = c.tenant | ||
|
|
||
| // Determine what the desired output format is. | ||
| format := strings.ToLower(c.format) | ||
| if format != "" && format != string(display.OutputFormatJSON) { | ||
| c.errOnce = fmt.Errorf("Invalid format. Use `--format=json` or omit this option to use the default format.") | ||
| return | ||
| } | ||
| c.renderer.Format = display.OutputFormat(format) | ||
|
Comment on lines
-107
to
+166
There was a problem hiding this comment. Since we've already initialized a |
||
| }) | ||
|
|
||
| // Once initialized, we'll keep returning the same err that was | ||
| // originally encountered. | ||
| return c.errOnce | ||
|
Comment on lines
+169
to
+171
There was a problem hiding this comment. This was a bug fix in the UX such that you'll occasionally get |
||
| } | ||
|
|
||
| func (c *cli) initContext() (err error) { | ||
| if c.path == "" { | ||
| c.path = path.Join(os.Getenv("HOME"), ".config", "auth0", "config.json") | ||
woloski marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| if _, err := os.Stat(c.path); os.IsNotExist(err) { | ||
| return fmt.Errorf("Not yet configured. Try `auth0 login`.") | ||
| } | ||
|
|
||
| var buf []byte | ||
| if buf, err = ioutil.ReadFile(c.path); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := json.Unmarshal(buf, &c.config); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if c.tenant == "" && c.config.DefaultTenant == "" { | ||
| return fmt.Errorf("Not yet configured. Try `auth0 login`.") | ||
| } | ||
|
|
||
| if c.tenant == "" { | ||
| c.tenant = c.config.DefaultTenant | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We forgot to include this -- ultimately this is the parameter we thread through to the
management.Newcall (e.g. https://github.com/go-auth0/auth0)