Health API: Provide means to resolve conflicting result `Fix`es

Open
#151 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
java
Domain
api

Research direction

Start with the Health API and the Fix/result model introduced by pull request #149. Trace how fixes expose their affected paths and how consumers currently apply them sequentially, then investigate the API design needed for conflicting fixes. Done should provide a decided, documented means to identify or resolve fixes affecting the same resources.

Written by the indexing model from the issue text.

Description

With the merge of https://github.com/cryptomator/cryptofs/pull/149, a result returns an Fix object, which represents the fix for the result (meaning that after applying the fix, the result does not appear again in a subsequent check).

Still, a key problem is not fixed: How to resolve conflicting (aka affecting the same resource) fixes?

It is explicitly spoken of fixes not only results, because a fix can affect more paths than just the result-causing ones. Example

Result A reports a file at the wrong place /Foo/Bar.c9r. The Fix is to move it to /Baz/Bar.c9r.
The result-causing paths are only /Foo/Bar.c9r, but the fix-affected paths are /Foo/Bar.c9r and /Baz/Bar.c9r.

Every fix alters the state of the filesystem, hence, subsequent fixes (including the same fix) might fail. Currently, the health API does not account for that and only reports all problems of the current filesystem state. The consumer can only execute one fix after another and rerun the health check(s) to fix previously failed fixes.

Dominant language
Java
Stars
110
Forks
39
Avg merge
1d 28m
Merged PRs (30d)
4

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cryptomator/cryptofs

All issues in cryptomator/cryptofs

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.