DiamondLightSource / DiamondLightSource/glazed

Review which data fields we're actually using

Open
#90 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
0
Forks
2
Avg merge
5d 4h
Merged PRs (30d)
2

Description

The model structs we currently have closely follow the data sent by tiled but much of it is not used or not reliable.

* Search responses have a "meta" field with optional and arbitrary data
* RunMetadata has a "start: Start" field mapping to the start document but this is never used in glazed (and can't be relied on to be anything more than an arbitrary json value).
* Attributes has "access_blob", "specs",
* Links contains a combination of all the link fields used by any of the types in tiled and might be better served by a hashmap
* etc

It might be useful to remove the fields we're not using and replacing them if and when they're being used in glazed.

It would make testing a lot easier when we don't have to return a vast amount of unrelated data from mock servers to test query handling.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting the model structs mentioned in the issue—RunMetadata, Attributes, and Links—and trace their use in query handling and mock server tests. Done means identifying which fields are unused or unreliable, deciding what should remain or change, and updating affected tests and mock responses.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, rust
Domain
backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.