[NIT-2424] Improve error log when opening database

[gligneul]

No description provided.

[Tristan-Wilson]

LGTM

[ganeshvanahalli]

The detailed error logging could be extended to other databases such as arbitrumdata and wasm along with l2chaindata, if an error occurs while opening them.

To simplify checks when there is an error, I think its good to have a wrapper function like

func WrapDBErrors(dbName string, dbErr error) error {
	// Similar to the logic you have currently to check if a db is misplaced in parent/grandparent dir
}

[gligneul]

The detailed error logging could be extended to other databases such as arbitrumdata and wasm along with l2chaindata, if an error occurs while opening them.

To simplify checks when there is an error, I think its good to have a wrapper function like

I added a function called checkMisplacedDatabases to check all three databases.

[joshuacolvin0]

I would leave out the comment about persistent.chain and persistent.global-config. Most people wouldn't set it, and the people that do would most likely only set one of them. More likely that they mounted a directory incorrectly or had a bad tar file.

I think a better error message would be something like
fmt.Errorf("found %d unexpected files in database directory, including: %s", file_count, first_three_filenames)

[joshuacolvin0]

The detailed error logging could be extended to other databases such as arbitrumdata and wasm along with l2chaindata, if an error occurs while opening them.

To simplify checks when there is an error, I think its good to have a wrapper function like

func WrapDBErrors(dbName string, dbErr error) error {
	// Similar to the logic you have currently to check if a db is misplaced in parent/grandparent dir
}

If databases are in different directories, it isn't really possible to give a comprehensive error. I think it is better to just look for a single database across a couple parent directories, otherwise just output simple error

[ganeshvanahalli]

The detailed error logging could be extended to other databases such as arbitrumdata and wasm along with l2chaindata, if an error occurs while opening them.
To simplify checks when there is an error, I think its good to have a wrapper function like

func WrapDBErrors(dbName string, dbErr error) error {
	// Similar to the logic you have currently to check if a db is misplaced in parent/grandparent dir
}

If databases are in different directories, it isn't really possible to give a comprehensive error. I think it is better to just look for a single database across a couple parent directories, otherwise just output simple error

I agree, I meant to have a generalized function WrapDBErrors that can be used to add extra information when error occurs while opening a particular db, and not to check for each of them beforehand.
For example, in

nitro/cmd/nitro/init.go

Lines 295 to 298 in 2423bd8

	chainData, err := stack.OpenDatabaseWithFreezerWithExtraOptions("l2chaindata", config.Execution.Caching.DatabaseCache, config.Persistent.Handles, config.Persistent.Ancient, "l2chaindata/", false, persistentConfig.Pebble.ExtraOptions("l2chaindata"))
	if err != nil {
	return nil, nil, err
	}

instead of returning nil, nil, err, we could return nil, nil, WrapDBErrors("l2chaindata", err)

But if the check is only relevant to arbitrumdata, the generalization is not required.

[magicxyyz]

looks good, added one suggestion to the database dir misplacement checks

[magicxyyz]

LGTM

[ganeshvanahalli]

LGTM