Skip to content
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.

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

Replace separators in strings to avoid confusion with export separator #3946

Merged
merged 9 commits into from
Oct 2, 2023
48 changes: 21 additions & 27 deletions specifyweb/frontend/js_src/lib/components/QueryBuilder/Export.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ import { commonText } from '../../localization/common';
import { queryText } from '../../localization/query';
import { ping } from '../../utils/ajax/ping';
import { f } from '../../utils/functools';
import type { RA } from '../../utils/types';
import { filterArray, RA } from '../../utils/types';
import { keysToLowerCase } from '../../utils/utils';
import type { SerializedResource } from '../DataModel/helperTypes';
import type { SpecifyResource } from '../DataModel/legacyTypes';
import { schema } from '../DataModel/schema';
import type { SpQuery, SpQueryField, Tables } from '../DataModel/types';
import { Dialog } from '../Molecules/Dialog';
import { downloadFile } from '../Molecules/FilePicker';
import { hasPermission } from '../Permissions/helpers';
import { userPreferences } from '../Preferences/userPreferences';
import { mappingPathIsComplete } from '../WbPlanView/helpers';
import { generateMappingPathPreview } from '../WbPlanView/mappingPreview';
import { downloadDataSet } from '../WorkBench/helpers';
import { QueryButton } from './Components';
import type { QueryField } from './helpers';
import { hasLocalityColumns } from './helpers';
Expand Down Expand Up @@ -80,25 +80,28 @@ export function QueryExportButtons({
*Will be only called if query is not distinct,
*selection not enabled when distinct selected
*/
function handleSelectedResults(): string {
const selectedResults = results?.current?.filter((item) =>
f.has(selectedRows, item?.[0])
);
function exportSelected() {
const name = `${
queryResource.isNew()
? `${queryText.newQueryName()} ${schema.models[baseTableName].label}`
: queryResource.get('name')
} - ${new Date().toDateString()}.csv`;

const joinedSelected = selectedResults?.map((subArray) =>
subArray?.slice(1).join(separator)
const selectedResults = results?.current?.map((row) =>
row !== undefined && f.has(selectedRows, row[0])
? row?.slice(1).map((cell) => cell?.toString() ?? '')
: undefined
);

const resultToExport = [
fields
.map((field) =>
generateMappingPathPreview(baseTableName, field.mappingPath)
)
.join(separator),
...(joinedSelected ?? []),
];
if (selectedResults === undefined) return;

const filteredResults = filterArray(selectedResults);

const columnsName = fields.map((field) =>
generateMappingPathPreview(baseTableName, field.mappingPath)
);

return resultToExport.join('\n');
return downloadDataSet(name, filteredResults, columnsName, separator);
}

const canUseKml =
Expand Down Expand Up @@ -132,16 +135,7 @@ export function QueryExportButtons({
onClick={(): void => {
selectedRows.size === 0
? doQueryExport('/stored_query/exportcsv/', separator)
: downloadFile(
`${
queryResource.isNew()
? `${queryText.newQueryName()} ${
schema.models[baseTableName].label
}`
: queryResource.get('name')
} - ${new Date().toDateString()}.csv`,
handleSelectedResults()
);
: exportSelected();
}}
>
{queryText.createCsv()}
Expand Down
20 changes: 8 additions & 12 deletions specifyweb/frontend/js_src/lib/components/WorkBench/helpers.ts
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
import { stringify } from 'csv-stringify/browser/esm';
import { RA } from '../../utils/types';

import { downloadFile } from '../Molecules/FilePicker';
import type { Dataset } from '../WbPlanView/Wrapped';
import { userPreferences } from '../Preferences/userPreferences';

export const downloadDataSet = async ({
name,
rows,
columns,
}: Dataset): Promise<void> =>
export const downloadDataSet = async (
name: string,
rows: RA<RA<string>>,
columns: RA<string>,
delimiter: string
) =>
new Promise((resolve, reject) =>
stringify(
[columns, ...rows],
{
delimiter: userPreferences.get(
'workBench',
'editor',
'exportFileDelimiter'
),
delimiter: delimiter,
},
(error, output) => {
if (error === undefined)
Expand Down
12 changes: 11 additions & 1 deletion specifyweb/frontend/js_src/lib/components/WorkBench/wbView.js
Original file line number Diff line number Diff line change
Expand Up @@ -1967,7 +1967,17 @@ export const WBView = Backbone.View.extend({
);
},
export() {
downloadDataSet(this.dataset).catch(raise);
const delimiter = userPreferences.get(
'workBench',
'editor',
'exportFileDelimiter'
);
downloadDataSet(
this.dataset.name,
this.dataset.rows,
this.dataset.columns,
delimiter
).catch(raise);
},
revertChanges() {
const dialog = this.options.display(
Expand Down