nspcc-dev/neofs-node

node: Refactor using `StorageEngine` in `Object` service

Open

#1,834 opened on Oct 4, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (49 forks)auto 404
I4S2U4enhancementgood first issueneofs-storage

Repository metrics

Stars
 (36 stars)
PR merge metrics
 (PR metrics pending)

Description

Object service server of storage node uses engine.StorageEngine type directly almost everywhere. Such code architecture doesn't allow to tune local storage behavior. For example, in #1798 there was a need to block all local operations, but on Object server only: Control service should still call the engine.

I propose to refactor engine's usage as it done it ObjectService.Put server

https://github.com/nspcc-dev/neofs-node/blob/4eb0ed11f8e56beee3dfbee632cb4b9cad3bb47c/pkg/services/object/put/local.go#L11-L16

Each component should precisely document expected behavior of local object storage by itself via locally defined interface. As a bonus, instance can be easily mocked for testing.

Contributor guide

Research direction
Examine the existing `ObjectService.Put` server implementation as a model, then apply similar interface abstraction to other components in the Object service.
Tech stack
go
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75