Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 1x 1x 16x 1x 1x 1x 1x 1x 1x 16x 1x 1x 16x 1x 1x 16x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 1x 1x 2x 2x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 3x 3x 1x 1x 1x 1x 1x 1x 3x 3x 1x 1x 2x 2x 2x 1x 1x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 5x 5x 68x 68x 68x 68x 68x 68x 5x 5x 5x 5x 5x 5x 5x 1x 1x 1x 1x 1x 1x 9x 9x 9x 9x 9x 1x 1x 5x 5x 5x 5x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 16x 16x 16x 944x 944x 944x 944x 944x 944x 944x 16x 16x 1x 1x 159x 159x 159x 159x 159x 61x 61x 159x 159x 159x 159x 159x 159x 159x 159x 12x 159x 159x 61x 61x 159x 159x 1x 1x 1x 1x 1x 25x 25x 25x 25x 1x 1x 16x 16x 25x 8x 8x 25x 1x 1x 61x 61x 61x 207x 207x 61x 61x 61x 61x 1x 1x 1x 1x 1x 1x 1x 1x 61x 207x 207x 207x 61x 61x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 1x 1x 12x 12x 12x 1x 1x 1x 1x 1x 1x 1x 1x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 4x 4x 4x 1x | import { get, omit, pickBy, set } from 'lodash-es';
import { type MathJsInstance, type MathNode, type Parser } from 'mathjs';
import { sha1 } from 'object-hash';
import { getMathJS, lockMathJs } from '@amalia/amalia-lang/amalia-mathjs';
import { type AmaliaFormula, type AmaliaFunctionKeys } from '@amalia/amalia-lang/formula/types';
import { AmaliaAccessorKeywords, type VariableType } from '@amalia/amalia-lang/tokens/types';
import { CalculationError, type DatasetRow } from '@amalia/core/types';
import { type BaseCustomObjectDefinition } from '@amalia/data-capture/record-models/types';
import { dayjs } from '@amalia/ext/dayjs';
import { assert, toError } from '@amalia/ext/typescript';
import {
type ComputedFunctionResult,
type ComputedVariable,
type ComputeEnginePrimitiveTypes,
type ComputeEngineResult,
type DatasetRowContent,
type FilterDataset,
type MetricsDataset,
} from '@amalia/payout-calculation/types';
import { type Period } from '@amalia/payout-definition/periods/types';
import { type Plan, type PlanAssignment, type Relationship } from '@amalia/payout-definition/plans/types';
import { type TeamAssignment } from '@amalia/tenants/assignments/teams/types';
import { formatUserFullName, type UserContract } from '@amalia/tenants/users/types';
import { semesterRange } from './dates';
import { AmaliaFunction } from './functions';
import { RowConverterUtils } from './rowConverter.utils';
import { SanitizeFormula } from './sanitizeFormula';
export type CalculationScope = Record<AmaliaAccessorKeywords | string, ComputeEngineResult>;
export type ParserScope = Map<string, ComputeEngineResult>;
export type PeriodExtended = Period & {
startOfMonth: number;
startOfQuarter: number;
startOfSemester: number;
startOfYear: number;
endOfMonth: number;
endOfQuarter: number;
endOfSemester: number;
endOfYear: number;
};
type UserWithTeamMembers = UserContract & { teamMembers: UserContract[] };
export type TeamInParserScope = {
id?: string;
name?: string;
archived?: boolean;
members?: UserContract[];
managers?: UserContract[];
employees?: UserContract[];
childrenTeams?: TeamInParserScope[];
};
interface ConstructorOptions {
// Replace advanced functions (IF, convertCurrency...) with their stubbed equivalent.
// Useful for scope evaluation and formula validation.
stubAdvancedFunctions?: boolean;
// Set the user.
user?: UserContract;
// Set his team members.
userTeamMembers?: UserContract[];
// Set the plan
plan?: Plan;
// Set the team
teams?: TeamInParserScope[];
// Set the period.
period?: Period;
}
export class CalculationParser {
private readonly parser: Parser;
private period?: PeriodExtended;
private user?: UserContract;
private team?: TeamInParserScope;
private teams?: TeamInParserScope[] = [];
private plan?: Plan;
public constructor({ stubAdvancedFunctions, user, plan, teams, period, userTeamMembers }: ConstructorOptions = {}) {
// Create a new instance of mathJs on each CalculationParser.
// This avoids data leaking when calculating in parallel.
const mathJs = getMathJS();
// Set functions
this.setParserFunctions(mathJs, stubAdvancedFunctions || false);
this.parser = mathJs.parser();
lockMathJs(mathJs);
if (user) {
this.setUser(user, userTeamMembers);
}
if (plan) {
assert(
!plan.forecastId || (plan.forecastId && !!plan.forecast),
'Forecast id not null but relation forecast missing',
);
this.setPlan(plan);
}
if (teams) {
this.setTeams(teams);
}
if (period) {
this.setPeriod(period);
}
}
// ====================== GETTERS / SETTERS ======================
public setPeriod(period: Period) {
// Since our current period system is broken, we can't trust neither
// the startDate nor the endDate to be in the current period because
// of the timezone issue. So we're gonna calculate the middle of them,
// which should give us more or less the middle of the period.
const periodMiddle = (period.startDate + period.endDate) / 2;
const dayjsReference = dayjs.utc(periodMiddle, 'X');
const semester = semesterRange(dayjsReference);
const extendedPeriod = {
...period,
currentDate: dayjs.utc().unix(),
startOfMonth: dayjsReference.clone().startOf('month').unix(),
startOfQuarter: dayjsReference.clone().startOf('quarter').unix(),
startOfSemester: semester.startDate.unix(),
startOfYear: dayjsReference.clone().startOf('year').unix(),
endOfMonth: dayjsReference.clone().endOf('month').unix(),
endOfQuarter: dayjsReference.clone().endOf('quarter').unix(),
endOfSemester: semester.endDate.unix(),
endOfYear: dayjsReference.clone().endOf('year').unix(),
};
this.period = extendedPeriod;
this.parser.set(AmaliaAccessorKeywords.statementPeriod, extendedPeriod);
}
public getPeriod(): PeriodExtended | undefined {
return this.period;
}
public setUser(user: UserContract, userTeamMembers?: UserContract[]) {
this.user = user;
this.parser.set(AmaliaAccessorKeywords.user, {
...user,
fullName: formatUserFullName(user),
teamMembers: userTeamMembers,
} as UserWithTeamMembers);
}
public getUser(): UserContract | null {
return this.user ?? null;
}
public getUserTeamMembers(): UserContract[] {
return (this.parser.get(AmaliaAccessorKeywords.user) as UserWithTeamMembers).teamMembers;
}
public setTeams(teams: TeamInParserScope[]) {
this.teams = teams;
// Only setting the first team in the parser
// If not team found, insert an empty one
const team = teams[0] || { members: [], managers: [], employees: [] };
this.team = team;
this.parser.set(AmaliaAccessorKeywords.team, team);
}
public getTeam() {
return this.team;
}
public getTeams() {
return this.teams;
}
public setPlan(plan: Plan) {
this.plan = plan;
this.parser.set(AmaliaAccessorKeywords.plan, plan);
}
public getPlan() {
return this.plan;
}
public setPlanAssignment(planAssignment: PlanAssignment) {
// Change null dates to +-Infinity, so we can compare in MathJS.
this.parser.set(AmaliaAccessorKeywords.planAssignement, {
...planAssignment,
effectiveAsOf: planAssignment.effectiveAsOf || -Infinity,
effectiveUntil: planAssignment.effectiveUntil || Infinity,
planName: planAssignment.plan?.name,
});
}
public setTeamAssignment(teamAssignment: TeamAssignment | null) {
if (teamAssignment) {
// Change null dates to +-Infinity, so we can compare in MathJS.
this.parser.set(AmaliaAccessorKeywords.teamAssignment, {
...teamAssignment,
effectiveAsOf: teamAssignment.effectiveAsOf || -Infinity,
effectiveUntil: teamAssignment.effectiveUntil || Infinity,
});
} else {
this.parser.set(AmaliaAccessorKeywords.teamAssignment, null);
}
}
public addFilter(
dataset: FilterDataset | MetricsDataset,
rows: DatasetRow[],
relationshipsMap: Record<string, Relationship>,
customObjectDefinitionMap: Record<string, BaseCustomObjectDefinition>,
) {
const rowContents = rows.map((row) =>
RowConverterUtils.convertRowDatesAndCurrencies(
dataset.customObjectDefinition.machineName,
row.content,
relationshipsMap,
customObjectDefinitionMap,
),
);
this.parser.set(AmaliaAccessorKeywords.filter, {
...this.parser.get(AmaliaAccessorKeywords.filter),
[dataset.filterMachineName]: rowContents,
});
}
public getAllScope(): Record<string, unknown> {
return this.parser.getAll();
}
public getPropertyFromScope(propertyDeep: string): unknown {
const [scopeKey, ...rest] = propertyDeep.split('.');
const value = this.parser.get(scopeKey) as unknown;
// If we had only one level, return it, also do a lodash get inside.
return rest.length ? get(value, rest) : value;
}
public saveComputedVariableToScope(variableType: VariableType, variableMachineName: string, value: unknown) {
const currentValue = this.parser.get(variableType) as Record<string, ComputedVariable>;
this.parser.set(variableType, {
...currentValue,
[variableMachineName]: value,
});
}
public saveComputedObjectVariableToScope(
datasetName: string,
path: string,
variableMachineName: string,
value: unknown,
) {
const currentValue = this.parser.get('filter') as Record<string, DatasetRow[]>;
const newValue = set(currentValue, `${datasetName}.${path}.${variableMachineName}`, value);
this.parser.set('filter', newValue);
}
// ====================== PARSER AND EVALUATIONS ======================
public setParserFunctions(mathJs: MathJsInstance, stubAdvancedFunction: boolean) {
const functionsEnum = AmaliaFunction.getAllFunctions();
(Object.keys(functionsEnum) as AmaliaFunctionKeys[]).forEach((functionKey) => {
const functionDefinition = functionsEnum[functionKey];
// Load the mock implementation if necessary (aka in the frontend for validation) and available, otherwise load the real implementation.
const functionToImport =
stubAdvancedFunction && functionDefinition.execMock ? functionDefinition.execMock : functionDefinition.exec;
mathJs.import({ [functionKey]: functionToImport }, { override: true });
});
}
public computeFormula(formula: AmaliaFormula, scope?: CalculationScope): ComputeEngineResult {
let savedScope: CalculationScope | undefined;
// Before evaluating, create a backup of the parser scope keys
// that are going to be overwritten.
if (scope) {
savedScope = this.saveParserScope(scope);
}
try {
const sanitizedFormula = typeof formula === 'string' ? SanitizeFormula.amaliaFormulaToMathJs(formula) : formula;
assert(sanitizedFormula !== null, 'Formula is null');
return this.parser.evaluate(sanitizedFormula) as ComputeEngineResult;
} catch (e) {
throw new CalculationError(toError(e));
} finally {
if (scope) {
this.restoreParserScope(scope, savedScope);
}
}
}
/**
* Return '' if formula is valid, or the error if it's not.
*/
public formulaHasError(formula: AmaliaFormula, scope?: CalculationScope): string {
try {
const result = this.computeFormula(formula, scope);
if (result === null || result === undefined) {
return 'Calculation returns undefined';
}
return '';
} catch (e) {
return toError(e).message;
}
}
private saveParserScope(scope: CalculationScope): CalculationScope {
const savedScope: CalculationScope = {};
Object.keys(scope).forEach((key) => {
set(savedScope, key, this.parser.get(key) || {});
this.parser.set(key, get(scope, key));
});
return savedScope;
}
/**
* Restore parser scope.
* @param scope
* @param savedScope
* @private
*/
private restoreParserScope(scope: CalculationScope, savedScope?: CalculationScope) {
Object.keys(scope).forEach((key) => {
this.parser.set(key, undefined);
if (savedScope && Object.keys(get(savedScope, key) as object).length > 0) {
this.parser.set(key, get(savedScope, key));
}
});
}
// ====================== ADVANCED FUNCTIONS OVERRIDE ======================
/**
* Generate a computedFunctionResult that we will be able to reuse later.
*
* @param computedFunctionResult
* @param value
* @param ignoreKeys
*/
public generateComputedFunctionResult(
computedFunctionResult: ComputedFunctionResult,
value: ComputeEngineResult,
ignoreKeys?: string[],
) {
const functionKey = `${computedFunctionResult.function}Result`;
const argsComputed = omit(computedFunctionResult.args, ignoreKeys ?? []);
// Filter out undefined values (which means no argument was passed here).
const argsKey = CalculationParser.computeArgumentsSha(argsComputed);
return { [functionKey]: { [argsKey]: value } };
}
private static computeArgumentsSha(argsComputed: Record<string, ComputeEnginePrimitiveTypes>) {
const argsFiltered = pickBy(argsComputed, (v) => v !== undefined);
return sha1(argsFiltered);
}
/**
* Fetch in the scope the previously stored computedFunctionResult.
* @param args
* @param scope
* @param functionName
*/
public static readonly getFunctionResult = <T extends ComputeEngineResult = ComputeEngineResult>(
args: MathNode[],
scope: ParserScope,
functionName: AmaliaFunctionKeys,
): T => {
const callback = AmaliaFunction.getAllFunctions()[functionName].generateComputedFunctionResult;
assert(callback, 'Trying to getFunctionResult on a function that does not support it');
const argsComputed = callback(args) as Record<string, ComputeEnginePrimitiveTypes>;
const argsKey = CalculationParser.computeArgumentsSha(argsComputed);
const currentFunctionValues = scope.get(`${functionName}Result`);
assert(
currentFunctionValues &&
typeof currentFunctionValues === 'object' &&
argsKey in currentFunctionValues &&
!Array.isArray(currentFunctionValues),
`Could not find ${functionName} result`,
);
const value = (currentFunctionValues as DatasetRowContent)[argsKey] as T | undefined;
if (value === undefined) {
throw new Error(`Could not find ${functionName} result`);
}
return value;
};
}
|