Skip to content

feat(query): Add filter/order/limit to subqueries #1704

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

Open
paustint wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(query): Add filter/order/limit to subqueries #1704

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
4 changes: 4 additions & 0 deletions apps/jetstream-desktop-client/src/app/components/core/AppStateResetOnOrgChange.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ export const AppStateResetOnOrgChange = () => {
useResetAtom(fromQueryState.queryFieldsMapState),
useResetAtom(fromQueryState.selectedQueryFieldsState),
useResetAtom(fromQueryState.selectedSubqueryFieldsState),
useResetAtom(fromQueryState.querySubqueryFiltersState),
useResetAtom(fromQueryState.querySubqueryOrderByState),
useResetAtom(fromQueryState.querySubqueryLimitState),
useResetAtom(fromQueryState.subqueryConfigPanelState),
useResetAtom(fromQueryState.filterQueryFieldsState),
useResetAtom(fromQueryState.orderByQueryFieldsState),
useResetAtom(fromQueryState.queryFiltersState),
Expand Down
4 changes: 4 additions & 0 deletions apps/jetstream/src/app/components/core/AppStateResetOnOrgChange.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ export const AppStateResetOnOrgChange = () => {
useResetAtom(fromQueryState.queryFieldsMapState),
useResetAtom(fromQueryState.selectedQueryFieldsState),
useResetAtom(fromQueryState.selectedSubqueryFieldsState),
useResetAtom(fromQueryState.querySubqueryFiltersState),
useResetAtom(fromQueryState.querySubqueryOrderByState),
useResetAtom(fromQueryState.querySubqueryLimitState),
useResetAtom(fromQueryState.subqueryConfigPanelState),
useResetAtom(fromQueryState.filterQueryFieldsState),
useResetAtom(fromQueryState.orderByQueryFieldsState),
useResetAtom(fromQueryState.queryFiltersState),
Expand Down
68 changes: 65 additions & 3 deletions libs/features/query/src/QueryBuilder/QueryBuilder.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import { applicationCookieState, selectedOrgState, soqlQueryFormatOptionsState }
import { formatQuery } from '@jetstreamapp/soql-parser-js';
import { useAtom, useAtomValue, useSetAtom } from 'jotai';
import { useResetAtom } from 'jotai/utils';
import { Fragment, useCallback, useRef, useState } from 'react';
import { Fragment, FunctionComponent, useCallback, useEffect, useRef, useState } from 'react';
import { useNavigate } from 'react-router-dom';
import ManualSoql from '../QueryOptions/ManualSoql';
import QueryBuilderAdvancedOptions from '../QueryOptions/QueryBuilderAdvancedOptions';
Expand All @@ -61,6 +61,7 @@ import QueryWalkthrough from '../QueryWalkthrough/QueryWalkthrough';
import ExecuteQueryButton from './ExecuteQueryButton';
import QueryBuilderSoqlUpdater from './QueryBuilderSoqlUpdater';
import QueryFieldsComponent from './QueryFields';
import QuerySubqueryConfigPanel from './QuerySubqueryConfigPanel';
import QuerySubquerySObjects from './QuerySubquerySObjects';

const HEIGHT_BUFFER = 175;
Expand All @@ -72,6 +73,36 @@ const METADATA_QUERY_ID = 'metadata';
const METADATA_QUERY_TITLE = 'Query Metadata Records';
const METADATA_QUERY_ICON: IconObj = { type: 'standard', icon: 'settings', description: 'Metadata Query' };

// Tiny atom-connected wrappers so order-by / limit subscriptions stay leaf-scoped —
// a change to queryOrderByState / queryLimit re-renders the wrapper, not the whole QueryBuilder body.
interface ConnectedQueryOrderByProps {
sobject: string;
fields: ListItem[];
onLoadRelatedFields: (item: ListItem) => Promise<ListItem[]>;
}

const ConnectedQueryOrderBy: FunctionComponent<ConnectedQueryOrderByProps> = ({ sobject, fields, onLoadRelatedFields }) => {
const [orderByClauses, setOrderByClauses] = useAtom(fromQueryState.queryOrderByState);
return (
<QueryOrderBy
sobject={sobject}
fields={fields}
orderByClauses={orderByClauses}
setOrderByClauses={setOrderByClauses}
onLoadRelatedFields={onLoadRelatedFields}
/>
);
};

const ConnectedQueryLimit: FunctionComponent = () => {
const [limit, setLimit] = useAtom(fromQueryState.queryLimit);
const [limitSkip, setLimitSkip] = useAtom(fromQueryState.queryLimitSkip);
const hasLimitOverride = useAtomValue(fromQueryState.selectQueryLimitHasOverride);
return (
<QueryLimit limit={limit} setLimit={setLimit} limitSkip={limitSkip} setLimitSkip={setLimitSkip} hasLimitOverride={hasLimitOverride} />
);
};

export const QueryBuilder = () => {
const { trackEvent } = useAmplitude();
const navigate = useNavigate();
Expand All @@ -94,6 +125,8 @@ export const QueryBuilder = () => {
const setGroupByFields = useSetAtom(fromQueryState.groupByQueryFieldsState);
const queryKey = useAtomValue(fromQueryState.selectQueryKeyState);
const [queryFilters, setQueryFilters] = useAtom(fromQueryState.queryFiltersState);
const subqueryConfigPanel = useAtomValue(fromQueryState.subqueryConfigPanelState);
const resetSubqueryConfigPanel = useResetAtom(fromQueryState.subqueryConfigPanelState);

const resetSelectedQueryFieldsState = useResetAtom(fromQueryState.selectedQueryFieldsState);
const resetFilterQueryFieldsState = useResetAtom(fromQueryState.filterQueryFieldsState);
Expand All @@ -103,6 +136,9 @@ export const QueryBuilder = () => {
const resetQueryFieldsMapState = useResetAtom(fromQueryState.queryFieldsMapState);
const resetQueryFieldsKey = useResetAtom(fromQueryState.queryFieldsKey);
const resetSelectedSubqueryFieldsState = useResetAtom(fromQueryState.selectedSubqueryFieldsState);
const resetQuerySubqueryFiltersState = useResetAtom(fromQueryState.querySubqueryFiltersState);
const resetQuerySubqueryOrderByState = useResetAtom(fromQueryState.querySubqueryOrderByState);
const resetQuerySubqueryLimitState = useResetAtom(fromQueryState.querySubqueryLimitState);
const resetQueryFiltersState = useResetAtom(fromQueryState.queryFiltersState);
const resetQueryHavingState = useResetAtom(fromQueryState.queryHavingState);
const resetFieldFilterFunctions = useResetAtom(fromQueryState.fieldFilterFunctions);
Expand Down Expand Up @@ -241,6 +277,10 @@ export const QueryBuilder = () => {
resetFilterQueryFieldsState();
resetOrderByQueryFieldsState();
resetSelectedSubqueryFieldsState();
resetQuerySubqueryFiltersState();
resetQuerySubqueryOrderByState();
resetQuerySubqueryLimitState();
resetSubqueryConfigPanel();
resetQueryFiltersState();
resetQueryHavingState();
resetFieldFilterFunctions();
Expand All @@ -260,6 +300,10 @@ export const QueryBuilder = () => {
resetFilterQueryFieldsState,
resetOrderByQueryFieldsState,
resetSelectedSubqueryFieldsState,
resetQuerySubqueryFiltersState,
resetQuerySubqueryOrderByState,
resetQuerySubqueryLimitState,
resetSubqueryConfigPanel,
resetQueryFiltersState,
resetQueryHavingState,
resetFieldFilterFunctions,
Expand All @@ -279,6 +323,14 @@ export const QueryBuilder = () => {
resetState();
}, [isTooling, resetState]);

// The subquery config panel is ephemeral UI. Clear it on unmount so it never
// re-opens when the user navigates away and later returns to this page.
useEffect(() => {
return () => {
resetSubqueryConfigPanel();
};
}, [resetSubqueryConfigPanel]);

function handleOpenHistory(type: fromQueryHistoryState.QueryHistoryType) {
queryHistoryRef.current?.open(type);
}
Expand All @@ -287,6 +339,16 @@ export const QueryBuilder = () => {
<Fragment>
<QueryBuilderSoqlUpdater />
{showWalkthrough && <QueryWalkthrough onClose={handleQueryWalkthroughClose} />}
{subqueryConfigPanel && (
<QuerySubqueryConfigPanel
key={subqueryConfigPanel.relationshipName}
org={selectedOrg}
isOpen
relationshipName={subqueryConfigPanel.relationshipName}
childSObject={subqueryConfigPanel.childSObject}
onClose={resetSubqueryConfigPanel}
/>
)}
<Page testId="query-builder-page">
<PageHeader>
<PageHeaderRow>
Expand Down Expand Up @@ -464,7 +526,7 @@ export const QueryBuilder = () => {
title: 'Order By',
titleSummaryIfCollapsed: <QueryOrderByTitleSummary key={queryKey} />,
content: (
<QueryOrderBy
<ConnectedQueryOrderBy
key={queryKey}
sobject={selectedSObject.name}
fields={orderByFields}
Expand All @@ -476,7 +538,7 @@ export const QueryBuilder = () => {
id: 'limit',
title: 'Limit',
titleSummaryIfCollapsed: <QueryLimitTitleSummary key={queryKey} />,
content: <QueryLimit key={queryKey} />,
content: <ConnectedQueryLimit key={queryKey} />,
},
{
id: 'soql',
Expand Down
Loading
Loading