Refactor and improve users import cmd #735

sergiught · 2023-04-13T12:10:43Z

🔧 Changes

This PR brings various improvements to the users import command. Additional context added within code comments below.

📚 References

🔬 Testing

📝 Checklist

All new/changed/fixed functionality is covered by tests (or N/A)
I have added documentation for all new/changed functionality (or N/A)

sergiught · 2023-04-13T12:31:06Z

docs/auth0_users_import.md

@@ -18,9 +18,15 @@ auth0 users import [flags]
 ```
  auth0 users import
  auth0 users import --connection "Username-Password-Authentication"
+  auth0 users import --connection "Username-Password-Authentication" --users-body "[]"


The biggest change here is the exposure of the users body flag. Previously this was hidden and only used to store the contents of the file opened up through the editor. We're now allowing users to pass the body directly bypassing the template selection. This change also enables us to add automated integration tests and improves DX.

This data should also be able to be passed by pipe, like in other similar commands.

Thanks @Widcket 👍🏻 good catch. Updated in 735e93f (#735)

The docs should also be updated to include a piped example, like in auth0 rules create or auth0 api.

1d66957 (#735)

sergiught · 2023-04-13T12:32:14Z

internal/cli/users.go

-			if editorErr != nil {
-				return fmt.Errorf("Failed to capture input from the editor: %w", editorErr)
-			}
+			if inputs.UsersBody == "" {


If we don't pass a body directly, then we're gonna select a template and use the editor.

sergiught · 2023-04-13T12:32:31Z

internal/cli/users.go

 			}

-			if !confirmed {
-				return nil
+			if canPrompt(cmd) {


This gets skipped if we use --no-input.

sergiught · 2023-04-13T12:33:13Z

internal/cli/users.go

-
-	list, err := c.api.Connection.List()
+func (c *cli) dbConnectionPickerOptions() ([]string, error) {
+	list, err := c.api.Connection.List(management.Parameter("strategy", management.ConnectionStrategyAuth0))


We're improving the logic here by directly only retrieving database connections from the API instead of retrieving everything and then filtering them out.

sergiught · 2023-04-13T12:33:32Z

internal/cli/users_test.go

@@ -52,25 +52,6 @@ func TestConnectionsPickerOptions(t *testing.T) {
 				assert.ErrorContains(t, err, "There are currently no database connections.")
 			},
 		},
-		{
-			name: "no database connections",


No longer needed as we retrieve only database conns directly from the API.

codecov-commenter · 2023-04-13T12:59:56Z

Codecov Report

Patch coverage: 57.74% and project coverage change: +0.22 🎉

Comparison is base (59a0cad) 70.60% compared to head (de8a9a4) 70.82%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #735      +/-   ##
==========================================
+ Coverage   70.60%   70.82%   +0.22%     
==========================================
  Files          87       87              
  Lines       11197    11210      +13     
==========================================
+ Hits         7906     7940      +34     
+ Misses       2778     2750      -28     
- Partials      513      520       +7

Impacted Files	Coverage Δ
internal/cli/users.go	`74.63% <57.74%> (+5.19%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Widcket · 2023-04-13T13:01:42Z

internal/cli/users.go

-		LongForm:   "template-body",
+	userImportBody = Flag{
+		Name:       "Users Body",
+		LongForm:   "users-body",


Is this a flag name pattern we use in the CLI ("resource-property"), for this kind of input?

For the rules script, we use script:

For the data passed to the api command, we use data:

Thanks for raising this. I actually think we're lacking a bit of consistency in these areas. Would you suggest just naming this users so it's clear what kind of content it is? Or perhaps rename the others to rules-script for example?

I think that we should prefer shorter flag names wherever possible, for usability reasons. Also I suspect changing this pattern to "resources-property" would cause a bigger inconsistency, requiring the renaming of a lot more flags.

users is fine for this, I think.

Renamed it to users in c092246 (#735).

But I also removed the short form as it was conflicting and replacing it with anything else than u doesn't really work so well.

Consider having -u be the short form for users and -U the short version for upsert.

Good point 👍🏻 de8a9a4 (#735)

For some reason I thought short forms had to always be lower case.

willvedd

Large improvement!

sergiught force-pushed the patch/users-import branch 2 times, most recently from 3933e6a to 538b6bf Compare April 13, 2023 12:29

sergiught commented Apr 13, 2023

View reviewed changes

sergiught marked this pull request as ready for review April 13, 2023 12:33

sergiught requested a review from a team as a code owner April 13, 2023 12:33

sergiught requested a review from Widcket April 13, 2023 12:57

Widcket reviewed Apr 13, 2023

View reviewed changes

sergiught requested a review from Widcket April 13, 2023 13:23

Widcket approved these changes Apr 13, 2023

View reviewed changes

sergiught added 7 commits April 13, 2023 17:13

Refactor and improve users import cmd

d161b02

Add ability to pipe data to users import job

25b30dc

Bump docs

d2afaaa

Rename flag users-body to users in users import cmd

b7c3c13

Add short form for users flag in users import cmd

81886fe

Remove short form in upset and email-results flags in users import cmd

990c398

Update docs

7f4744c

sergiught force-pushed the patch/users-import branch 3 times, most recently from 527cce8 to 6caee69 Compare April 13, 2023 16:21

Update tests

19b6a0c

sergiught force-pushed the patch/users-import branch from 6caee69 to 19b6a0c Compare April 13, 2023 16:32

willvedd approved these changes Apr 13, 2023

View reviewed changes

sergiught merged commit be546f2 into main Apr 13, 2023

sergiught deleted the patch/users-import branch April 13, 2023 17:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor and improve users import cmd #735

Refactor and improve users import cmd #735

sergiught commented Apr 13, 2023 •

edited

Loading

sergiught Apr 13, 2023

Widcket Apr 13, 2023 •

edited

Loading

sergiught Apr 13, 2023

Widcket Apr 13, 2023

sergiught Apr 13, 2023

sergiught Apr 13, 2023

sergiught Apr 13, 2023

sergiught Apr 13, 2023

sergiught Apr 13, 2023

codecov-commenter commented Apr 13, 2023 •

edited

Loading

Widcket Apr 13, 2023

sergiught Apr 13, 2023 •

edited

Loading

Widcket Apr 13, 2023

sergiught Apr 13, 2023 •

edited

Loading

Widcket Apr 13, 2023

sergiught Apr 13, 2023

willvedd left a comment

Refactor and improve users import cmd #735

Refactor and improve users import cmd #735

Conversation

sergiught commented Apr 13, 2023 • edited Loading

🔧 Changes

📚 References

🔬 Testing

📝 Checklist

Choose a reason for hiding this comment

Widcket Apr 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Apr 13, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

sergiught Apr 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergiught Apr 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willvedd left a comment

Choose a reason for hiding this comment

sergiught commented Apr 13, 2023 •

edited

Loading

Widcket Apr 13, 2023 •

edited

Loading

codecov-commenter commented Apr 13, 2023 •

edited

Loading

sergiught Apr 13, 2023 •

edited

Loading

sergiught Apr 13, 2023 •

edited

Loading