Introduce Skeleton-Application, Runtime hooks and demystify runtime boot logic #5752

fschade · 2021-08-30T15:42:11Z

The main reason for this pr was to provide a skeleton application which showcases how applications can inject file-handlers.

The challenge here was that in some cases the application needed to obtain those information from an api which can take time to process. It was not possible to wait for applications and the runtime did proceed even if the application hasn't finished loading what ever it needed (e.g. promises).

To tackle that case it was necessary to introduce such a logic (hooks). The runtime now understand 3 types of hooks.

initialize
this hook gets fired once the application is requested and got loaded by the runtime, it is not safe to call other applications from here because it's not guaranteed that all other applications have finished their registration process.

ready
all other applications are registered, this is a good place to call other applications or provide needed third party application data

mounted
this gets called after the main ui from the runtime got announced to the browser, from here every action will happen AFTER the ui is in place.

we took the opportunity while working on the runtime to refactor and demystify the whole runtime boot logic and rewrite it from the ground up in typescript.

the main reasons for doing this:

we decided to go with typescript
it was a long javascript file and hard to understand
the dependencies where mixed with the application logic
it will help with the vue 3 migration
it was hard up to nearly impossible to test

the application boot logic is now class-based and introduces a 'NextApplication' style, it takes care that all current applications still work by doing an automatic conversion between current and next. The next style applications can't be used at the moment, we first need to decide how the public interface could look like.

It also introduces a runtime API which only exposes (by DI) allowed functionality to the requested applications.

This can change in the future and for now we only have to decide how the public application runtime API should look like, everything else can be changed later without breaking existing applications.

This is a prerequisite for:

application don't load in order anymore The order of applications in the config.json apps should not be important #2891
vue 3 migration Migrate to Vue 3 #5269
let extensions register more flexible file open actions let extensions register more flexible file open actions #5135
remove loadConfig on extensions Remove loadConfig on extensions #3726
capabilities seem to be loaded too late sometimes Capabilities seem to be loaded too late sometimes #3771 (needs api tweak)
allow to include custom js/html when running ocis web Allow to include custom js/html when running ocis web #4735
app provider App Provider #5712
allow extensions to inject views in files app Allow extensions to inject views in files app #5460
a new runtime
doing a backend switch at runtime
request async information in the boot process of a application
boot logic testability

this is wip and the skeleton app needs more attention and functionality

update-docs · 2021-08-30T15:42:14Z

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

ownclouders · 2021-08-30T16:08:03Z

Results for oCISSharingPermissions2 https://drone.owncloud.com/owncloud/web/18712/58/1
💥 The acceptance tests pipeline failed. The build has been cancelled.

ownclouders · 2021-08-30T17:09:46Z

Results for oCISSharingPermissions2 https://drone.owncloud.com/owncloud/web/18713/58/1
💥 The acceptance tests pipeline failed. The build has been cancelled.

pascalwengerter

Looks pretty awesome! Not sure how we should proceed here (before you're going on holidays next week), maybe it makes sense to pull the runtime/boot-refactoring out of this PR in a separate one already, so the cognitive load of this one shrinks plus I think it also helps with the Vue3 upgrade

packages/web-runtime/src/defaults/vue.js

packages/web-runtime/src/container/api.ts

packages/web-runtime/src/container/application/index.ts

packages/web-runtime/src/container/store.ts

packages/web-runtime/src/services/api.ts

introduce runtime api and use it to lazy register extensions from remote applications

in the proccess of adding a skeleton application we faced the issue of not having real runtime hooks. this introduces 3 hooks and exposes a dedicated runtime api to the application. this is fully backwards compatible

ownclouders · 2021-09-03T11:14:32Z

Results for oC10iPhone1 https://drone.owncloud.com/owncloud/web/18834/45/1
The following scenarios passed on retry:

webUIDeleteFilesFolders/deleteFilesFolders.feature:59

ownclouders · 2021-09-03T14:07:23Z

Results for oC10Files1 https://drone.owncloud.com/owncloud/web/18837/12/1
The following scenarios passed on retry:

webUIFilesActionMenu/versions.feature:36

LukasHirt · 2021-09-03T13:51:51Z

packages/web-runtime/src/container/api.ts

+
+  const applicationRoutes = routes.map(applicationRoute => {
+    if (!isObject(applicationRoute)) {
+      throw new ApiError("route can't be blank", applicationRoute)


Do we want to force the extension to have routes? What if we'd have some extension that is supposed to do only background jobs? Maybe something not to look into now but for the future 🤷

in the current version of the "application-manifest" we force to use routes. Int he class based which isn't exported right now the user has to call that api it's wown. So if he calls it without providing routes... it errors, if he skip it all ist fine.

packages/web-runtime/src/container/api.ts

kulmann

Found one important thing: configuring an application in the config.json which is not reachable causes the full runtime to stop with a config error page. Extension loading should fail silently (with console error logging, but not by crashing the whole platform). Some other remarks in the comments.

kulmann · 2021-09-15T12:56:52Z

packages/web-runtime/src/container/types.ts

+}
+
+/** application quick action describes a application action that is used in the runtime */
+export interface ApplicationQuickActions {


I'd prefer declaring the quick actions in singular form as well, i.e. interface name ApplicationQuickAction with the props from the mapped values.

Hm ok, for compatibility reasons. I'll introduce a singular ApplicationQuickAction interface and use that for the values in the ApplicationQuickActions interface. Good enough for now.

kulmann · 2021-09-15T13:09:09Z

packages/web-runtime/src/container/api.ts

+const announceNavigationItems = (
+  applicationId: string,
+  store: Store<unknown>,
+  navigationItems: ClassicApplicationScript['navItems']


Why not

Suggested change

navigationItems: ClassicApplicationScript['navItems']

navigationItems: ApplicationNavigationItem[]

? 🤔

Or in other words: you already introduced types, why not use them here? Instead you're creating a dependency to the ClassicApplicationScript which should not be needed in the (more) generic runtime API.

kulmann · 2021-09-15T13:13:26Z

packages/web-runtime/src/container/api.ts

+const announceTranslations = (
+  supportedLanguages: { [key: string]: string },
+  translations: unknown,
+  appTranslations: ClassicApplicationScript['translations']


Same here, why reference the ClassicApplicationScript? Would be nicer to introduce a dedicated translation type in types.ts and then reuse it here.

kulmann · 2021-09-15T13:13:40Z

packages/web-runtime/src/container/api.ts

+ */
+const announceQuickActions = (
+  store: Store<unknown>,
+  quickActions: ClassicApplicationScript['quickActions']


Same here, why reference the ClassicApplicationScript?

kulmann

Took the liberty of fixing some minor things in this PR. Failing hard with the whole system on one application not being able to load is a no-go - but since the next release is 2 weeks ahead we'll have enough time to fix that in a different PR. Fine to merge this now! Thanks for all the urgently needed cleanup! ❤️

ownclouders · 2021-09-16T08:25:03Z

Results for oCISFiles1 https://drone.owncloud.com/owncloud/web/19075/52/1
The following scenarios passed on retry:

webUIFiles/download.feature:11

sonarcloud · 2021-09-16T09:44:47Z

SonarCloud Quality Gate failed.

2 Bugs
0 Vulnerabilities
0 Security Hotspots
12 Code Smells

0.6% Coverage
0.0% Duplication

ownclouders · 2021-09-16T09:56:13Z

Results for oC10SharingInternalUsersSharingIndicator https://drone.owncloud.com/owncloud/web/19079/28/1
The following scenarios passed on retry:

webUISharingInternalUsersSharingIndicator/shareWithUsers.feature:154
webUISharingInternalUsersToRootSharingIndicator/shareWithUsers.feature:98

ownclouders · 2021-09-16T10:12:42Z

Results for oC10Files1 https://drone.owncloud.com/owncloud/web/19079/12/1
The following scenarios passed on retry:

webUIFilesActionMenu/versions.feature:15

Merge: a9ed4c1 a445a3d Author: Pascal Wengerter <pwengerter@owncloud.com> Date: Thu Sep 16 11:30:21 2021 +0100 Merge pull request #5752 from owncloud/skeleton-app Introduce Skeleton-Application, Runtime hooks and demystify runtime boot logic

fschade requested review from kulmann and pascalwengerter as code owners August 30, 2021 15:42

fschade force-pushed the skeleton-app branch from d57e819 to 57585af Compare August 30, 2021 16:45

pascalwengerter mentioned this pull request Aug 30, 2021

[draft] Try Vue3 compat mode #5368

Closed

4 tasks

pascalwengerter reviewed Sep 1, 2021

View reviewed changes

wkloucek mentioned this pull request Sep 2, 2021

Integrate REVA appprovider owncloud/ocis#2250

Closed

fschade added 2 commits September 3, 2021 12:33

base skeleton

c9e1767

feat(api): lazy extension registration

547ef66

introduce runtime api and use it to lazy register extensions from remote applications

fschade force-pushed the skeleton-app branch from 9bd12a2 to 5b91d37 Compare September 3, 2021 10:33

feat(web-runtime): introduce skeleton app and runtime-hooks

dad1a0a

in the proccess of adding a skeleton application we faced the issue of not having real runtime hooks. this introduces 3 hooks and exposes a dedicated runtime api to the application. this is fully backwards compatible

fschade force-pushed the skeleton-app branch from 5b91d37 to dad1a0a Compare September 3, 2021 10:42

fschade requested a review from pascalwengerter September 3, 2021 10:43

use foreach to announce application mounted hook

a573d44

LukasHirt reviewed Sep 3, 2021

View reviewed changes

LukasHirt mentioned this pull request Sep 7, 2021

Created basic extensions framework docs owncloud/ocis#294

Closed

1 task

pascalwengerter changed the title ~~[WIP] Introduce Skeleton-Application, Runtime hooks and demystify runtime boot logic~~ [Introduce Skeleton-Application, Runtime hooks and demystify runtime boot logic Sep 8, 2021

pascalwengerter changed the title ~~[Introduce Skeleton-Application, Runtime hooks and demystify runtime boot logic~~ Introduce Skeleton-Application, Runtime hooks and demystify runtime boot logic Sep 8, 2021

pascalwengerter mentioned this pull request Sep 14, 2021

[full-ci] Internalize app provider #5805

Merged

5 tasks

kulmann requested changes Sep 15, 2021

View reviewed changes

kulmann added 2 commits September 15, 2021 16:13

Make quick action usage more clear

5a9c412

Remove ClassicApplicationScript references from api

90504cc

kulmann force-pushed the skeleton-app branch from 412445d to 90504cc Compare September 16, 2021 08:00

kulmann approved these changes Sep 16, 2021

View reviewed changes

Fix code smells

a445a3d

pascalwengerter merged commit 76036fd into master Sep 16, 2021

delete-merged-branch bot deleted the skeleton-app branch September 16, 2021 10:30

kulmann mentioned this pull request Sep 16, 2021

Fix that unreachable applications let the whole system die #5813

Merged

9 tasks

fschade mentioned this pull request Oct 7, 2021

[docs-only] 1.13.0 Release Notes owncloud/ocis#2585

Merged

kulmann mentioned this pull request Mar 8, 2022

The order of applications in the config.json apps should not be important #2891

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce Skeleton-Application, Runtime hooks and demystify runtime boot logic #5752

Introduce Skeleton-Application, Runtime hooks and demystify runtime boot logic #5752

fschade commented Aug 30, 2021 •

edited

Loading

update-docs bot commented Aug 30, 2021

ownclouders commented Aug 30, 2021

ownclouders commented Aug 30, 2021

pascalwengerter left a comment

ownclouders commented Sep 3, 2021

ownclouders commented Sep 3, 2021

LukasHirt Sep 3, 2021

fschade Sep 3, 2021

kulmann left a comment

kulmann Sep 15, 2021

kulmann Sep 15, 2021

kulmann Sep 15, 2021

kulmann Sep 15, 2021

kulmann Sep 15, 2021

kulmann Sep 15, 2021

kulmann left a comment

ownclouders commented Sep 16, 2021

sonarcloud bot commented Sep 16, 2021

ownclouders commented Sep 16, 2021

ownclouders commented Sep 16, 2021

	navigationItems: ClassicApplicationScript['navItems']
	navigationItems: ApplicationNavigationItem[]

Introduce Skeleton-Application, Runtime hooks and demystify runtime boot logic #5752

Introduce Skeleton-Application, Runtime hooks and demystify runtime boot logic #5752

Conversation

fschade commented Aug 30, 2021 • edited Loading

update-docs bot commented Aug 30, 2021

ownclouders commented Aug 30, 2021

ownclouders commented Aug 30, 2021

pascalwengerter left a comment

Choose a reason for hiding this comment

ownclouders commented Sep 3, 2021

ownclouders commented Sep 3, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kulmann 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

kulmann left a comment

Choose a reason for hiding this comment

ownclouders commented Sep 16, 2021

sonarcloud bot commented Sep 16, 2021

ownclouders commented Sep 16, 2021

ownclouders commented Sep 16, 2021

fschade commented Aug 30, 2021 •

edited

Loading