Skip to content

feat: allow alternative field export format #1517

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: allow alternative field export format #1517

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
164 changes: 124 additions & 40 deletions libs/features/sobject-export/src/SObjectExport.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { logger } from '@jetstream/shared/client-logger';
import { INDEXED_DB, TITLES } from '@jetstream/shared/constants';
import { APP_ROUTES } from '@jetstream/shared/ui-router';
import { useRollbar, useTitle } from '@jetstream/shared/ui-utils';
import { getErrorMessage, getErrorMessageAndStackObj } from '@jetstream/shared/utils';
import { getErrorMessage, getErrorMessageAndStackObj, NOOP } from '@jetstream/shared/utils';
import { SplitWrapper as Split } from '@jetstream/splitjs';
import { DescribeGlobalSObjectResult, ListItem, Maybe } from '@jetstream/types';
import {
Expand Down Expand Up @@ -31,7 +31,9 @@ import { recentHistoryItemsDb } from '@jetstream/ui/db';
import { useAtomValue } from 'jotai';
import localforage from 'localforage';
import { Fragment, FunctionComponent, useEffect, useRef, useState } from 'react';
import { prepareMetadataExport } from './sobject-export-metadata-utils';
import {
ExportFormat,
ExportHeaderOption,
ExportOptions,
ExportWorksheetLayout,
Expand All @@ -44,6 +46,7 @@ import {
getAttributes,
getChildRelationshipNames,
getExtendedFieldDefinitionData,
getMetadataAttributes,
getSobjectMetadata,
prepareExport,
} from './sobject-export-utils';
Expand All @@ -57,6 +60,16 @@ const FIELD_ATTRIBUTES: ListItem<SobjectExportFieldName>[] = getAttributes().map
tertiaryLabel,
}));

const METADATA_FIELD_ATTRIBUTES: ListItem<SobjectExportFieldName>[] = getMetadataAttributes().map(
({ label, name, description, tertiaryLabel }) => ({
id: name,
label: `${label} (${name})`,
value: name,
secondaryLabel: description,
tertiaryLabel,
}),
);

const DEFAULT_SELECTION: SobjectExportFieldName[] = [
'calculatedFormula',
'createable',
Expand All @@ -75,9 +88,12 @@ const DEFAULT_SELECTION: SobjectExportFieldName[] = [
'updateable',
];

const DEFAULT_METADATA_SELECTION = METADATA_FIELD_ATTRIBUTES.map((item) => item.value);

const DEFAULT_OPTIONS: ExportOptions = {
exportFormat: 'describe', // describe, metadata
worksheetLayout: 'combined', // combined, split
headerOption: 'label', // label, name
headerOption: 'name', // label, name
Copy link

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

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

The default headerOption was changed from 'label' to 'name', which changes the default behavior for all users. This could be unexpected for existing users who rely on the previous default of 'label'. Consider either reverting this change to maintain backward compatibility, or documenting this breaking change in the PR description and release notes. If the intent is to use 'name' as the default only for metadata exports, this should be handled conditionally rather than changing the global default.

Suggested change
headerOption: 'name', // label, name
headerOption: 'label', // label, name

Copilot uses AI. Check for mistakes.
includesStandardFields: true,
includeObjectAttributes: false,
saveAsDefaultSelection: false,
Expand All @@ -93,6 +109,7 @@ export const SObjectExport: FunctionComponent<SObjectExportProps> = () => {
const { google_apiKey, google_appId, google_clientId } = useAtomValue(applicationCookieState);
const { hasGoogleDriveAccess, googleShowUpgradeToPro } = useAtomValue(googleDriveAccessState);

const picklistExportFormatRef = useRef<PicklistRef>(null);
const picklistWorksheetLayoutRef = useRef<PicklistRef>(null);
const picklistHeaderOptionRef = useRef<PicklistRef>(null);

Expand All @@ -109,17 +126,29 @@ export const SObjectExport: FunctionComponent<SObjectExportProps> = () => {
const [hasSelectionsMade, setHasSelectionsMade] = useState(false);
const [options, setOptions] = useState<ExportOptions>({ ...DEFAULT_OPTIONS });

const isMetadataExport = options.exportFormat === 'metadata';

useEffect(() => {
setSobjects(null);
setSelectedSObjects([]);
}, [selectedOrg]);

useEffect(() => {
if (isMetadataExport) {
picklistHeaderOptionRef.current?.selectItem('name');
picklistWorksheetLayoutRef.current?.selectItem('split');
Comment on lines +137 to +139
Copy link

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

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

When switching to metadata export mode, the worksheet layout picklist is programmatically set to 'split' via the ref, but the underlying options.worksheetLayout state is not updated. This creates an inconsistency where the picklist display might not match the actual state value. Additionally, the worksheet layout picklist is not disabled for metadata exports (unlike other options), allowing users to change it. Consider either: (1) disabling the worksheet layout picklist for metadata exports if 'split' is the required layout, or (2) updating the options state when switching to metadata export mode to keep the UI and state in sync.

Suggested change
if (isMetadataExport) {
picklistHeaderOptionRef.current?.selectItem('name');
picklistWorksheetLayoutRef.current?.selectItem('split');
if (isMetadataExport) {
// Ensure the UI picklists show the correct options for metadata exports
picklistHeaderOptionRef.current?.selectItem('name');
picklistWorksheetLayoutRef.current?.selectItem('split');
// Keep underlying options state in sync with the picklist selections
setOptions((prev) => ({
...prev,
headerOption: 'name',
worksheetLayout: 'split',
}));

Copilot uses AI. Check for mistakes.
}
}, [isMetadataExport]);

useEffect(() => {
(async () => {
try {
const results = await localforage.getItem<SavedExportOptions>(INDEXED_DB.KEYS.sobjectExportSelection);
if (results?.options) {
setOptions(results.options);
if (picklistExportFormatRef.current) {
picklistExportFormatRef.current.selectItem(results.options.exportFormat || 'describe');
}
if (picklistWorksheetLayoutRef.current) {
picklistWorksheetLayoutRef.current.selectItem(results.options.worksheetLayout);
}
Expand All @@ -136,7 +165,7 @@ export const SObjectExport: FunctionComponent<SObjectExportProps> = () => {
logger.error('Error loading default export selection', ex);
}
})();
}, [picklistWorksheetLayoutRef, picklistHeaderOptionRef]);
}, [picklistExportFormatRef, picklistWorksheetLayoutRef, picklistHeaderOptionRef]);

useEffect(() => {
setHasSelectionsMade(!!selectedSObjects?.length && !!selectedAttributes?.length);
Comment on lines 170 to 171
Copy link

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

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

The hasSelectionsMade check requires selectedAttributes to have values, but in metadata export mode, the attribute selection is disabled and fixed. The metadata export doesn't actually use selectedAttributes (it uses allFields directly), so requiring selectedAttributes to have values for metadata exports doesn't make logical sense. Consider updating the hasSelectionsMade logic to skip the selectedAttributes check when isMetadataExport is true: setHasSelectionsMade(!!selectedSObjects?.length && (isMetadataExport || !!selectedAttributes?.length))

Copilot uses AI. Check for mistakes.
Expand All @@ -152,6 +181,9 @@ export const SObjectExport: FunctionComponent<SObjectExportProps> = () => {

function resetOptionsToDefault() {
setOptions({ ...DEFAULT_OPTIONS });
if (picklistExportFormatRef.current) {
picklistExportFormatRef.current.selectItem(DEFAULT_OPTIONS.exportFormat);
}
if (picklistWorksheetLayoutRef.current) {
picklistWorksheetLayoutRef.current.selectItem(DEFAULT_OPTIONS.worksheetLayout);
}
Expand All @@ -168,24 +200,27 @@ export const SObjectExport: FunctionComponent<SObjectExportProps> = () => {
try {
setLoading(true);
setErrorMessage(null);
const metadataResults = await getSobjectMetadata(selectedOrg, selectedSObjects);
const sobjectsWithChildRelationships = selectedAttributes.includes('childRelationshipName')
? await getChildRelationshipNames(selectedOrg, metadataResults)
: {};

const extendedFieldDefinitionData: Record<string, Record<string, FieldDefinitionRecord>> = selectedAttributes.some((item) =>
FIELD_DEFINITION_API_FIELDS.has(item as any),
)
? await getExtendedFieldDefinitionData(selectedOrg, selectedSObjects)
: {};
let output: Record<string, any[]>;

const output = prepareExport(
metadataResults,
sobjectsWithChildRelationships,
extendedFieldDefinitionData,
selectedAttributes,
options,
);
if (isMetadataExport) {
// Use metadata export for Create Fields import template format
output = await prepareMetadataExport(selectedOrg, selectedSObjects, options);
} else {
// Use describe export for traditional format
const metadataResults = await getSobjectMetadata(selectedOrg, selectedSObjects);
const sobjectsWithChildRelationships = selectedAttributes.includes('childRelationshipName')
? await getChildRelationshipNames(selectedOrg, metadataResults)
: {};

const extendedFieldDefinitionData: Record<string, Record<string, FieldDefinitionRecord>> = selectedAttributes.some((item) =>
FIELD_DEFINITION_API_FIELDS.has(item as any),
)
? await getExtendedFieldDefinitionData(selectedOrg, selectedSObjects)
: {};

output = prepareExport(metadataResults, sobjectsWithChildRelationships, extendedFieldDefinitionData, selectedAttributes, options);
}

if (options.saveAsDefaultSelection) {
try {
Expand Down Expand Up @@ -284,20 +319,68 @@ export const SObjectExport: FunctionComponent<SObjectExportProps> = () => {
/>
</div>
<div className="slds-p-horizontal_x-small">
<ListWithFilterMultiSelect
labels={{
listHeading: 'Field Attributes',
filter: 'Filter Attributes',
descriptorSingular: 'field attribute',
descriptorPlural: 'field attributes',
}}
items={FIELD_ATTRIBUTES as ListItem[]}
selectedItems={selectedAttributes}
allowRefresh
lastRefreshed="Reset to default"
onRefresh={resetAttributesToDefault}
onSelected={(items) => setSelectedAttributes(items as SobjectExportFieldName[])}
<Picklist
ref={picklistExportFormatRef}
className="slds-m-top_x-small"
label="Export Format"
items={[
{
id: 'describe',
value: 'describe',
label: 'Describe Format',
secondaryLabel: 'Same format as Query Builder',
secondaryLabelOnNewLine: true,
},
{
id: 'metadata',
value: 'metadata',
label: 'Metadata Format',
secondaryLabel: 'Create Fields import template',
secondaryLabelOnNewLine: true,
},
]}
selectedItemIds={[options.exportFormat]}
allowDeselection={false}
disabled={loading}
onChange={(items) => handleOptionsChange({ exportFormat: items[0].id as ExportFormat })}
/>
{isMetadataExport && (
<>
<ScopedNotification theme="info" className="slds-m-top_x-small">
Metadata format will include all metadata fields and can be used as an import template in the Create Object and Fields
feature.
Comment on lines +350 to +351
Copy link

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

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

The notification message doesn't mention that only custom fields (not standard fields) are exported in metadata format. Users might be confused when they don't see standard fields in the export. Consider updating the message to clarify this limitation, for example: "Metadata format will include all custom field metadata and can be used as an import template in the Create Object and Fields feature. Note: Only custom fields are exported in this format."

Suggested change
Metadata format will include all metadata fields and can be used as an import template in the Create Object and Fields
feature.
Metadata format will include all custom field metadata and can be used as an import template in the Create Object and Fields
feature. Note: Only custom fields are exported in this format.

Copilot uses AI. Check for mistakes.
</ScopedNotification>
<ListWithFilterMultiSelect
labels={{
listHeading: 'Metadata Attributes',
filter: 'Filter Metadata Attributes',
descriptorSingular: 'metadata attribute',
descriptorPlural: 'metadata attributes',
}}
disabled
items={METADATA_FIELD_ATTRIBUTES as ListItem[]}
selectedItems={DEFAULT_METADATA_SELECTION}
omitFilter
onSelected={NOOP}
/>
</>
)}
{!isMetadataExport && (
<ListWithFilterMultiSelect
labels={{
listHeading: 'Field Attributes',
filter: 'Filter Attributes',
descriptorSingular: 'field attribute',
descriptorPlural: 'field attributes',
}}
items={FIELD_ATTRIBUTES as ListItem[]}
selectedItems={selectedAttributes}
allowRefresh
lastRefreshed="Reset to default"
onRefresh={resetAttributesToDefault}
onSelected={(items) => setSelectedAttributes(items as SobjectExportFieldName[])}
/>
)}
</div>
<div className="slds-p-horizontal_x-small">
<Grid>
Expand Down Expand Up @@ -346,35 +429,36 @@ export const SObjectExport: FunctionComponent<SObjectExportProps> = () => {
{ id: 'label', value: 'label', label: 'Use standard label (e.x. AI Prediction Field)' },
{ id: 'name', value: 'name', label: 'Use camelCase label (e.x. aiPredictionField)' },
]}
selectedItemIds={[options.headerOption]}
selectedItemIds={[isMetadataExport ? 'name' : options.headerOption]}
allowDeselection={false}
disabled={loading}
disabled={loading || isMetadataExport}
onChange={(items) => handleOptionsChange({ headerOption: items[0].id as ExportHeaderOption })}
/>
<Checkbox
id={`includeStandardFields`}
className="slds-m-top_x-small"
label="Includes standard fields"
checked={options.includesStandardFields}
disabled={loading}
labelHelp="If selected, standard fields will be included in addition to custom fields."
checked={isMetadataExport ? false : options.includesStandardFields}
disabled={loading || isMetadataExport}
onChange={(value) => handleOptionsChange({ includesStandardFields: value })}
/>
<Checkbox
id={`includeObjectAttributes`}
className="slds-m-top_x-small"
label="Include object attributes"
labelHelp="If selected, a worksheet will be added with object attributes in addition to field attributes"
checked={options.includeObjectAttributes}
disabled={loading}
checked={isMetadataExport ? false : options.includeObjectAttributes}
disabled={loading || isMetadataExport}
onChange={(value) => handleOptionsChange({ includeObjectAttributes: value })}
/>
<Checkbox
id={`saveAsDefaultSelection`}
className="slds-m-top_x-small"
label="Save selected fields and options as default"
labelHelp="Choose this option if you want the default selected fields to be saved for the next time you need to do an export."
checked={options.saveAsDefaultSelection}
disabled={loading}
checked={isMetadataExport ? false : options.saveAsDefaultSelection}
disabled={loading || isMetadataExport}
onChange={(value) => handleOptionsChange({ saveAsDefaultSelection: value })}
/>
</div>
Expand Down
Loading
Loading