User-feedback functionality #2419

PascalLike · 2017-12-08T16:57:40Z

Starting with https://github.com/geonetwork/core-geonetwork/wiki/Userfeedback-proposal
we created a functionality for user feedback on metadata records.

The changes are implemented starting by 4 angular directives:

gnUserfeedbacklasthome - Shows messages and ratings on homepage
gnUserfeedback - Shows messages and ratings on metadata view
gnUserfeedbackfull - See details about messages and ratings associated with a metadata record and manages publication of feedbacks from anonymous users.
gnUserfeedbacknew - To insert a comment and a rating.

The creation of user feedbacks is allowed for every user. For feedbacks from not signed in users a basic workflow will be applied (the comment will be hidden to non-reviewers until the reviewer approval).

gnUserfeedbacklasthome is added on the home page.

gnUserfeedback, gnUserfeedbackfull and gnUserfeedbacknew are integrated in the record view.

The GN API now contains new methods for UF (api/{version/}userfeedback/...): Creating, deleting, publishing and listing. Some methods returns statistic used by the different views implemented in the directives.

The feedbacks are stored in new tables in gn's database.

The functionality is disabled by default but can be activated in settings page. Is very similar to the rating functionality, so the setting for local rating now supports these 3 options:
off - no rating
basic - the current 5 star rating
advanced - the new user feedback functionality

There is another function called user feedback and it's a bit ambiguos. The official documentation should be updated.

This software has been improved under the ELISE action, which is supported by the ISA² Programme. ISA² is a EUR 131 million programme of the European Commission, supporting the modernisation of public administrations in Europe through the development of eGovernment solutions. More than 20 solutions are already available, with more to come soon. All solutions are open source and available free of charge to any interested public administration in Europe.

Delawen · 2017-12-15T11:13:30Z

Moving this to 3.4.2 because I want to close today 3.4.1 to provide a stable version without some relevant bugs and this is a big change to be sure....

josegar74

Added some comments, for me looks fine.

Maybe would be good that also RegisteredUser profile comments require approval, not only anonymous comments.

josegar74 · 2018-02-28T13:44:31Z

core/src/main/java/org/fao/geonet/kernel/DataManager.java

+
+        Metadata metadata = metadataRepository.findOne(metadataId);
+
+        List<UserFeedback> list = userfeedbackRepository.findByMetadata_Uuid(metadata.getUuid());


Can't be added a method deleteByMetadataUuid to UserFeedbackRepository?

josegar74 · 2018-02-28T13:46:13Z

services/src/main/java/org/fao/geonet/api/userfeedback/service/UserFeedbackDatabaseService.java

+    final UserFeedbackRepository userFeedbackRepository = ApplicationContextHolder.get()
+        .getBean(UserFeedbackRepository.class);
+
+    // TODO: Manage UserFeedback not found


Please check this.

josegar74 · 2018-02-28T13:48:50Z

web/src/main/webapp/WEB-INF/classes/setup/sql/migrate/v340/migrate-default.sql

@@ -5,5 +5,7 @@ INSERT INTO Settings (name, value, datatype, position, internal) VALUES

 INSERT INTO Settings (name, value, datatype, position, internal) VALUES ('system/metadata/validation/removeSchemaLocation', 'false', 2, 9170, 'n');

+UPDATE Settings SET name = 'system/localrating/enable', datatype = 0 WHERE id = 211;


In the UI the values seem off, basic, advanced, I think the migration script should handle to change the previous values false, true.

Also should be added to the proper migration file, 340 is no longer valid when the PR is merged.

…les that go with it

Working angular userfeedback module structure Userfeedback API mockup integration UserFeedback Model remove file

Model and first API integration

Initial implementation for UserFeedbackDatabaseService methods user feedback Dto mapper Save fix

- user data (name, email, organisation) - comment textarea - keyword area - accordion for three part of ratings modal (categories, free input, keywords)

Splitting directive in a modular version User Feedback Api wiring Full comment list GUI-API integration Doc and code fix double comment fix To make templates on homepage work

- buttons now beside each other - comments section mockup on the homepage: now with numbers, not with good/bad

Issue with logged user Fix code without model mapper Basic publish workflow Delete userfeedback on metadata delete General fixes and multilanguage support

Font size and color changes * font size of comment increased * title of dataset decreased * score card now has 3 colors (mot only green) * scores in sidebar have color coding Improved coloring for the scores Added whitespace around the author name. Added quotes around the comment.

…epository

PascalLike · 2018-03-01T14:38:12Z

@josegar74 I updated according to your review. If it's fine for you, please, approve.

I just updated with last code from 3.4.x. There's a lot of code impacted for this new feature and it's expensive to keep it updated.

fxprunayre · 2018-04-12T09:10:54Z

@PascalLike do you think we should have this in 3.4.2 ? or make the release first, then merge ?

PascalLike · 2018-04-12T09:44:14Z

I would really like to see it merged in 3.4.2, so if it's fine for you please go ahead!

fxprunayre

LGTM. I added some questions about the API to be discussed. Some of my remarks are fixed in fxprunayre@df09c84 so you can cherry-pick.

Maybe this should be enabled by default ?

fxprunayre · 2018-04-12T09:22:42Z

services/src/main/java/org/fao/geonet/api/userfeedback/UserFeedbackAPI.java

+     * @throws Exception the exception
+     */
+    @ApiOperation(value = "Provides an average rating for a metadata record", nickname = "getMetadataUserComments")
+    @RequestMapping(value = "/metadata/{uuid}/userfeedbackrating", produces = MediaType.APPLICATION_JSON_VALUE, method = RequestMethod.GET)


I would renamed /metadata by /records to be consistent with the API

fxprunayre · 2018-04-12T09:26:41Z

services/src/main/java/org/fao/geonet/api/userfeedback/UserFeedbackAPI.java

+    @ResponseStatus(value = HttpStatus.OK)
+    @ResponseBody
+    public RatingAverage getMetadataRating(@PathVariable(value = "uuid")
+    final String metadataUuid, final HttpServletRequest request, final HttpServletResponse response, final HttpSession httpSession)


Add @ApiIgnore annotation to avoid non API parameters to be displayed in the doc

@ApiIgnore final HttpServletRequest request, @ApiIgnore final HttpServletResponse response, @ApiIgnore final HttpSession httpSession

fxprunayre · 2018-04-12T09:36:30Z

services/src/main/java/org/fao/geonet/api/userfeedback/UserFeedbackAPI.java

+
+            final IUserFeedbackService userFeedbackService = getUserFeedbackService();
+
+            final String uuid = request.getParameter("target");


target and maxnumber parameters are not part of the method signature and they are not displayed in the service doc

Use @RequestParam annotation ?

Also "target" may be renamed to "record" maybe as it is a metadata record.

At some point we may need to add paging here - but this is not part of this PR - we should maybe plan for adding this for users/groups/... API.

If target is mandatory, should we move that service to /records/{uuid}/userfeedback ? would be more consistent with userfeedbackrating

target is not mandatory, so maybe not. or should we have both ?

None of them is mandatory. I added them (uuid, previously target, and maxnumber) as not requested parameters

fxprunayre · 2018-04-12T12:07:47Z

web-ui/src/main/resources/catalog/components/userfeedback/GnUserfeedbackDirective.js

+
+                $http({
+                  method: 'GET',
+                  url: '../api/userfeedback?full=true&uuid=' + scope.metatdataUUID,


I don't see this full parameter in the server side. What is it for ?

No, it's not used anymore

PascalLike · 2018-04-12T12:27:30Z

Thanks for the review (and the commit). Please let me know if it's ok now

fxprunayre · 2018-04-12T12:37:42Z

web-ui/src/main/resources/catalog/components/userfeedback/GnUserfeedbackDirective.js

+                  console.log('DELETED ' + id);
+
+                  $http.delete('../api/userfeedback/' + id).success(function(data, status) {
+                    console.log(data);


Do we need all those console.log ?

fxprunayre · 2018-04-12T12:38:28Z

web-ui/src/main/resources/catalog/components/userfeedback/GnUserfeedbackDirective.js

+
+              };
+
+              scope, showPopover = function(info) {


Looks odd and useless no ?

fxprunayre · 2018-04-12T12:39:35Z

web-ui/src/main/resources/catalog/components/userfeedback/GnUserfeedbackDirective.js

+
+              };
+
+              function validateEmail(email) {


This function is never used no ? Email check is done in line 345 ?

fxprunayre · 2018-04-12T12:41:41Z

web-ui/src/main/resources/catalog/components/userfeedback/GnUserfeedbackDirective.js

+
+                $http.post('../api/userfeedback', data).success(function(data, status) {
+                  console.log(data);
+                  $window.location.reload();


When user post the feedback, the page is fully reload - we don't need that. Only refresh the list of feedback no ?

fxprunayre · 2018-04-12T13:00:01Z

web-ui/src/main/resources/catalog/components/userfeedback/partials/userfeedbacknew.html

+          <input type="hidden" data-ng-model="uf.ratingAVG">
+          <button type="button" class="btn btn-default" data-dismiss="modal"
+            data-translate="">GUFclose</button>
+          <button type="button" class="btn btn-primary"


Would be good to add recaptcha to avoid automatic submission of the form ?

fxprunayre · 2018-04-12T13:25:58Z

web-ui/src/main/resources/catalog/views/default/templates/home.html

@@ -172,6 +172,12 @@ <h4>
            <div data-gn-info-list=""></div>
          </form>
        </tab>
+
+        <tab heading="Comments" active="infoTabs.commentsalt.active" data-ng-show="isUserFeedbackEnabled">


Not translated

fxprunayre · 2018-04-12T13:28:20Z

web-ui/src/main/resources/catalog/components/userfeedback/partials/userfeedbacklasthome.html

+          - / - <span class="fa fa-fw fa-star">&nbsp;</span>
+        </div>
+        <div class="gn-userfeedback-reply">
+          <a>{{row.authorName}}</a><br>on {{row.date | date:'medium'}}


Link on user is not set - should we remove ?

At some point, we may group new messages on a same record ?

fxprunayre · 2018-04-12T13:58:33Z

web-ui/src/main/resources/catalog/locales/en-search.json

+  "GUFsave": "Save",
+  "GUFfeedbackOn": "Feedback on:",
+  "GUFnoComments": "No comments",
+  "GUFaddRating": "Review this dataset",


Maybe we should make this more generic "Review this resource" because you may have a service, map, ...

or adapt the label depending on the hierarchylevel ?

fxprunayre · 2018-04-12T14:06:39Z

web-ui/src/main/resources/catalog/locales/en-search.json

+  "GUFfeedbackOn": "Feedback on:",
+  "GUFnoComments": "No comments",
+  "GUFaddRating": "Review this dataset",
+  "GUFplusAddRating": "<span class=\"fa fa-plus\"></span> Review this dataset",


We usually put the HTML in templates not in translation to keep translation as easy as possible

Improve API doc. API / Add /records/uuid/userfeedback Add nbOfComments to load in directive Latest comments / remove link on user Latest comments / Add nb of comments parameter Author / Same layout in home page and other location Do not show no rating while loading Remove HTML from translation

PascalLike · 2018-04-12T17:06:26Z

Done. I really like this last improvements, now it looks better. Thank you

fxprunayre

Will do live testing tomorrow but looks good. Nice improvement.

fxprunayre · 2018-04-23T08:55:58Z

@PascalLike , We also need to index this depending on the settings in here https://github.com/geonetwork/core-geonetwork/blob/3.4.x/core/src/main/java/org/fao/geonet/kernel/DataManager.java#L683. Currently only the basic rating is displayed whatever the config. So this is misleading and the stars in search results does not represent the average of rating.

eg. no start displayed

on a record with one user feedback

Do you have time to cover that ?

fxprunayre · 2018-04-23T09:25:26Z

services/src/main/java/org/fao/geonet/api/userfeedback/UserFeedbackUtils.java

+        String metadataTitle;
+        try {
+            final Element element = input.getMetadata().getXmlData(false);
+            final XPath xpath = XPath.newInstance("gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:title/gco:CharacterString");


This will not work for records not in ISO19139.

fxprunayre · 2018-04-25T13:11:43Z

domain/src/main/java/org/fao/geonet/domain/userfeedback/Citation.java

+
+    /** The date. */
+    @Column
+    private Date date;


Would have been better to use same encoding for date as other classes ie. ISODate

PascalLike mentioned this pull request Dec 8, 2017

User-feedback functionality #2260

Closed

fxprunayre added this to the 3.4.1 milestone Dec 12, 2017

Delawen modified the milestones: 3.4.1, 3.4.2 Dec 15, 2017

Delawen requested review from juanluisrp, fxprunayre and jahow December 15, 2017 11:13

PascalLike mentioned this pull request Feb 28, 2018

Tâche 5.3 - Mes Messages SPW-DIG/metawal-core-geonetwork#399

Closed

3 tasks

josegar74 reviewed Feb 28, 2018

View reviewed changes

MichelGabriel and others added 17 commits March 1, 2018 13:43

First version of the HTML mockups of the new feedback and the CSS sty…

515c38d

…les that go with it

UserFeedback Module

01c1006

Working angular userfeedback module structure Userfeedback API mockup integration UserFeedback Model remove file

User feedback service

dfbebfa

Removing fake uuids

9cfab16

Model and first API integration

Fix setter method name

0248163

Initial implementation for UserFeedbackDatabaseService methods user feedback Dto mapper Save fix

New inputs added to comment and rating modals:

bc263e9

- user data (name, email, organisation) - comment textarea - keyword area - accordion for three part of ratings modal (categories, free input, keywords)

Modal bootstrap UI

0f18db5

Splitting directive in a modular version User Feedback Api wiring Full comment list GUI-API integration Doc and code fix double comment fix To make templates on homepage work

Styling changed for:

94582db

- buttons now beside each other - comments section mockup on the homepage: now with numbers, not with good/bad

Logged user comment

6ea9f4c

Issue with logged user Fix code without model mapper Basic publish workflow Delete userfeedback on metadata delete General fixes and multilanguage support

New categories, new texts and information

8464a86

Pull request review

46460b5

Switch db change from 3.3.0 to 3.4.0

d66269c

Recovery changes on DataManager

dff8172

Userfeedback - Moving delete method from Datamanager to UserFeedbackR…

86fc439

…epository

UserFeedback - removing unused checkboxes

c7b5bae

GUF, Update migration scripts

d54af4b

PascalLike force-pushed the userfeedback-3.4.1 branch from 898c42f to d54af4b Compare March 1, 2018 14:27

fxprunayre added the enhancement label Apr 12, 2018

fxprunayre requested changes Apr 12, 2018

View reviewed changes

fxprunayre and others added 2 commits April 12, 2018 12:32

GFU / Add ApiIgnore annotation. Move to /records API.

33537f1

UserFeedback - Fix for Less unit test

e49aaec

fxprunayre reviewed Apr 12, 2018

View reviewed changes

UserFeedback directive: remove unused parameter

36e9630

fxprunayre reviewed Apr 12, 2018

View reviewed changes

fxprunayre and others added 2 commits April 12, 2018 17:13

Userfeedback - reload comments after save and delete

240a3f3

fxprunayre approved these changes Apr 12, 2018

View reviewed changes

josegar74 approved these changes Apr 13, 2018

View reviewed changes

josegar74 merged commit fe32ce6 into geonetwork:3.4.x Apr 13, 2018

fxprunayre reviewed Apr 23, 2018

View reviewed changes

fxprunayre mentioned this pull request Apr 24, 2018

User feedback / In advanced mode, improve indexing and add search #2708

Merged

fxprunayre reviewed Apr 25, 2018

View reviewed changes

This was referenced Apr 26, 2018

User Feedback / Add possibility to customize rating criterias (from DB) & other improvements #2712

Merged

Feedback / Migrate to spring MVC #1606

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User-feedback functionality #2419

User-feedback functionality #2419

PascalLike commented Dec 8, 2017

Delawen commented Dec 15, 2017

josegar74 left a comment

josegar74 Feb 28, 2018

josegar74 Feb 28, 2018

josegar74 Feb 28, 2018

PascalLike commented Mar 1, 2018

fxprunayre commented Apr 12, 2018

PascalLike commented Apr 12, 2018

fxprunayre left a comment

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

PascalLike Apr 12, 2018

fxprunayre Apr 12, 2018

PascalLike Apr 12, 2018

PascalLike commented Apr 12, 2018

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

fxprunayre Apr 12, 2018

PascalLike commented Apr 12, 2018

fxprunayre left a comment

fxprunayre commented Apr 23, 2018

fxprunayre Apr 23, 2018

fxprunayre Apr 25, 2018


		Metadata metadata = metadataRepository.findOne(metadataId);

		List<UserFeedback> list = userfeedbackRepository.findByMetadata_Uuid(metadata.getUuid());

		@@ -5,5 +5,7 @@ INSERT INTO Settings (name, value, datatype, position, internal) VALUES

		INSERT INTO Settings (name, value, datatype, position, internal) VALUES ('system/metadata/validation/removeSchemaLocation', 'false', 2, 9170, 'n');

		UPDATE Settings SET name = 'system/localrating/enable', datatype = 0 WHERE id = 211;


		final IUserFeedbackService userFeedbackService = getUserFeedbackService();

		final String uuid = request.getParameter("target");

User-feedback functionality #2419

User-feedback functionality #2419

Conversation

PascalLike commented Dec 8, 2017

Delawen commented Dec 15, 2017

josegar74 left a 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

PascalLike commented Mar 1, 2018

fxprunayre commented Apr 12, 2018

PascalLike commented Apr 12, 2018

fxprunayre left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PascalLike commented Apr 12, 2018

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

Choose a reason for hiding this comment

PascalLike commented Apr 12, 2018

fxprunayre left a comment

Choose a reason for hiding this comment

fxprunayre commented Apr 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment