JSON Component Architecture

JSON Architecture		status: draft security: YES safety: ASIL_B
version: 2 realizes: wp__component_arch
doc__json_architecture		Generic Document

Overview

The component JSON implements functionality for reading/parsing JSON data and also to write. It provides currently only a C++ API.

Requirements Linked to Component Architecture

See the “fulfils” links in static and dynamic architecture below.

Description

JSON provides an abstraction layer to underlying implementations, in first iteration there is only one implementation provided. But generally there is a “Wrapper” and an “Implementation” lower-level component.

Design Decisions:

It was decided to use the vaJson parser from Vector (see vajson (doc__vajson)), which is ASIL D certified.

JSON writing functionality is provided by the vaJson serializer, which is wrapped by the “Wrapper” component.

Design Constraints:

The feature description states that this component provides a “JSON abstraction layer that can switch between different parsers/serializers under the hood.” Currently vaJson is the only implementation, for parsing as well as for serialization, so nothing is selectable.

Rationale Behind Architecture Decomposition

The decomposition in a wrapper and an implemetation component already comes from the feature definition, the main driver is to re-use existing implementation(s) and to allow replacing the implementation while providing a stable API.

Static Architecture

JSON		status: valid security: YES safety: ASIL_B
bazel_target: ["@@score_baselibs+//score/json:json","@@score_baselibs+//score/json:json_serializer"] bazel_type: ["cc_library","cc_library"] version: 2 consists of: comp__baselibs_json_wrapper, comp__baselibs_vajson belongs to: feat__baselibs has: comp_arc_dyn__baselibs__json_dynamic_view, comp_arc_sta__baselibs__json satisfies: comp_req__json__asil, comp_req__json__deserialization, comp_req__json__full_testability, comp_req__json__serialization, comp_req__json__user_format implements: logic_arc_int__baselibs__json included by: mod__baselibs, mod_view_sta__baselibs__baselibs coverage: lines 73% · branches 83% · files 16/22
comp__baselibs_json		Component

JSON Static view		status: valid security: YES safety: ASIL_B
version: 2 belongs to: comp__baselibs_json fulfils: comp_req__json__asil, comp_req__json__deserialization, comp_req__json__full_testability, comp_req__json__lang_idioms, comp_req__json__lang_infra, comp_req__json__serialization, comp_req__json__type_compatibility, comp_req__json__user_format
comp_arc_sta__baselibs__json		Component Package Diagram

Dynamic Architecture

JSON dynamic arch		status: invalid security: YES safety: ASIL_B
version: 2 belongs to: comp__baselibs_json fulfils: comp_req__json__asil, comp_req__json__deserialization, comp_req__json__full_testability, comp_req__json__lang_idioms, comp_req__json__lang_infra, comp_req__json__serialization, comp_req__json__type_compatibility, comp_req__json__user_format
put here a sequence diagram (TBD)
comp_arc_dyn__baselibs__json_dynamic_view		Component Sequence Diagram

Interfaces

Parse		status: valid security: YES safety: ASIL_B
version: 1 included by: logic_arc_int__baselibs__json
logic_arc_int_op__baselibs__parse		Logical Interface Operation

Write		status: valid security: YES safety: ASIL_B
version: 1 included by: logic_arc_int__baselibs__json
logic_arc_int_op__baselibs__write		Logical Interface Operation

Lower Level Components

JSON-Wrapper		status: valid security: YES safety: ASIL_B
version: 1 forms part of: comp__baselibs_json belongs to: feat__baselibs satisfies: comp_req__json__lang_idioms, comp_req__json__lang_infra, comp_req__json__type_compatibility implements: logic_arc_int__baselibs__json included by: mod__baselibs, mod_view_sta__baselibs__baselibs
comp__baselibs_json_wrapper		Component

See VaJson (comp__baselibs_vajson) in VaJson Architecture (doc__vajson_architecture) for the vaJson lower-level component.