Refactor and improve users import cmd #735
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 |
|---|---|---|
|
|
@@ -11,6 +11,7 @@ import ( | |
|
|
||
| "github.com/auth0/auth0-cli/internal/ansi" | ||
| "github.com/auth0/auth0-cli/internal/auth0" | ||
| "github.com/auth0/auth0-cli/internal/iostream" | ||
| "github.com/auth0/auth0-cli/internal/prompt" | ||
| "github.com/auth0/auth0-cli/internal/users" | ||
| ) | ||
|
|
@@ -76,30 +77,29 @@ var ( | |
| Help: "Number of users, that match the search criteria, to retrieve. Minimum 1, maximum 1000. If limit is hit, refine the search query.", | ||
| } | ||
| userImportTemplate = Flag{ | ||
| Name: "Template", | ||
| LongForm: "template", | ||
| ShortForm: "t", | ||
| Help: "Name of JSON example to be used. Cannot be used if the '--users' flag is passed. " + | ||
| "Options include: 'Empty', 'Basic Example', 'Custom Password Hash Example' and 'MFA Factors Example'.", | ||
| IsRequired: false, | ||
| } | ||
| userImportBody = Flag{ | ||
| Name: "Users Payload", | ||
| LongForm: "users", | ||
| ShortForm: "u", | ||
| Help: "JSON payload that contains an array of user(s) to be imported. Cannot be used if the '--template' flag is passed.", | ||
| IsRequired: false, | ||
| } | ||
| userEmailResults = Flag{ | ||
| Name: "Email Completion Results", | ||
| LongForm: "email-results", | ||
| Help: "When true, sends a completion email to all tenant owners when the job is finished. The default is true, so you must explicitly set this parameter to false if you do not want emails sent.", | ||
| IsRequired: false, | ||
| } | ||
| userImportUpsert = Flag{ | ||
| Name: "Upsert", | ||
| LongForm: "upsert", | ||
| Help: "When set to false, pre-existing users that match on email address, user ID, or username will fail. When set to true, pre-existing users that match on any of these fields will be updated, but only with upsertable attributes.", | ||
| IsRequired: false, | ||
| } | ||
|
|
@@ -229,9 +229,8 @@ func createUserCmd(cli *cli) *cobra.Command { | |
| auth0 users create --name "John Doe" --email [email protected] --connection "Username-Password-Authentication" --username "example" | ||
| auth0 users create -n "John Doe" -e [email protected] -c "Username-Password-Authentication" -u "example" --json`, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| // Users API currently only supports database connections. | ||
| options, err := cli.dbConnectionPickerOptions() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
@@ -537,7 +536,7 @@ func importUsersCmd(cli *cli) *cobra.Command { | |
| Connection string | ||
| ConnectionID string | ||
| Template string | ||
| UsersBody string | ||
| Upsert bool | ||
| SendCompletionEmail bool | ||
| } | ||
|
|
@@ -549,76 +548,89 @@ func importUsersCmd(cli *cli) *cobra.Command { | |
| The file size limit for a bulk import is 500KB. You will need to start multiple imports if your data exceeds this size.`, | ||
| Example: ` auth0 users import | ||
| auth0 users import --connection "Username-Password-Authentication" | ||
| auth0 users import --connection "Username-Password-Authentication" --users "[]" | ||
| auth0 users import --connection "Username-Password-Authentication" --users "$(cat path/to/users.json)" | ||
| cat path/to/users.json | auth0 users import --connection "Username-Password-Authentication" | ||
| auth0 users import -c "Username-Password-Authentication" --template "Basic Example" | ||
| auth0 users import -c "Username-Password-Authentication" --users "$(cat path/to/users.json)" --upsert --email-results | ||
| auth0 users import -c "Username-Password-Authentication" --users "$(cat path/to/users.json)" --upsert --email-results --no-input | ||
| cat path/to/users.json | auth0 users import -c "Username-Password-Authentication" --upsert --email-results --no-input | ||
| auth0 users import -c "Username-Password-Authentication" -u "$(cat path/to/users.json)" --upsert --email-results | ||
| cat path/to/users.json | auth0 users import -c "Username-Password-Authentication" --upsert --email-results | ||
| auth0 users import -c "Username-Password-Authentication" -t "Basic Example" --upsert --email-results | ||
| auth0 users import -c "Username-Password-Authentication" -t "Basic Example" --upsert=false --email-results=false | ||
| auth0 users import -c "Username-Password-Authentication" -t "Basic Example" --upsert=false --email-results=false`, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| // Users API currently only supports database connections. | ||
| dbConnectionOptions, err := cli.dbConnectionPickerOptions() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := userConnection.Select(cmd, &inputs.Connection, dbConnectionOptions, nil); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| connection, err := cli.api.Connection.ReadByName(inputs.Connection) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to find connection with name %q: %w", inputs.Connection, err) | ||
| } | ||
|
|
||
| inputs.ConnectionID = connection.GetID() | ||
|
|
||
| pipedUsersBody := iostream.PipedInput() | ||
| if len(pipedUsersBody) > 0 && inputs.UsersBody == "" { | ||
| inputs.UsersBody = string(pipedUsersBody) | ||
| } | ||
|
|
||
| if inputs.UsersBody == "" { | ||
| err := userImportTemplate.Select(cmd, &inputs.Template, userImportOptions.labels(), nil) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := userImportBody.OpenEditor( | ||
| cmd, | ||
| &inputs.UsersBody, | ||
| userImportOptions.getValue(inputs.Template), | ||
| inputs.Template+".*.json", | ||
| cli.userImportEditorHint, | ||
| ); err != nil { | ||
| return fmt.Errorf("failed to capture input from the editor: %w", err) | ||
| } | ||
| } | ||
|
|
||
| if canPrompt(cmd) { | ||
|
There was a problem hiding this comment. This gets skipped if we use --no-input. |
||
| var confirmed bool | ||
| if err := prompt.AskBool("Do you want to import these user(s)?", &confirmed, true); err != nil { | ||
| return fmt.Errorf("failed to capture prompt input: %w", err) | ||
| } | ||
| if !confirmed { | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| var usersBody []map[string]interface{} | ||
| if err := json.Unmarshal([]byte(inputs.UsersBody), &usersBody); err != nil { | ||
| return fmt.Errorf("invalid JSON input: %w", err) | ||
| } | ||
|
|
||
| job := &management.Job{ | ||
| ConnectionID: &inputs.ConnectionID, | ||
| Users: usersBody, | ||
| Upsert: &inputs.Upsert, | ||
| SendCompletionEmail: &inputs.SendCompletionEmail, | ||
| } | ||
|
|
||
| if err := ansi.Waiting(func() error { | ||
| return cli.api.Jobs.ImportUsers(job) | ||
| }); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| cli.renderer.Heading("started user import job") | ||
| cli.renderer.Infof("Job with ID '%s' successfully started.", ansi.Bold(job.GetID())) | ||
| cli.renderer.Infof("Run '%s' to get the status of the job.", ansi.Cyan("auth0 api jobs/"+job.GetID())) | ||
|
|
||
| if inputs.SendCompletionEmail { | ||
| cli.renderer.Infof("Results of your user import job will be sent to your email.") | ||
|
|
@@ -630,8 +642,10 @@ The file size limit for a bulk import is 500KB. You will need to start multiple | |
|
|
||
| userConnection.RegisterString(cmd, &inputs.Connection, "") | ||
| userImportTemplate.RegisterString(cmd, &inputs.Template, "") | ||
| userImportBody.RegisterString(cmd, &inputs.UsersBody, "") | ||
| userEmailResults.RegisterBool(cmd, &inputs.SendCompletionEmail, true) | ||
| userImportUpsert.RegisterBool(cmd, &inputs.Upsert, false) | ||
| cmd.MarkFlagsMutuallyExclusive("template", "users") | ||
|
|
||
| return cmd | ||
| } | ||
|
|
@@ -643,17 +657,15 @@ func formatUserDetailsPath(id string) string { | |
| return fmt.Sprintf("users/%s", id) | ||
| } | ||
|
|
||
| func (c *cli) dbConnectionPickerOptions() ([]string, error) { | ||
| list, err := c.api.Connection.List(management.Parameter("strategy", management.ConnectionStrategyAuth0)) | ||
|
There was a problem hiding this comment. We're improving the logic here by directly only retrieving database connections from the API instead of retrieving everything and then filtering them out. |
||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| var res []string | ||
| for _, conn := range list.Connections { | ||
| res = append(res, conn.GetName()) | ||
| } | ||
|
|
||
| if len(res) == 0 { | ||
|
|
@@ -666,9 +678,8 @@ func (c *cli) connectionPickerOptions() ([]string, error) { | |
| func (c *cli) getUserConnection(users *management.User) []string { | ||
| var res []string | ||
| for _, i := range users.Identities { | ||
| res = append(res, i.GetConnection()) | ||
| } | ||
| return res | ||
| } | ||
|
|
||
|
|
||
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
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.
If we don't pass a body directly, then we're gonna select a template and use the editor.