Subsequent variable declarations must have the same type when trying to type `t.context` [TypeScript]

[despairblue]

Copied from StackOverflow

Description

I use ava with typescript and want to type ava's test context. It's typed as any in ava's definition file.

@novemberborn suggested adding a generic to the test() signature

Test Source

What I specifically want is that the typescript compiler knows that t.context is of the type {foo: number} in the following test:

import test from 'ava'

test.beforeEach((t) => {
  t.context = { foo: 5 }
})

test('Is context typed', (t) => {
  // uncaught typo
  t.is(t.context.fooo, 5)
})

I tried to use declaration merging to do this, but it fails with TS2403: Subsequent variable declarations must have the same type. Variable 'context' must be of type 'any', but here has type '{ foo: number; }'. :

declare module 'ava' {
    interface ContextualTestContext {
      context: {
        foo: number,
      }
    }
}

test.beforeEach((t) => {
  t.context = { foo: 5 }
})

test('Is context typed', (t) => {
  // uncaught ypo
  t.is(t.context.fooo, 5)
})

Is there a way to do this without casting the context all the time like so:

interface IMyContext {
  foo: number
}

test.beforeEach((t) => {
  t.context = { foo: 5 }
})

test('Is context typed', (t) => {
  const context = <IMyContext> t.context
  // caught typo
  t.is(context.fooo, 5)
})

Error Message & Stack Trace

does not apply

Config

does not apply

Command-Line Arguments

does not apply

Relevant Links

• stackoverflow question

Environment

Tell us which operating system you are using, as well as which versions of Node.js, npm, and AVA. Run the following to get it quickly:

Node.js v6.9.5
darwin 16.4.0
0.18.2
3.10.10

[mmkal]

@despairblue @novemberborn Is anyone working on this? I've been looking for something similar and have something working locally.

I could submit a PR, but before I do the work to get it ready for review, I thought I should check nobody else is working on it.

[novemberborn]

@mmkal it's all yours!

[despairblue]

go for it!

On Sun, Mar 5, 2017, 12:47 Mark Wubben ***@***.***> wrote: @mmkal <https://github.com/mmkal> it's all yours! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1291 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA4neW60AvpjfrAjbBABXmH3Vu3HLuOwks5riqDpgaJpZM4MOj4P> .

-- Q: Why is this email five sentences or less? A: http://five.sentenc.es

[mmkal]

@despairblue @novemberborn thoughts on the first-cut version? #1298

[despairblue]

@mmkal I'll look into it tomorrow when I'm back at work, I was off for a week.

[despairblue]

@mmkal Awesome work in this PR. I'm just still struggling to get this to work with async beforeEachs. Changing the type of T in the beforeEach is not picked up by the typescript compiler:

import * as ava from 'ava'
import * as mongodb from 'mongodb'

function contextualize<T>(getContext: () => T): ava.RegisterContextual<T> {
  ava.test.beforeEach(async (t) => {
    Object.assign(t.context, await getContext())
  })

  return ava.test
}

const test = contextualize(async () => {
  const db = await mongodb.MongoClient.connect('mongodb://localhost:27017')

  return { db }
})

test('foo', async (t) => {
  // fails with "TS2339: Property 'db' does not exist on type 'Promise<{ db: Db; }>'."
  // console.log(t.context.db.serverConfig)

  // works
  const context = (await t.context)
  console.log(context.db.serverConfig)

  // is true since `t.context` is not a promise
  console.log(t.context === <any> context) // true
})

I think it's still ok to make each test async and await the context since it still saves me from defining an interface and casting the context.

[despairblue]

Nevermind changing the type-signature to actually reflect what's going on fixes this just fine. The issue is closed. Thank you!

function contextualize<T>(getContext: () => Promise<T>): ava.RegisterContextual<T> {