## Description
This PR upgrades Prettier to v2 + enforces TypeScript’s [`import
type`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export)
syntax where applicable. It’s submitted as a separate PR so we can merge
it easily.
As a part of this PR, we reformat the codebase heavily:
- add `import type` everywhere where it’s required, and
- re-format the code to account for Prettier 2’s breaking changes:
https://prettier.io/blog/2020/03/21/2.0.0.html#breaking-changes
This PR is submitted against `release` to make sure all new code by team
members will adhere to new formatting standards, and we’ll have fewer
conflicts when merging `bundle-optimizations` into `release`. (I’ll
merge `release` back into `bundle-optimizations` once this PR is
merged.)
### Why is this needed?
This PR is needed because, for the Lodash optimization from
7cbb12af88,
we need to use `import type`. Otherwise, `babel-plugin-lodash` complains
that `LoDashStatic` is not a lodash function.
However, just using `import type` in the current codebase will give you
this:
<img width="962" alt="Screenshot 2023-03-08 at 17 45 59"
src="https://user-images.githubusercontent.com/2953267/223775744-407afa0c-e8b9-44a1-90f9-b879348da57f.png">
That’s because Prettier 1 can’t parse `import type` at all. To parse it,
we need to upgrade to Prettier 2.
### Why enforce `import type`?
Apart from just enabling `import type` support, this PR enforces
specifying `import type` everywhere it’s needed. (Developers will get
immediate TypeScript and ESLint errors when they forget to do so.)
I’m doing this because I believe `import type` improves DX and makes
refactorings easier.
Let’s say you had a few imports like below. Can you tell which of these
imports will increase the bundle size? (Tip: it’s not all of them!)
```ts
// app/client/src/workers/Linting/utils.ts
import { Position } from "codemirror";
import { LintError as JSHintError, LintOptions } from "jshint";
import { get, isEmpty, isNumber, keys, last, set } from "lodash";
```
It’s pretty hard, right?
What about now?
```ts
// app/client/src/workers/Linting/utils.ts
import type { Position } from "codemirror";
import type { LintError as JSHintError, LintOptions } from "jshint";
import { get, isEmpty, isNumber, keys, last, set } from "lodash";
```
Now, it’s clear that only `lodash` will be bundled.
This helps developers to see which imports are problematic, but it
_also_ helps with refactorings. Now, if you want to see where
`codemirror` is bundled, you can just grep for `import \{.*\} from
"codemirror"` – and you won’t get any type-only imports.
This also helps (some) bundlers. Upon transpiling, TypeScript erases
type-only imports completely. In some environment (not ours), this makes
the bundle smaller, as the bundler doesn’t need to bundle type-only
imports anymore.
## Type of change
- Chore (housekeeping or task changes that don't impact user perception)
## How Has This Been Tested?
This was tested to not break the build.
### Test Plan
> Add Testsmith test cases links that relate to this PR
### Issues raised during DP testing
> Link issues raised during DP testing for better visiblity and tracking
(copy link from comments dropped on this PR)
## Checklist:
### Dev activity
- [x] 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
- [x] 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:
- [ ] Test plan has been approved by relevant developers
- [ ] Test plan has been peer reviewed by QA
- [ ] Cypress test cases have been added and approved by either SDET or
manual QA
- [ ] Organized project review call with relevant stakeholders after
Round 1/2 of QA
- [ ] Added Test Plan Approved label after reveiwing all Cypress test
---------
Co-authored-by: Satish Gandham <hello@satishgandham.com>
Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
150 lines
5.2 KiB
TypeScript
150 lines
5.2 KiB
TypeScript
import { ObjectsRegistry } from "../Objects/Registry";
|
|
|
|
export class DeployMode {
|
|
private locator = ObjectsRegistry.CommonLocators;
|
|
private agHelper = ObjectsRegistry.AggregateHelper;
|
|
|
|
_jsonFieldName = (fieldName: string) => `//p[text()='${fieldName}']`;
|
|
_jsonFormFieldByName = (fieldName: string, input: boolean = true) =>
|
|
this._jsonFieldName(fieldName) +
|
|
`/ancestor::div[@direction='column']//div[@data-testid='input-container']//${
|
|
input ? "input" : "textarea"
|
|
}`;
|
|
_jsonFormRadioFieldByName = (fieldName: string) =>
|
|
`//p[text()='${fieldName}']/ancestor::div[@direction='column']//div[@data-testid='radiogroup-container']//input`;
|
|
_jsonFormDatepickerFieldByName = (fieldName: string) =>
|
|
`//p[text()='${fieldName}']/ancestor::div[@direction='column']//div[@data-testid='datepicker-container']//input`;
|
|
_jsonSelectDropdown = "button.select-button";
|
|
private _jsonFormMultiSelectByName = (fieldName: string) =>
|
|
`//p[text()='${fieldName}']/ancestor::div[@direction='column']//div[@data-testid='multiselect-container']//div[contains(@class, 'rc-select-show-arrow')]`;
|
|
_clearDropdown = "button.select-button span.cancel-icon";
|
|
private _jsonFormMultiSelectOptions = (option: string) =>
|
|
`//div[@title='${option}']//input[@type='checkbox']/ancestor::div[@title='${option}']`;
|
|
private _backtoHome = ".t--back-to-home";
|
|
private _homeAppsmithImage = "a.t--appsmith-logo";
|
|
|
|
//refering PublishtheApp from command.js
|
|
public DeployApp(
|
|
eleToCheckInDeployPage: string = this.locator._backToEditor,
|
|
toCheckFailureToast = true,
|
|
) {
|
|
//cy.intercept("POST", "/api/v1/applications/publish/*").as("publishAppli");
|
|
// Wait before publish
|
|
this.agHelper.Sleep(2000); //wait for elements settle!
|
|
this.agHelper.AssertAutoSave();
|
|
// Stubbing window.open to open in the same tab
|
|
cy.window().then((window) => {
|
|
cy.stub(window, "open").callsFake((url) => {
|
|
window.location.href = Cypress.config().baseUrl + url.substring(1);
|
|
});
|
|
});
|
|
cy.get(this.locator._publishButton).click();
|
|
cy.log("Pagename: " + localStorage.getItem("PageName"));
|
|
|
|
//Below url check throwing error - hence commenting!
|
|
// cy.wait("@publishApp")
|
|
// .its("request.url")
|
|
// .should("not.contain", "edit");
|
|
//cy.wait('@publishApp').wait('@publishApp') //waitng for 2 calls to complete
|
|
|
|
this.agHelper.WaitUntilEleAppear(eleToCheckInDeployPage);
|
|
localStorage.setItem("inDeployedMode", "true");
|
|
toCheckFailureToast &&
|
|
this.agHelper.AssertElementAbsence(
|
|
this.locator._specificToast("has failed"),
|
|
); //Validating bug - 14141 + 14252
|
|
this.agHelper.Sleep(2000); //for Depoy page to settle!
|
|
}
|
|
|
|
// Stubbing window.open to open in the same tab
|
|
public StubbingWindow() {
|
|
cy.window().then((window: any) => {
|
|
cy.stub(window, "open").callsFake((url) => {
|
|
window.location.href = url;
|
|
window.location.target = "_self";
|
|
});
|
|
});
|
|
}
|
|
|
|
public NavigateBacktoEditor() {
|
|
cy.get(this.locator._backToEditor).click();
|
|
this.agHelper.Sleep(2000);
|
|
localStorage.setItem("inDeployedMode", "false");
|
|
this.agHelper.AssertElementVisible(this.locator._dropHere); //Assert if canvas is visible after Navigating back!
|
|
}
|
|
|
|
public NavigateToHomeDirectly() {
|
|
this.agHelper.GetNClick(this._backtoHome);
|
|
this.agHelper.Sleep(2000);
|
|
this.agHelper.AssertElementVisible(this._homeAppsmithImage);
|
|
}
|
|
|
|
public EnterJSONInputValue(fieldName: string, value: string, index = 0) {
|
|
cy.xpath(this._jsonFormFieldByName(fieldName))
|
|
.eq(index)
|
|
.click()
|
|
.type(value, { delay: 0 })
|
|
.wait(200);
|
|
}
|
|
|
|
public EnterJSONTextAreaValue(fieldName: string, value: string, index = 0) {
|
|
cy.xpath(this._jsonFormFieldByName(fieldName, false))
|
|
.eq(index)
|
|
.click()
|
|
.type(value, { delay: 0 })
|
|
.wait(200);
|
|
}
|
|
|
|
public ClearJSONFieldValue(fieldName: string, index = 0, isInput = true) {
|
|
cy.xpath(this._jsonFormFieldByName(fieldName, isInput))
|
|
.eq(index)
|
|
.clear()
|
|
.wait(300);
|
|
}
|
|
|
|
public SelectJsonFormDropDown(dropdownOption: string, index = 0) {
|
|
cy.get(this._jsonSelectDropdown).eq(index).scrollIntoView().click();
|
|
cy.get(this.locator._selectOptionValue(dropdownOption)).click({
|
|
force: true,
|
|
});
|
|
this.agHelper.Sleep(); //for selected value to reflect!
|
|
}
|
|
|
|
public SelectJsonFormMultiSelect(
|
|
name: string,
|
|
options: string[],
|
|
index = 0,
|
|
check = true,
|
|
) {
|
|
cy.xpath(this._jsonFormMultiSelectByName(name))
|
|
.eq(index)
|
|
.scrollIntoView()
|
|
.click();
|
|
this.agHelper.Sleep(500);
|
|
|
|
if (check) {
|
|
options.forEach(($each) => {
|
|
cy.get(this.locator._multiSelectOptions($each))
|
|
.check({ force: true })
|
|
.wait(800);
|
|
cy.xpath(this._jsonFormMultiSelectOptions($each)).should(
|
|
"have.class",
|
|
"rc-select-item-option-selected",
|
|
);
|
|
});
|
|
} else {
|
|
options.forEach(($each) => {
|
|
cy.get(this.locator._multiSelectOptions($each))
|
|
.uncheck({ force: true })
|
|
.wait(800);
|
|
cy.xpath(this._jsonFormMultiSelectOptions($each)).should(
|
|
"not.have.class",
|
|
"rc-select-item-option-selected",
|
|
);
|
|
});
|
|
}
|
|
// //closing multiselect dropdown
|
|
cy.get("body").type("{esc}");
|
|
}
|
|
}
|