Add url parameter which open a specific details tab right away #32152

DeepDiver1975 · 2018-07-25T09:44:03Z

Description

This adds a url parameter to the files app which will open the details view and a specified tab for the given file in the scrollto parameter

Motivation and Context

We need to open the share tab via url directly. Needed by the office online integration

How Has This Been Tested?

Manually

Screenshots (if appropriate):

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)
Technical debt
Tests

Checklist:

Code changes
Unit tests added
Acceptance tests added
Documentation ticket raised:

Open tasks:

Backport (if applicable set "backport-request" label and remove when the backport was done)

codecov · 2018-07-25T10:22:08Z

Codecov Report

Merging #32152 into master will decrease coverage by <.01%.
The diff coverage is 80%.

@@             Coverage Diff              @@
##             master   #32152      +/-   ##
============================================
- Coverage      63.9%    63.9%   -0.01%     
- Complexity    18547    18548       +1     
============================================
  Files          1169     1169              
  Lines         69730    69732       +2     
  Branches       1267     1267              
============================================
+ Hits          44559    44560       +1     
- Misses        24802    24803       +1     
  Partials        369      369

Flag	Coverage Δ	Complexity Δ
#javascript	`52.81% <ø> (ø)`	`0 <ø> (ø)`	⬇️
#phpunit	`65.17% <80%> (-0.01%)`	`18548 <21> (+1)`

Impacted Files	Coverage Δ	Complexity Δ
apps/files/lib/Controller/ViewController.php	`90.47% <80%> (-0.56%)`	`26 <21> (+1)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d3ebca2...058eaa3. Read the comment docs.

PVince81 · 2018-07-25T16:15:17Z

apps/files/js/app.js

@@ -87,6 +87,7 @@
 					fileActions: fileActions,
 					allowLegacyActions: true,
 					scrollTo: urlParams.scrollto,
+					details: urlParams.details,


I suggest a more precise name for the option key like "detailTabId".
and the URL param could be "detail"

PVince81 · 2018-07-25T16:15:44Z

apps/files/js/filelist.js

@@ -2519,10 +2518,14 @@
 			this.$el.find('.mask').remove();
 			this.$table.removeClass('hidden');
 		},
-		scrollTo:function(file) {
+		scrollTo:function(file, detailsTab) {


see, here you called it detailsTab... call it detailsTabId

PVince81

Looks fine, as discussed.

After renaming the vars you can move on to unit tests. Good luck 😄

DeepDiver1975 · 2018-07-26T10:16:34Z

After renaming the vars you can move on to unit tests. Good luck smile

Teach me, master

PVince81 · 2018-07-26T10:27:38Z

argh, seems we don't have tests for scrollto either.

one idea is to add a new group of tests (in describe() block) in apps/files/tests/js/fileListSpec.js.
then:

instantiate a new FileList (example here https://github.com/owncloud/core/blob/master/apps/files/tests/js/filelistSpec.js#L2139) and pass both scrollto and the new param
register a dummy tab with overridden id like here https://github.com/owncloud/core/blob/master/apps/files/tests/js/detailsviewSpec.js#L70
simulate passing time for the scroll action to do its thing (example mock clock here https://github.com/owncloud/core/blob/master/apps/files/tests/js/filelistSpec.js#L2296)
then use the DOM with fileList.$el.find() to find the tab in question and see if it has the CSS class of being active (you can find which it is with DOM inspector)

phil-davis · 2018-07-26T10:31:54Z

It looks like it wants a webUI acceptance test.

DeepDiver1975 · 2018-07-26T10:39:59Z

@PVince81 @phil-davis I'm lost .... ;-)

@PVince81 js test or web acceptance test? I see more value in web acceptance tests for this.

phil-davis · 2018-07-26T10:45:57Z

I can make a webUI acceptance test. I will look this evening. I am doing a presentation on BDD and automated testing at a Pokhara developers meetup on Saturday, so implementing this will be a good little example that I can use.

You guys decide on the query parameter naming first (=requirements)!

PVince81 · 2018-07-26T10:48:29Z

fine by me, let's do the web UI acceptance test then

phil-davis · 2018-07-26T10:52:17Z

Assigned self to add webUI automated test.

phil-davis · 2018-07-27T11:16:43Z

webUI tests have been added to test direct browsing to the comments, share and versions tabs of a file in the top-level directory, and in a sub-folder. They pass locally for me, hopefully CI likes them.

@individual-it please review.

individual-it · 2018-07-27T11:20:27Z

tests/acceptance/features/bootstrap/WebUIFilesContext.php

+			$this->featureContext->getCurrentUser(), $this->getCurrentFolderFilePath()
+		);
+		$this->visitPath(
+			$this->featureContext->getBaseUrl() . '/index.php/apps/files/?dir=' . $folderName . '&fileid=' . $fileId . '&details=' . $tabName


a pretty long line

this can be put in the pageObject /index.php/apps/files/ is already in there

phil-davis · 2018-07-27T11:20:42Z

What does not work is trying to browse directly to open the share or comments tab of a folder:

http://172.17.0.1:8080/index.php/apps/files/?dir=/&fileid=2147506251&details=shareTabView

where 2147506251 is the file id of a folder that is in the top / directory of the user.

The UI redirects to open the folder.

But manually in the UI I can click "..." "Details" or "Sharing" for a folder and share the folder or make comments about the folder.

What is the requirement?

individual-it · 2018-07-27T11:26:12Z

tests/acceptance/features/lib/FilesPageElement/SharingDialog.php

+	 */
+	public function isDetailsPanelVisible($tabName) {
+		try {
+			$visible = $this->findById($tabName)->isVisible();


you have to check here if findById() returns null because that line might explode with calling isVisible() on null

DeepDiver1975 · 2018-07-27T11:26:51Z

where 2147506251 is the file id of a folder that is in the top / directory of the

I need to have a look at this ..... THX for testing!

phil-davis · 2018-07-27T11:42:06Z

@DeepDiver1975 if browsing directly to a folder's sharing details tab is a requirement, then I can easily add test scenarios for that that fail - and you can make it pass!

DeepDiver1975 · 2018-07-27T13:24:45Z

@DeepDiver1975 if browsing directly to a folder's sharing details tab is a requirement, then I can easily add test scenarios for that that fail - and you can make it pass!

I don't need it for my initial requirement - I need this only to work on files.
But I agree that it would be great to have this for folders as well ....... but I have no idea how to implement this.

DeepDiver1975 · 2018-07-27T13:29:17Z

Well - if the file id of a folder is in the url the folder itself is opened - opening any tab does not really work with this respect.

Notjhing to do from my pov

phil-davis · 2018-07-27T13:54:23Z

As long as it is not a requirement, then no problem that you can't open the sharing details of a folder directly by URL.

I have some timing issue in the tests - mostly they fail on drone, probably because it does not wait long enough for the preview to get rendered in the details pane. And one of the checks in the test scenarios is that the preview is there. I will look at that...

phil-davis · 2018-07-31T05:58:25Z

@individual-it please review webUI acceptance tests again.

… details dialog

individual-it · 2018-07-31T07:55:32Z

acceptance tests look fine 👍

phil-davis · 2018-07-31T07:57:05Z

@PVince81 ready for your review again...

PVince81

👍

DeepDiver1975 · 2018-07-31T08:19:15Z

THX @phil-davis @individual-it

DeepDiver1975 · 2018-07-31T08:20:15Z

objections in backporting? Once we make wopi work with oc10 we will need this ...

PVince81 · 2018-07-31T08:20:55Z

raised documentation ticket: https://github.com/owncloud/documentation/issues/4331

PVince81 · 2018-07-31T08:21:06Z

@DeepDiver1975 please backport, it's a nice addition

phil-davis · 2018-07-31T08:59:24Z

Backport stable10 #32202

This fixes #265 and relates to owncloud/core#32152. It details the ability to open one of three file sidebars (versions, comments, and shares) by using a permalink.

lock · 2019-07-31T09:01:40Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

DeepDiver1975 added the 3 - To Review label Jul 25, 2018

DeepDiver1975 added this to the development milestone Jul 25, 2018

DeepDiver1975 self-assigned this Jul 25, 2018

DeepDiver1975 requested a review from PVince81 July 25, 2018 09:44

PVince81 reviewed Jul 25, 2018

View reviewed changes

DeepDiver1975 force-pushed the master-d1f28e5880af3e456b43e8e9dbc3fd6eff455ddd branch from f1fab2a to e97c96a Compare July 26, 2018 10:10

DeepDiver1975 changed the title ~~[master] Add url parameter which open a specific details tab right away~~ Add url parameter which open a specific details tab right away Jul 26, 2018

phil-davis self-assigned this Jul 26, 2018

phil-davis force-pushed the master-d1f28e5880af3e456b43e8e9dbc3fd6eff455ddd branch from e97c96a to a5ed65a Compare July 27, 2018 11:08

individual-it reviewed Jul 27, 2018

View reviewed changes

phil-davis force-pushed the master-d1f28e5880af3e456b43e8e9dbc3fd6eff455ddd branch 2 times, most recently from e75a467 to a941a44 Compare July 30, 2018 09:58

DeepDiver1975 and others added 3 commits July 31, 2018 12:13

Add url parameter which open a specific details tab right away

e46dc19

webUI acceptance tests for direct browsing to open the details panel

ca0b3f0

Refactor to make DetailsDialog

6c172d7

phil-davis force-pushed the master-d1f28e5880af3e456b43e8e9dbc3fd6eff455ddd branch 2 times, most recently from 182127e to 5b9c682 Compare July 31, 2018 06:46

wait for thumbnails or other ajax to happen when browsing to open the…

058eaa3

… details dialog

phil-davis force-pushed the master-d1f28e5880af3e456b43e8e9dbc3fd6eff455ddd branch from 5b9c682 to 058eaa3 Compare July 31, 2018 06:49

PVince81 approved these changes Jul 31, 2018

View reviewed changes

DeepDiver1975 merged commit 8a811f5 into master Jul 31, 2018

DeepDiver1975 deleted the master-d1f28e5880af3e456b43e8e9dbc3fd6eff455ddd branch July 31, 2018 08:19

PVince81 added the backport-request label Jul 31, 2018

DeepDiver1975 mentioned this pull request Jul 31, 2018

[stable10] Add url parameter which open a specific details tab right … #32202

Merged

phil-davis removed the backport-request label Jul 31, 2018

settermjd mentioned this pull request Aug 10, 2018

Link to open file sidebar from permalink owncloud/docs#29

Closed

davitol mentioned this pull request Sep 7, 2018

Add url parameter which open a specific details tab right away also available for Folders #32629

Closed

PVince81 mentioned this pull request Nov 19, 2018

Link to open file sidebar from permalink owncloud/docs#265

Closed

This was referenced Apr 26, 2019

add new capability privateLinksDetailsParam #35101

Merged

[10.2.0] add new capability privateLinksDetailsParam #35104

Merged

settermjd mentioned this pull request May 20, 2019

Document ability to open the file sidebar from a permalink owncloud/docs#1228

Merged

lock bot locked as resolved and limited conversation to collaborators Jul 31, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add url parameter which open a specific details tab right away #32152

Add url parameter which open a specific details tab right away #32152

DeepDiver1975 commented Jul 25, 2018 •

edited

Loading

codecov bot commented Jul 25, 2018 •

edited

Loading

PVince81 Jul 25, 2018

PVince81 Jul 25, 2018

PVince81 left a comment

DeepDiver1975 commented Jul 26, 2018

PVince81 commented Jul 26, 2018

phil-davis commented Jul 26, 2018

DeepDiver1975 commented Jul 26, 2018

phil-davis commented Jul 26, 2018

PVince81 commented Jul 26, 2018

phil-davis commented Jul 26, 2018

phil-davis commented Jul 27, 2018

individual-it Jul 27, 2018 •

edited

Loading

phil-davis commented Jul 27, 2018 •

edited

Loading

individual-it Jul 27, 2018

DeepDiver1975 commented Jul 27, 2018

phil-davis commented Jul 27, 2018

DeepDiver1975 commented Jul 27, 2018

DeepDiver1975 commented Jul 27, 2018

phil-davis commented Jul 27, 2018

phil-davis commented Jul 31, 2018

individual-it commented Jul 31, 2018

phil-davis commented Jul 31, 2018

PVince81 left a comment

DeepDiver1975 commented Jul 31, 2018

DeepDiver1975 commented Jul 31, 2018

PVince81 commented Jul 31, 2018

PVince81 commented Jul 31, 2018

phil-davis commented Jul 31, 2018

lock bot commented Jul 31, 2019

Add url parameter which open a specific details tab right away #32152

Add url parameter which open a specific details tab right away #32152

Conversation

DeepDiver1975 commented Jul 25, 2018 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Open tasks:

codecov bot commented Jul 25, 2018 • edited Loading

Codecov Report

PVince81 Jul 25, 2018

Choose a reason for hiding this comment

PVince81 Jul 25, 2018

Choose a reason for hiding this comment

PVince81 left a comment

Choose a reason for hiding this comment

DeepDiver1975 commented Jul 26, 2018

PVince81 commented Jul 26, 2018

phil-davis commented Jul 26, 2018

DeepDiver1975 commented Jul 26, 2018

phil-davis commented Jul 26, 2018

PVince81 commented Jul 26, 2018

phil-davis commented Jul 26, 2018

phil-davis commented Jul 27, 2018

individual-it Jul 27, 2018 • edited Loading

Choose a reason for hiding this comment

phil-davis commented Jul 27, 2018 • edited Loading

individual-it Jul 27, 2018

Choose a reason for hiding this comment

DeepDiver1975 commented Jul 27, 2018

phil-davis commented Jul 27, 2018

DeepDiver1975 commented Jul 27, 2018

DeepDiver1975 commented Jul 27, 2018

phil-davis commented Jul 27, 2018

phil-davis commented Jul 31, 2018

individual-it commented Jul 31, 2018

phil-davis commented Jul 31, 2018

PVince81 left a comment

Choose a reason for hiding this comment

DeepDiver1975 commented Jul 31, 2018

DeepDiver1975 commented Jul 31, 2018

PVince81 commented Jul 31, 2018

PVince81 commented Jul 31, 2018

phil-davis commented Jul 31, 2018

lock bot commented Jul 31, 2019

DeepDiver1975 commented Jul 25, 2018 •

edited

Loading

codecov bot commented Jul 25, 2018 •

edited

Loading

individual-it Jul 27, 2018 •

edited

Loading

phil-davis commented Jul 27, 2018 •

edited

Loading