Update tenant-gate.ts #475
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding a custom tenantgate option to support any tenant list checking function that returns a boolean value
nearlyjuly
requested review from
mistermoe,
csuwildcat,
thehenrytsai and
diehuxx
as code owners
diehuxx
previously approved these changes
Aug 16, 2023
There was a problem hiding this comment.
Thanks for the contribution @nearlyjuly ! You're right that we don't provide any explanation for custom tenant gating as far as I can find. I think a better place to provide an example is in the README. I'll push a commit to this PR in just a sec.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The list of tenant DIDs for a DWN may be anything from single figures to many hundreds (perhaps thousands?). It's likely that there will be a custom solution to manage large numbers in particular, to set permissions or create a tenant removal process. This draft PR is a suggestion to make this a little easier, by having a custom tenantGate that can be set using
tenantGate : new ExternalTenantGate(externalTenantCheck)when initialising the DWN instance.This would make it straightforward to pass in a function that checks if the DID is a tenant in any way, so long as the response is true or false.
Although it is straightforward to create a custom tenantGate, I feel this is a simple way to convey what is needed if someone is unfamiliar with this project.
(If this is not a massive issue then I'll delete)