TrueCloudLab/frostfs-contract
24
0
Fork 19
Code Issues 18 Pull requests Projects Releases 3 Activity Actions

nns: Mention domain in panic messages #98

Merged
fyrchik merged 1 commit from elebedeva/frostfs-contract:fix/nns-panic-message into master 2024-06-21 13:58:28 +00:00
Conversation 0 Commits 1 Files changed 2 +47 -25
elebedeva commented 2024-06-20 14:55:54 +00:00
Member
Copy link

Close #92

Output after fix:

  1. Domain name too short
❯ ./bin/frostfs-adm -c ./dev/adm/frostfs-adm.yml morph nns register --name x
unable to register domain: script failed (FAULT state) due to an error: at instruction 1403 (THROW): unhandled exception: "invalid domain name format: 'x': domain name too short: got = 1, min = 2"
  1. Domain name too long
❯ ./bin/frostfs-adm -c ./dev/adm/frostfs-adm.yml morph nns register --name makaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.ns
unable to register domain: script failed (FAULT state) due to an error: at instruction 1403 (THROW): unhandled exception: "invalid domain name format: 'makaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.ns': domain name too long: got = 264, max = 255"
  1. Invalid fragment in domain name
❯ ./bin/frostfs-adm -c ./dev/adm/frostfs-adm.yml morph nns register --name -makaroni.ns
unable to register domain: script failed (FAULT state) due to an error: at instruction 1403 (THROW): unhandled exception: "invalid domain name format: '-makaroni.ns': invalid fragment '-makaroni'"

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

Close #92 Output after fix: 1. Domain name too short ``` ❯ ./bin/frostfs-adm -c ./dev/adm/frostfs-adm.yml morph nns register --name x unable to register domain: script failed (FAULT state) due to an error: at instruction 1403 (THROW): unhandled exception: "invalid domain name format: 'x': domain name too short: got = 1, min = 2" ``` 2. Domain name too long ``` ❯ ./bin/frostfs-adm -c ./dev/adm/frostfs-adm.yml morph nns register --name makaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.ns unable to register domain: script failed (FAULT state) due to an error: at instruction 1403 (THROW): unhandled exception: "invalid domain name format: 'makaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.nsmakaroni.ns': domain name too long: got = 264, max = 255" ``` 3. Invalid fragment in domain name ``` ❯ ./bin/frostfs-adm -c ./dev/adm/frostfs-adm.yml morph nns register --name -makaroni.ns unable to register domain: script failed (FAULT state) due to an error: at instruction 1403 (THROW): unhandled exception: "invalid domain name format: '-makaroni.ns': invalid fragment '-makaroni'" ``` Signed-off-by: Ekaterina Lebedeva <ekaterina.lebedeva@yadro.com>
🚀 1
elebedeva requested review from storage-core-committers 2024-06-20 14:58:21 +00:00
elebedeva requested review from storage-core-developers 2024-06-20 14:58:25 +00:00
acid-ant reviewed 2024-06-21 07:13:56 +00:00
nns/nns_contract.go Outdated
@ -222,3 +222,3 @@
fragments := splitAndCheck(name)
if fragments == nil {
panic("invalid domain name format")
panic(getDomainNamePanicMessage(name))
acid-ant commented 2024-06-21 07:13:55 +00:00
Member
Copy link

How about to panic inside splitAndCheck and remove this and bellow if statements?

How about to panic inside `splitAndCheck` and remove this and bellow `if` statements?
elebedeva commented 2024-06-21 07:52:24 +00:00
Author
Member
Copy link

fixed

fixed
acid-ant marked this conversation as resolved
fyrchik requested changes 2024-06-21 07:26:34 +00:00
nns/nns_contract.go Outdated
@ -913,0 +914,4 @@
// getDomainNamePanicMessage returns panic message for invalid domain name containing
// mentioned domain name
func getDomainNamePanicMessage(name string) string {
msg := "invalid domain name format: '" + name + "'"
fyrchik commented 2024-06-21 07:26:29 +00:00
Owner
Copy link

You check something in splitAndCheck and then perform similar checks here.
They can diverge with time, so the message will cease reflecting the real error.

How about this:

  1. Check that if splitAndCheck returns nil we always panic.
  2. Move panic inside split and check and panic where the error occurs.
You check something in `splitAndCheck` and then perform similar checks here. They can diverge with time, so the message will cease reflecting the real error. How about this: 1. Check that if `splitAndCheck` returns nil we always `panic`. 2. Move panic inside split and check and panic where the error occurs.
elebedeva commented 2024-06-21 07:52:55 +00:00
Author
Member
Copy link

done

done
elebedeva force-pushed fix/nns-panic-message from 52bf87411c to a6c20b344c 2024-06-21 07:51:30 +00:00 Compare
elebedeva force-pushed fix/nns-panic-message from a6c20b344c to 4e2882394c 2024-06-21 07:54:56 +00:00 Compare
acid-ant requested changes 2024-06-21 08:11:46 +00:00
nns/nns_contract.go Outdated
@ -739,0 +724,4 @@
func checkDomainNameLength(name string) {
l := len(name)
if l > maxDomainNameLength {
panic(getDomainNamePanicMessage(name, "domain name too long: got = "+std.Itoa(len(name), 10)+", max = "+std.Itoa(maxDomainNameLength, 10)))
acid-ant commented 2024-06-21 08:10:38 +00:00
Member
Copy link

len(name) --> l

`len(name)` --> `l`
👍 1
nns/nns_contract.go Outdated
@ -739,0 +727,4 @@
panic(getDomainNamePanicMessage(name, "domain name too long: got = "+std.Itoa(len(name), 10)+", max = "+std.Itoa(maxDomainNameLength, 10)))
}
if l < minDomainNameLength {
panic(getDomainNamePanicMessage(name, "domain name too short: got = "+std.Itoa(len(name), 10)+", min = "+std.Itoa(minDomainNameLength, 10)))
acid-ant commented 2024-06-21 08:11:02 +00:00
Member
Copy link

len(name) --> l

`len(name)` --> `l`
👍 1
elebedeva force-pushed fix/nns-panic-message from 4e2882394c to b8efeec81c 2024-06-21 08:17:17 +00:00 Compare
acid-ant approved these changes 2024-06-21 08:21:00 +00:00
dstepanov-yadro approved these changes 2024-06-21 08:30:04 +00:00
achuprov approved these changes 2024-06-21 08:30:06 +00:00
fyrchik reviewed 2024-06-21 10:19:17 +00:00
nns/nns_contract.go Outdated
@ -913,0 +905,4 @@
// getDomainNamePanicMessage returns panic message for invalid domain name containing
// mentioned domain name
func getDomainNamePanicMessage(name string, problem string) string {
fyrchik commented 2024-06-21 10:19:17 +00:00
Owner
Copy link

IMO a separate function is useless.
It takes space in the byte code, even though it is basically a string concatenation.
The compiler is not clever enough to inline even though problem != "" can be derived statically.

How about removing this function and moving common string in the constant?

IMO a separate function is useless. It takes space in the byte code, even though it is basically a string concatenation. The compiler is not clever enough to inline even though `problem != ""` can be derived statically. How about removing this function and moving common string in the constant?
elebedeva commented 2024-06-21 12:32:42 +00:00
Author
Member
Copy link

Agree, removed getDomainNamePanicMessage() and added the constant

Agree, removed `getDomainNamePanicMessage()` and added the constant
fyrchik reviewed 2024-06-21 10:19:21 +00:00
fyrchik reviewed 2024-06-21 10:19:24 +00:00
elebedeva force-pushed fix/nns-panic-message from b8efeec81c to 439699236a 2024-06-21 12:31:24 +00:00 Compare
fyrchik approved these changes 2024-06-21 12:56:29 +00:00
elebedeva force-pushed fix/nns-panic-message from 439699236a to d70e971bd5 2024-06-21 13:02:12 +00:00 Compare
elebedeva force-pushed fix/nns-panic-message from d70e971bd5 to 49e5270f67 2024-06-21 13:13:03 +00:00 Compare
fyrchik merged commit 49e5270f67 into master 2024-06-21 13:58:28 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
acid-ant
dstepanov-yadro
achuprov
fyrchik
Labels
Clear labels   
P0

Highest

  
P1

High

  
P2

Medium

  
P3

Low

  
good first issue

Good for newcomers

  
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
good first issue
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-contract#98
No description provided.
Delete branch "elebedeva/frostfs-contract:fix/nns-panic-message"

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?