Fix BB-760 : When elasticsearch configuration is missing, server crashes

[Tarunmeena0901]

Problem

BB-760

Solution

As the reason behind the crashing of BB server was the absence of elastic search configuration in our configuration template , I added some checks just before we are initializng the search server in app.js .
Those checks will ensure incase of missing configuration elastic search will still get some hardcoded configuration which will prevent it from crashing on initializing

and also incase of missing configuration error will be logged in console and a warning banner will be displayed on homepage

Areas of Impact

• ./src/server/app.js
• ./src/api/app.js

[MonkeyDo]

Sorry for the long delay!
I have some suggestions to simplify the code a bit and deduplicate some code:

[MonkeyDo]

Since this code is duplicated in api/app.js, it would make more sense to implement all this default config fallback code in search.init instead.

[MonkeyDo]

This is going to be true even though search was initialized with a default configuration, no?
In that case the messages below could be misleading as search could be available with default config.

I propose we do something like for the auth setup and make search.init return a boolean if the connection is alive and false otherwise:

bookbrainz-site/src/server/app.js

Line 97 in e6c2111

const authInitiated = auth.init(app);

Here's what the code could look like:

/**
 * Search init
 * @description Sets up the search server connection with defaults,
 * and returns a connection status boolean
 * @param {ORM} orm the BookBrainz ORM
 * @param {ClientOptions} [connectionSettings] Optional (but recommended) connection settings, will provide defaults if missing
 * @returns {Promise<boolean>} A Promise which resolves to the connection status boolean
 */
export async function init(orm, connectionSettings) {
	/* Fallback configuration code here */

	_client = new ElasticSearch.Client(connectionSettings);
	try {
		// check for connection
		await _client.ping();
	}
	catch (error) {
		// not connected
		return false;
	}
	const mainIndexExists = await _client.indices.exists({index: _index});
	if (!mainIndexExists) {
		// Automatically index on app startup if we haven't already, but don't block app setup
		generateIndex(orm).catch(log.error);
	}
	// connected
	return true;
}

With these imported types

import ElasticSearch, {type ClientOptions} from '@elastic/elasticsearch';
import {type ORM} from 'bookbrainz-data';

And finally in app.js you can do
const searchInitiated = await search.init(app.locals.orm, Object.assign({}, config.search));
and add an banner if searchInitiated is false

[Tarunmeena0901]

Great solution! One thing I would like to ask: the type you mentioned here
{type ClientOptions} from '@elastic/elasticsearch'; doesn't have the properties that options should have like "auth" and "host"

options = {
	auth: { password: 'changeme', username: 'elastic' },
	node: 'http://localhost:9200',
	requestTimeout: 60000,
	host: 'localhost:9200'
};

[MonkeyDo]

I think we can do a single message for all environments, maybe something like
'We could not connect to our search server, all search functionality is unavailable.'

[Tarunmeena0901]

There were some unexpected es lint error not releated to the changes in this PR , but I fixed them too I hope it does no make things confusing for you