Add option to hide successful tuple imports and display import summary (#437)

Author: ewanharris

cmd/tuple/write.go

@@ -32,6 +32,14 @@ import (
 
 const writeCommandArgumentsCount = 3
 
+var hideImportedTuples bool
+
+type ImportStats struct {
+	TotalTuples      int
+	SuccessfulTuples int
+	FailedTuples     int
+}
+
 // writeCmd represents the write command.
 var writeCmd = &cobra.Command{
 	Use:   "write",
@@ -142,7 +150,21 @@ func writeTuplesFromFile(flags *flag.FlagSet, fgaClient *client.OpenFgaClient) e
 		return err
 	}
 
-	return output.Display(response) //nolint:wrapcheck
+	outputResponse := make(map[string]interface{})
+
+	if !hideImportedTuples && len(response.Successful) > 0 {
+		outputResponse["successful"] = response.Successful
+	}
+
+	if len(response.Failed) > 0 {
+		outputResponse["failed"] = response.Failed
+	}
+
+	outputResponse["total_count"] = len(tuples)
+	outputResponse["successful_count"] = len(response.Successful)
+	outputResponse["failed_count"] = len(response.Failed)
+
+	return output.Display(outputResponse) //nolint:wrapcheck
 }
 
 func init() {
@@ -152,4 +174,5 @@ func init() {
 	writeCmd.Flags().String("condition-context", "", "Condition Context (as a JSON string)")
 	writeCmd.Flags().Int32("max-tuples-per-write", MaxTuplesPerWrite, "Max tuples per write chunk.")
 	writeCmd.Flags().Int32("max-parallel-requests", MaxParallelRequests, "Max number of requests to issue to the server in parallel.")
+	writeCmd.Flags().BoolVar(&hideImportedTuples, "hide-imported-tuples", false, "Hide successfully imported tuples from output")
 }

tests/tuple-test-cases.yaml

@@ -14,3 +14,11 @@ tests:
     stdout:
       json:
         successful.0.user: "user:anne"
+  003 - it shows only counts when hide-imported-tuples is true:
+    command: fga tuple write --file=./tests/fixtures/basic-tuples.json --hide-imported-tuples --store-id=$(./tests/scripts/test-data/get-store-id.sh) --model-id=$(./tests/scripts/test-data/get-model-id.sh)
+    exit-code: 0
+    stdout:
+      json:
+        total_count: "1"
+        successful_count: "1"
+        failed_count: "0"