PromucFlow_constructor/app/client/src/plugins/Linting/utils/pathUtils.ts
Valera Melnikov c42e0317de
fix: change appsmith alias (#35349)
In order to unify package names, we decided to use `@appsmith` prefix as
a marker to indicate that packages belong to our codebase and that these
packages are developed internally. So that we can use this prefix, we
need to rename the alias of the same name. But since `@appsmith` is
currently being used as an alias for `ee` folder, we have to rename the
alias as the first step.

Related discussion
https://theappsmith.slack.com/archives/CPG2ZTXEY/p1722516279126329

EE PR — https://github.com/appsmithorg/appsmith-ee/pull/4801

## Automation

/ok-to-test tags="@tag.All"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/10267368821>
> Commit: 2b00af2d257e4d4304db0a80072afef7513de6be
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=10267368821&attempt=2"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.All`
> Spec:
> <hr>Tue, 06 Aug 2024 14:24:22 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No
2024-08-06 17:52:22 +03:00

108 lines
3.8 KiB
TypeScript

import { isWidgetEntity } from "ee/plugins/Linting/lib/entity";
import {
convertPathToString,
getEntityNameAndPropertyPath,
isTrueObject,
} from "ee/workers/Evaluation/evaluationUtils";
import { toPath, union } from "lodash";
import { isDynamicEntity } from "ee/plugins/Linting/lib/entity/isDynamicEntity";
import type { IEntity } from "ee/plugins/Linting/lib/entity/types";
export class PathUtils {
static getReactivePaths(entity: IEntity) {
if (!isDynamicEntity(entity)) return [];
const config = entity.getConfig();
const name = entity.getName();
const reactivePaths = config.reactivePaths;
if (!reactivePaths) return [];
return PathUtils.getFullNamesFromPropertyPaths(
Object.keys(reactivePaths),
name,
);
}
static getBindingPaths(entity: IEntity) {
if (!isDynamicEntity(entity)) return [];
const config = entity.getConfig();
const name = entity.getName();
const bindingPaths = config.bindingPaths;
if (!bindingPaths) return [];
return PathUtils.getFullNamesFromPropertyPaths(
Object.keys(bindingPaths),
name,
);
}
static getTriggerPaths(entity: IEntity) {
if (!isWidgetEntity(entity)) return [];
const config = entity.getConfig();
const name = entity.getName();
const triggerPaths = config.triggerPaths;
return PathUtils.getFullNamesFromPropertyPaths(
Object.keys(triggerPaths),
name,
);
}
static getDynamicPaths(entity: IEntity) {
if (!isDynamicEntity(entity)) return [];
const reactivePaths = PathUtils.getReactivePaths(entity);
const triggerPaths = PathUtils.getTriggerPaths(entity);
const bindingPaths = PathUtils.getBindingPaths(entity);
return union(reactivePaths, triggerPaths, bindingPaths);
}
static getFullNamesFromPropertyPaths(paths: string[], parentName: string) {
return paths.map((path) => `${parentName}.${path}`);
}
static isDataPath(fullPath: string, entity: IEntity) {
if (!isWidgetEntity(entity) || !this.isDynamicLeaf(entity, fullPath))
return false;
const entityConfig = entity.getConfig();
const { propertyPath } = getEntityNameAndPropertyPath(fullPath);
return !(propertyPath in entityConfig.triggerPaths);
}
static getDataPaths(entity: IEntity) {
if (!isWidgetEntity(entity)) return [];
return PathUtils.getBindingPaths(entity);
}
static isDynamicLeaf(entity: IEntity, fullPropertyPath: string) {
const [entityName, ...propPathEls] = toPath(fullPropertyPath);
// Framework feature: Top level items are never leaves
if (entityName === fullPropertyPath) return false;
const entityConfig = entity.getConfig() as Record<string, unknown>;
if (!entityConfig) return false;
const reactivePaths = entityConfig.reactivePaths as Record<string, unknown>;
if (!isDynamicEntity(entity) || !entityConfig) return false;
const relativePropertyPath = convertPathToString(propPathEls);
return (
relativePropertyPath in reactivePaths ||
(isWidgetEntity(entity) &&
relativePropertyPath in entity.getConfig().triggerPaths)
);
}
static getAllPaths = (
// TODO: Fix this the next time the file is edited
// eslint-disable-next-line @typescript-eslint/no-explicit-any
records: any,
curKey = "",
result: Record<string, true> = {},
): Record<string, true> => {
if (curKey) result[curKey] = true;
if (Array.isArray(records)) {
for (let i = 0; i < records.length; i++) {
const tempKey = curKey ? `${curKey}[${i}]` : `${i}`;
PathUtils.getAllPaths(records[i], tempKey, result);
}
} else if (isTrueObject(records)) {
for (const key of Object.keys(records)) {
const tempKey = curKey ? `${curKey}.${key}` : `${key}`;
PathUtils.getAllPaths(records[key], tempKey, result);
}
}
return result;
};
}