Union type in after:run plugin no longer works

[katsadim]

this is mainly a typescript question and it goes like this:

We have the following code in cypress/cli/types/cypress.d.ts:

(action: 'after:run', fn: (results: CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult) => void | Promise<void>): void

Lets focus on the type of the results argument. This is a union type. And there is no nice way to discriminate the union!

This PR "breaking: Normalize results from module api, after:run, and after:spec" and more specifically the removal of the common field status from CypressRunResult field in this change seems to be the culprit.

According to the (admitedely deprecated) TS documentation, we need a common field to discriminate union types. But now this common type is gone!

Before I would do sth like:

if (results.status === "failed") {
   // i know that we are talking about `CypressCommandLine.CypressFailedRunResult` so I cast to it without the IDE flaggin this as an error!
} else {
  // it is for sure `CypressCommandLine.CypressRunResult`
}

But I am not sure what to do now! Any ideas?

[JordanWeatherby]

Did you ever figure this out? this is causing me problems trying to upgrade to cypress v13

[katsadim]

Unfortunately i gave up on it.

[JordanWeatherby]

I ended up being able to do this to return if it failed or not

const resultIsFailure = (
  result: CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult,
) => {
  if ('status' in result) {
    return result.status === 'failed'
  }
  return result.totalFailed > 0
}