protobom / protobom/storage

Silent Failure to store with partially identical documents

Open
#48 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
8
Forks
7
Avg merge
3d 5h
Merged PRs (30d)
7

Description

During development of document changeset functionality in bomctl, we were attempting to test storing the same document more than once, with only slight differences in the metadata of the document.

So: same sbom id, different metadata contents, same nodelist content.

The storage backend was failing to store said 'revised' documents based on the on conflict, ignore directive in the code, and the only indicator that something failed was the lack of documents in the cache.

Want to use this issue for discussion and tracking, as the maintainers have been made aware of the issue.
Topics:

  • Should we be silently failing in these situations?
  • How do we handle storing slightly modified documents successfully without duplication of every entry?
    • @jhoward-lm has a working idea for this

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

No files, tests, or entry points are named. Start by reviewing the storage backend's conflict-handling behavior for documents with the same SBOM ID, then reproduce a store with identical nodelist content and changed metadata. Done requires an agreed approach for avoiding silent failure and unnecessary duplicate entries.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.