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

JSON format for client-server communication #1478

Closed
lxpdd opened this issue Jul 18, 2022 · 0 comments
Closed

JSON format for client-server communication #1478

lxpdd opened this issue Jul 18, 2022 · 0 comments
Labels
enhancement Improvments of existing code

Comments

@lxpdd
Copy link
Contributor

lxpdd commented Jul 18, 2022

AS IS state

Currently there is a two special cases for getting copybook contents:
copybook-resolve - to handle copybook request
copybook-download - to handle copybook download request

And the format is not reliable, neither extensible because depends on regex rule:
/^([^.]+)\.([^.]+)(\.(quiet|verbose))?\.(.+)\.([^.]+)\.([^.]+)$/
Examples of the plaintext in server->client communication: 
cobol-lsp.copybook-resolve.cobFile.bookName.COBOL
cobol-lsp.copybook-download.quiet.cobFile.bookName2.COBOL

Acceptance Criteria

  • No Regexp used for processing client-server messages
  • Command to resolve or download copybooks are sent in JSON format

Definition of Done

  • The story is implemented according to the description.
  • Unit testing done (Preferably by TDD approach, coverage should be at least 70%).
  • Code review done by at least one other team member.
  • Manual testing is done.
  • Documentation is added and reviewed (if needed).
  • The pull request is approved.
  • The story is merged into the development branch.
  • Tests are performed on the development branch.

Technical proposal

Data format should be change format into JSON to be more reliable, readable and extensible,
it could contains such field as:
{prefix, cobolFileName, copybookName, dialect, command}

@lxpdd lxpdd added the enhancement Improvments of existing code label Jul 18, 2022
lxpdd added a commit to lxpdd/che-che4z-lsp-for-cobol that referenced this issue Jul 18, 2022
@ishche ishche closed this as completed Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvments of existing code
Projects
Status: Released
Development

No branches or pull requests

2 participants