Provide a Remap operation for JSON diagrams

Open
#149 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
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust
Domain
backend

Research direction

Start with the existing CEL transform operation and the JSON diagram operation described in the issue. Compare whether remapping should be a separate operation or an alternative to Transform, using the existing Rust map_block node as the native API reference; done means the scope and implementation direction for non-serializable messages are agreed.

Written by the indexing model from the issue text.

Description

Currently the CEL transform operation is a highly flexible way to remap one data structure into another, but it has a critical drawback: It only works for serializable and deserializable messages.

Some messages may include fields that are not serializable or deserializable, but that still need to undergo some kind of remapping, e.g. change of field names, change between a tuple and a struct. This will be especially important for tuple-based operations like inject.

We could provide a remapping utility, either as its own JSON diagram operation or as an alternative to CEL for the existing Transform operation.

We don't need to do anything for the native Rust API since it's already easy enough for a user to write a map_block node.

Dominant language
Rust
Stars
75
Forks
18
Avg merge
12d 12h
Merged PRs (30d)
3

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 open-rmf/crossflow

All issues in open-rmf/crossflow

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.