Skip to content

Data extensions editor: Implement "Hide modeled APIs" checkbox and make it the default #2651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shati-patel merged 1 commit into from
Jul 27, 2023
Merged

Data extensions editor: Implement "Hide modeled APIs" checkbox and make it the default #2651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion extensions/ql-vscode/src/view/data-extensions-editor/DataExtensionsEditor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ export function DataExtensionsEditor({
new Set(),
);

const [hideModeledApis, setHideModeledApis] = useState(true);

const [modeledMethods, setModeledMethods] = useState<
Record<string, ModeledMethod>
>(initialModeledMethods);
Expand Down Expand Up @@ -252,6 +254,10 @@ export function DataExtensionsEditor({
});
}, [viewState?.mode]);

const onHideModeledApis = useCallback(() => {
Copy link
Copy Markdown
Contributor

@robertbrignull robertbrignull Jul 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be picky (sorry I didn't mention this while pairing) and to fit in with conventions, I believe we should call this handleHideModeledApisChanged or something like that. Calling the function itself handleX is apparently the standard convention, especially when created using useCallback.

Copy link
Copy Markdown
Contributor Author

@shati-patel shati-patel Jul 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! [As discussed offline, I'll leave the name as-is for now since the rest of this file also doesn't follow the handleXXX convention 😅 ]

setHideModeledApis((oldHideModeledApis) => !oldHideModeledApis);
}, []);

if (viewState === undefined || externalApiUsages.length === 0) {
return <LoadingContainer>Loading...</LoadingContainer>;
}
Expand Down Expand Up @@ -292,7 +298,12 @@ export function DataExtensionsEditor({
</HeaderColumn>
<HeaderSpacer />
<HeaderColumn>
<VSCodeCheckbox>Hide modeled APIs</VSCodeCheckbox>
<VSCodeCheckbox
checked={hideModeledApis}
onChange={onHideModeledApis}
>
Hide modeled APIs
</VSCodeCheckbox>
</HeaderColumn>
</HeaderContainer>

Expand Down Expand Up @@ -320,6 +331,7 @@ export function DataExtensionsEditor({
modeledMethods={modeledMethods}
modifiedSignatures={modifiedSignatures}
viewState={viewState}
hideModeledApis={hideModeledApis}
onChange={onChange}
onSaveModelClick={onSaveModelClick}
onGenerateFromLlmClick={onGenerateFromLlmClick}
Expand Down
3 changes: 3 additions & 0 deletions extensions/ql-vscode/src/view/data-extensions-editor/LibraryRow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ type Props = {
modeledMethods: Record<string, ModeledMethod>;
modifiedSignatures: Set<string>;
viewState: DataExtensionEditorViewState;
hideModeledApis: boolean;
onChange: (
modelName: string,
externalApiUsage: ExternalApiUsage,
Expand All @@ -97,6 +98,7 @@ export const LibraryRow = ({
modeledMethods,
modifiedSignatures,
viewState,
hideModeledApis,
onChange,
onSaveModelClick,
onGenerateFromLlmClick,
Expand Down Expand Up @@ -208,6 +210,7 @@ export const LibraryRow = ({
modeledMethods={modeledMethods}
modifiedSignatures={modifiedSignatures}
mode={viewState.mode}
hideModeledApis={hideModeledApis}
onChange={onChangeWithModelName}
/>
<SectionDivider />
Expand Down
6 changes: 5 additions & 1 deletion extensions/ql-vscode/src/view/data-extensions-editor/MethodRow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,16 @@ type Props = {
modeledMethod: ModeledMethod | undefined;
methodIsUnsaved: boolean;
mode: Mode;
hideModeledApis: boolean;
onChange: (
externalApiUsage: ExternalApiUsage,
modeledMethod: ModeledMethod,
) => void;
};

export const MethodRow = (props: Props) => {
const { externalApiUsage, modeledMethod, methodIsUnsaved } = props;
const { externalApiUsage, modeledMethod, methodIsUnsaved, hideModeledApis } =
props;

const methodCanBeModeled =
!externalApiUsage.supported ||
Expand All @@ -72,6 +74,8 @@ export const MethodRow = (props: Props) => {

if (methodCanBeModeled) {
return <ModelableMethodRow {...props} />;
} else if (hideModeledApis) {
return null;
} else {
return <UnmodelableMethodRow {...props} />;
}
Expand Down
3 changes: 3 additions & 0 deletions extensions/ql-vscode/src/view/data-extensions-editor/ModeledMethodDataGrid.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ type Props = {
modeledMethods: Record<string, ModeledMethod>;
modifiedSignatures: Set<string>;
mode: Mode;
hideModeledApis: boolean;
onChange: (
externalApiUsage: ExternalApiUsage,
modeledMethod: ModeledMethod,
Expand All @@ -27,6 +28,7 @@ export const ModeledMethodDataGrid = ({
modeledMethods,
modifiedSignatures,
mode,
hideModeledApis,
onChange,
}: Props) => {
const sortedExternalApiUsages = useMemo(
Expand Down Expand Up @@ -60,6 +62,7 @@ export const ModeledMethodDataGrid = ({
modeledMethod={modeledMethods[externalApiUsage.signature]}
methodIsUnsaved={modifiedSignatures.has(externalApiUsage.signature)}
mode={mode}
hideModeledApis={hideModeledApis}
onChange={onChange}
/>
))}
Expand Down
3 changes: 3 additions & 0 deletions extensions/ql-vscode/src/view/data-extensions-editor/ModeledMethodsList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ type Props = {
modeledMethods: Record<string, ModeledMethod>;
modifiedSignatures: Set<string>;
viewState: DataExtensionEditorViewState;
hideModeledApis: boolean;
onChange: (
modelName: string,
externalApiUsage: ExternalApiUsage,
Expand All @@ -41,6 +42,7 @@ export const ModeledMethodsList = ({
modeledMethods,
modifiedSignatures,
viewState,
hideModeledApis,
onChange,
onSaveModelClick,
onGenerateFromLlmClick,
Expand Down Expand Up @@ -83,6 +85,7 @@ export const ModeledMethodsList = ({
modeledMethods={modeledMethods}
modifiedSignatures={modifiedSignatures}
viewState={viewState}
hideModeledApis={hideModeledApis}
onChange={onChange}
onSaveModelClick={onSaveModelClick}
onGenerateFromLlmClick={onGenerateFromLlmClick}
Expand Down