Share item model attributes javascript api v2

[mrow4a]

This PR:

• depreciates share attributes javascript api v1 which relied on "in-core registration of attributes" via ShareItemModel.registerShareAttribute
• new js attr api v2 allows apps to extend ShareItemModel.updateShare and ShareItemModel.addShare function to pass the custom 'attributes'. This allows for much more customizations to checkbozes instead of relying on core api.
• target 10.3?

Tested matrix of v1/v2 with:

• richdocuments Move logic of share attributes checkboxes to richdocuments richdocuments#264
• onlyoffice 2.3.1
• onlyoffice Move logic of share attributes checkboxes to the app for flexibility ONLYOFFICE/onlyoffice-owncloud#275
• richdocuments Move logic of share attributes checkboxes to richdocuments richdocuments#264 together with onlyoffice 2.3.1 on docx
• richdocuments Move logic of share attributes checkboxes to richdocuments richdocuments#264 together with onlyoffice Move logic of share attributes checkboxes to the app for flexibility ONLYOFFICE/onlyoffice-owncloud#275 on docx

[codecov]

Codecov Report

Merging #35836 into master will increase coverage by 0.14%.
The diff coverage is 92.85%.

@@            Coverage Diff             @@
##           master   #35836      +/-   ##
==========================================
+ Coverage   53.85%      54%   +0.14%     
==========================================
  Files          63       63              
  Lines        7377     7403      +26     
  Branches     1301     1307       +6     
==========================================
+ Hits         3973     3998      +25     
  Misses       3019     3019              
- Partials      385      386       +1

Flag	Coverage Δ
#javascript	54% <92.85%> (+0.14%)	⬆️

Impacted Files	Coverage Δ
core/js/sharedialogshareelistview.js	81.14% <100%> (+0.65%)	⬆️
core/js/shareitemmodel.js	80.92% <92.75%> (+0.92%)	⬆️

---

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 95e7aa0...e99e2f2. Read the comment docs.

[micbar]

We are blocked, needs review from @PVince81

[CLAassistant]

All committers have signed the CLA.

[mrow4a]

@pmaier1 @PVince81 @DeepDiver1975 updated top post with tested matrix of v1/v2.

[mrow4a]

@DeepDiver1975 @pmaier1 @micbar all tests green

[PVince81]

Looks fine overall.

One thing I'm not very clear about is that some comment says that the API v2 requires overriding the ShareItemModel.addShare/updateShare, but I don't see any overriding done in the unit tests. What I see however, is that the model has an "attributes" JS property that can be set.

I guess the overriding by apps is only needed in case special handling is needed ? Can you clarify ?

[PVince81]

"boyh" => "both"

[mrow4a]

@PVince81 yes, this is used when some special handling is needed:

• if app has custom checkboxes not relying on other permissions (edit, share etc) app could just send a request to api server directly
• if app checkbox changes with permissions (edit, share etc), addShare/updateShare is wrapped to intercept that change.

If this is possible, I can try to write a test that wrapps the updateShare call. Should I?

[PVince81]

If this is possible, I can try to write a test that wrapps the updateShare call. Should I?

the test might not be that useful as the code path has no effect on the rest of the logic, considering that the overriding is mostly there for rendering purposes ?

if you think there's more to it, please go ahead and add tests. (and fix the typo)

then we're good to go :-)

[mrow4a]

@PVince81 added tests for wrapping - check for can be wrapped in js tests.

[PVince81]

👍

[PVince81]

👍

[LinneyS]

@mrow4a
Sorry, but I don’t understand which branch should I use now to test the new logic?

[mrow4a]

@LinneyS please for now use share_item_model_attr_api_v2 (https://github.com/owncloud/core/tree/share_item_model_attr_api_v2) , in the future owncloud master (which is current target for next oc10 release), but this fix is required there #36086 .

[mrow4a]

@LinneyS I would recommend also not to rush with implementing new logic in your app, we are still searching for best recommended "styling". I would be happy also to submit some PR to your working branch for share attributes, or in talk.owncloud.com we could have a chat and make sure we are all aligned.