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

Update implementation to use compositional generator/parser pairs #1

Open
aryanjassal opened this issue Feb 12, 2025 · 4 comments · May be fixed by #2
Open

Update implementation to use compositional generator/parser pairs #1

aryanjassal opened this issue Feb 12, 2025 · 4 comments · May be fixed by #2
Assignees

Comments

@aryanjassal
Copy link
Member

Specification

This is an old repo which was originally forked. This is the older implementation, which we need to change to support using compositional generators to archive the file trees into a single file, which can be streamed.

Additional context

Directly related to MatrixAI/Polykey#811

Tasks

  1. Make sure the repo is non-ESM
  2. Get inspiration from https://github.com/MatrixAI/js-encryptedfs
  3. Use nested/compositional generators/parsers
  4. Rely on provided implementation for fs to allow usage of efs
  5. Add CI
  6. Expose appropriate types/methods
  7. The code shouldn't buffer anything - the buffer should be configurable. It should just be chunking stuff up.
  8. The block size should also be configurable, however the default is 512 bytes per block.
@aryanjassal aryanjassal self-assigned this Feb 12, 2025
Copy link

linear bot commented Feb 12, 2025

ENG-529

@aryanjassal aryanjassal added the development label Feb 12, 2025 — with Linear
@aryanjassal
Copy link
Member Author

Also need to investigate ixjs for observable-based syntax.

@aryanjassal aryanjassal linked a pull request Feb 12, 2025 that will close this issue
12 tasks
@CMCDragonkai
Copy link
Member

Generally we do not use ixjs or rxjs in libraries. Only applications.

@CMCDragonkai
Copy link
Member

Just look at the claims domain in PK to see how we do parsing and generation. It shouldn't be that complicated. The main thing is pushing into web streams though. So my thinking is that web streams is a PK domain thing, you'd want to expose compositional functions here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

2 participants