Add option to hide successful tuple imports and display import summary

[Siddhant-K-code]

Description

This PR adds a new flag --hide-imported-tuples to the tuple write command that improves the output handling for large tuple imports.

tl;dr; Changes:

• Add --hide-imported-tuples flag to suppress successful import output
• Return total_count, failed_count, successful_count processed
• Always show failed tuples even when hiding successful ones (for debugging purpose)
• Add a test for the new functionality

Example usage:

fga tuple write --store-id=01H0H015178Y2V4CX10C2KGHF4 --file tuples.json --hide-imported-tuples

Example outputs:

With successful imports (without --hide-imported-tuples):

{
  "successful": [
    {
      "user": "user:anne",
      "relation": "viewer",
      "object": "document:roadmap"
    }
  ],
  "failed_count":0,
  "successful_count":1,
  "total_count":1
}

With failed imports:

{
  "failed": [
    {
      "tuple_key": {
        "user": "user:carl",
        "relation": "writer",
        "object": "document:roadmap"
      },
      "reason": "Write validation error ..."
    }
  ],
  "failed_count":1,
  "successful_count":0,
  "total_count":1
}

References

fixes #376

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] - Enhance documentation for tuple write command output format openfga.dev#926
• 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

[aaguiarz]

Thanks a lot @Siddhant-K-code!

Can you change it to output something like:

{
"total_count": 24,
"failed": [
{
"tuple_key": {
"object":"document:roadmap",
"relation":"writer",
"user":"carl"
},
"reason":"Write validation error ..."
}
]
}

So, we always detail the errors, as they are valuable, and output to the total count.

[Siddhant-K-code]

@aaguiarz do you think, we should remove the separate txt summary from below?

[aaguiarz]

Yes, let's remove it, so we keep it a json output that can be easily parsed if needed

[Siddhant-K-code]

lint fixes 🫠

[Siddhant-K-code]

💭 total_count could be ambiguous, I think we can also return successful_count & failed_count with it (everytime). Wdyt @aaguiarz ?

[aaguiarz]

@Siddhant-K-code yeah, I like that more :)

[Siddhant-K-code]

@aaguiarz, We are good to go now 🚀

do you think, we should also add this to the documentation?

[aaguiarz]

@Siddhant-K-code yes, it should be added to the documentation, thanks in advance for that!

[Siddhant-K-code]

@aaguiarz, I've raised the docs PR, here: openfga/openfga.dev#926

[Siddhant-K-code]

I think, we are good to release it now, after release, we can merge the docs PR.
Let me know if there are any blockers on this one.

[ewanharris]

This looks good, thanks @Siddhant-K-code!

Would you mind squashing into a single commit?

[stacklok-cloud]

Minder Vulnerability Report ✅

Minder analyzed this PR and found it does not add any new vulnerable dependencies.

Vulnerability scan of bd62defd:

• 🐞 vulnerable packages: 0
• 🛠 fixes available for: 0

[Siddhant-K-code]

@ewanharris, it is good to go now 🚀