Suite's history #328

m-suchorski · 2018-08-16T13:27:44Z

User can now view and go to any version of that suite.

Description

User is now able to go trough all versions of the suite by clicking on the timestamp.
Suite's versions are displayed after clicking the current version on the top toolbar.

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 not work as expected)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.

I hereby agree to the terms of the AET Contributor License Agreement.

tkaik

Please update Changelog

tkaik · 2018-08-16T14:32:31Z

api/datastorage-api/src/main/java/com/cognifide/aet/vs/MetadataDAO.java

+  /**
+   * @param dbKey - key with project and company name
+   * @param name - name of suite
+   * @param version Suite object found by given criteria or null.


Please fix this javadoc - move Suite object found by given criteria or null. to @return and add description for version param

tkaik · 2018-08-16T14:49:35Z

core/datastorage/src/main/java/com/cognifide/aet/vs/metadata/MetadataDAOMongoDBImpl.java

@@ -143,6 +157,21 @@ public Suite apply(Document result) {
    }).toList();
  }

+  public List<String> listSuiteVersions(DBKey dbKey, String name) throws StorageException{


This method should return list of pairs: { version: "..", correlationId: "..} - we can't assume that oldest suite will have version equal to 1 because Cleaner might have deleted it

PiteroS678 · 2018-08-16T14:51:13Z

report/src/main/webapp/app/layout/toolbar/toolbarTop.controller.js

+      return 'http://aet-vagrant' + '/api' + '/history' + '?' +
+        $allParametersList[0] + '&' +
+        $allParametersList[1] + '&' +
+        $allParametersList[2];


The path is wrong when correlationId is used.
Example: /report.html?company=xxx&project=xxx&correlationId=xxx

tkaik · 2018-08-16T14:53:42Z

core/datastorage/src/main/java/com/cognifide/aet/vs/metadata/MetadataDAOMongoDBImpl.java

+        .find(Filters.eq(SUITE_PARAM_NAME, name))
+        .sort(Sorts.descending(SUITE_VERSION_PARAM_NAME));
+
+    return FluentIterable.from(found).transform(new Function<Document, String>() {


You may use Java 8 features instead, e.g.:

StreamSupport.stream(found.spliterator(), false) .map(result -> result.getString("correlationId")) .collect(Collectors.toList());

into feature/suite-history

tkaik · 2018-08-20T07:41:09Z

core/datastorage/src/main/java/com/cognifide/aet/vs/metadata/MetadataDAOMongoDBImpl.java

+        .collect(Collectors.toList());
+  }
+
+  public List<List<String>> listSuiteVersions(DBKey dbKey, String name) throws StorageException {


This method should return List<Map<String, String>> or List<SuiteVersion> (where SuiteVersion is a new class with 2 fields - version and correlationId. Then in HistoryServlet you just need to call gson.toJson instead of the whole JsonArray/JsonObject building

tkaik

Please update Report app documentation with new Suite features

malaskowski

Please update also report documentation with example of using history.

malaskowski · 2018-08-21T08:26:24Z

report/src/main/webapp/app/layout/toolbar/toolbarTop.controller.js

    updateToolbar();

    /***************************************
     ***********  Private methods  *********
     ***************************************/

    function updateToolbar() {
+      document.getElementsByClassName('suite-history-container')[0].style.display = 'none';


You can use jQuery here.

malaskowski · 2018-08-21T08:28:23Z

report/src/main/webapp/app/layout/toolbar/toolbarTop.controller.js

        };
      }
    }

+    function buildApiPath($allParametersList) {
+      return 'http://aet-vagrant' + '/api' + '/history' + '?' +


Please use AET endpoint address defined in the endpointConfigurationService.

malaskowski · 2018-08-21T08:30:18Z

report/src/main/webapp/app/layout/toolbar/toolbarTop.controller.js

+        $allParametersList[2];
+    }
+
+    function getSuiteHistory(suiteHeaders, $rootScope, $http) {


This kind of logic should be placed into angular service not in the controller.
E.g. look at metadataEndpointService.

malaskowski · 2018-08-21T08:32:09Z

report/src/main/webapp/app/layout/toolbar/toolbarTop.view.html

@@ -83,5 +86,31 @@
    <div class="toolbar-block fontawesome-link" data-toggle="modal" data-target="#helpModal">
      <i class="fas fa-question-circle fa-lg"></i>
    </div>
+    <div class="suite-history-container">


Maybe it would be good idea to put that into separate modal? Like e.g. noteModal (separate controller and view).

malaskowski · 2018-08-21T08:35:28Z

rest-endpoint/src/main/java/com/cognifide/aet/rest/MetadataServlet.java

@@ -75,7 +76,11 @@ protected void process(DBKey dbKey, HttpServletRequest req, HttpServletResponse
      if (isValidCorrelationId(correlationId)) {
        suite = metadataDAO.getSuite(dbKey, correlationId);
      } else if (isValidName(suiteName)) {
-        suite = metadataDAO.getLatestRun(dbKey, suiteName);
+        if(isValidName(suiteVersion)){


Shouldn't there be method isValidVersion here?

tkaik · 2018-08-22T09:37:50Z

documentation/src/main/wiki/RestAPI.md

+* **URL**: `/api/history`
+* **HTTP Method**: GET
+* **Parameters**: `company`, `project`, `suite`
+* **Example**: http://aet.example.com/api/history??company=cognifide&project=example&suite=mysimplesuite


Please fix typo - double ?

tkaik · 2018-08-22T09:39:11Z

documentation/src/main/wiki/SuiteReportFeatures.md

+
+![Suite history](assets/suiteReport/suite-history.png)
+
+Clicking the suite's name in the top toolbar will show a popup in which the user can see every suite's version that is still available in the database. User can also directly go to the newest version of the suite by clicking 


It looks like unfinished sentence :)

Right, I don't know what happened there. Fixing now.

malaskowski · 2018-08-22T09:38:52Z

report/src/main/webapp/app/services/history.service.js

+   */
+  function historyService($rootScope, $http, endpointConfiguration) {
+    var suiteHeaders;
+    $rootScope.endpointUrl = endpointConfiguration.getEndpoint().getUrl;


Is that necessary to bind this value to the $rootScope variable?
Maybe you can use local variable instead?

This value isn't used anywhere in the service file - it is used only in the view file so it has to be put in the $rootScope, otherwise it wouldn't be possible to use it in the historyModal.view.html file.

Where exactly in historyModal.view.html is used endpointUrl?

malaskowski · 2018-08-22T09:44:10Z

rest-endpoint/src/main/java/com/cognifide/aet/rest/MetadataServlet.java

-        suite = metadataDAO.getLatestRun(dbKey, suiteName);
+        if(isValidVersion(suiteVersion)){
+          suite = metadataDAO.getSuite(dbKey, suiteName, suiteVersion);
+        }else {


Please fix formatting here

tkaik · 2018-08-23T06:49:24Z

report/src/main/webapp/app/services/history.service.js

+      var suite = cUrl.searchParams.get('suite');
+      if (suite === null) {
+        var correlationId = cUrl.searchParams.get('correlationId');
+        suite = correlationId.split('-')[2];


It is possible that company or project or suite values contain - character - then this line will not work correctly.
I think it can be done like this (probably can be done simpler :))

var cp = company + '-' + project + '-'; var suiteNameWithTimestamp = correlationId.substr(a.indexOf(cp) + cp.length) // e.g. now: suiteNameWithTimestamp == 'suite-name-123123123` - we need to cut timestamp from here

tkaik · 2018-08-23T06:54:40Z

report/src/main/webapp/app/services/history.service.js

+          var company = suiteHeaders[i].correlationId.split('-')[0];
+          var project = suiteHeaders[i].correlationId.split('-')[1];
+          var suite = suiteHeaders[i].correlationId.split('-')[2];
+          var correlationId = suiteHeaders[i].correlationId.split('-')[3];


I think that you're parsing timestamp from the correlationID here, so this var should be renamed to e.g. timestamp
And as above - we should handle cases where company/project/suite have '-' characters

tkaik · 2018-08-27T14:03:56Z

report/src/main/webapp/app/services/history.service.js

+          var company = company;
+          var project = project;
+          var suite = suite;
+          var timestamp = suiteHeaders[i].correlationId.split('-')[suiteHeaders[i].correlationId.split('-').length - 1];


This is a bit hard to read now, can we make suiteHeaders[i].correlationId.split('-') a variable? e.g.:

var correlationIdParts = suiteHeaders[i].correlationId.split('-'); var timestamp = correlationIdParts[correlationIdParts.length - 1]

tkaik · 2018-08-27T14:04:37Z

report/src/main/webapp/app/services/history.service.js

+            project: project,
+            suite: suite,
+            version: version,
+            correlationId: timestamp,


correlationId: timestamp is a bit confusing, please change to timestamp: timestamp (because it's not correlatoinId here)

into feature/suite-history

PiteroS678 and others added 6 commits August 13, 2018 13:48

new servlet - HistoryServlet

3a2ec2a

history.html added

7f00eab

license added

ecbc0d8

access to specific suite version

c38b889

access to specific suite version

f83a33a

Suite's history is now displayed in a lightbox

99debc8

tkaik reviewed Aug 16, 2018

View reviewed changes

CHANGELOG update

3179138

tkaik reviewed Aug 16, 2018

View reviewed changes

PiteroS678 reviewed Aug 16, 2018

View reviewed changes

tkaik reviewed Aug 16, 2018

View reviewed changes

Marcin Suchorski and others added 5 commits August 17, 2018 07:29

Overlay deleted

e58d84d

Merge branch 'feature/suite-history' of https://github.com/Cognifide/aet

21ce958

into feature/suite-history

added version to HistoryServlet output

90bfa60

javadoc update

76ebe6e

minor refactor

26610db

PiteroS678 force-pushed the feature/suite-history branch from 1d95203 to 26610db Compare August 17, 2018 09:18

Wiki - RestAPI update

71aaf63

PiteroS678 force-pushed the feature/suite-history branch from 4d23c65 to 71aaf63 Compare August 17, 2018 11:11

Marcin Suchorski and others added 2 commits August 17, 2018 13:40

Suite's history is now properly displayed with correlationId in URL

e4e8408

history.html 'references' removed

e700335

tkaik reviewed Aug 20, 2018

View reviewed changes

PiteroS678 added 4 commits August 20, 2018 10:22

refactor

df0372e

minor refactor

f90f430

refactor

2867454

Merge branch 'master' into feature/suite-history

acfbd2f

tkaik suggested changes Aug 20, 2018

View reviewed changes

malaskowski suggested changes Aug 21, 2018

View reviewed changes

historyRebased color changed

1072bc2

Marcin Suchorski and others added 4 commits August 22, 2018 10:22

Updated documentation

fced7a7

Documentation image fix

157db3b

Suite's history is now displayed properly when correlation id is used

900e4c0

HistoryServlet - OSGi annotation

f7c1d59

PiteroS678 force-pushed the feature/suite-history branch from 6a20f26 to f7c1d59 Compare August 22, 2018 09:20

tkaik reviewed Aug 22, 2018

View reviewed changes

malaskowski suggested changes Aug 22, 2018

View reviewed changes

PiteroS678 and others added 4 commits August 22, 2018 12:27

formatting fix

df785c8

typo fix

74a918a

Documentation fix

811eee5

Documentation missing image fix

56d8785

tkaik reviewed Aug 23, 2018

View reviewed changes

Marcin Suchorski added 4 commits August 23, 2018 12:42

Handle case with correlationId

80d3f20

Fix for modal visual bug

2744b96

Fixed array numeration

41e7b54

Fixed array numeration

ccab222

tkaik reviewed Aug 27, 2018

View reviewed changes

Fixed variable naming

5facea8

tkaik approved these changes Aug 28, 2018

View reviewed changes

tkaik and others added 3 commits August 28, 2018 13:48

Merge branch 'master' into feature/suite-history

aa91053

JS Fix

7e4c414

Merge branch 'feature/suite-history' of https://github.com/Cognifide/aet

28c36c1

into feature/suite-history

malaskowski approved these changes Aug 28, 2018

View reviewed changes

Merge branch 'master' into feature/suite-history

3c4908a

tkaik merged commit f9460fd into master Aug 29, 2018

m-suchorski mentioned this pull request Sep 11, 2018

Rerun one test / Rerun suite #337

Merged

6 tasks

wiiitek deleted the feature/suite-history branch October 13, 2018 13:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Suite's history #328

Suite's history #328

m-suchorski commented Aug 16, 2018

tkaik left a comment

tkaik Aug 16, 2018

tkaik Aug 16, 2018

PiteroS678 Aug 16, 2018

tkaik Aug 16, 2018

tkaik Aug 20, 2018

tkaik left a comment

malaskowski left a comment

malaskowski Aug 21, 2018

m-suchorski Aug 22, 2018

malaskowski Aug 21, 2018

m-suchorski Aug 22, 2018

malaskowski Aug 21, 2018

m-suchorski Aug 22, 2018

malaskowski Aug 21, 2018

m-suchorski Aug 22, 2018

malaskowski Aug 21, 2018

tkaik Aug 22, 2018

tkaik Aug 22, 2018

m-suchorski Aug 23, 2018

malaskowski Aug 22, 2018

m-suchorski Aug 23, 2018

malaskowski Aug 23, 2018

malaskowski Aug 22, 2018

tkaik Aug 23, 2018 •

edited

Loading

tkaik Aug 23, 2018 •

edited

Loading

tkaik Aug 27, 2018

tkaik Aug 27, 2018


		![Suite history](assets/suiteReport/suite-history.png)

		Clicking the suite's name in the top toolbar will show a popup in which the user can see every suite's version that is still available in the database. User can also directly go to the newest version of the suite by clicking

Suite's history #328

Suite's history #328

Conversation

m-suchorski commented Aug 16, 2018

Description

Types of changes

Checklist:

tkaik 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

tkaik left a comment

Choose a reason for hiding this comment

malaskowski 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

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

tkaik Aug 23, 2018 • edited Loading

Choose a reason for hiding this comment

tkaik Aug 23, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tkaik Aug 23, 2018 •

edited

Loading

tkaik Aug 23, 2018 •

edited

Loading