TrueCloudLab/frostfs-node
20
1
Fork 27
Code Issues 93 Pull requests 4 Projects Releases 1 Activity Actions

WIP: Make notary support enabled by default in morph client #961

Closed
elebedeva wants to merge 2 commits from elebedeva/frostfs-node:feat/morph-default-notary-support into master
pull from: elebedeva/frostfs-node:feat/morph-default-notary-support
merge into: TrueCloudLab:master
Conversation 2 Commits 2 Files changed 8 +83 -58
elebedeva commented 2024-02-06 00:27:28 +00:00
Member
Copy link

Close #905

Notary support is enabled by default in morph client constructor. EnableNotarySupport() is marked as deprecated. Added DisableNotarySupport() method. Replaced panics with returned errors.

Tested with dev-env.

Signed-off-by: Ekaterina Lebedeva ekaterina.lebedeva@yadro.com

Close #905 Notary support is enabled by default in morph client constructor. `EnableNotarySupport()` is marked as `deprecated`. Added `DisableNotarySupport()` method. Replaced panics with returned errors. Tested with `dev-env`. Signed-off-by: Ekaterina Lebedeva <ekaterina.lebedeva@yadro.com>
elebedeva force-pushed feat/morph-default-notary-support from acd57e376a to 13645804b8 2024-02-06 15:11:45 +00:00 Compare
elebedeva force-pushed feat/morph-default-notary-support from 13645804b8 to a9b564a27e 2024-02-06 15:22:02 +00:00 Compare
elebedeva changed title from WIP: Make notary support enabled by default in morph client to Make notary support enabled by default in morph client 2024-02-06 15:35:01 +00:00
elebedeva requested review from storage-core-committers 2024-02-06 15:35:15 +00:00
elebedeva requested review from storage-core-developers 2024-02-06 15:35:16 +00:00
dstepanov-yadro reviewed 2024-02-06 15:41:33 +00:00
cmd/frostfs-node/morph.go Outdated
@ -72,15 +72,6 @@ func initMorphComponents(ctx context.Context, c *cfg) {
lookupScriptHashesInNNS(c) // smart contract auto negotiation
if c.cfgMorph.notaryEnabled {
dstepanov-yadro commented 2024-02-06 15:41:33 +00:00
Member
Copy link

c.cfgMorph.notaryEnabled is used after this? Can be deleted?

`c.cfgMorph.notaryEnabled` is used after this? Can be deleted?
👍 1
elebedeva commented 2024-02-20 12:54:41 +00:00
Author
Member
Copy link

replaced c.cfgMorph.notaryEnabled with c.cfgMorph.notaryDisabled, it is used to skip notary-related steps in non-notary environments.

replaced `c.cfgMorph.notaryEnabled` with `c.cfgMorph.notaryDisabled`, it is used to skip notary-related steps in non-notary environments.
dstepanov-yadro marked this conversation as resolved
fyrchik reviewed 2024-02-06 16:52:27 +00:00
pkg/innerring/initialization.go Outdated
@ -130,3 +122,4 @@
if !s.mainNotaryConfig.disabled {
// enable notary support in the main client
//lint:ignore SA1019 we need notary support enabled in main chain
fyrchik commented 2024-02-06 16:52:25 +00:00
Owner
Copy link

What is the problem here?

What is the problem here?
elebedeva commented 2024-02-20 13:44:09 +00:00
Author
Member
Copy link

I thought it was an appropriate case of using EnableNotarySupport() even if it's deprecated. Now it seems illogical (having in mind that if notary support is disabled - it must be on purpose) so i decided to return an error here instead.

I thought it was an appropriate case of using `EnableNotarySupport()` even if it's deprecated. Now it seems illogical (having in mind that if notary support is disabled - it must be on purpose) so i decided to return an `error` here instead.
fyrchik marked this conversation as resolved
pkg/morph/client/notary.go Outdated
@ -287,3 +338,3 @@
if c.notary == nil {
panic(notaryNotEnabledPanicMsg)
return errors.New(notaryNotEnabledErrMsg)
fyrchik commented 2024-02-06 16:16:16 +00:00
Owner
Copy link

What about a global var ErrNotaryNotEnabled = errors.New? It could exist alongside the message constant, if it is used anywhere else.

What about a global `var ErrNotaryNotEnabled = errors.New`? It could exist alongside the message constant, if it is used anywhere else.
elebedeva commented 2024-02-20 12:55:32 +00:00
Author
Member
Copy link

fixed.

fixed.
fyrchik marked this conversation as resolved
elebedeva force-pushed feat/morph-default-notary-support from a9b564a27e to e1301c90da 2024-02-20 08:57:38 +00:00 Compare
elebedeva force-pushed feat/morph-default-notary-support from e1301c90da to db61e5448a 2024-02-20 09:15:48 +00:00 Compare
acid-ant reviewed 2024-02-20 09:18:36 +00:00
cmd/frostfs-node/morph.go Outdated
@ -83,3 +75,2 @@
c.log.Info(logs.FrostFSNodeNotarySupport,
zap.Bool("sidechain_enabled", c.cfgMorph.notaryEnabled),
zap.Bool("sidechain_enabled", !c.cfgMorph.notaryDisabled),
acid-ant commented 2024-02-20 09:06:19 +00:00
Member
Copy link

Why not to rename sidechain_enabled too?

Why not to rename `sidechain_enabled` too?
elebedeva commented 2024-02-20 12:51:49 +00:00
Author
Member
Copy link

fixed.

fixed.
acid-ant marked this conversation as resolved
pkg/morph/client/notary.go Outdated
@ -78,6 +81,43 @@ func defaultNotaryConfig(c *Client) *notaryCfg {
// EnableNotarySupport creates notary structure in client that provides
// ability for client to get alphabet keys from committee or provided source
// and use proxy contract script hash to create tx for notary contract.
func (c *Client) enableNotarySupport(opts ...NotaryOption) error {
acid-ant commented 2024-02-20 09:18:28 +00:00
Member
Copy link

What the difference with EnableNotarySupport?

What the difference with `EnableNotarySupport`?
elebedeva commented 2024-02-20 14:11:04 +00:00
Author
Member
Copy link

It's the same EnableNotarySupport() but now it's called from Client constructor therefore there is no need to make it public.

It's the same `EnableNotarySupport()` but now it's called from `Client constructor` therefore there is no need to make it public.
acid-ant commented 2024-02-20 15:19:16 +00:00
Member
Copy link

Why not to remove it or call private from public? Why we need to duplicate code?

Why not to remove it or call private from public? Why we need to duplicate code?
elebedeva commented 2024-02-20 15:27:26 +00:00
Author
Member
Copy link

@aarifullin mentions it here:

To [enable notary support by default in morph client constructor], we need to invoke EnableNotarySupport in constructor, but at the same it would be better to make this method deprecated to notify client to stop using this invocation explictly.

I suggest to create enableNotarySupport, copy the definition to there

@aarifullin mentions it [here](https://git.frostfs.info/TrueCloudLab/frostfs-node/issues/905): > To [enable notary support by default in morph client constructor], we need to invoke `EnableNotarySupport` in constructor, but at the same it would be better to make this method `deprecated` to notify client to stop using this invocation explictly. > I suggest to create `enableNotarySupport`, copy the definition to there
acid-ant commented 2024-02-20 15:46:39 +00:00
Member
Copy link

Let's do like @aarifullin suggested:

func (c *Client) EnableNotarySupport(opts ...NotaryOption) error {
  return c.enableNotarySupport(opts...) // also use in the constructor
}
Let's do like @aarifullin suggested: ``` func (c *Client) EnableNotarySupport(opts ...NotaryOption) error { return c.enableNotarySupport(opts...) // also use in the constructor } ```
elebedeva commented 2024-02-20 15:49:41 +00:00
Author
Member
Copy link

fixed.

fixed.
acid-ant marked this conversation as resolved
elebedeva force-pushed feat/morph-default-notary-support from db61e5448a to 519e988798 2024-02-20 12:42:53 +00:00 Compare
elebedeva force-pushed feat/morph-default-notary-support from 519e988798 to 62e2e8881e 2024-02-20 12:49:43 +00:00 Compare
dstepanov-yadro approved these changes 2024-02-20 13:06:31 +00:00
elebedeva force-pushed feat/morph-default-notary-support from 62e2e8881e to ac36ae3c23 2024-02-20 15:30:33 +00:00 Compare
elebedeva force-pushed feat/morph-default-notary-support from ac36ae3c23 to 318a23d820 2024-02-20 15:48:41 +00:00 Compare
elebedeva force-pushed feat/morph-default-notary-support from 318a23d820 to ff0f029788 2024-02-20 15:50:27 +00:00 Compare
acid-ant approved these changes 2024-02-20 16:12:17 +00:00
aarifullin approved these changes 2024-02-21 10:34:02 +00:00
fyrchik approved these changes 2024-02-21 11:36:07 +00:00
pkg/innerring/initialization.go
@ -137,3 +123,1 @@
if err != nil {
return fmt.Errorf("could not enable main chain notary support: %w", err)
}
return fmt.Errorf("main chain notary support is disabled")
fyrchik commented 2024-02-21 11:35:12 +00:00
Owner
Copy link

Either the condition or the message is wrong, in this branch notary is enabled, but the message says it is disabled, why so?

Also, we could use errors.New here.

Either the condition or the message is wrong, in this branch notary is enabled, but the message says it is disabled, why so? Also, we could use `errors.New` here.
fyrchik commented 2024-02-21 11:37:29 +00:00
Owner
Copy link

Was it tested on dev-env? (container creation is enough)

Was it tested on dev-env? (container creation is enough)
elebedeva changed title from Make notary support enabled by default in morph client to WIP: Make notary support enabled by default in morph client 2024-02-21 16:26:18 +00:00
elebedeva commented 2024-03-26 08:11:36 +00:00
Author
Member
Copy link

While implementing this feature faced next problem in innerring:

  1. initialization of morph client now requires proxy contract

    • notary support is enabled in client's constructor
    • notary options must be passed to constructor
    • proxy contract is required notary option

  2. initialization of contracts requires morph client

Closing PR until solution is found.

While implementing this feature faced next problem in innerring: 1. initialization of morph client now requires proxy contract - notary support is enabled in client's constructor - notary options must be passed to constructor - proxy contract is required notary option 2. initialization of contracts requires morph client Closing PR until solution is found.
elebedeva closed this pull request 2024-03-26 08:11:49 +00:00
All checks were successful
DCO action / DCO (pull_request) Successful in 3m14s
Required
Details
Build / Build Components (1.21) (pull_request) Successful in 4m44s
Required
Details
Build / Build Components (1.20) (pull_request) Successful in 4m51s
Required
Details
Tests and linters / Lint (pull_request) Successful in 6m2s
Required
Details
Vulncheck / Vulncheck (pull_request) Successful in 10m18s
Required
Details
Tests and linters / Staticcheck (pull_request) Successful in 13m26s
Required
Details
Tests and linters / Tests (1.20) (pull_request) Successful in 13m47s
Required
Details
Tests and linters / Tests (1.21) (pull_request) Successful in 13m59s
Required
Details
Tests and linters / Tests with -race (pull_request) Successful in 3m35s
Required
Details

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No reviewers
dstepanov-yadro
acid-ant
aarifullin
fyrchik
Labels
Clear labels   
P0

Highest

  
P1

High

  
P2

Medium

  
P3

Low

  
badger

Badger DB related issues

  
frostfs-adm

   
frostfs-cli

   
frostfs-ir

   
frostfs-lens

   
frostfs-node

   
good first issue

Good for newcomers

  
triage
  
Infrastructure

Infrastructure, Automation, CI/CD or DevOps related stuff

  
blocked

The issue or PR is blocked by something

  
bug

Something is not working

  
config

Configuration format update or breaking change

  
discussion

Talking about something in order to reach a decision or to exchange ideas

  
documentation

Documentation related

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
go

Language features adoption

  
help wanted

Extra attention is needed

  
internal

   
invalid

Something is wrong

  
kludge

This is a kludge and we know it

  
observability

Related to metrics, tracing and logs

  
perfomance

Perfomance related

  
question

More information is needed

  
refactoring

Refactoring

  
wontfix

This won't be fixed

No labels
P0
P1
P2
P3
badger
frostfs-adm
frostfs-cli
frostfs-ir
frostfs-lens
frostfs-node
good first issue
triage
Infrastructure
blocked
bug
config
discussion
documentation
duplicate
enhancement
go
help wanted
internal
invalid
kludge
observability
perfomance
question
refactoring
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
5 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: TrueCloudLab/frostfs-node#961
No description provided.
Delete branch "elebedeva/frostfs-node:feat/morph-default-notary-support"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?