McMaster-Baja-Racing / McMaster-Baja-Racing/Better-Data-Viewer

Refactor: AnalyzerParams

Open
#157 0 comments 0 reactions 1 assignee View on GitHub

@hydrowoxy is already working on this.

Since Feb 27, 2025.

backend code quality
Dominant language
TypeScript
Stars
3
Forks
2
PR merge metrics
No merged PRs in 30d

Description

AnalyzerParams is a powerful object used to store the parameters meant for every single analyzer. That being said, the requirements for each are very different, including:

  • the length of input files, output files and input columns (Some only work for 2 files, others many more)
  • The additional options which supply fields like windowSize, epsilon, etc, which are different for each
  • Stuff differs on the receiving side (on the request) vs what the analyzer uses, like the live field.

Recommendation: Create an analyzer type for each unique analyzer or specific usecase such that we can have strong typesafety. An additional feature may be to have automatic polymorphic deserialization based on the type requested. This would involve telling the Jackson deserializer which datatype to parse the requests body into.

Contributor guide

Open the contributing guide

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.