chore: Suggestion to simplifying the user or customer getting

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.15.1-develop.1](https://github.com/cheqd/credential-service/compare/2.15.0...2.15.1-develop.1) (2024-01-11)
+
+
+### Bug Fixes
+
+* Fix error handling on tracking operations [DEV-3527] ([#461](https://github.com/cheqd/credential-service/issues/461)) ([53d7dfd](https://github.com/cheqd/credential-service/commit/53d7dfdcc23d90dba85a681f39ebc724b7fbdcc2))
+
 ## [2.15.0](https://github.com/cheqd/credential-service/compare/2.14.0...2.15.0) (2024-01-05)
 
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cheqd/credential-service",
-	"version": "2.15.0",
+	"version": "2.15.1-develop.1",
 	"description": "cheqd Credential Service Backend",
 	"source": "src/index.ts",
 	"main": "dist/index.js",

src/controllers/account.ts

@@ -111,41 +111,28 @@ export class AccountController {
 		}
 
 		const identityStrategySetup = new IdentityServiceStrategySetup(response.locals.customer.customerId);
-		let apiKey = await identityStrategySetup.agent.getAPIKey(response.locals.customer, response.locals.user);
-		// If there is no API key for the customer - create it
-		if (!apiKey) {
-			apiKey = await identityStrategySetup.agent.setAPIKey(
-				request.session.idToken,
-				response.locals.customer,
-				response.locals.user
-			);
-		} else if (apiKey.isExpired()) {
-			// If API key is expired - update it
-			apiKey = await identityStrategySetup.agent.updateAPIKey(apiKey, request.session.idToken);
-		}
-		return response.status(StatusCodes.OK).json({
-			idToken: apiKey?.apiKey,
-		});
-	}
-
-	public async setupDefaultRole(request: Request, response: Response) {
-		if (request.body) {
-			const { body } = request;
-			if (!body.user.isSuspended) {
-				const logToHelper = new LogToHelper();
-				const _r = await logToHelper.setup();
-				if (_r.status !== StatusCodes.OK) {
-					return response.status(StatusCodes.BAD_GATEWAY).json({
-						error: _r.error,
-					});
-				}
-				const resp = await logToHelper.setDefaultRoleForUser(body.user.id as string);
-				return response.status(resp.status).json({
-					error: resp.error,
-				});
+		try {
+			// Get the API key for the customer
+			let apiKey = await identityStrategySetup.agent.getAPIKey(response.locals.customer, response.locals.user);
+			// If there is no API key for the customer - create it
+			if (!apiKey) {
+				apiKey = await identityStrategySetup.agent.setAPIKey(
+					request.session.idToken,
+					response.locals.customer,
+					response.locals.user
+				);
+			} else if (apiKey.isExpired()) {
+				// If API key is expired - update it
+				apiKey = await identityStrategySetup.agent.updateAPIKey(apiKey, request.session.idToken);
 			}
+			return response.status(StatusCodes.OK).json({
+				idToken: apiKey?.apiKey,
+			});
+		} catch (error) {
+			return response.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
+				error: `Internal error: ${(error as Error)?.message || error}`,
+			});
 		}
-		return response.status(StatusCodes.BAD_REQUEST).json({});
 	}
 
 	public async bootstrap(request: Request, response: Response) {

src/controllers/credential-status.ts

@@ -562,13 +562,14 @@ export class CredentialStatusController {
 				},
 			} as ITrackOperation;
 
-			const trackResult = await identityServiceStrategySetup.agent.trackOperation(trackResourceInfo);
+			const trackResult = await identityServiceStrategySetup.agent
+				.trackOperation(trackResourceInfo)
+				.catch((error) => {
+					return { error };
+				});
 			if (trackResult.error) {
-				return response
-					.status(StatusCodes.INTERNAL_SERVER_ERROR)
-					.json(trackResult as CreateEncryptedStatusListUnsuccessfulResponseBody);
+				console.error(`Tracking Error: ${trackResult.error}`);
 			}
-
 			// return result
 			return response.status(StatusCodes.OK).json({ ...result, encrypted: undefined });
 		} catch (error) {
@@ -695,14 +696,14 @@ export class CredentialStatusController {
 					feePaymentNetwork: CheqdNetwork.Testnet,
 				},
 			} as ITrackOperation;
-			const trackResult = await identityServiceStrategySetup.agent.trackOperation(trackResourceInfo);
-
+			const trackResult = await identityServiceStrategySetup.agent
+				.trackOperation(trackResourceInfo)
+				.catch((error) => {
+					return { error };
+				});
 			if (trackResult.error) {
-				return response
-					.status(StatusCodes.INTERNAL_SERVER_ERROR)
-					.json(trackResult as CreateEncryptedStatusListUnsuccessfulResponseBody);
+				console.error(`Tracking Error: ${trackResult.error}`);
 			}
-
 			// return result
 			return response.status(StatusCodes.OK).json({ ...result, encrypted: undefined });
 		} catch (error) {
@@ -873,12 +874,13 @@ export class CredentialStatusController {
 						symmetricKey: '',
 					},
 				} as ITrackOperation;
-				const trackResult = await identityServiceStrategySetup.agent.trackOperation(trackResourceInfo);
+				const trackResult = await identityServiceStrategySetup.agent
+					.trackOperation(trackResourceInfo)
+					.catch((error) => {
+						return { error };
+					});
 				if (trackResult.error) {
-					return response.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
-						updated: false,
-						error: trackResult.error,
-					} as UpdateUnencryptedStatusListUnsuccessfulResponseBody);
+					console.error(`Tracking Error: ${trackResult.error}`);
 				}
 			}
 
@@ -1072,12 +1074,13 @@ export class CredentialStatusController {
 						feePaymentNetwork: CheqdNetwork.Testnet,
 					},
 				} as ITrackOperation;
-				const trackResult = await identityServiceStrategySetup.agent.trackOperation(trackResourceInfo);
+				const trackResult = await identityServiceStrategySetup.agent
+					.trackOperation(trackResourceInfo)
+					.catch((error) => {
+						return { error };
+					});
 				if (trackResult.error) {
-					return response.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
-						updated: false,
-						error: trackResult.error,
-					} as UpdateUnencryptedStatusListUnsuccessfulResponseBody);
+					console.error(`Tracking Error: ${trackResult.error}`);
 				}
 			}
 

src/controllers/credentials.ts

@@ -331,11 +331,13 @@ export class CredentialController {
 				} as ITrackOperation;
 
 				// Track operation
-				const trackResult = await identityServiceStrategySetup.agent.trackOperation(trackInfo);
-				if (trackResult.error) {
-					return response.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
-						error: trackResult.error,
+				const trackResult = await identityServiceStrategySetup.agent
+					.trackOperation(trackInfo)
+					.catch((error) => {
+						return { error };
 					});
+				if (trackResult.error) {
+					console.error(`Tracking Error: ${trackResult.error}`);
 				}
 			}
 			// Return Ok response
@@ -435,11 +437,13 @@ export class CredentialController {
 				} as ITrackOperation;
 
 				// Track operation
-				const trackResult = await identityServiceStrategySetup.agent.trackOperation(trackInfo);
-				if (trackResult.error) {
-					return response.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
-						error: trackResult.error,
+				const trackResult = await identityServiceStrategySetup.agent
+					.trackOperation(trackInfo)
+					.catch((error) => {
+						return { error };
 					});
+				if (trackResult.error) {
+					console.error(`Tracking Error: ${trackResult.error}`);
 				}
 			}
 
@@ -537,11 +541,13 @@ export class CredentialController {
 				} as ITrackOperation;
 
 				// Track operation
-				const trackResult = await identityServiceStrategySetup.agent.trackOperation(trackInfo);
-				if (trackResult.error) {
-					return response.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
-						error: trackResult.error,
+				const trackResult = await identityServiceStrategySetup.agent
+					.trackOperation(trackInfo)
+					.catch((error) => {
+						return { error };
 					});
+				if (trackResult.error) {
+					console.error(`Tracking Error: ${trackResult.error}`);
 				}
 			}
 			// Return Ok response

src/controllers/resource.ts

@@ -190,11 +190,13 @@ export class ResourceController {
 					},
 				} as ITrackOperation;
 
-				const trackResult = await identityServiceStrategySetup.agent.trackOperation(trackResourceInfo);
-				if (trackResult.error) {
-					return response.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
-						error: `${trackResult.error}`,
+				const trackResult = await identityServiceStrategySetup.agent
+					.trackOperation(trackResourceInfo)
+					.catch((error) => {
+						return { error };
 					});
+				if (trackResult.error) {
+					console.error(`Tracking Error: ${trackResult.error}`);
 				}
 
 				return response.status(StatusCodes.CREATED).json({

src/middleware/auth/base-auth-handler.ts

@@ -136,8 +136,6 @@ export class BaseAuthHandler extends BaseAPIGuard implements IAuthHandler {
 				this.setUserInfoStrategy(new APITokenUserInfoFetcher(token));
 			} else {
 				this.setUserInfoStrategy(new M2MTokenUserInfoFetcher(token));
-				const customerId = request.headers['customer-id'];
-				if (typeof customerId === 'string') this.setCustomerId(customerId);
 			}
 		} else {
 			this.setUserInfoStrategy(new SwaggerUserInfoFetcher());

src/middleware/auth/user-info-fetcher/m2m-token.ts

@@ -18,6 +18,10 @@ export class M2MTokenUserInfoFetcher extends AuthReturn implements IUserInfoFetc
 	}
 
 	async fetchUserInfo(request: Request, oauthProvider: IOAuthProvider): Promise<IAuthResponse> {
+		// Get customerId from header
+		const customerId = request.headers['customer-id'];
+		if (typeof customerId === 'string') this.setCustomerId(customerId);
+		// Verify M2M token
 		return this.verifyJWTToken(this.token as string, oauthProvider);
 	}
 

src/middleware/authentication.ts

@@ -135,10 +135,12 @@ export class Authentication {
 				});
 			}
 			// Only for rules when it's not allowed for unauthorized users
-			// we need to find customer and assign it to the response.locals
+			// we need to find customer or user and assign them to the response.locals
 			if (!_resp.data.isAllowedUnauthorized) {
+				let customer;
+				let user;
 				if (_resp.data.userId !== '') {
-					const user = await UserService.instance.get(_resp.data.userId);
+					user = await UserService.instance.get(_resp.data.userId);
 					if (!user) {
 						return response.status(StatusCodes.NOT_FOUND).json({
 							error: `Looks like user with logToId ${_resp.data.userId} is not found`,
@@ -149,18 +151,23 @@ export class Authentication {
 							error: `Looks like user with logToId ${_resp.data.userId} is not assigned to any CredentialService customer`,
 						});
 					}
-					response.locals.customer = user.customer;
-					response.locals.user = user;
-				} else if (!(['/account/create'].includes(request.path) && _resp.data.customerId == '')) {
-					// allow bootstrap apis to create a customer if there is not customerId
-					const customer = await CustomerService.instance.get(_resp.data.customerId);
+					customer = user.customer;
+				} 
+				if (_resp.data.customerId !== '' && !customer) {
+					customer = await CustomerService.instance.get(_resp.data.customerId);
 					if (!customer) {
 						return response.status(StatusCodes.NOT_FOUND).json({
-							error: `Looks like user with logToId ${_resp.data.customerId} is not found`,
+							error: `Looks like customer with id ${_resp.data.customerId} is not found`,
 						});
 					}
-					response.locals.customer = customer;
 				}
+				if (!customer && !user) {
+					return response.status(StatusCodes.UNAUTHORIZED).json({
+						error: `Looks like customer and user are not found in the system or they are not registered yet. Please contact administrator.`,
+					})
+				}
+				response.locals.customer = customer;
+				response.locals.user = user;
 			}
 			next();
 		} catch (err) {