Make APE-`Chain` a part of `frostfs-api` #80

New issue

Open

opened 2025-02-07 12:37:23 +00:00 by aarifullin · 1 comment

aarifullin commented

2025-02-07 12:37:23 +00:00

Member

Currently, Chain is a standalone entity that is defined within policy-engine package.
At the same time, the entity Chain is also introduced in frostfs-sdk-go but SDK has no idea about real chain's internals:

// Chain is an SDK representation for v2's Chain.
//
// Note that Chain (as well as v2's Chain) and all related entities
// are NOT operated by Access-Policy-Engine (APE). The client is responsible
// to convert these types to policy-engine entities.
type Chain struct {
	// Raw is the encoded chain kind.
	// It assumes that Raw's bytes are the result of encoding provided by
	// policy-engine package.
	Raw []byte
}

Thus, that causes some difficulties between client-server interaction because non-GO client implementation is required to mirror policy-engine package and support the same data serialization/deserialization.
So, we should introduce Chain in frostfs-api and use generated types within frostfs-sdk-go and policy-engine.

Currently, [Chain](https://git.frostfs.info/TrueCloudLab/policy-engine/src/branch/master/pkg/chain/chain.go#L28-L34) is a standalone entity that is defined within [policy-engine](https://git.frostfs.info/TrueCloudLab/policy-engine) package. At the same time, the entity [Chain](https://git.frostfs.info/TrueCloudLab/frostfs-sdk-go/src/branch/master/ape/chain.go) is also introduced in `frostfs-sdk-go` but SDK has no idea about _real_ chain's internals: ```go // Chain is an SDK representation for v2's Chain. // // Note that Chain (as well as v2's Chain) and all related entities // are NOT operated by Access-Policy-Engine (APE). The client is responsible // to convert these types to policy-engine entities. type Chain struct { // Raw is the encoded chain kind. // It assumes that Raw's bytes are the result of encoding provided by // policy-engine package. Raw []byte } ``` Thus, that causes some difficulties between client-server interaction because non-GO client implementation is required to _mirror_ `policy-engine` package and support the same data [serialization/deserialization](https://git.frostfs.info/TrueCloudLab/policy-engine/src/branch/master/pkg/chain/chain.go#L37). So, we should introduce [Chain](https://git.frostfs.info/TrueCloudLab/policy-engine/src/branch/master/pkg/chain/chain.go#L28-L34) in `frostfs-api` and use generated types within `frostfs-sdk-go` and `policy-engine`.