-
Notifications
You must be signed in to change notification settings - Fork 83
Cross SDK public API surface alignment for creating containers #1280
Copy link
Copy link
Open
Labels
Area-DotNet-SDK.NET SDK APIs, native bindings, packaging, samples, or tests..NET SDK APIs, native bindings, packaging, samples, or tests.Area-Node-SDKNode.js and TypeScript SDK APIs, bindings, packaging, CLI integration, or tests.Node.js and TypeScript SDK APIs, bindings, packaging, CLI integration, or tests.Area-Rust-SDKPublic Rust SDK APIs and integration with the MXC execution engine.Public Rust SDK APIs and integration with the MXC execution engine.Issue-TaskEngineering, maintenance, or operational work that is not a bug or feature request.Engineering, maintenance, or operational work that is not a bug or feature request.Release v1.0Issues tracked for the version 1.0 releaseIssues tracked for the version 1.0 release
Description
Activity
Metadata
Metadata
Assignees
Labels
Area-DotNet-SDK.NET SDK APIs, native bindings, packaging, samples, or tests..NET SDK APIs, native bindings, packaging, samples, or tests.Area-Node-SDKNode.js and TypeScript SDK APIs, bindings, packaging, CLI integration, or tests.Node.js and TypeScript SDK APIs, bindings, packaging, CLI integration, or tests.Area-Rust-SDKPublic Rust SDK APIs and integration with the MXC execution engine.Public Rust SDK APIs and integration with the MXC execution engine.Issue-TaskEngineering, maintenance, or operational work that is not a bug or feature request.Engineering, maintenance, or operational work that is not a bug or feature request.Release v1.0Issues tracked for the version 1.0 releaseIssues tracked for the version 1.0 release
Description of the task
Right now we have the following matrix of API support:
SandboxRequestSandboxPolicySandboxRequestSandboxPolicyContainerConfigrun()Run()RunAsync()spawnSandboxAsync()spawn_sandbox()Spawn()mxc_ffifoundation and returns either NodeChildProcessorIPtyinterfacerun_state_aware_json()ProvisionSandbox()StartSandbox()StopSandbox()DeprovisionSandbox()provisionSandbox()startSandbox()stopSandbox()deprovisionSandbox()exec_sandbox()ExecInSandbox()ExecInSandboxAsync()execInSandbox()execInSandboxAsync()exec_attached()ExecInSandboxAttached()What we want at the completion of this issue
All node rust SDKs should use in proc mxc_ffi shared library for their api calls. Node is now set up to use the mxc_ffi layer however, the public facing APIs need to be updated to call into them rather than the mxc executables. NOTE: rust can stay synchronous for v1 while the other SDKs can have their both synchronous and *Async functions.
SandboxRequestV1SandboxRequestV1SandboxRequestV1Run()RunAsync()Run()RunAsync()spawn()Spawn()Spawn()provision_sandbox()start_sandbox()stop_sandbox()deprovision_sandbox()Provision_sandbox()StartSandbox()StopSandbox()DeprovisionSandbox()provisionSandbox()startSandbox()stopSandbox()deprovisionSandbox()exec_in_sandbox()ExecInSandbox()ExecInSandboxAsync()execInSandbox()execInSandboxAsync()exec_in_attached()ExecInSandboxAttached()execInSandboxAttached()Additional context
No response