#VULCAN-274/ Group reports in a page and minimise reports functionality #707

m-o-n-i-s-h · 2023-11-23T06:25:05Z

Group Reports and Minimize Reports Functionality

Features

Group one or more reports and we can specify a border and border colour to those grouped reports.
Minimize button for reports.
Added an option in table report config called compact canvas. when the query status is NO_DATA the card height is set to default 210px.

Note: This implementation can be only be done through JSON for now. If you are okay with this implementation. Then I can create some component through which user can configure the group reports.

Sample JSON

{
    "title": "My dashboard",
    "version": "2.3",
    .......
    "pages": [
      {
        "title": "Main Page",
        "groups": [
          {
            "groupId": 1, // Group Id
            "border": "5px solid",
            "borderColor": "red"
          }
        ],
        "reports": [
          {
            "id": "322e3326-29f9-42d5-972b-e0b0b78ca581",
            "groupId": 1, // Group Id
            "groupOrder": 1, // Group order is used to achieve horizontal compaction
         .....
          },{
            "id": "483908d-29f9-42d5-972b-e0b0b78ca581",
            "groupId": 1, // Group Id
            "groupOrder": 2, // Group order is used to achieve horizontal compaction and it is incremental
         .....
          },
     ]
}

NOTICE
The program was tested solely for our own use cases, which might differ from yours.

Author Info: Monish [email protected] on behalf of Mercedes-Benz Research and Development India

https://github.com/mercedes-benz/mercedes-benz-foss/blob/master/PROVIDER_INFORMATION.md

Sample JSON
sample-moview-json.txt

Signed off: Monish [email protected]

codecov · 2023-11-23T06:34:14Z

Codecov Report

Attention: Patch coverage is 42.59259% with 62 lines in your changes are missing coverage. Please review.

Project coverage is 38.77%. Comparing base (19b7538) to head (4252df5).
Report is 45 commits behind head on develop.

❗ Current head 4252df5 differs from pull request most recent head cef1bcd. Consider uploading reports for the commit cef1bcd to get more accurate results

Files	Patch %	Lines
src/page/Page.tsx	51.42%	17 Missing ⚠️
src/page/PageReducer.ts	0.00%	13 Missing ⚠️
src/page/PageThunks.ts	16.66%	10 Missing ⚠️
src/component/groupreport/GroupReport.tsx	27.27%	8 Missing ⚠️
src/page/PageToolBox.tsx	0.00%	7 Missing ⚠️
src/report/Report.tsx	60.00%	6 Missing ⚠️
src/card/Card.tsx	50.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #707      +/-   ##
===========================================
+ Coverage    37.49%   38.77%   +1.27%     
===========================================
  Files          216      205      -11     
  Lines         9140     8565     -575     
  Branches      2703     2528     -175     
===========================================
- Hits          3427     3321     -106     
+ Misses        5654     5185     -469     
  Partials        59       59

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

sonarcloud · 2023-11-23T06:36:40Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

No Coverage information
1.0% Duplication

alfredorubin96 · 2024-04-11T12:56:29Z

Thank you for your work, could you please:

add cypress test for this functionality
attach a video of how it works
add documentation of how it works

sonarcloud · 2024-05-06T09:31:44Z

Quality Gate failed

Failed conditions
7.9% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

m-o-n-i-s-h · 2024-05-06T10:00:22Z

@alfredorubin96 , Added a GIF for your reference. This feature helps us to group two or more reports in a page.

// This is a sample dashboard json payload

{
  "title": "My dashboard",
  "version": "2.4",
  "settings": {
    "pagenumber": 0,
    "editable": true,
    "fullscreenEnabled": false,
    "parameters": {},
    "theme": "light"
  },
  "pages": [
    {
      "title": "Main Page",
      "groups": [
        {
          "groupId": 1,
          "border": "5px solid",
          "borderColor": "red"
        }
      ],
      "reports": [
        {
          "id": "50bbc9f4-dbec-4e41-8471-62b5a091b883",
          "title": "Not a group report",
          "query": "MATCH (n)-[e]->(m) RETURN n,e,m LIMIT 20\n\n\n",
          "width": 6,
          "height": 4,
          "x": 0,
          "y": 4,
          "type": "graph",
          "selection": {
            "Person": "name",
            "ACTED_IN": "(label)",
            "Movie": "title",
            "DIRECTED": "(label)",
            "PRODUCED": "(label)"
          },
          "settings": {},
          "schema": [
            [
              "Person",
              "born",
              "name"
            ],
            [
              "ACTED_IN",
              "roles"
            ],
            [
              "Movie",
              "tagline",
              "title",
              "released"
            ],
            [
              "DIRECTED"
            ],
            [
              "PRODUCED"
            ]
          ]
        },
        {
          "id": "6060fb1d-978b-429a-a020-3de2634cc711",
          "title": "Some random report",
          "query": "MATCH (n)-[e]->(m) RETURN n,e,m LIMIT 20\n\n\n",
          "width": 6,
          "height": 4,
          "x": 6,
          "y": 4,
          "type": "graph",
          "selection": {
            "Person": "name",
            "ACTED_IN": "(label)",
            "Movie": "title",
            "DIRECTED": "(label)",
            "PRODUCED": "(label)"
          },
          "settings": {
            "minimizable": true
          },
          "schema": [
            [
              "Person",
              "born",
              "name"
            ],
            [
              "ACTED_IN",
              "roles"
            ],
            [
              "Movie",
              "tagline",
              "title",
              "released"
            ],
            [
              "DIRECTED"
            ],
            [
              "PRODUCED"
            ]
          ]
        },
        {
          "id": "6a68555a-f891-493b-851a-dc15a34d948d",
          "groupId": 2,
          "groupOrder": 1,
          "title": "Group report 2 - A",
          "query": "MATCH (p:Person)-[:ACTED_IN]->(m:Movie)\nRETURN p, m.title",
          "width": 6,
          "height": 4,
          "x": 12,
          "y": 0,
          "type": "graph",
          "selection": {
            "Person": "name"
          },
          "settings": {
            "minimizable": true
          },
          "schema": [
            [
              "Person",
              "born",
              "name"
            ]
          ]
        },
        {
          "id": "8e632236-445b-483e-9540-627d3c8d34b7",
          "groupId": 2,
          "groupOrder": 2,
          "title": "Group report 2 - B",
          "query": "MATCH (p:Person)-[:ACTED_IN]->(m:Movie)\nRETURN p, collect(m.title)\n\n",
          "width": 6,
          "height": 4,
          "x": 18,
          "y": 0,
          "type": "graph",
          "selection": {
            "Person": "name"
          },
          "settings": {
            "minimizable": true
          },
          "schema": [
            [
              "Person",
              "born",
              "name"
            ]
          ]
        },
        {
          "id": "322e3326-29f9-42d5-972b-e0b0b78ca581",
          "groupId": 1,
          "groupOrder": 1,
          "title": "Group report 1 - A",
          "query": "**This is your first dashboard!** \n \nYou can click (⋮) to edit this report, or add a new report to get started. You can run any Cypher query directly from each report and render data in a variety of formats. \n \nTip: try _renaming_ this report by editing the title text. You can also edit the dashboard header at the top of the screen.\n\n\n",
          "width": 6,
          "height": 4,
          "x": 0,
          "y": 0,
          "type": "text",
          "selection": {},
          "settings": {
            "minimizable": true
          }
        },
        {
          "id": "c753770c-e1f7-41a7-b4d2-ddc418fcefb8",
          "groupId": 1,
          "groupOrder": 2,
          "title": "Group report 1 - B",
          "query": "MATCH (n)-[e]->(m) RETURN n,e,m LIMIT 20\n\n\n",
          "width": 6,
          "height": 4,
          "x": 6,
          "y": 0,
          "type": "graph",
          "selection": {
            "Person": "name",
            "ACTED_IN": "(label)",
            "Movie": "title",
            "DIRECTED": "(label)",
            "PRODUCED": "(label)"
          },
          "settings": {
            "minimizable": true
          },
          "schema": [
            [
              "Person",
              "born",
              "name"
            ],
            [
              "ACTED_IN",
              "roles"
            ],
            [
              "Movie",
              "tagline",
              "title",
              "released"
            ],
            [
              "DIRECTED"
            ],
            [
              "PRODUCED"
            ]
          ]
        }
      ],
      "toolbox": []
    }
  ],
  "parameters": {},
  "extensions": {
    "active": true,
    "activeReducers": []
  },
  "uuid": "bc58c8bf-d023-4528-8fc3-335d0d6d2d96"
}

I have added a GIF for your reference. I have not implemented a settings for this. For now I am configuring it in JSON.

NOTICE
The program was tested solely for our own use cases, which might differ from yours.

Author Info: Monish [email protected] on behalf of Mercedes-Benz Research and Development India

https://github.com/mercedes-benz/mercedes-benz-foss/blob/master/PROVIDER_INFORMATION.md

Sample JSON
sample-moview-json.txt

Signed off: Monish [email protected]

m-o-n-i-s-h added 3 commits November 23, 2023 10:30

group report changes

f426cd4

Refactored

2c35a32

Group report and Compact canvas for table report

92f3c22

m-o-n-i-s-h mentioned this pull request Nov 23, 2023

#VULCAN-274/ Group reports in a page and minimise reports functionality #644

Closed

Merge branch 'develop' into group-report-2.4.0

4252df5

m-o-n-i-s-h added 6 commits May 6, 2024 11:25

Merge branch 'upstream-develop' into group-report-2.4.0

a8e6545

merged latest code

7f60425

Updated height

502f588

Addressed sonarqube issue

767c3e7

Fixed sonar

75e21d4

Fixed sonar

cef1bcd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#VULCAN-274/ Group reports in a page and minimise reports functionality #707

#VULCAN-274/ Group reports in a page and minimise reports functionality #707

m-o-n-i-s-h commented Nov 23, 2023

codecov bot commented Nov 23, 2023 •

edited

Loading

sonarcloud bot commented Nov 23, 2023

alfredorubin96 commented Apr 11, 2024 •

edited

Loading

sonarcloud bot commented May 6, 2024

m-o-n-i-s-h commented May 6, 2024

#VULCAN-274/ Group reports in a page and minimise reports functionality #707

Are you sure you want to change the base?

#VULCAN-274/ Group reports in a page and minimise reports functionality #707

Conversation

m-o-n-i-s-h commented Nov 23, 2023

Group Reports and Minimize Reports Functionality

Features

codecov bot commented Nov 23, 2023 • edited Loading

Codecov Report

sonarcloud bot commented Nov 23, 2023

alfredorubin96 commented Apr 11, 2024 • edited Loading

sonarcloud bot commented May 6, 2024

Quality Gate failed

m-o-n-i-s-h commented May 6, 2024

codecov bot commented Nov 23, 2023 •

edited

Loading

alfredorubin96 commented Apr 11, 2024 •

edited

Loading