Skip to content

Commit

Permalink
fix(logger): logger is supposed to be optional but not treated optional
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerald Baulig committed Oct 17, 2024
1 parent b14c24a commit 824621f
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 56 deletions.
82 changes: 39 additions & 43 deletions src/database/provider/arango/base.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,16 @@ export interface CustomQuery {
* ArangoDB database provider.
*/
export class Arango implements DatabaseProvider {
db: Database;
customQueries: Map<string, CustomQuery>;
collectionNameAnalyzerMap: Map<string, ViewMap>;
logger: Logger;
public readonly customQueries = new Map<string, CustomQuery>();
public readonly collectionNameAnalyzerMap = new Map<string, ViewMap>();
/**
*
* @param {Object} conn Arangojs database connection.
*/
constructor(conn: any, logger?: Logger) {
this.db = conn;
this.customQueries = new Map<string, CustomQuery>();
this.logger = logger;
this.collectionNameAnalyzerMap = new Map<string, ViewMap>();
}
constructor(
public readonly db: Database,
public readonly logger?: Logger,
) {}

/**
* Find documents based on filter.
Expand All @@ -44,7 +40,7 @@ export class Arango implements DatabaseProvider {
async find(collectionName: string, filter?: any, options?: any): Promise<any> {
if (_.isNil(collectionName) || !_.isString(collectionName) ||
_.isEmpty(collectionName)) {
this.logger.error('invalid or missing collection argument for find operation');
this.logger?.error('invalid or missing collection argument for find operation');
throw new Error('invalid or missing collection argument for find operation');
}

Expand All @@ -58,7 +54,7 @@ export class Arango implements DatabaseProvider {
if (!_.isEmpty(opts.customQueries)) {
for (let queryName of opts.customQueries) {
if (!this.customQueries.has(queryName)) {
this.logger.error(`custom query ${query} not found`);
this.logger?.error(`custom query ${query} not found`);
throw new Error(`custom query ${query} not found`);
}
const customQuery = this.customQueries.get(queryName);
Expand Down Expand Up @@ -133,7 +129,7 @@ export class Arango implements DatabaseProvider {
// override sortQuery (to rank based on score for frequency search match - term frequency–inverse document frequency algorithm TF-IDF)
sortQuery = `SORT TFIDF(node) DESC`;
} else {
this.logger.info(`View and analyzer configuration data not set for ${collectionName} and hence ignoring search string`);
this.logger?.info(`View and analyzer configuration data not set for ${collectionName} and hence ignoring search string`);
}
}

Expand Down Expand Up @@ -196,12 +192,12 @@ export class Arango implements DatabaseProvider {
async findByID(collectionName: string, ids: string | string[]): Promise<any> {
if (_.isNil(collectionName) || !_.isString(collectionName) ||
_.isEmpty(collectionName)) {
this.logger.error('invalid or missing collection argument for findByID operation');
this.logger?.error('invalid or missing collection argument for findByID operation');
throw new Error('invalid or missing collection argument for findByID operation');
}

if (_.isNil(ids)) {
this.logger.error('invalid or missing ids argument for findByID operation');
this.logger?.error('invalid or missing ids argument for findByID operation');
throw new Error('invalid or missing ids argument for findByID operation');
}
if (!_.isArray(ids)) {
Expand Down Expand Up @@ -269,21 +265,21 @@ export class Arango implements DatabaseProvider {
let updateDocsResponse = [];
if (_.isNil(collectionName) ||
!_.isString(collectionName) || _.isEmpty(collectionName)) {
this.logger.error('invalid or missing collection argument for update operation');
this.logger?.error('invalid or missing collection argument for update operation');
throw new Error('invalid or missing collection argument for update operation');
}
if (_.isNil(documents)) {
this.logger.error('invalid or missing document argument for update operation');
this.logger?.error('invalid or missing document argument for update operation');
throw new Error('invalid or missing document argument for update operation');
}
const collection = this.db.collection(collectionName);
const collectionExists = await collection.exists();
if (!collectionExists) {
this.logger.error(`Collection ${collectionName} does not exist for update operation`);
this.logger?.error(`Collection ${collectionName} does not exist for update operation`);
throw new Error(`Collection ${collectionName} does not exist for update operation`);
}
if (!_.isArray(documents)) {
this.logger.error(`Documents should be list for update operation`);
this.logger?.error(`Documents should be list for update operation`);
throw new Error(`Documents should be list for update operation`);
}
const docsWithHandlers = await this.getDocumentHandlers(collectionName, collection, documents);
Expand Down Expand Up @@ -326,11 +322,11 @@ export class Arango implements DatabaseProvider {
async upsert(collectionName: string, documents: any): Promise<any> {
if (_.isNil(collectionName) ||
!_.isString(collectionName) || _.isEmpty(collectionName)) {
this.logger.error('invalid or missing collection argument for upsert operation');
this.logger?.error('invalid or missing collection argument for upsert operation');
throw new Error('invalid or missing collection argument for upsert operation');
}
if (_.isNil(documents)) {
this.logger.error('invalid or missing documents argument for upsert operation');
this.logger?.error('invalid or missing documents argument for upsert operation');
throw new Error('invalid or missing documents argument for upsert operation');
}
let docs = _.cloneDeep(documents);
Expand All @@ -344,7 +340,7 @@ export class Arango implements DatabaseProvider {
const collection = this.db.collection(collectionName);
const collectionExists = await collection.exists();
if (!collectionExists) {
this.logger.error(`Collection ${collectionName} does not exist for upsert operation`);
this.logger?.error(`Collection ${collectionName} does not exist for upsert operation`);
throw new Error(`Collection ${collectionName} does not exist for upsert operation`);
}
let upsertedDocs = await collection.saveAll(docs, { returnNew: true, overwriteMode: 'update' });
Expand All @@ -371,17 +367,17 @@ export class Arango implements DatabaseProvider {
async delete(collectionName: string, ids: string[]): Promise<any> {
if (_.isNil(collectionName) ||
!_.isString(collectionName) || _.isEmpty(collectionName)) {
this.logger.error('invalid or missing collection argument');
this.logger?.error('invalid or missing collection argument');
throw new Error('invalid or missing collection argument');
}
if (_.isNil(ids) || _.isEmpty(ids)) {
this.logger.error('invalid or missing document IDs argument for delete operation');
this.logger?.error('invalid or missing document IDs argument for delete operation');
throw new Error('invalid or missing document IDs argument for delete operation');
}
const collection = this.db.collection(collectionName);
const collectionExists = await collection.exists();
if (!collectionExists) {
this.logger.error(`Collection ${collectionName} does not exist for delete operation`);
this.logger?.error(`Collection ${collectionName} does not exist for delete operation`);
throw new Error(`Collection ${collectionName} does not exist for delete operation`);
}

Expand Down Expand Up @@ -419,7 +415,7 @@ export class Arango implements DatabaseProvider {
async count(collectionName: string, filter: any): Promise<any> {
if (_.isNil(collectionName) ||
!_.isString(collectionName) || _.isEmpty(collectionName)) {
this.logger.error('invalid or missing collection argument for count operation');
this.logger?.error('invalid or missing collection argument for count operation');
throw new Error('invalid or missing collection argument for count operation');
}
let filterQuery: any = filter || {};
Expand Down Expand Up @@ -481,12 +477,12 @@ export class Arango implements DatabaseProvider {
for (let view of viewName) {
try {
let response = await this.db.view(view).drop();
this.logger.info(`View ${view} dropped successfully`, response);
this.logger?.info(`View ${view} dropped successfully`, response);
if (response === true) {
dropViewResponse.push({ id: view, code: 200, message: `View ${view} dropped successfully` });
}
} catch (err) {
this.logger.error(`Error dropping View ${view}`, { code: err.code, message: err.message, stack: err.stack });
this.logger?.error(`Error dropping View ${view}`, { code: err.code, message: err.message, stack: err.stack });
dropViewResponse.push({ id: view, code: err.code, message: err.message });
}
}
Expand All @@ -504,12 +500,12 @@ export class Arango implements DatabaseProvider {
for (let analyzer of analyzerName) {
try {
let response = await this.db.analyzer(analyzer).drop();
this.logger.info(`Analyzer ${analyzer} deleted successfully`, response);
this.logger?.info(`Analyzer ${analyzer} deleted successfully`, response);
if (response.code === 200 && response.error === false) {
deleteResponse.push({ id: analyzer, code: response.code, message: `Analyzer ${analyzer} deleted successfully` });
}
} catch (err) {
this.logger.error(`Error deleting analyzer ${analyzer}`, { code: err.code, message: err.message, stack: err.stack });
this.logger?.error(`Error deleting analyzer ${analyzer}`, { code: err.code, message: err.message, stack: err.stack });
deleteResponse.push({ id: analyzer, code: err.code, message: err.message });
}
}
Expand All @@ -525,11 +521,11 @@ export class Arango implements DatabaseProvider {
*/
async insert(collectionName: string, documents: any): Promise<any> {
if (_.isNil(collectionName) || !_.isString(collectionName) || _.isEmpty(collectionName)) {
this.logger.error('invalid or missing collection argument for insert operation');
this.logger?.error('invalid or missing collection argument for insert operation');
throw new Error('invalid or missing collection argument for insert operation');
}
if (_.isNil(documents)) {
this.logger.error('invalid or missing documents argument for insert operation');
this.logger?.error('invalid or missing documents argument for insert operation');
throw new Error('invalid or missing documents argument for insert operation');
}
let docs = _.cloneDeep(documents);
Expand Down Expand Up @@ -578,7 +574,7 @@ export class Arango implements DatabaseProvider {
*/
unregisterCustomQuery(name: string): void {
if (!this.customQueries.has(name)) {
this.logger.error('custom function not found');
this.logger?.error('custom function not found');
throw new Error('custom function not found');
}
this.customQueries.delete(name);
Expand All @@ -590,11 +586,11 @@ export class Arango implements DatabaseProvider {

async createAnalyzerAndView(viewConfig: ViewAnalyzerOptions, collectionName: string): Promise<void> {
if (!viewConfig.view.viewName || !viewConfig?.view?.options) {
this.logger.error(`View name or view configuration missing for ${collectionName}`);
this.logger?.error(`View name or view configuration missing for ${collectionName}`);
throw new Error(`View name or view configuration missing for ${collectionName}`);
}
if ((!viewConfig?.analyzers) || (viewConfig.analyzers.length === 0) || !(viewConfig.analyzerOptions)) {
this.logger.error(`Analyzer options or configuration missing for ${collectionName}`);
this.logger?.error(`Analyzer options or configuration missing for ${collectionName}`);
throw new Error(`Analyzer options or configuration missing for ${collectionName}`);
}
// create analyzer if it does not exist
Expand All @@ -605,13 +601,13 @@ export class Arango implements DatabaseProvider {
let analyzerCfg = viewConfig.analyzerOptions.filter((optionsCfg) => Object.keys(optionsCfg)[0] === analyzerName);
if (analyzerCfg?.length === 1) {
await analyzer.create(analyzerCfg[0][analyzerName] as any);
this.logger.info(`Analyzer ${analyzerName} created successfully`);
this.logger?.info(`Analyzer ${analyzerName} created successfully`);
}
} catch (err) {
this.logger.error(`Error creating analyzer ${analyzerName}`, { code: err.code, message: err.message, stack: err.stack });
this.logger?.error(`Error creating analyzer ${analyzerName}`, { code: err.code, message: err.message, stack: err.stack });
}
} else {
this.logger.info(`Analyzer ${analyzerName} already exists`);
this.logger?.info(`Analyzer ${analyzerName} already exists`);
}
}

Expand All @@ -621,11 +617,11 @@ export class Arango implements DatabaseProvider {
try {
if (!collectionExists) {
await collection.create();
this.logger.info(`Collection ${collectionName} created successfully`);
this.logger?.info(`Collection ${collectionName} created successfully`);
}
} catch (err) {
if (err.message && err.message.indexOf('duplicate name') == -1) {
this.logger.error(`Error creating collection ${collectionName}`, { code: err.code, message: err.message, stack: err.stack });
this.logger?.error(`Error creating collection ${collectionName}`, { code: err.code, message: err.message, stack: err.stack });
throw err;
}
}
Expand All @@ -636,12 +632,12 @@ export class Arango implements DatabaseProvider {
if (!viewExists) {
try {
await this.db.createView(viewConfig?.view?.viewName, viewConfig?.view?.options);
this.logger.info(`View ${viewConfig?.view?.viewName} created successfully`);
this.logger?.info(`View ${viewConfig?.view?.viewName} created successfully`);
} catch (err) {
this.logger.error(`Error creating View ${viewConfig?.view?.viewName}`, { code: err.code, message: err.message, stack: err.stack });
this.logger?.error(`Error creating View ${viewConfig?.view?.viewName}`, { code: err.code, message: err.message, stack: err.stack });
}
} else {
this.logger.info(`View ${viewConfig?.view?.viewName} already exists`);
this.logger?.info(`View ${viewConfig?.view?.viewName} already exists`);
}
// map the collectionName with list of indexed fields, view name, analyzerslist, similarity threshold
// to be used in find()
Expand Down
16 changes: 7 additions & 9 deletions src/database/provider/arango/graph.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,13 @@ import { TraversalResponse } from './interface';
import { Logger } from 'winston';

export class ArangoGraph extends Arango implements GraphDatabaseProvider {
graph: Graph;
edgeDefConfig: any;
logger: Logger;

constructor(conn: Database, graph: Graph, edgeDefConfig: any, logger: Logger) {
super(conn);
this.graph = graph;
this.edgeDefConfig = edgeDefConfig; // edge definition config
this.logger = logger;
constructor(
db: Database,
public readonly graph: Graph,
public readonly edgeDefConfig: any,
public readonly logger: Logger
) {
super(db);
}

/**
Expand Down
8 changes: 4 additions & 4 deletions src/database/provider/arango/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ const connect = async (conf: any, logger: Logger): Promise<any> => {
let i = 1;
try {
return await retry(async () => {
logger.info('Attempt to connect database', {
logger?.info('Attempt to connect database', {
dbHost, dbPort, dbName,
attempt: i
});
Expand All @@ -55,7 +55,7 @@ const connect = async (conf: any, logger: Logger): Promise<any> => {
} catch (err) {
if (err.name === 'ArangoError' && err.errorNum === 1228) {
if (autoCreate) {
logger.verbose(`auto creating arango database ${dbName}`);
logger?.verbose(`auto creating arango database ${dbName}`);
// Database does not exist, create a new one
db.database(DB_SYSTEM);
await db.createDatabase(dbName);
Expand All @@ -71,7 +71,7 @@ const connect = async (conf: any, logger: Logger): Promise<any> => {
catch (err) {
const safeError = Object.getOwnPropertyNames(Object.getPrototypeOf(err))
.reduce((acc, curr) => { return acc[curr] = err[curr], acc; }, {});
logger.error('Database connection error', { err: safeError, dbHost, dbPort, dbName, attempt: i });
logger?.error('Database connection error', { err: safeError, dbHost, dbPort, dbName, attempt: i });
mainError = err;
}
throw mainError;
Expand Down Expand Up @@ -119,7 +119,7 @@ export const create = async (conf: any, logger: any, graphName?: string, edgeDef
const viewCfg = JSON.parse(fs.readFileSync(path, 'utf8'));
await db.createAnalyzerAndView(viewCfg, collectionName);
} catch (error) {
logger.error('Error creating analyzer or view', {
logger?.error('Error creating analyzer or view', {
code: error.code, message: error.message, stack: error.stack
});
}
Expand Down

0 comments on commit 824621f

Please sign in to comment.