Custom export format #549

nebs-dev · 2022-08-15T16:17:29Z

Resolves #532

Added:

new export options for the period token distribution
new settings section for custom export
api endpoint /exportSummary that i using export data transformer from any external url
refactor of settings form

kristoferlund · 2022-08-24T21:52:42Z

packages/api/src/period/utils/core.ts

@@ -295,3 +300,50 @@ export const isPeriodLatest = async (

  return false;
 };
+
+export const getSummarizedReceiverData = (
+  data: PeriodDetailsGiverReceiverDto[] | undefined,


Try to avoid funcftions accepting undefined if possible. Passing undefinedto a function only passes the "problem" to somewhere else in the code.

kristoferlund · 2022-08-24T21:54:07Z

packages/api/src/period/utils/core.ts

+        on: operateItem.on,
+      };
+    }),
+    // eslint-disable-next-line @typescript-eslint/no-implied-eval


I simplefied this part and reworked implementation in jsonTransformer slightly.

kristoferlund · 2022-08-24T21:59:56Z

packages/frontend/src/components/settings/SettingsForm.tsx

@@ -55,6 +57,14 @@ const FormFields = (
            setting.valueRealized as string,
            disabled
          );
+        else if (setting.type === 'Radio')


We cannot assume these are the two only possible values. Along with the settings definition we would need to store possible values. If this seems like too much work for now, just go with a plain string.

kristoferlund · 2022-08-24T22:02:42Z

packages/frontend/src/pages/Settings/SettingsPage.tsx

@@ -53,6 +56,10 @@ const SettingsPage = (): JSX.Element | null => {
              <NavItem to={`${url}/application`} description="Application" />
              <NavItem to={`${url}/period`} description="Period Defaults" />
              <NavItem to={`${url}/discord`} description="Discord Bot" />
+              <NavItem


The cusom export settings page doesn't render properly here.

"Rendered more hooks than during the previous render."

kristoferlund · 2022-08-24T22:03:24Z

packages/frontend/package.json

@@ -39,9 +39,11 @@
    "env-cmd": "^10.1.0",
    "ethers": "^5.6.8",
    "final-form": "^4.20.4",
+    "js-base64": "^3.7.2",


Currently unused.

kristoferlund · 2022-08-24T22:06:50Z

packages/api/src/period/types.ts

@@ -124,3 +125,9 @@ export interface ReplaceQuantifierRequestBody {
  currentQuantifierId: string;
  newQuantifierId: string;
 }
+
+export interface SummarizedPeriodData {


This represents one interface for one custom export only. There will be many export types defined by .. whoever. There will be no export intefaces since everything is based just on the transformer json format.

kristoferlund · 2022-08-24T22:07:53Z

packages/api/src/settings/validators.ts

@@ -89,6 +90,11 @@ export function isSettingValueAllowedBySettingType(
    return valid;
  }

+  if (this.type === 'Object') {


It is not object but JSON, right?

kristoferlund · 2022-08-24T22:09:12Z

packages/frontend/package.json

@@ -58,6 +60,7 @@
    "recoil": "^0.7.4",
    "recoil-nexus": "^0.4.0",
    "recoil-persist": "^4.2.0",
+    "safe-eval": "^0.4.1",


Do safe-eval need to be imported in frontend?

…praise into enh/custom_export_formats

kristoferlund · 2022-08-31T20:17:40Z

packages/api/src/period/controllers/core.ts

+  const fields = [
+    {
+      label: 'ADDRESS',
+      value: 'address',
+    },
+    {
+      label: 'AMOUNT',
+      value: 'amount',
+    },
+    {
+      label: 'TOKEN',
+      value: 'tokenName',
+    },
+  ];


Export should not assume these are the fields to export. Instead use the information in the transformer json: map.item.

kristoferlund · 2022-08-31T20:23:15Z

packages/frontend/src/pages/Periods/Details/components/PeriodDetails.tsx

+      handleExport();
+    } else if (option.value === 'export-summary') {
+      handleExport();


export-full and export-summary should not be the same.

kristoferlund · 2022-09-02T07:25:06Z

packages/frontend/src/model/periods.ts

+    if (!period) return undefined;
+
+    const response = await apiAuthClient.get(
+      `/admin/periods/${period._id}/exportSummary?context=${exportContext}&supportPercentage=${supportPercentage}`,


/exportSummary returns summarised praise data for the period, basically the input to the custom export
New endpoint: /customExport does what /exportSummary currently does.

Co-authored-by: Nebs <nebojsa.stojanovic0@gmail.com>

kristoferlund · 2022-09-19T08:57:52Z

@nebs-dev remove checkbox in the export dialog and instead just print message.

If CS support percentage > 0:

Thank your for supporting the continued development of Praise, 2% of the distribution will be donated to the Praise dev team.

If CS support percentage = 0:

Consider supporting the development of Praise by donating a small amount of the distribution to the Praise dev team. Settings: Custom token export

- Removed unused types on other export endpoints

…in `budget`and `token`

…ponents

sonarqubecloud · 2022-09-21T20:19:10Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
7 Code Smells

No Coverage information
5.1% Duplication

kristoferlund

Great work with this issue Nebs! Merging now.

new api endpoint, distribute button(needs to be changed)

bee3e2b

nebs-dev requested a review from kristoferlund August 15, 2022 16:17

nebs-dev self-assigned this Aug 15, 2022

nebs-dev and others added 9 commits August 16, 2022 17:54

new api endpoint, use transformer

a22fb1e

use json from transformer, move logic into utils

cdf4bb6

new settings for custom export, settings form, new migrations

d39b2a3

changed env template, changed transformer

48832d7

fixed merge conflicts

0cef309

moved transformer and other code for custom export to the backend

677543a

changed UI for the custom export settings

413840a

remove unnecessary code

3f1a248

Minor rework of transformer

0270b3b

kristoferlund reviewed Aug 24, 2022

View reviewed changes

nebs-dev and others added 10 commits August 25, 2022 19:32

Merge branch 'main' into enh/custom_export_formats

5c4dd7d

Merge branch 'enh/custom_export_formats' of github.com:commons-stack/…

9891744

…praise into enh/custom_export_formats

merge main, fixed PR comments

41767f9

Add handling of errors where the response data is a Blob

fce3b30

Throw BadRequestErrorif transform error occurs

2fd9ee0

load transformer from the repo, export dialog

4cda761

fix merge conflicts

581a41b

changed export notifications

443d724

Refactor of settings form

c1a9c00

added code in tsconfig for the safeEval typescript declaration

3aae9ed

nebs-dev changed the title ~~WIP: Custom export format~~ Custom export format Aug 31, 2022

nebs-dev marked this pull request as ready for review September 1, 2022 08:23

kristoferlund requested changes Sep 1, 2022

View reviewed changes

nebs-dev added 2 commits September 1, 2022 15:41

export fields from transformer, add option to export json file

7e02bff

add validation for custom context input

0e00d9c

kristoferlund reviewed Sep 2, 2022

View reviewed changes

Handle error returned by server

989af98

Co-authored-by: Nebs <nebojsa.stojanovic0@gmail.com>

nebs-dev and others added 24 commits September 19, 2022 11:41

Removed option to choose support percentage in export dialog

f6f7286

Rename CUSTOM_EXPORT_CSV_FORMAT to CUSTOM_EXPORT_FORMAT

79cfde4

Consistent naming of API endpoints

b689ef4

Rename ISelectedItem to SelectInputOption

c724084

Merge the three export hooks into one for clarity: useExportPraise

296c795

- Added input type for custom export

110b36b

- Removed unused types on other export endpoints

Use promise.all to speed up export

8cd4629

Refactoring names

5450a2b

Add CS support eth address

8145dba

Refactor, transformer context schema cannot be known assumed to conta…

e5a9835

…in `budget`and `token`

Return correct file format

c58c607

Rename TransformerMap

bc7fa68

Refactoring names

fb47c9e

Interface name change

49b33b2

Allow filtering of empty eth addresses

f8643f3

Export dialog text changes + don't use functions to produce React com…

835ad16

…ponents

Set export dialog title based on info in transformer

41154f0

Text changes

8fc3963

JSON formatting for readability

8f74cef

Padding and button color

2f31d2a

Correct api url in tests

e37431d

"await" should not be used redundantly

515bae8

Make filtering option part of transformer object instead of context

354dbfc

Filter export after transform instead of before

4574a9b

kristoferlund approved these changes Sep 23, 2022

View reviewed changes

kristoferlund merged commit 6d120e7 into main Sep 23, 2022

kristoferlund deleted the enh/custom_export_formats branch September 26, 2022 08:55

kristoferlund mentioned this pull request Sep 26, 2022

v0.12.0 #602

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom export format #549

Custom export format #549

nebs-dev commented Aug 15, 2022 •

edited

Loading

kristoferlund Aug 24, 2022

kristoferlund Aug 24, 2022

kristoferlund Aug 24, 2022

kristoferlund Aug 24, 2022

kristoferlund Aug 24, 2022

kristoferlund Aug 24, 2022

kristoferlund Aug 24, 2022

kristoferlund Aug 24, 2022

kristoferlund Aug 31, 2022 •

edited

Loading

kristoferlund Aug 31, 2022

kristoferlund Sep 2, 2022

kristoferlund commented Sep 19, 2022

sonarqubecloud bot commented Sep 21, 2022

kristoferlund left a comment

Custom export format #549

Custom export format #549

Conversation

nebs-dev commented Aug 15, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kristoferlund Aug 31, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kristoferlund commented Sep 19, 2022

sonarqubecloud bot commented Sep 21, 2022

kristoferlund left a comment

Choose a reason for hiding this comment

nebs-dev commented Aug 15, 2022 •

edited

Loading

kristoferlund Aug 31, 2022 •

edited

Loading