feat: add JSONL tuple import support (#530)

* Add jsonl support for tuple write

* Add condition to JSONL integration fixture

* Update basic model and fixture files

* fix wrapcheck warning

* Update JSONL fixture user

Author: aaguiarz

README.md

@@ -708,7 +708,7 @@ fga tuple **write** <user> <relation> <object> --store-id=<store-id>
 * `--condition-context`: Condition context (optional)
 * `--store-id`: Specifies the store id
 * `--model-id`: Specifies the model id to target (optional)
-* `--file`: Specifies the file name, `json`, `yaml` and `csv` files are supported
+* `--file`: Specifies the file name, `json`, `jsonl`, `yaml` and `csv` files are supported
 * `--max-tuples-per-write`: Max tuples to send in a single write (optional, default=1, or 40 if `--max-rps` is set and this flag is omitted)
 * `--max-parallel-requests`: Max requests to send in parallel (optional, default=4, or `max-rps/5` if `--max-rps` is set and this flag is omitted)
 * `--hide-imported-tuples`: When importing from a file, do not output successfully imported tuples in the command output (optional, default=false)
@@ -757,6 +757,14 @@ If using a `yaml` file, the format should be:
   object: folder:product-2021Q1
 ```
 
+If using a `jsonl` file, the format should be:
+
+```jsonl
+{"user": "user:anne", "relation": "owner", "object": "folder:product"}
+{"user": "folder:product", "relation": "parent", "object": "folder:product-2021", "condition": {"name": "inOfficeIP", "context": {"ip_addr": "10.0.0.1"}}}
+{"user": "user:beth", "relation": "viewer", "object": "folder:product-2021"}
+```
+
 If using a `json` file, the format should be:
 
 ```json
@@ -845,7 +853,7 @@ fga tuple **delete** <user> <relation> <object> --store-id=<store-id>
 * `<object>`: Object
 * `--store-id`: Specifies the store id
 * `--model-id`: Specifies the model id to target (optional)
-* `--file`: Specifies the file name, `yaml` and `json` files are supported
+* `--file`: Specifies the file name, `yaml`, `json`, and `jsonl` files are supported
 * `--max-tuples-per-write`: Max tuples to send in a single write (optional, default=1)
 * `--max-parallel-requests`: Max requests to send in parallel (optional, default=4)
 

cmd/tuple/delete_test.go

@@ -120,6 +120,27 @@ func TestDeleteTuplesFileData(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "it can correctly parse a jsonl file",
+			file: "testdata/tuples.jsonl",
+			expectedTuples: []openfga.TupleKeyWithoutCondition{
+				{
+					User:     "user:anne",
+					Relation: "owner",
+					Object:   "folder:product",
+				},
+				{
+					User:     "folder:product",
+					Relation: "parent",
+					Object:   "folder:product-2021",
+				},
+				{
+					User:     "user:beth",
+					Relation: "viewer",
+					Object:   "folder:product-2021",
+				},
+			},
+		},
 		{
 			name: "it can correctly parse a yaml file",
 			file: "testdata/tuples.yaml",
@@ -179,6 +200,11 @@ func TestDeleteTuplesFileData(t *testing.T) {
 			file:          "testdata/tuples_empty.json",
 			expectedError: "failed to parse input tuples: tuples file is empty (json)",
 		},
+		{
+			name:          "empty jsonl file should throw a warning",
+			file:          "testdata/tuples_empty.jsonl",
+			expectedError: "failed to parse input tuples: tuples file is empty (jsonl)",
+		},
 		{
 			name:          "empty yaml file should throw a warning",
 			file:          "testdata/tuples_empty.yaml",

cmd/tuple/testdata/tuples.jsonl

@@ -0,0 +1,3 @@
+{"user":"user:anne","relation":"owner","object":"folder:product"}
+{"user":"folder:product","relation":"parent","object":"folder:product-2021","condition":{"name":"inOfficeIP","context":{"ip_addr":"10.0.0.1"}}}
+{"user":"user:beth","relation":"viewer","object":"folder:product-2021"}

cmd/tuple/testdata/tuples_empty.jsonl

@@ -148,6 +148,31 @@ func TestParseTuplesFileData(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "it can correctly parse a jsonl file",
+			file: "testdata/tuples.jsonl",
+			expectedTuples: []client.ClientTupleKey{
+				{
+					User:     "user:anne",
+					Relation: "owner",
+					Object:   "folder:product",
+				},
+				{
+					User:     "folder:product",
+					Relation: "parent",
+					Object:   "folder:product-2021",
+					Condition: &openfga.RelationshipCondition{
+						Name:    "inOfficeIP",
+						Context: &map[string]interface{}{"ip_addr": "10.0.0.1"},
+					},
+				},
+				{
+					User:     "user:beth",
+					Relation: "viewer",
+					Object:   "folder:product-2021",
+				},
+			},
+		},
 		{
 			name: "it can correctly parse a yaml file",
 			file: "testdata/tuples.yaml",

cmd/tuple/write_test.go

@@ -1,6 +1,9 @@
 package tuplefile
 
 import (
+	"bufio"
+	"bytes"
+	"encoding/json"
 	"fmt"
 	"os"
 	"path"
@@ -26,6 +29,8 @@ func ReadTupleFile(fileName string) ([]client.ClientTupleKey, error) {
 		if err == nil && len(tuples) == 0 {
 			err = clierrors.EmptyTuplesFileError(strings.TrimPrefix(path.Ext(fileName), "."))
 		}
+	case ".jsonl":
+		err = parseTuplesFromJSONL(data, &tuples)
 	case ".csv":
 		err = parseTuplesFromCSV(data, &tuples)
 	default:
@@ -38,3 +43,37 @@ func ReadTupleFile(fileName string) ([]client.ClientTupleKey, error) {
 
 	return tuples, nil
 }
+
+func parseTuplesFromJSONL(data []byte, tuples *[]client.ClientTupleKey) error {
+	scanner := bufio.NewScanner(bytes.NewReader(data))
+	lineNum := 0
+
+	for scanner.Scan() {
+		lineNum++
+
+		line := strings.TrimSpace(scanner.Text())
+		if line == "" {
+			continue
+		}
+
+		var tuple client.ClientTupleKey
+
+		err := json.Unmarshal([]byte(line), &tuple)
+		if err != nil {
+			return fmt.Errorf("failed to read tuple from jsonl file on line %d: %w", lineNum, err)
+		}
+
+		*tuples = append(*tuples, tuple)
+	}
+
+	err := scanner.Err()
+	if err != nil {
+		return fmt.Errorf("failed to read jsonl file: %w", err)
+	}
+
+	if len(*tuples) == 0 {
+		return clierrors.EmptyTuplesFileError("jsonl") //nolint:wrapcheck
+	}
+
+	return nil
+}

internal/tuplefile/read.go

@@ -5,4 +5,8 @@ type user
 
 type group
   relations
-    define owner: [user]
+    define owner: [user, user with inOfficeIP]
+
+condition inOfficeIP(ip_addr: ipaddress) {
+  ip_addr.in_cidr("192.168.0.0/24")
+}

tests/fixtures/basic-model.fga

@@ -4,4 +4,4 @@
         "relation": "owner",
         "object": "group:foo"
     }
-]
+]

tests/fixtures/basic-tuples.json

@@ -0,0 +1,2 @@
+{"user": "user:bob", "relation": "owner", "object": "group:foo", "condition": {"name": "inOfficeIP", "context": {"ip_addr": "10.0.0.1"}}}
+

tests/fixtures/basic-tuples.jsonl

@@ -8,6 +8,12 @@ tests:
     stdout:
       json:
         successful.0.user: "user:anne"
+  001b - it successfully writes tuples to a store using jsonl:
+    command: fga tuple write --file=./tests/fixtures/basic-tuples.jsonl --max-tuples-per-write=1 --max-parallel-requests=1 --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:
+        successful.0.user: "user:bob"
   002 - it successfully deletes tuples from a store:
     command: fga tuple delete --file=./tests/fixtures/basic-tuples.json --max-tuples-per-write=1 --max-parallel-requests=1 --store-id=$(./tests/scripts/test-data/get-store-id.sh) --model-id=$(./tests/scripts/test-data/get-model-id.sh)
     exit-code: 0