Sync API Refactor #87

helmturner · 2023-11-25T13:06:53Z

PR Checklist

Addresses an existing open issue: fixes #000
That issue was marked as status: accepting prs
Steps in CONTRIBUTING.md were taken

Overview

Refactor sync api to be easier to follow and map nicely with the new async api (wip)

use maps/sets for more declarative code
rename things
Change the api for guards to be separate from that of serialize/deserialize type handlers
give guards their own configuration, but still run them for any unhandled values

feat: guards are distinct from type handlers chore: rename some things types: general type improvements chore: add more iterable utils

vercel · 2023-11-25T13:06:59Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
tupleson-async	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 4, 2024 6:35am

feat!: new guard api

codecov · 2023-11-26T00:45:11Z

Codecov Report

Attention: 300 lines in your changes are missing coverage. Please review.

Comparison is base (9bf904f) 94.08% compared to head (9aa3dc1) 85.64%.
Report is 1 commits behind head on main.

Files	Patch %	Lines
src/async/createFoldAsyncFn.ts	0.00%	120 Missing ⚠️
src/async/createUnfoldAsyncFn.ts	0.00%	62 Missing ⚠️
src/iterableTypes.ts	0.00%	33 Missing ⚠️
src/async/serializeAsync2.ts	93.07%	26 Missing and 1 partial ⚠️
src/tsonAssert.ts	0.00%	24 Missing ⚠️
src/async/handlers/tsonPromise2.ts	77.04%	14 Missing ⚠️
src/internals/testUtils.ts	86.36%	12 Missing ⚠️
src/async/iterableUtils.ts	87.50%	4 Missing ⚠️
src/internals/isComplexValue.ts	57.14%	3 Missing ⚠️
src/sync/serialize.ts	98.30%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #87      +/-   ##
==========================================
- Coverage   94.08%   85.64%   -8.44%     
==========================================
  Files          31       40       +9     
  Lines        1876     2864     +988     
  Branches      194      258      +64     
==========================================
+ Hits         1765     2453     +688     
- Misses        109      407     +298     
- Partials        2        4       +2

Flag	Coverage Δ
unit	`85.64% <73.30%> (-8.44%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

## PR Checklist - [ ] Addresses an existing open issue: fixes #000 - [ ] That issue was marked as [`status: accepting prs`](https://github.com/trpc/tupleson/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [ ] Steps in [CONTRIBUTING.md](https://github.com/trpc/tupleson/blob/main/.github/CONTRIBUTING.md) were taken ## Overview

fix: correct assertion behavior docs: update readme for guards

helmturner · 2024-01-04T00:03:15Z

I've got the async serializer (mostly) spitting out the expected result. The main feature here is using an iterative algorithm for serialization, rather than a recursive one. There's more to do, but this is illustrative enough to be a PoC.

The benefits I'm hoping to achieve:

Better error handling
Deep-serialization of of arbitrarily complex values (e.g. Promise<AsyncIterable<Promise<string>>>)
Separation from, but interoperability with, the transport layer
Separation of concerns between streaming and serializing
An API that is easy to customize for your use-case (websocket, http JSON streams, http2/3 SSE streams, etc)
AsyncGenerators are a first class-citizen

Todos:

Clean up & normalize error handling
Change string flags to numbers
Improve serialization output of built-ins (e.g. Arrrays, POJOs)
Deserialization
Lots of cleanup

fix: don't stringify primitives prematurely tests: improved tests for new async stuff

Akxe · 2024-01-04T09:22:23Z

src/index.test.ts

+	const stringHandler = {
 		primitive: "string",
-	};
+	} as TsonType<string, string>;


This is equivalent to the other way around. Did you want to use the satisfies operator?

Actually, this is necessary due to the changes in src/sync/syncTypes.ts (sorry for the slow reply!)

helmturner added 2 commits November 25, 2023 06:42

initial new abstraction for sync

6b9752a

types: clean up interfaces in iterableTypes.ts

98a8f81

feat: guards are distinct from type handlers chore: rename some things types: general type improvements chore: add more iterable utils

helmturner requested a review from KATT November 25, 2023 13:07

chore: refactor sync api

f588184

feat!: new guard api

helmturner force-pushed the experimental-simplifications branch from ead1435 to f588184 Compare November 25, 2023 13:17

vercel bot deployed to Preview November 25, 2023 13:17 View deployment

types: fix new type signature for TsonType

78491c8

vercel bot had a problem deploying to Preview November 25, 2023 13:19 Failure

fix: un-break guards and circular reference checks

92ffe33

vercel bot deployed to Preview November 26, 2023 00:44 View deployment

tests: fix irrelevant type error in test

d7c8dbc

vercel bot deployed to Preview November 26, 2023 00:47 View deployment

vercel bot had a problem deploying to Preview November 26, 2023 01:48 Failure

chore: cleanup

8737f51

vercel bot had a problem deploying to Preview November 26, 2023 02:34 Failure

chore: fix typo

ab9df8e

vercel bot deployed to Preview November 26, 2023 02:35 View deployment

chore: cleanup

f97876b

vercel bot had a problem deploying to Preview November 26, 2023 02:38 Failure

chore: cleanup

c9b3e9a

vercel bot deployed to Preview November 26, 2023 02:42 View deployment

helmturner changed the title ~~initial new abstraction for sync~~ Sync API Refactor Nov 26, 2023

helmturner added 4 commits November 26, 2023 14:25

chore: format

7c74043

tests: catch missing coverage case, cleanup

2f14075

fix: guard shouldn't pass if neither throws nor true

0d467de

tests: add test for assert

23bc039

fix: correct assertion behavior docs: update readme for guards

vercel bot deployed to Preview November 26, 2023 21:18 View deployment

helmturner added 2 commits December 10, 2023 17:47

pff

14f2fa6

chore: right serialization result, wrong indexes

88db45d

vercel bot deployed to Preview January 3, 2024 23:25 View deployment

helmturner added 2 commits January 4, 2024 00:14

fix: correct pointer values

f367de1

fix: don't stringify primitives prematurely tests: improved tests for new async stuff

fix: disambiguate serialization output of builtins

9aa3dc1

vercel bot deployed to Preview January 4, 2024 06:35 View deployment

Akxe reviewed Jan 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Sync API Refactor #87

Sync API Refactor #87

Uh oh!

helmturner commented Nov 25, 2023

Uh oh!

vercel bot commented Nov 25, 2023 •

edited

Loading

Uh oh!

codecov bot commented Nov 26, 2023 •

edited

Loading

Uh oh!

helmturner commented Jan 4, 2024 •

edited

Loading

Uh oh!

Akxe Jan 4, 2024

Uh oh!

helmturner Jan 9, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Sync API Refactor #87

Are you sure you want to change the base?

Sync API Refactor #87

Uh oh!

Conversation

helmturner commented Nov 25, 2023

PR Checklist

Overview

Uh oh!

vercel bot commented Nov 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Nov 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

helmturner commented Jan 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Akxe Jan 4, 2024

Choose a reason for hiding this comment

Uh oh!

helmturner Jan 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vercel bot commented Nov 25, 2023 •

edited

Loading

codecov bot commented Nov 26, 2023 •

edited

Loading

helmturner commented Jan 4, 2024 •

edited

Loading

helmturner Jan 9, 2024 •

edited

Loading