Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweaks to JSON serialization feature #240

Merged

Conversation

dmitrii-ubskii
Copy link
Member

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

What is the goal of this PR?

We clarify the serialization feature as serialization/json and reword the step description.

@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.

@dmitrii-ubskii dmitrii-ubskii merged commit ff4f58b into typedb:master Mar 28, 2023
dmitrii-ubskii added a commit to typedb/typedb-driver-nodejs that referenced this pull request Mar 28, 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.
dmitrii-ubskii added a commit to typedb/typedb-driver-python that referenced this pull request Mar 28, 2023
## What is the goal of this PR?

We update serialization API from `json()` to more canonical `to_json()`
and update the BDD test steps to reflect the changes in typedb-behaviour
(typedb/typedb-behaviour#240).
dmitrii-ubskii added a commit to typedb/typedb-driver that referenced this pull request Mar 28, 2023
## What is the goal of this PR?

We update the BDD test steps to reflect the changes in typedb-behaviour
(typedb/typedb-behaviour#240).
@dmitrii-ubskii dmitrii-ubskii deleted the json-serialization-fixes branch October 9, 2023 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants