Clientlog Service

[kobergj]

Introduces the clientlog service that send machine readable notifications to clients

[kobergj]

• Provide a README.md for that service in the root folder of that service.
  • Use CamelCase for section headers.
• For images and example files used in README.md:
  • Create a folder named md-sources on the same level where README.md is located. Put all the images and example files referenced by README.md into this folder.
  • Use absolute references like https://raw.githubusercontent.com/owncloud/ocis/master/services/<service-name>/md-sources/file to make the content accessible for both README.md and owncloud.dev
    bad <img src="https://github.com/owncloud/ocis/blob/master/services/graph/images/mermaid-graph.svg" width="500" />
    good <img src="https://raw.githubusercontent.com/owncloud/ocis/master/services/graph/images/mermaid-graph.svg" width="500" />
• If new CLI command are introduced, that command must be described in readme.md.
• If new global envvar is introduced, the name must start with OCIS_.
• Add the service to the makefile in the ocis repo root.
• Make the service startable for binary and individual startup:
  • For single binary add service to ocis/pkg/runtime
  • For individual startup add service to ocis/pkg/commands
• Add the service to .drone.star to enable CI.
• Inform doc team in an early stage to review the readme AND the environment variables created.
  • The description must reflect the behaviour AND usually has a positive code quality impact.
• Create proper description strings for envvars - see other services for examples, especially when it comes to multiple values. This must include:
  • base description, set of available values, description of each value.
• When suggestable commits are created for text changes and you agree, collect them to a batch and commit them. Do not forget to rebase locally to avoid overwriting the changes made.
• If new envvars are introduced which serve the same purpose but in multiple services, an additional envvar must be added at the beginning of the list starting with OCIS_ (global envvar).
• Ensure that a service has a debug port
• If the new service introduces a new port:
  • the port must be added to port-ranges.md and to the readme.md file.
• Make sure to have a function FullDefaultConfig() in pkg/config/defaults/defaultconfig.go of your service. It is needed to create the documentation.

[kobergj]

@felix-schwarz I was told you already thought about sses and how they should look like. Unfortunately nobody could tell me where you have written them down. This is what we have so far for client notifications. It's very basic but we can iterate over it.

Any suggestions/remarks/comments from your side?

[fschade]

nothing crucial, up to you

testing... not sure, not much business logic involved

[fschade]

... ;)

[kobergj]

Not much business logic. Mocking services would be a nightmare. Removed the _test.go files

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
2 Code Smells

8.8% Coverage
15.4% Duplication