feat: add is-allowed API to JS, Python, and Go SDKs#221
Open
feat: add is-allowed API to JS, Python, and Go SDKs#221
Conversation
Three new endpoints across all SDKs:
- checkCvmIsAllowed: POST /cvms/{cvmId}/is-allowed
- checkAppIsAllowed: POST /apps/{appId}/is-allowed
- checkAppCvmsIsAllowed: POST /apps/{appId}/cvms/is-allowed (batch)
Contributor
📋 Check Results✨ JS SDK - Code FormattingShow format check results🔍 JS SDK - TypeScript Type CheckShow type check output🧪 JS SDK - Test ResultsShow test output📝 JS SDK - Lint CheckShow lint results🌐 JS SDK - Browser CompatibilityShow browser test results🌐 Browser Compatibility ReportBrowser compatibility tests completed across:
The SDK has been verified to work in modern browser environments. Check run: https://github.com/Phala-Network/phala-cloud/actions/runs/23397583430 |
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+231
to
+232
| class CheckCvmIsAllowedRequest(CloudModel): | ||
| cvm_id: str = Field(..., alias="cvmId") |
There was a problem hiding this comment.
Bug: The new request models lack populate_by_name=True, causing them to reject idiomatic snake_case arguments and only accept camelCase aliases, which will lead to ValidationError for SDK users.
Severity: HIGH
Suggested Fix
Update the base class for CheckCvmIsAllowedRequest, CheckAppIsAllowedRequest, and CheckAppCvmsIsAllowedRequest to one that includes populate_by_name=True in its Pydantic model configuration, similar to the existing _AliasModel. Alternatively, add ConfigDict(populate_by_name=True) to each of the new models directly.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: python/src/phala_cloud/models/cvms.py#L231-L232
Potential issue: The new request models `CheckCvmIsAllowedRequest`,
`CheckAppIsAllowedRequest`, and `CheckAppCvmsIsAllowedRequest` inherit from
`CloudModel`, which does not set `populate_by_name=True` in its Pydantic configuration.
In Pydantic v2, this means that fields with an alias, such as `cvm_id: str = Field(...,
alias="cvmId")`, can only be populated using the alias name (`"cvmId"`). Consequently,
when SDK users attempt to instantiate these models using idiomatic Python snake_case
arguments (e.g., `cvm_id="..."`), a `ValidationError` will be raised at runtime,
breaking the functionality of the associated API client methods.
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Three new actions across all three SDKs for checking on-chain DStack App contract allowance:
checkCvmIsAllowed—POST /cvms/{cvmId}/is-allowed(single CVM, optional param overrides)checkAppIsAllowed—POST /apps/{appId}/is-allowed(pure contract query)checkAppCvmsIsAllowed—POST /apps/{appId}/cvms/is-allowed(batch all CVMs under app)JS (
sdks/js/)src/actions/cvms/check_cvm_is_allowed.tssrc/actions/apps/check_app_is_allowed.tssrc/actions/apps/check_app_cvms_is_allowed.tsIsAllowedResultSchema/IsAllowedResulttypePython (
sdks/python/)models/cvms.py:IsAllowedResult,AppCvmsBatchIsAllowedResponse, request typesfull_client.pywith safe variantsGo (
sdks/go/)types_cvms.go:IsAllowedResult,CheckCvmIsAllowedRequest,AppCvmsBatchIsAllowedResponsecvms.goandapps.goTest plan
go build+go vet+go testpass