ObjectTypeLiteral support #415

WoH · 2019-08-14T09:51:56Z

Currently open issue: #50

R4R

tests/unit/swagger/definitionsGeneration/definitions.spec.ts

src/metadataGeneration/tsoa.ts

tests/integration/dynamic-controllers-express-server.spec.ts

dgreene1 · 2019-08-23T15:02:27Z

I see that this is still marked as "Draft" Do you want to remove that @WoH or are you still waiting for more feedback from other members or something?

HoldYourWaffle · 2019-08-23T17:03:10Z

I'm a little confused (probably due to severe lack of sleep) so sorry if this is a stupid question, but what kind of 'objects' can we use know? Is it an implementation of #353?

WoH · 2019-08-23T17:15:38Z

@dgreene1:

I see that this is still marked as "Draft" Do you want to remove that @WoH or are you still waiting for more feedback from other members or something?

Mostly I'm dreading the tests I'll want to write around this. This PR should already cover nested JSDoc annotations and pretty much everything we support on interface declarations. However, that means we want to make sure it does and will not regress at any point in the future.

@HoldYourWaffle:

I'm a little confused (probably due to severe lack of sleep) so sorry if this is a stupid question, but what kind of 'objects' can we use know? Is it an implementation of #353?

No. The primary concern of this PR are type definitions wrapped inside {}.
See here for reference:

interface Model {
  prop: {
    nested: string
  }
}

or

function(): { value: number } {
  ...
}

HoldYourWaffle · 2019-08-23T17:38:48Z

The primary concern of this PR are type definitions wrapped inside {}

Wait how is that different from my implementation of #353 (supporting refObjects)? Does this only support 'objects' with a single property?
Again sorry for my stupidity, I just can't get it to click in my head for some reason...

WoH · 2019-08-23T18:18:20Z

Wait how is that different from my implementation of #353 (supporting refObjects)? Does this only support 'objects' with a single property?
Again sorry for my stupidity, I just can't get it to click in my head for some reason...

Ok, so a refObject is the internal representation for a named interface, sometimes a type alias in tsoa. Simply called a referenceType, so that's the term for this I will use in the context of this explanation. This thing is not supported as QueryParam.

What I'm doing is adding a way to resolve ObjectLiteralTypes. That's what would allow you to not create a new interface every time you want to add an arbitrary amount of sub-properties to your property (of a referenceType) but to do it the TypeScript way of adding another set of angle brackets and specifying the sub-properties between. These types would then be inlined into the property schema of the referenceType

HoldYourWaffle · 2019-08-23T20:57:47Z

Oh wait I think I get it, you're adding support for an "anonymous" object, just not in @Query.
That makes sense, thank you for making my dumb and tired brain understand.

As a side note, I might post a very work-in-progress PR with my implementation of refObject (and I suppose these literals too in the future) in @Query. I made this implementation 2 months ago in a really big rush (needed it for a project with a tight deadline) so it's nowhere near a "mergeable" state (I'm not even sure what some parts are doing anymore), but it might be good to get some feedback on the general direction I'm going.

WoH · 2019-08-24T13:59:46Z

I'll open this one up, got some (admittedly lazy) JSDoc validation specs in.
Excess prop handling (only 'throw-on-extras' explicitly tested right now) should be covered in the koa no additional integration spec, but there's probably room for more.

HoldYourWaffle · 2019-08-24T16:38:06Z

Just like with #444 we should consider which PR we want to merge first, my cleanup (#445) or this.
(Again assuming my cleanup gets merged)

WoH · 2019-08-25T09:52:37Z

Anticipating some of @dgreene1's review in f3d9fb0 and 55f9ca7 to reduce the time he has to invest in PR review (hopefully).

I tried to improve UX for validations, throw if metadata is missing, added an assertion that a nested object value is an object in the first place.

Got around to spec excess prop handling (ignore, remove, throw), see 55f9ca7

Happy to get reviews at this point.

WoH · 2019-08-25T09:57:55Z

tests/fixtures/testModel.ts

@@ -333,12 +422,6 @@ export class TestClassModel extends TestClassBaseModel {
  stringProperty: string;
  protected protectedStringProperty: string;

-  public static typeLiterals = {


I removed these since they were messing up type resolution (Boolean, Number and String will throw) now that we actually examine the content of the Block.

E: They were not actually used in tests anyway.

WoH · 2019-08-30T09:25:44Z

Rebased for the green checkmark.

WoH · 2019-09-01T15:24:55Z

@dgreene1 I just rebased and realized checks are not running anymore. Is this intended?

I’m hoping this solves #415 (comment)

dgreene1 · 2019-09-01T15:32:37Z

@dgreene1 I just rebased and realized checks are not running anymore. Is this intended?

I don’t know what’s up with github actions. I just made a change that should hopefully force the tests to be run on each commit.

src/metadataGeneration/typeResolver.ts

- Assert nOL is object - Throw on missing nested properties - Print excess prop value

WoH · 2019-09-01T15:53:36Z

I don’t know what’s up with github actions. I just made a change that should hopefully force the tests to be run on each commit.

Works now

PSA: f8eef44#diff-d107cbd1a26a9e3dbdf1db48ecdeac37R1 was apparently not subjected to the prettier hook, I had to do some trickery to get the automatic fix out of this PR, but I can append it if it's wanted, I did not, in order to avoid merge conflicts and keep this PR clean.

dgreene1

Really fantastic job on this PR. I think those two places that were lacking intersection tests are the only places that I think are lacking coverage.

tests/integration/dynamic-controllers-express-server.spec.ts

dgreene1 reviewed Aug 14, 2019

View reviewed changes

tests/unit/swagger/definitionsGeneration/definitions.spec.ts Outdated Show resolved Hide resolved

tests/unit/swagger/definitionsGeneration/definitions.spec.ts Outdated Show resolved Hide resolved

src/metadataGeneration/tsoa.ts Outdated Show resolved Hide resolved

WoH force-pushed the deepobj branch from ad751d8 to 8addac7 Compare August 14, 2019 16:19

WoH commented Aug 14, 2019

View reviewed changes

tests/integration/dynamic-controllers-express-server.spec.ts Show resolved Hide resolved

WoH force-pushed the deepobj branch 2 times, most recently from da71a89 to d84d72f Compare August 22, 2019 22:14

WoH force-pushed the deepobj branch from d84d72f to d1b29d1 Compare August 23, 2019 21:54

WoH marked this pull request as ready for review August 24, 2019 13:58

WoH force-pushed the deepobj branch from 7dcab83 to 08b02bb Compare August 24, 2019 14:57

WoH force-pushed the deepobj branch from 8efdd69 to 55f9ca7 Compare August 25, 2019 09:49

WoH commented Aug 25, 2019

View reviewed changes

WoH force-pushed the deepobj branch from 55f9ca7 to aa7c7b0 Compare August 30, 2019 07:15

WoH force-pushed the deepobj branch 2 times, most recently from 3fe932a to d9a9367 Compare September 1, 2019 15:21

dgreene1 added a commit that referenced this pull request Sep 1, 2019

Trying to ensure tests run on new commits.

ddbf2fd

I’m hoping this solves #415 (comment)

dgreene1 reviewed Sep 1, 2019

View reviewed changes

src/metadataGeneration/typeResolver.ts Outdated Show resolved Hide resolved

WoH added 3 commits September 1, 2019 17:51

ObjectTypeLiteral support

978627c

nOL: Validation

d1fab03

nOL: refactor

ffddb29

WoH added 5 commits September 1, 2019 17:51

nOL Validation: JSDoc validation tests

6521cf9

nOL Validation: Reuse prop helper

f289aa2

nOL: assertions, throws, more info

199a864

- Assert nOL is object - Throw on missing nested properties - Print excess prop value

nOL: Excess prop validation specs

8ff14c4

nOL: Don't cast

852bf09

WoH force-pushed the deepobj branch from 1ea71ce to 852bf09 Compare September 1, 2019 15:52

dgreene1 requested changes Sep 1, 2019

View reviewed changes

tests/integration/dynamic-controllers-express-server.spec.ts Show resolved Hide resolved

tests/integration/dynamic-controllers-express-server.spec.ts Show resolved Hide resolved

nOL: (Nested) Intersection validation specs

d0fe540

dgreene1 merged commit 28e599d into lukeautry:master Sep 1, 2019

dgreene1 mentioned this pull request Sep 4, 2019

Unknown type: TypeLiteral when using a dictionary on a model object #50

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ObjectTypeLiteral support #415

ObjectTypeLiteral support #415

WoH commented Aug 14, 2019 •

edited

Loading

dgreene1 commented Aug 23, 2019

HoldYourWaffle commented Aug 23, 2019

WoH commented Aug 23, 2019 •

edited

Loading

HoldYourWaffle commented Aug 23, 2019

WoH commented Aug 23, 2019

HoldYourWaffle commented Aug 23, 2019

WoH commented Aug 24, 2019 •

edited

Loading

HoldYourWaffle commented Aug 24, 2019

WoH commented Aug 25, 2019 •

edited

Loading

WoH Aug 25, 2019 •

edited

Loading

WoH commented Aug 30, 2019

WoH commented Sep 1, 2019

dgreene1 commented Sep 1, 2019

WoH commented Sep 1, 2019 •

edited

Loading

dgreene1 left a comment

ObjectTypeLiteral support #415

ObjectTypeLiteral support #415

Conversation

WoH commented Aug 14, 2019 • edited Loading

dgreene1 commented Aug 23, 2019

HoldYourWaffle commented Aug 23, 2019

WoH commented Aug 23, 2019 • edited Loading

HoldYourWaffle commented Aug 23, 2019

WoH commented Aug 23, 2019

HoldYourWaffle commented Aug 23, 2019

WoH commented Aug 24, 2019 • edited Loading

HoldYourWaffle commented Aug 24, 2019

WoH commented Aug 25, 2019 • edited Loading

WoH Aug 25, 2019 • edited Loading

Choose a reason for hiding this comment

WoH commented Aug 30, 2019

WoH commented Sep 1, 2019

dgreene1 commented Sep 1, 2019

WoH commented Sep 1, 2019 • edited Loading

dgreene1 left a comment

Choose a reason for hiding this comment

WoH commented Aug 14, 2019 •

edited

Loading

WoH commented Aug 23, 2019 •

edited

Loading

WoH commented Aug 24, 2019 •

edited

Loading

WoH commented Aug 25, 2019 •

edited

Loading

WoH Aug 25, 2019 •

edited

Loading

WoH commented Sep 1, 2019 •

edited

Loading