sillsdev / sillsdev/harmony

better exception details from snapshot worker

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

Nobody has claimed this yet.

Dominant language
C#
Stars
14
Forks
4
Avg merge
3d 21h
Merged PRs (30d)
3

Description

First off `EditChange.NewEntity throws an error, it would be good to include the commit ID and timestamp in the message.

Additonally SnapshotWorker.ApplyCommitChanges may throw exceptions, if it does we want to track as much context as we can. It may be helpful to split that method into multiple others to make this work well.

Ideally any exception would be caught and rethrown with more context, including the commit id and time, as well as change which triggered the error and the entity id. More is better but those would be most helpful.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Locate EditChange.NewEntity and SnapshotWorker.ApplyCommitChanges, then trace where their exceptions are created or propagated. Review how commit IDs, timestamps, changes, and entity IDs are available at those entry points. Done means exceptions from both paths include the requested contextual details, including when ApplyCommitChanges handles a failing change.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
distributed-systems
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.