Epic: Extension system

[kulmann]

We're preparing to improve/build our extension system and become more approachable by community developers.

Preparation

The following preparation steps need to be done:

• publish web-pkg and web-client to npmjs. They are not in perfect shape, yet, but we already cleaned them up a lot. Publish packages #8380
• develop strategy for versioning of packages published to npmjs.
• pull the owncloud design system into the web monorepo. Not strictly needed for development (design system is bundled with the web runtime), but having types would improve the DX of extension development a lot.
• clean up config.json / proper config management

Ideas

We have a few ideas of "good first extensions" to gain more insights regarding requirements. These include:

• file listing view modes should be their own extensions (file list, tiles view, single file, ...)
• editors/viewers for various file types (like we already have for text files, images, ...)
• panels for the right sidebar (e.g. a panel for EXIF data of photos)
• any kind of file related action (to be included in the context menu in the file list / right sidebar "Actions" panel, like we already have "copy/move", "delete", "rename", ...)
• audio/video player for the left sidebar + context panel for the right sidebar, e.g. "add to playlist"
• Extension: EPub Viewer #5891 (comment)
• ...
• request interceptors to e.g. add custom headers

Related

• Load assets of extension #2958
• let extensions register more flexible file open actions #5135
• Allow providing alternative file list views #2585
• Allow extensions to inject views in files app #5460
• Document existing extension points #2423
• Dev docs for extension framework #9892
• Configurable tours #7096 (comment)
• Reusage of web components in extensions limited #8281
• extension point for replacing visuals of top loading indicator #8698
• [full-ci] Use icon from app registered for the file type #9088
• Update CERN links #9210
• Extension: Low Code Data Apps Integration #9217
• Extension: DICOM Viewer #9215
• Add Nav-Items to left sidebar #9239
• Viewer/Editor App abstraction #9302
• Support playing of TAS recordings (.fm2) fschade/ocis-arcade#3
• Resolve business logic leaks ofweb-app-external #10256
• Content editor extension type #10387

[ChrisEdS]

Whoop whoop, this will be huge! I really looking forward to the extension system!

[tbsbdr]

Description

User Stories

• As an organisation / developer I want to customise the web ui so that I can adapt it to my special purposes.

• As ownCloud we need to provide an extension system so that we don't need to develop every feature on my own.

Value

• feature richness
• gain market share

Acceptance Criteria

• good developer experience for writing extensions

  • little boiler plate
  • good documentation
  • easy onboarding

• stable APIs (eg. extension-sdk, extension registry, extension points, web-pkg feature set, server-api abstractionlayer (web client)) - outcome: easy maintenance of your own extensions

• Examples

• to be continued...

Definition of ready

• Everybody needs to understand the value written in the user story
• Acceptance criteria have to be defined
• All dependencies of the user story need to be identified
• Feature should be seen from an end user perspective
• Story has to be estimated
• Story points need to be less than 20

Definition of done

• Functional requirements
  • Functionality described in the user story works
  • Acceptance criteria are fulfilled
• Quality
  • Code review happened
  • CI is green (that includes new and existing automated tests)
  • Critical code received unit tests by the developer
• Non-functional requirements
  • No sonar cloud issues