PromucFlow_constructor/app/client/src/utils/autocomplete/TernWorkerService.ts
Favour Ohanekwu e6f2dcacde
feat: Improve Linting performance (#23865)
## Description
This PR introduces a new architecture, making evaluation and linting
independent.

<img width="500" alt="Screenshot 2023-07-04 at 17 24 40"
src="https://github.com/appsmithorg/appsmith/assets/46670083/00b1eab9-cd79-4442-b51a-5345c2d6c4da">


In the previous architecture, one dependency graph was used to hold the
relationship between entities in the application and subsequently, the
"evaluation order" and "paths to lint" were generated.

Although similar, the dependency graph required for evaluation and
linting differ. For example, trigger fields should not depend on any
other entity/entity path in the eval's dependency graph since they are
not reactive. This is not the case for the linting dependency graph.

## Performance

- This PR introduces "lint only" actions. These actions trigger linting,
but not evaluation. For example, UPDATE_JS_ACTION_BODY_INIT (which is
fired immediately after a user edits the body of a JS Object). Since
linting fires without waiting for a successful update on the server,
**response time decreases by 40%** (from 2s to 1.2s).


- Reduction in time taken to generate paths requiring linting.

<img width="715" alt="Screenshot 2023-07-04 at 18 10 52"
src="https://github.com/appsmithorg/appsmith/assets/46670083/d73a4bfc-de73-4fa7-bdca-af1e5d8ce8a1">



#### PR fixes following issue(s)
Fixes #23447 
Fixes #23166
Fixes #24194 
Fixes #23720 
Fixes #23868 
Fixes #21895 

Latest DP: https://appsmith-r3f9e325p-get-appsmith.vercel.app/



#### Type of change

- Chore (housekeeping or task changes that don't impact user perception)

## Testing
>
#### How Has This Been Tested?
- [x] Manual
- [ ] Jest
- [ ] Cypress
>
>
#### Test Plan

https://github.com/appsmithorg/appsmith/pull/23865#issuecomment-1606738633
>
>
#### Issues raised during DP testing

https://github.com/appsmithorg/appsmith/pull/23865#issuecomment-1608779227
response:
https://github.com/appsmithorg/appsmith/pull/23865#issuecomment-1619677033
>
>
>
## Checklist:
#### Dev activity
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] PR is being merged under a feature flag


#### QA activity:
- [ ] [Speedbreak
features](https://github.com/appsmithorg/TestSmith/wiki/Test-plan-implementation#speedbreaker-features-to-consider-for-every-change)
have been covered
- [ ] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans/_edit#areas-of-interest)
- [x] Test plan has been peer reviewed by project stakeholders and other
QA members
- [x] Manually tested functionality on DP
- [ ] We had an implementation alignment call with stakeholders post QA
Round 2
- [ ] Cypress test cases have been added and approved by SDET/manual QA
- [ ] Added `Test Plan Approved` label after Cypress tests were reviewed
- [ ] Added `Test Plan Approved` label after JUnit tests were reviewed

---------

Co-authored-by: arunvjn <arun@appsmith.com>
Co-authored-by: Ivan Akulov <mail@iamakulov.com>
2023-07-05 14:34:03 +01:00

87 lines
2.4 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import type { Def, Server } from "tern";
import type { CallbackFn } from "./types";
import { TernWorkerAction } from "./types";
const ternWorker = new Worker(
new URL("../../workers/Tern/tern.worker.ts", import.meta.url),
{
// Note: the `Worker` part of the name is slightly important LinkRelPreload_spec.js
// relies on it to find workers in the list of all requests.
name: "TernWorker",
type: "module",
},
);
function getFile(ts: any, name: string, c: CallbackFn) {
const buf = ts.docs[name];
if (buf) c(ts.docValue(ts, buf));
else if (ts.options.getFile) ts.options.getFile(name, c);
else c(null);
}
type TernWorkerServerConstructor = {
(ts: any): void;
new (ts: any): Server;
};
function TernWorkerServer(this: any, ts: any) {
const worker = (ts.worker = ternWorker);
worker.postMessage({
type: TernWorkerAction.INIT,
plugins: ts.options.plugins,
scripts: ts.options.workerDeps,
});
let msgId = 0;
let pending: { [x: number]: CallbackFn } = {};
function send(data: any, c?: CallbackFn) {
if (c) {
data.id = ++msgId;
pending[msgId] = c;
}
worker.postMessage(data);
}
worker.onmessage = function (e) {
const data = e.data;
if (data) {
if (data.type == TernWorkerAction.GET_FILE) {
getFile(ts, data.name, function (err, text) {
send({
type: TernWorkerAction.GET_FILE,
err: String(err),
text: text,
id: data.id,
});
});
} else if (data.type == TernWorkerAction.DEBUG) {
window.console.log(data.message);
} else if (data.id && pending[data.id]) {
pending[data.id](data.err, data.body);
delete pending[data.id];
}
}
};
worker.onerror = function (e) {
for (const id in pending) pending[id](e);
pending = {};
};
this.addFile = function (name: string, text: string) {
send({ type: TernWorkerAction.ADD_FILE, name: name, text: text });
};
this.delFile = function (name: string) {
send({ type: TernWorkerAction.DELETE_FILE, name: name });
};
this.request = function (body: any, c: CallbackFn) {
send({ type: TernWorkerAction.REQUEST, body: body }, c);
};
this.addDefs = function (defs: Def) {
send({ type: TernWorkerAction.ADD_DEF, defs });
};
this.deleteDefs = function (name: string) {
send({ type: TernWorkerAction.DELETE_DEF, name });
};
}
export default TernWorkerServer as TernWorkerServerConstructor;