feat: Improved Promise handling to support packages like Prisma #1924

arthurfiorette · 2024-04-16T13:52:27Z

closes #1923
closes kitajs/kitajs#280

This PR adds support to any Promise<T> | PromiseLike<T> type to be extracted into T. As promises cannot be transformed into any value and can only be used once resolved, this is a safe assumption to extract.

My test case at test/valid-data/promise-extensions/main.ts ensures every "thenable" type is correctly extracted.

export type PromiseAlias = Promise<A>;

export class PromiseClass extends Promise<A> {}

export interface PromiseInterface extends Promise<A> {}

export type LikeType = PromiseLike<A>;

export type PromiseOrAlias = Promise<A> | A;

export type LikeOrType = PromiseLike<A> | A;

export type AndPromise = Promise<A> & { a: string };

export type AndLikePromise = PromiseLike<A> & { a: string };

export class LikeClass implements PromiseLike<A> {
    then<TResult1 = A, TResult2 = never>(
        onfulfilled?: ((value: A) => TResult1 | PromiseLike<TResult1>) | null | undefined,
        onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined
    ): PromiseLike<TResult1 | TResult2> {
        return new Promise(() => {});
    }
}

export abstract class LikeAbstractClass implements PromiseLike<A> {
    abstract then<TResult1 = A, TResult2 = never>(
        onfulfilled?: ((value: A) => TResult1 | PromiseLike<TResult1>) | null | undefined,
        onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined
    );
}

export interface LikeInterface extends PromiseLike<A> {}

// Prisma has a base promise type just like this
export interface WithProperty extends Promise<A> {
    [Symbol.toStringTag]: "WithProperty";
}

export interface ThenableInterface {
    then<TResult1 = A, TResult2 = never>(
        onfulfilled?: ((value: A) => TResult1 | PromiseLike<TResult1>) | null | undefined,
        onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined
    ): PromiseLike<TResult1 | TResult2>;
}

export class ThenableClass {
    then<TResult1 = A, TResult2 = never>(
        onfulfilled?: ((value: A) => TResult1 | PromiseLike<TResult1>) | null | undefined,
        onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined
    ): PromiseLike<TResult1 | TResult2> {
        return new Promise(() => {});
    }
}

All of them results into the following json schema:

{
  "PromiseAlias ": {
    "$ref": "#/definitions/A"
  }
}

(with their respective type name)

My base comparison was to strictly follow what the native Awaited native type added by microsoft/TypeScript#45350.

It works without much hassle by using a internal ts.TypeChecker property. I also added https://www.npmjs.com/package/ts-expose-internals as a dev dependency

Version

Published prerelease version: v2.2.0-next.0

Changelog

🎉 This release contains work from new contributors! 🎉

Thanks for all your work!

❤️ Sampsa Kaskela (@SampsaKaskela)

❤️ Rama Krishna Ghanta (@ramaghanta)

❤️ Tim (@timothympace)

🚀 Enhancement

feat: Improved Promise handling to support packages like Prisma #1924 (@arthurfiorette)

🐛 Bug Fix

ci: update node version #1961 (@domoritz)
bug: fix usage of * in type on Windows #1942 (@SampsaKaskela @domoritz)
removed import assertion #1944 (@ramaghanta)
Provide more type saftey for vega-lite fixme #1947 (@timothympace)

🔩 Dependency Updates

chore(deps-dev): bump vega-lite from 5.18.0 to 5.18.1 #1960 (@dependabot[bot])
chore(deps): bump commander from 12.0.0 to 12.1.0 #1959 (@dependabot[bot])
chore(deps-dev): bump @eslint/js from 9.2.0 to 9.3.0 #1958 (@dependabot[bot])
chore(deps-dev): bump tsx from 4.9.1 to 4.10.5 #1957 (@dependabot[bot])
chore(deps-dev): bump vega from 5.28.0 to 5.29.0 #1955 (@dependabot[bot])
chore(deps-dev): bump @babel/core from 7.24.4 to 7.24.5 #1953 (@dependabot[bot])
chore(deps-dev): bump chai from 5.1.0 to 5.1.1 #1952 (@dependabot[bot])
chore(deps-dev): bump @babel/preset-env from 7.24.4 to 7.24.5 #1954 (@dependabot[bot])
chore(deps-dev): bump typescript-eslint from 7.7.1 to 7.8.0 #1948 (@dependabot[bot])
chore(deps-dev): bump ajv from 8.12.0 to 8.13.0 #1950 (@dependabot[bot])
chore(deps-dev): bump tsx from 4.7.3 to 4.9.1 #1951 (@dependabot[bot])
chore(deps-dev): bump eslint from 9.1.1 to 9.2.0 #1949 (@dependabot[bot])
chore(deps-dev): bump tsx from 4.7.2 to 4.7.3 #1940 (@dependabot[bot])
chore(deps-dev): bump eslint from 9.1.0 to 9.1.1 #1939 (@dependabot[bot])

Authors: 6

@dependabot[bot]
Arthur Fiorette (@arthurfiorette)
Dominik Moritz (@domoritz)
Rama Krishna Ghanta (@ramaghanta)
Sampsa Kaskela (@SampsaKaskela)
Tim (@timothympace)

src/NodeParser/FunctionNodeParser.ts

arthurfiorette · 2024-05-16T02:41:51Z

test/vega-lite/schema.json

@@ -27149,6 +27149,8 @@
    },
    "SingleDefUnitChannel": {
      "enum": [
+        "text",


Somehow this type started getting out of order and breaking CI:

https://github.com/vega/ts-json-schema-generator/actions/runs/9105537200/job/25031273060#step:7:25

I changed its order so tests can pass, I'm also almost sure enum is order insensitive.

arthurfiorette · 2024-05-16T02:45:45Z

Hey @domoritz, it's ready for review :)

domoritz · 2024-05-16T02:47:03Z

I was waiting for tests to pass. I'll check when I'm back from traveling.

arthurfiorette · 2024-05-16T03:03:09Z

I was waiting for tests to pass

me too 😭

arthurfiorette · 2024-05-16T03:19:27Z

@domoritz done!

Codecov action failed but all missing coverage entries are from safety checks that should never hit in the current typescript version.

domoritz

This is great. Just a few comments.

src/NodeParser/FunctionNodeParser.ts

domoritz · 2024-05-19T18:15:09Z

src/NodeParser/TypeReferenceNodeParser.ts

+        if (typeSymbol.name === "Promise" || typeSymbol.name === "PromiseLike") {
+            // Promise without type resolves to Promise<any>
+            if (!node.typeArguments || node.typeArguments.length === 0) {
+                return new AnyType();


Can we move this logic into the PromiseNodeParser?

Actually not, It might be a skill issue of mine but I couldn't get it to work without this statement.

When I remove it, this is the error thrown:

● valid-data-type › promise-extensions TypeError: Cannot read properties of undefined (reading 'getId') 123 | 124 | // Check for simple type equality > 125 | if (source.getId() === target.getId()) { | ^ 126 | return true; 127 | } 128 | at getId (src/Utils/isAssignableTo.ts:125:16) at src/NodeParser/ConditionalTypeNodeParser.ts:44:77 at predicate (src/Utils/narrowType.ts:59:12) at ConditionalTypeNodeParser.createType (src/NodeParser/ConditionalTypeNodeParser.ts:44:41) at ChainNodeParser.createType (src/ChainNodeParser.ts:35:54) at TypeAliasNodeParser.createType (src/NodeParser/TypeAliasNodeParser.ts:40:43) at AnnotatedNodeParser.createType (src/NodeParser/AnnotatedNodeParser.ts:34:47) at ExposeNodeParser.createType (src/ExposeNodeParser.ts:23:45) at CircularReferenceNodeParser.createType (src/CircularReferenceNodeParser.ts:24:43) at ChainNodeParser.createType (src/ChainNodeParser.ts:35:54) at TypeReferenceNodeParser.createType (src/NodeParser/TypeReferenceNodeParser.ts:78:37) at ChainNodeParser.createType (src/ChainNodeParser.ts:35:54) at PromiseNodeParser.createType (src/NodeParser/PromiseNodeParser.ts:71:47) at ChainNodeParser.createType (src/ChainNodeParser.ts:35:54) at TypeReferenceNodeParser.createType (src/NodeParser/TypeReferenceNodeParser.ts:78:37) at ChainNodeParser.createType (src/ChainNodeParser.ts:35:54) at createType (src/NodeParser/UnionNodeParser.ts:22:45) at Array.map (<anonymous>) at UnionNodeParser.map [as createType] (src/NodeParser/UnionNodeParser.ts:21:14) at ChainNodeParser.createType (src/ChainNodeParser.ts:35:54) at TypeAliasNodeParser.createType (src/NodeParser/TypeAliasNodeParser.ts:40:43) at AnnotatedNodeParser.createType (src/NodeParser/AnnotatedNodeParser.ts:34:47) at ExposeNodeParser.createType (src/ExposeNodeParser.ts:23:45) at CircularReferenceNodeParser.createType (src/CircularReferenceNodeParser.ts:24:43) at ChainNodeParser.createType (src/ChainNodeParser.ts:35:54) at TopRefNodeParser.createType (src/TopRefNodeParser.ts:14:47) at createType (src/SchemaGenerator.ts:30:36) at Array.map (<anonymous>) at SchemaGenerator.map [as createSchemaFromNodes] (src/SchemaGenerator.ts:29:37) at SchemaGenerator.createSchemaFromNodes [as createSchema] (src/SchemaGenerator.ts:25:21) at Object.createSchema (test/utils.ts:61:34)

test/config.test.ts

Co-authored-by: Dominik Moritz <domoritz@gmail.com>

src/NodeParser/FunctionNodeParser.ts

arthurfiorette · 2024-05-20T16:05:37Z

is there anything left?

arthurfiorette and others added 4 commits January 31, 2023 10:34

fix: errors for sourceless nodes

717bb1a

initial promise support

68b6c0b

Merge remote-tracking branch 'upstream/next' into next

09ff47a

revert

19e481f

domoritz changed the title ~~Improved Promise handling to support packages like Prisma~~ feat: Improved Promise handling to support packages like Prisma Apr 16, 2024

arthurfiorette added 7 commits May 15, 2024 20:38

feat: final implementation

2d36fbf

Merge remote-tracking branch 'upstream/next' into next

2517d66

fix: imports

a13545c

code

c78f38c

lint

8f80837

code

624736e

fix: tests

7944bc7

arthurfiorette marked this pull request as ready for review May 16, 2024 01:43

expose internals

697805f

arthurfiorette commented May 16, 2024

View reviewed changes

src/NodeParser/FunctionNodeParser.ts Outdated Show resolved Hide resolved

arthurfiorette added 5 commits May 15, 2024 23:13

i was wrong

a05e492

fix: entire check

9ca48e0

fix: lint

ec698e2

type

3b74479

somehow tests were getting this out of order

a4a497f

arthurfiorette commented May 16, 2024

View reviewed changes

arthurfiorette added 2 commits May 15, 2024 23:43

fix: removed unused method

2a3e4ce

feat: added unnamed class test

42d2bd9

fix: test

e5daa4a

documented promise unwrapping

d6ed5a7

domoritz approved these changes May 19, 2024

View reviewed changes

Update src/NodeParser/FunctionNodeParser.ts

6b11f65

Co-authored-by: Dominik Moritz <domoritz@gmail.com>

domoritz reviewed May 19, 2024

View reviewed changes

src/NodeParser/FunctionNodeParser.ts Outdated Show resolved Hide resolved

arthurfiorette added 2 commits May 19, 2024 16:32

fix: removed allowUnionTypes

8100f43

chore: style

e804590

domoritz merged commit 183b426 into vega:next May 20, 2024
2 of 4 checks passed

This was referenced May 23, 2024

feat: support export * statements #1962

Merged

feat: add back cjs output #1964

Merged

arthurfiorette self-assigned this May 23, 2024

arthurfiorette mentioned this pull request May 27, 2024

Invalid index in type #1974

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Improved Promise handling to support packages like Prisma #1924

feat: Improved Promise handling to support packages like Prisma #1924

arthurfiorette commented Apr 16, 2024 •

edited by github-actions bot

Loading

arthurfiorette May 16, 2024

arthurfiorette commented May 16, 2024

domoritz commented May 16, 2024

arthurfiorette commented May 16, 2024

arthurfiorette commented May 16, 2024 •

edited

Loading

domoritz left a comment

domoritz May 19, 2024

arthurfiorette May 19, 2024

arthurfiorette commented May 20, 2024

feat: Improved Promise handling to support packages like Prisma #1924

feat: Improved Promise handling to support packages like Prisma #1924

Conversation

arthurfiorette commented Apr 16, 2024 • edited by github-actions bot Loading

Version

🚀 Enhancement

🐛 Bug Fix

🔩 Dependency Updates

Authors: 6

arthurfiorette May 16, 2024

Choose a reason for hiding this comment

arthurfiorette commented May 16, 2024

domoritz commented May 16, 2024

arthurfiorette commented May 16, 2024

arthurfiorette commented May 16, 2024 • edited Loading

domoritz left a comment

Choose a reason for hiding this comment

domoritz May 19, 2024

Choose a reason for hiding this comment

arthurfiorette May 19, 2024

Choose a reason for hiding this comment

arthurfiorette commented May 20, 2024

arthurfiorette commented Apr 16, 2024 •

edited by github-actions bot

Loading

arthurfiorette commented May 16, 2024 •

edited

Loading