feat: tuple write/delete cmd accepts file; deprecate tuple import

[gabrielbussolo]

aims to fix #161

validates if one of the conditions met: a file or the 3 arguments

➜  openfga-cli git:(161-add...) ✗ ./dist/fga tuple write 
Error: you need to specify either 3 arguments or a file

writing with a file

./dist/fga tuple write --store-id 01HB3AZ6RAAGHJQ9HKXV9C89SE --file file.json  
{
  "successful": [
    {
      "object":"document:Z",
      "relation":"reader",
      "user":"user:anne"
    },
    {
      "object":"document:Z",
      "relation":"reader",
      "user":"user:jones"
    },
    {
      "object":"document:Z",
      "relation":"reader",
      "user":"user:gabriel"
    }
  ],
  "failed":null
}

file: file.json

[
    {
        "user":"user:anne",
        "relation":"reader",
        "object":"document:Z"
    },
    {
        "user":"user:jones",
        "relation":"reader",
        "object":"document:Z"
    },
    {
        "user":"user:gabriel",
        "relation":"reader",
        "object":"document:Z"
    }
]

file.yaml

- user: "user:anne"
  relation: "reader"
  object: "document:Z"
- user: "user:jones"
  relation: "reader"
  object: "document:Z"
- user: "user:gabriel"
  relation: "reader"
  object: "document:Z"

keep the current behavior of insert with args:

➜  openfga-cli git:(161-add...) ✗ ./dist/fga tuple write user:hello reader document:Z
{}

there is no rule to warn if both are informed (file AND args) but args will be ignored

delete command works same

Deprecate tuple import command

 ./dist/fga tuple import --store-id 01HB3AZ6RAAGHJQ9HKXV9C89SE --file file.json
Command "import" is deprecated, use the write/delete command with the flag --file instead

Description

References

Review Checklist

• I have clicked on "allow edits by maintainers".
• I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
• The correct base branch is being used, if not main
• I have added tests to validate that the change in functionality is working as expected

[gabrielbussolo]

if you can take a look @rhamzeh ;D

[rhamzeh]

Thanks! Can I also ask you to run make format and make lint to make sure we got rid of any lint errors?

[rhamzeh]

@gabrielbussolo may I ask you to also update the README in this PR to document the new options for write and delete?

[gabrielbussolo]

@gabrielbussolo may I ask you to also update the README in this PR to document the new options for write and delete?

sure thing @rhamzeh, ill do it tomorrow ;D

[gabrielbussolo]

@gabrielbussolo may I ask you to also update the README in this PR to document the new options for write and delete?

Updated the README, also fixed the comments. ;D

There is a specific lint screaming at me:

➜  openfga-cli git:(161-add-support-for-specifying-a-list-of-tuples-to-delete) ✗ make lint
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest && golangci-lint run
# github.com/golangci/golangci-lint/cmd/golangci-lint
ld: warning: -bind_at_load is deprecated on macOS
cmd/tuple/delete.go:111:11: err113: do not define dynamic errors, use wrapped static errors instead: "fmt.Errorf(\"at least %d arg(s) are required OR the flag --%s\", n, flag)" (goerr113)
                        return fmt.Errorf("at least %d arg(s) are required OR the flag --%s", n, flag)
                               ^
make: *** [lint] Error 1

is asking to create a specific error for it, but on this case I dont think it makes sense once i need to format the error before I send it (same approach as the cobra.ExactArgs).

also, about the lint, it forces to create a const for a number, and its ok on some contexts, but when we have a function such as cobra.ExactArgs(3) its pretty explicit what it does, do imho we could ignore it.

the first one i didnt solved, the second one i created a const. What is the team approach on it?

[rhamzeh]

the first one i didnt solved, the second one i created a const. What is the team approach on it?

For both of these cases, it's safe to add a lint ignore.

• //nolint:goerr113 for the error (See here

  cli/cmd/store/create.go

  Line 62 in cb4adfe

  return nil, fmt.Errorf(`required flag(s) "name" not set`) //nolint:goerr113

  )
• //nolint:gomnd for the const (See here

  cli/cmd/query/check.go

  Line 58 in 48eb34c

  Args: cobra.ExactArgs(3), //nolint:gomnd

  )

Other than this lint issue, good to merge!

[gabrielbussolo]

Other than this lint issue, good to merge!

perfect, so its done @rhamzeh

[rhamzeh]

Thanks @gabrielbussolo!