Skip to content
This repository was archived by the owner on Oct 9, 2023. It is now read-only.

JSON serialization fixes #220

Merged
merged 3 commits into from
Mar 28, 2023

Conversation

dmitrii-ubskii
Copy link
Member

@dmitrii-ubskii dmitrii-ubskii commented Mar 27, 2023

What is the goal of this PR?

We update serialization API from JSON() to more canonical toJSONRecord()* and update the BDD test steps to reflect the changes in typedb-behaviour (typedb/typedb-behaviour#240).

* We're avoiding toJSON() as it is reserved by JavaScript for built-in JSON serialization. Since our JSON representation is lossy, we'd like the user to be explicit in their intent.

@typedb-bot
Copy link
Member

typedb-bot commented Mar 27, 2023

PR Review Checklist

Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.


Trivial Change

  • This change is trivial and does not require a code or architecture review.

Code

  • Packages, classes, and methods have a single domain of responsibility.
  • Packages, classes, and methods are grouped into cohesive and consistent domain model.
  • The code is canonical and the minimum required to achieve the goal.
  • Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
  • Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
  • The code is algorithmically efficient and scalable for the whole application.

Architecture

  • Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
  • Any required build and release automations are updated and/or implemented.
  • Any new components follows a consistent style with respect to the pre-existing codebase.
  • The architecture intuitively reflects the application domain, and is easy to understand.
  • The architecture has a well-defined hierarchy of encapsulated components.
  • The architecture is extensible and scalable.

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
dmitrii-ubskii Dmitrii Ubskii
@dmitrii-ubskii dmitrii-ubskii force-pushed the json-serialization-fixes branch from d7370cf to c9e25d7 Compare March 27, 2023 13:57

Verified

This commit was signed with the committer’s verified signature.
dmitrii-ubskii Dmitrii Ubskii

Verified

This commit was signed with the committer’s verified signature.
dmitrii-ubskii Dmitrii Ubskii
@dmitrii-ubskii dmitrii-ubskii changed the title json serialization fixups JSON serialization fixes Mar 28, 2023
@dmitrii-ubskii dmitrii-ubskii marked this pull request as ready for review March 28, 2023 08:56
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants