Settings service

[micbar]

Concept

• Outcome of concepting workshop in add dev docs for settings service ocis#171
• Ticket for Phoenix implementation https://github.com/owncloud/enterprise/issues/3899

Tasks

• Create a new service

  • Repo setup
  • Update Boilerplate Update config handling, Debug binary flags boilr-ocis-extension#10
  • Run Boilerplate
  • protobuf spec for...
    • registering and listing settings bundles
    • loading and saving settings of a user
    • registering roles and permissions (along with settings bundles) https://github.com/owncloud/ocis-settings/issues/10
  • grpc services for...
    • registering and listing settings bundles
    • loading and saving settings of a user
    • registering roles and permissions (along with settings bundles) https://github.com/owncloud/ocis-settings/issues/10
    • getting and setting roles of a user https://github.com/owncloud/ocis-settings/issues/10
    • when roles and permissions exist: filter settings in settings bundles to only deliver the settings the user is allowed to see https://github.com/owncloud/ocis-settings/issues/10
  • http services for...
    • delivering the web frontend for integration in phoenix
    • setup swagger http endpoint generation from protobuf => only requires annotations on grpc services to generate http endpoints and a working javascript client
    • fix that generated web endpoints try to decode the request body for get requests
  • use X-Ocis-Accounts-Uuid from request header to exchange me account uuid keyword with the actual account uuid of the authenticated user. Unmint token x-access-token header and use it for me ocis-settings#12

• Use the accounts service as a first consumer of the settings service

  • for quick result: hardcode settings bundle registration
  • fix that the account service doesn't die anymore on init if the settings service is not reachable (only show a warning instead)
  • possible improvement: put user profile settings bundle content into a (json) file, which then gets loaded from disc -> hardcoded settings bundles kind of cluttering the code
  • use service discovery for reaching settings service instead of hardcoded address
  • provide endpoint for getting a uuid for the authenticated user (required for loading and saving settings, keyed by user uuid)

• Use phoenix as an early consumer of the settings service

  • bring settings values into phoenix through owncloud-sdk
  • use language from profile settings bundle in phoenix
  • use timezone from profile settings bundle in phoenix Timezone setting web#3496

• Create UI POC: settings

  • set up empty ocis-web-app for integration in ocis-web: export appInfo, navItems, routes
  • integrate generated js client for backend communication
  • implement generating and rendering all form elements from the settings bundle content
    • string -> text field
    • int -> number input
    • bool -> checkbox
    • single choice list -> dropdown with radio buttons
    • multi choice list -> dropdown with checkboxes
  • navigation between settings bundles of different extensions through router
  • generate sidebar nav items from existing settings bundles for navigating between settings of different extensions Dynamically generate sidebar nav items web#3497
  • implement loading and saving user settings for form elements
  • fix and then use radio button in ODS Fix/improve radio button owncloud-design-system#726
  • fix and then use checkbox in ODS Fix/improve checkbox owncloud-design-system#728
  • fix keyboard event handlers on oc-text-input component in ODS Fix oc-text-input keydown events owncloud-design-system#745

• Create UI POC: assigning roles to users?

• Documentation

  • settings extension
    • abstract concept, including diagram
    • settings bundle description
    • settings value description Finish documentation for settings bundles & values ocis-settings#11
    • glossary (extend step by step)
    • roles & permissions concept https://github.com/owncloud/ocis-settings/issues/13
  • howto: registering settings bundles with the settings service Write documentation on how to register settings bundles ocis-hello#71

• Concept work

  • First settings: Language and Timezone for the user profile settings bundle.
  • Open question: Required to Define useful settings for other services? Ideas for settings and settings bundles ocis#289

• Tests

  • Acceptance test in phoenix for changing language Add settings tests web#3491
  • GRPC tests in ocis-settings first try of gprc tests ocis-settings#2

User stories for POC

• As a user new to the instance I want that oCIS remembers me if I log in a second time to enable other users to share with me.
• As a user on oCIS I want to set my timezone the UI to have correct values in my web VIEW when I am traveling.

Estimation

Effort: L
Complexity: L...

[micbar]

@kulmann Repo is ready to push the boilerplate

[kulmann]

boilerplate pushed 👍

[kulmann]

As of now, this request from the account service...

... gets stored as json in the settings service and then rendered to this in the settings service web app

These are two settings bundles (Notifications and Profile) from the account service. Of course the settings are only to showcase the different form element types.

@micbar

[refs]

@kulmann Perhaps change the copy on the cancel button to English for consistency?

[kulmann]

@kulmann Perhaps change the copy on the cancel button to English for consistency?

Nope, automatically translated by phoenix already. ;-)

[kulmann]

Loading and saving user settings values now works in the UI. This still needs visual improvements in the frontend and currently has a hardcoded account uuid in the service (need to pick it from the request header), but is a big step forward.

The values in the screenshot have been saved through the form and are there again after a page reload.

Persisted JSON looks like this:

cc @refs @micbar @felixboehm @pmaier1

[exalate-issue-sync]

Remote key is https://jira.owncloud.com/browse/OCIS-6

[micbar]

closed