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

test(deferObservable): add type definition test #1479

Closed
wants to merge 1 commit into from

Conversation

kwonoj
Copy link
Member

@kwonoj kwonoj commented Mar 17, 2016

Description:

This PR adds type definition test for deferObservable, as well as amending parameter type to allow function can throw without return value.

Related issue (if exists):

Additional

Issue at Typescript (microsoft/TypeScript#1042) will allow non-void function can throw once it's arrived.

@@ -72,4 +72,16 @@ describe('Observable.defer', () => {
expectObservable(e1, unsub).toBe(expected);
expectSubscriptions(source.subscriptions).toBe(sourceSubs);
});

type(() => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might be the wrong time to point this out... but I have NO IDEA what these tests do. I find them almost unreadable.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think there's wrong time, or even it'd be great time since we don't have much test for this yet. :)

Basically this test is ensuring type definition is 'works' as it's actual functionality does, for instance in case of this one defer, type should support cases

  • when factory function returns observable<T>, subscribe should carry over type T so you can access its properties without type errors
  • factory function can throw without return anything, so defer should accept function throws but does not return

both of declaration in line 82 / 83 illustrates those usecases, and since it's compile time it is being verified when test case is being compiled. If those are not working as intended, compiler will throw out messages of expected type vs. provided one.

I also agree it could be possibly confusing to consume this kind of test (small one would be ok, but case like this? https://github.com/ReactiveX/RxJS/pull/1189/files) and it'd be great if there's suggestion how to improve this or requirement should be added for better visibility. Since there is barely no test yet, changes can be easily introduced.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it seems like it would be better just to work that into the TypeScript of our actual tests. Since those will cause the compilation of the spec file themselves to fail and thus cause the tests to fail. Do we really need an additional test that doesn't seem to do anything once it's transpiled?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feasible opinion. In most cases test cases already consumes type definitions, so probably won't need to be covered once again via explicit. I remember few cases that test case does not include all of possible type definition cases though - start with opt out and only add necessary cases once it's being noticed maybe better way to go?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overloaded signature like combinelatest (#1189) might be few edge cases need these kind of test cases.

@kwonoj kwonoj added the blocked label Mar 17, 2016
@kwonoj
Copy link
Member Author

kwonoj commented Mar 17, 2016

Let me not check this in to have better proposed PR for typing tests. /cc @david-driscoll also assume he might be interested as well.

@kwonoj
Copy link
Member Author

kwonoj commented Mar 18, 2016

I have closed this PR without merging in favor of #1484.

@lock
Copy link

lock bot commented Jun 7, 2018

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Jun 7, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants