The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
import { type MessageDescriptor } from '@lingui/core';
import { msg } from '@lingui/core/macro';
import { assertUnreachable } from 'twenty-shared/utils';
import { type FlatEntityMapsExceptionContext } from 'src/engine/metadata-modules/flat-entity/exceptions/flat-entity-maps.exception';
import { CustomException } from 'src/utils/custom-exception';
export enum ApplicationExceptionCode {
OBJECT_NOT_FOUND = 'OBJECT_NOT_FOUND',
FIELD_NOT_FOUND = 'FIELD_NOT_FOUND',
LOGIC_FUNCTION_NOT_FOUND = 'LOGIC_FUNCTION_NOT_FOUND',
FRONT_COMPONENT_NOT_FOUND = 'FRONT_COMPONENT_NOT_FOUND',
ENTITY_NOT_FOUND = 'ENTITY_NOT_FOUND',
APPLICATION_NOT_FOUND = 'APPLICATION_NOT_FOUND',
APP_NOT_INSTALLED = 'APP_NOT_INSTALLED',
FORBIDDEN = 'FORBIDDEN',
INVALID_INPUT = 'INVALID_INPUT',
SOURCE_CHANNEL_MISMATCH = 'SOURCE_CHANNEL_MISMATCH',
PACKAGE_RESOLUTION_FAILED = 'PACKAGE_RESOLUTION_FAILED',
TARBALL_EXTRACTION_FAILED = 'TARBALL_EXTRACTION_FAILED',
UPGRADE_FAILED = 'UPGRADE_FAILED',
PRE_INSTALL_ERROR = 'PRE_INSTALL_ERROR',
POST_INSTALL_ERROR = 'POST_INSTALL_ERROR',
UNINSTALL_ERROR = 'UNINSTALL_ERROR',
APP_ALREADY_INSTALLED = 'APP_ALREADY_INSTALLED',
CANNOT_DOWNGRADE_APPLICATION = 'CANNOT_DOWNGRADE_APPLICATION',
SERVER_VERSION_INCOMPATIBLE = 'SERVER_VERSION_INCOMPATIBLE',
WORKSPACE_VERSION_INCOMPATIBLE = 'WORKSPACE_VERSION_INCOMPATIBLE',
INVALID_APP_ENGINE_REQUIREMENT = 'INVALID_APP_ENGINE_REQUIREMENT',
INVALID_SERVER_VERSION = 'INVALID_SERVER_VERSION',
INVALID_WORKSPACE_VERSION = 'INVALID_WORKSPACE_VERSION',
APPLICATION_INSTALLATION_FAILED = 'APPLICATION_INSTALLATION_FAILED',
KEY_VALUE_PERSISTENCE_FAILED = 'KEY_VALUE_PERSISTENCE_FAILED',
APPLICATION_NOT_EXPORTABLE = 'APPLICATION_NOT_EXPORTABLE',
STANDARD_APPLICATION_NOT_EXPORTABLE = 'STANDARD_APPLICATION_NOT_EXPORTABLE',
}
const getApplicationExceptionUserFriendlyMessage = (
code: ApplicationExceptionCode,
) => {
switch (code) {
case ApplicationExceptionCode.OBJECT_NOT_FOUND:
return msg`Object not found.`;
case ApplicationExceptionCode.FIELD_NOT_FOUND:
return msg`Field not found.`;
case ApplicationExceptionCode.LOGIC_FUNCTION_NOT_FOUND:
return msg`Logic function not found.`;
case ApplicationExceptionCode.FRONT_COMPONENT_NOT_FOUND:
return msg`Front component not found.`;
case ApplicationExceptionCode.ENTITY_NOT_FOUND:
return msg`Entity not found.`;
case ApplicationExceptionCode.APPLICATION_NOT_FOUND:
return msg`Application not found.`;
case ApplicationExceptionCode.APP_NOT_INSTALLED:
return msg`Application is not installed in this workspace. Install it first.`;
case ApplicationExceptionCode.FORBIDDEN:
return msg`You do not have permission to perform this action.`;
case ApplicationExceptionCode.INVALID_INPUT:
return msg`Invalid input provided.`;
case ApplicationExceptionCode.SOURCE_CHANNEL_MISMATCH:
return msg`Source channel mismatch.`;
case ApplicationExceptionCode.PACKAGE_RESOLUTION_FAILED:
return msg`Unable to retrieve the application package.`;
case ApplicationExceptionCode.TARBALL_EXTRACTION_FAILED:
return msg`Failed to extract tarball.`;
case ApplicationExceptionCode.UPGRADE_FAILED:
return msg`Application upgrade failed.`;
case ApplicationExceptionCode.PRE_INSTALL_ERROR:
return msg`Application pre-install logic function failed.`;
case ApplicationExceptionCode.POST_INSTALL_ERROR:
return msg`Application post-install logic function failed.`;
case ApplicationExceptionCode.UNINSTALL_ERROR:
return msg`Application uninstall logic function failed.`;
case ApplicationExceptionCode.APP_ALREADY_INSTALLED:
return msg`This version of the application is already installed in this workspace.`;
case ApplicationExceptionCode.CANNOT_DOWNGRADE_APPLICATION:
return msg`A higher version of this application is already installed. Downgrading is not allowed.`;
case ApplicationExceptionCode.SERVER_VERSION_INCOMPATIBLE:
return msg`This app requires a newer version of the Twenty server. Please upgrade your server or use a compatible app version.`;
case ApplicationExceptionCode.WORKSPACE_VERSION_INCOMPATIBLE:
return msg`This app requires a newer version than this workspace has finished upgrading to. Please try again once the workspace upgrade completes.`;
case ApplicationExceptionCode.INVALID_APP_ENGINE_REQUIREMENT:
return msg`The app manifest declares an invalid server version requirement.`;
case ApplicationExceptionCode.INVALID_SERVER_VERSION:
return msg`The server's APP_VERSION is not a valid semver version. Self-hosted instances must configure a valid APP_VERSION.`;
case ApplicationExceptionCode.INVALID_WORKSPACE_VERSION:
return msg`This workspace's upgrade state could not be determined. Please try again once the workspace has finished upgrading.`;
case ApplicationExceptionCode.APPLICATION_INSTALLATION_FAILED:
return msg`We couldn't install this application because some of its metadata could not be applied to your workspace.`;
case ApplicationExceptionCode.KEY_VALUE_PERSISTENCE_FAILED:
return msg`The application key-value entry could not be saved. Please try again.`;
case ApplicationExceptionCode.APPLICATION_NOT_EXPORTABLE:
return msg`Only applications synced from local source can be exported.`;
case ApplicationExceptionCode.STANDARD_APPLICATION_NOT_EXPORTABLE:
return msg`The standard application cannot be exported.`;
default:
assertUnreachable(code);
}
};
export class ApplicationException extends CustomException<ApplicationExceptionCode> {
context?: FlatEntityMapsExceptionContext;
constructor(
message: string,
code: ApplicationExceptionCode,
{
userFriendlyMessage,
context,
}: {
userFriendlyMessage?: MessageDescriptor;
context?: FlatEntityMapsExceptionContext;
} = {},
) {
super(message, code, {
userFriendlyMessage:
userFriendlyMessage ?? getApplicationExceptionUserFriendlyMessage(code),
});
this.context = context;
}
}