User Dashboard - Center Report Card: Support #943

ryanrath · 2019-05-23T14:07:46Z

Description

The changes made in this PR are in support of the novice_appkernels branch of the appkernels module. Specifically:

classes/Rest/Controllers/SummaryControllerProvider.php:
- While testing I ran into problems w/ the $queryConfig->featured property not being present. Which caused exceptions to be thrown. So I just added a quick guard to make sure that the property was present prior to inspecting its value.
classes/XDUser.php:
- The getResources function is utilized in the main novice_appkernels PR in the appkernels module, but as it made sense to include it in XDUser.php the change was made here.
html/gui/js/Viewer.js:
- Eslint flagged this file for some reason so I just went through and reformatted it according to our current rules.
html/index.php:
- These files are required by components included in the appkernels module which were moved from the internal dashboard to the main interface.

Motivation and Context

To get OpenXDMoD ready to support the CenterReportCardPortlet as well as host the AppKernelPerformanceMap from the internal dashboard.

Tests performed

Manual Testing was performed in conjunction w/ the App Kernels novice_appkernels branch installed. These changes are live on my dev port [9006].

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project as found in the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

These files belong in the `appkernels` module and have been moved there.

Just cleaning things up to appease the linter.

This should not have been committed.

This change is included in the appkernels module branch `novice_appkernels`.

The inclusion of these files should be via AppKernels assets.d file.

plessbd · 2019-05-24T14:46:02Z

html/gui/js/Viewer.js

+            },
+
+            listeners: {
+                // eslint-disable-next-line no-shadow


part of me wants to just fix this instead of disabling the linter...

plessbd · 2019-05-24T14:46:19Z

html/gui/js/Viewer.js

+                        token = tabPanel.id + CCR.xdmod.ui.tokenDelimiter + tab.id;
+                        Ext.History.add(token);
+                        // eslint-disable-next-line no-mixed-operators
+                    } else if (hasActiveTab && hasTab && tab.id !== CCR.xdmod.ui.activeTab.id ||


part of me wants to just fix this instead of disabling the linter...

plessbd · 2019-05-24T14:46:33Z

html/gui/js/Viewer.js


-      if (token) {
+                var root = CCR.exists(parts.root) ? parts.root : 'main_tab_panel';
+                // eslint-disable-next-line no-shadow


part of me wants to just fix this instead of disabling the linter...

plessbd · 2019-05-24T14:47:15Z

html/gui/js/Viewer.js

+        CCR.xdmod.ui.Viewer.viewerInstance = this;
+    }, // initComponent
+    getParameterByName: function (name, source) {
+        // eslint-disable-next-line no-param-reassign,no-useless-escape


part of me wants to just fix this instead of disabling the linter...

html/internal_dashboard/index.php

classes/Rest/Controllers/SummaryControllerProvider.php

@jpwhite4

Updates per @jpwhite4 code review comments Co-Authored-By: Joe White <[email protected]>

jpwhite4 · 2019-05-28T13:47:27Z

classes/XDUser.php

@@ -2606,4 +2606,48 @@ public function isSticky()
    {
        return $this->sticky;
    }
+
+    /**
+     * Retrieves the resources that this user has access to.


I don't think this function belongs in the XDUser class. It also circumvents the ACL tables - which surely is the authoritative source of user access information. Why not build on the existing getDimensionValues functionality in the Warehouse Controller? This already has the access control code and use the GroupBy classes to acces the data in the datawarehouse.

*nod* It does circumvent the ACL tables. I'll look at the getDimensionValues function for a re-write. As an explanation, the results of this function are used in constructing a \AppKernel\PerformanceMap` object which utilizes the ACL tables to restrict the final output by the resources the requesting user has access to. But those changes are in the AppKernels module PR and I didn't reference it specifically. Thanks again for the catch, I'll have an update incoming shortly.

Ok, so quick update after actually reading my code ( I blame lack of caffeine ) ... This function doesn't circumvent the ACL tables in so much as it doesn't actually need them ( per se ). It uses this Users's organization_id to retrieve the resource_fact.id's associated with their organization. It's implied that if they are associated with an organization then they are also associated with their organization's resources.

So, since the function uses / requires User's Organization, I added it directly to XDUser instead of adding it as a helper function that accepts a $userOrganization parameter someplace else.

This is so that we can control when `$user->getAllRoles()` includes the public acl. The default value for all arguments has been set to `true` as that was the behavior pre-change. This will be used in the `AppKernels` module to help filter appropriately for the Center Report Card Portlet.

We're no longer using this function so it is being removed.

Was missing a parameter from the `checkDataAccess` function call.

@jpwhite4

After much research and discussion w/ @jpwhite4, this function is being re-added w/ some additional documentation && an authorization check to ensure that it is only called for Center [Director|Staff] users. In addition, the REST endpoint that uses this function ( in the `appkernel` module )is also being updated to require users who request it to be Center [Director|Staff] as well.

Just needed to update the sql so that it returns data in the same format as `MetricExplorer::getDimensionValues` as that is what `AppKernels/PerformanceMap` is currently setup to process.

jpwhite4 and others added 6 commits May 23, 2019 09:51

Initial Prototype of Novice User Portal

9bad2f1

Initial Commit

35038b0

Removing unrelated files

d49fb80

These files belong in the `appkernels` module and have been moved there.

Linting Cleanup

a061af5

Just cleaning things up to appease the linter.

Removing unused file

2fec36d

This should not have been committed.

Removing unused code

aa1610a

This change is included in the appkernels module branch `novice_appkernels`.

ryanrath mentioned this pull request May 23, 2019

User Dashboard - Center Report Card ubccr/xdmod-appkernels#63

Merged

6 tasks

Unneeded code

686d062

The inclusion of these files should be via AppKernels assets.d file.

ryanrath requested review from jpwhite4 and smgallo May 23, 2019 14:52

Merge branch 'xdmod8.5' into novice_appkernels

bc88a67

plessbd previously approved these changes May 24, 2019

View reviewed changes

Merge branch 'xdmod8.5' into novice_appkernels

6e75fc8

jpwhite4 requested changes May 28, 2019

View reviewed changes

classes/Rest/Controllers/SummaryControllerProvider.php Outdated Show resolved Hide resolved

Update classes/Rest/Controllers/SummaryControllerProvider.php

f30977d

Updates per @jpwhite4 code review comments Co-Authored-By: Joe White <[email protected]>

ryanrath dismissed plessbd’s stale review via f30977d May 28, 2019 13:39

jpwhite4 reviewed May 28, 2019

View reviewed changes

jpwhite4 added the Category:User Dashboard Screen shown after user login label May 29, 2019

ryanrath and others added 7 commits May 30, 2019 13:18

Removing unused function

35dcd49

We're no longer using this function so it is being removed.

Merge branch 'xdmod8.5' into novice_appkernels

a044361

Added missing function parameter

d5e813a

Was missing a parameter from the `checkDataAccess` function call.

Updated getResources sql

822902c

Just needed to update the sql so that it returns data in the same format as `MetricExplorer::getDimensionValues` as that is what `AppKernels/PerformanceMap` is currently setup to process.

Merge branch 'xdmod8.5' into novice_appkernels

857a2c7

jpwhite4 approved these changes Jun 13, 2019

View reviewed changes

Merge branch 'xdmod8.5' into novice_appkernels

7b274c6

ryanrath merged commit bc90988 into ubccr:xdmod8.5 Jun 13, 2019

plessbd changed the title ~~Novice User Interface - Center Report Card: Support~~ User Dashboard - Center Report Card: Support Oct 16, 2019

plessbd added this to the 8.5.0 milestone Oct 16, 2019

plessbd added the new feature New functionality label Oct 16, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User Dashboard - Center Report Card: Support #943

User Dashboard - Center Report Card: Support #943

ryanrath commented May 23, 2019

plessbd May 24, 2019

plessbd May 24, 2019

plessbd May 24, 2019

plessbd May 24, 2019

jpwhite4 May 28, 2019

ryanrath May 28, 2019 •

edited

Loading

User Dashboard - Center Report Card: Support #943

User Dashboard - Center Report Card: Support #943

Conversation

ryanrath commented May 23, 2019

Description

Motivation and Context

Tests performed

Types of changes

Checklist:

plessbd May 24, 2019

Choose a reason for hiding this comment

plessbd May 24, 2019

Choose a reason for hiding this comment

plessbd May 24, 2019

Choose a reason for hiding this comment

plessbd May 24, 2019

Choose a reason for hiding this comment

jpwhite4 May 28, 2019

Choose a reason for hiding this comment

ryanrath May 28, 2019 • edited Loading

Choose a reason for hiding this comment

ryanrath May 28, 2019 •

edited

Loading