feat(sdk): Call init if obligations are empty.

[c-r33d]

Proposed Changes

1.) Call Init if obligations are empty, instead of throwing an error. Only return an error if we do not have any required obligations returned from the server. (Note: It's possible there is no error and no required obligations, which the code handles.)
2.) Rename return object type from Obligations to RequiredObligations

Important

Since the goal of the Obligations() function
is to return the required obligations on the TDF
do not return an error if we have greater than 0 obligation fqns.

This is to avoid confusion for downstream peps that just want to know
the required obligations for the TDF.

It's possible that we have a RewrapForbidden error because of obligations
in which we should not return that to the consumer of the SDK, just that
these are the required obligations.

Checklist

• I have added or updated unit tests
• I have added or updated integration tests (if appropriate)
• I have added or updated documentation

Testing Instructions

[gemini-code-assist]

Summary of Changes

Hello @c-r33d, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the SDK's handling of TDF and NanoTDF obligations by introducing a more resilient mechanism for their retrieval. Instead of failing when obligations are not pre-populated, the system will now proactively attempt to initialize them via an Init() call. This improvement streamlines the process of accessing obligations, making the SDK more robust and user-friendly by reducing the need for explicit pre-initialization checks.

Highlights

• Automatic Obligation Initialization: The Obligations method in both NanoTDFReader and Reader (for TDF and NanoTDF respectively) will now automatically call Init() to populate requiredObligations if they are found to be empty. This change prevents an error from being returned and ensures that obligations are always attempted to be retrieved, potentially triggering a rewrap call.
• Error Handling Simplification: The ErrObligationsNotPopulated error has been removed from the SDK, as the new logic handles the case where obligations are not yet populated by attempting to initialize them.
• Test Case Updates: Existing test cases in sdk/nanotdf_test.go and sdk/tdf_test.go have been updated to reflect this new behavior. Specifically, tests now expect NoError when calling Obligations even if they weren't explicitly populated beforehand, and a new fakeObligationFQN constant was introduced for testing purposes. The handleRewrapRequest in nanotdf_test.go now includes metadata with obligations.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

---

Obligations wait, Init called, a new rewrap, Data flows freely.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request enhances the SDK by modifying the Obligations method in both TDFReader and NanoTDFReader. The method now automatically calls Init() to fetch obligations if they aren't already populated, which improves the developer experience. The implementation correctly handles cases where Init() might fail but still return the necessary obligations, for instance, during a rewrap failure. The accompanying test updates are thorough and validate the new behavior. My feedback consists of minor suggestions to improve comment clarity for better long-term maintainability.

[github-actions]

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	175.553469ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	108.082265ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric	Value
Total Decrypts	100
Successful Decrypts	100
Failed Decrypts	0
Total Time	358.431791ms
Throughput	278.99 requests/second

TDF3 Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	38.885920067s
Average Latency	387.531392ms
Throughput	128.58 requests/second

NANOTDF Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	27.492818406s
Average Latency	274.003286ms
Throughput	181.87 requests/second

[github-actions]

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	183.497539ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	101.632012ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric	Value
Total Decrypts	100
Successful Decrypts	100
Failed Decrypts	0
Total Time	359.802327ms
Throughput	277.93 requests/second

TDF3 Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	39.598849742s
Average Latency	394.848278ms
Throughput	126.27 requests/second

NANOTDF Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	27.762424137s
Average Latency	276.483077ms
Throughput	180.10 requests/second

[github-actions]

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	167.171457ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	92.627624ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric	Value
Total Decrypts	100
Successful Decrypts	100
Failed Decrypts	0
Total Time	373.005689ms
Throughput	268.09 requests/second

TDF3 Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	39.01203789s
Average Latency	387.97915ms
Throughput	128.17 requests/second

NANOTDF Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	27.136907146s
Average Latency	270.481186ms
Throughput	184.25 requests/second

Invalidated by push of 33881f8

[github-actions]

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	169.590886ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric	Value
Approved Decision Requests	1000
Denied Decision Requests	0
Total Time	95.808937ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric	Value
Total Decrypts	100
Successful Decrypts	100
Failed Decrypts	0
Total Time	357.522655ms
Throughput	279.70 requests/second

TDF3 Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	38.481750076s
Average Latency	383.07036ms
Throughput	129.93 requests/second

NANOTDF Benchmark Results:

Metric	Value
Total Requests	5000
Successful Requests	5000
Failed Requests	0
Concurrent Requests	50
Total Time	27.267774985s
Average Latency	271.939533ms
Throughput	183.37 requests/second

[github-actions]

X-Test Failure Results

opentdfplatform7XXVE3.dockerbuild
cukes-report
✅ js-v0.4.34
✅ go-v0.4.34
bats-test-results
test-cases-mapping-report
✅ js-pull-2825
✅ java-pull-2825
✅ go-pull-2825

[github-actions]

X-Test Failure Results

opentdfplatform7XXVE3.dockerbuild
cukes-report
✅ js-v0.4.34
✅ go-v0.4.34
bats-test-results
test-cases-mapping-report
✅ js-pull-2825
✅ java-pull-2825
✅ go-pull-2825
✅ java-v0.4.34