Update browser types, adding channel and making names consistent

[flotwig]

Current behavior:

Browsers are defined like this:

export type Browser = {
  /** short browser name */
  name: BrowserName
  family: BrowserFamily
  /** ... **/
}

...which isn't well-suited to filtering out browsers based on behavior.

Desired behavior:

Browsers are defined like this:

export type Browser = {
  /** short browser name */
  name: BrowserName
  /** family is used to describe the underlying type of the browsr */
  family: BrowserFamily
  /** channel describes the stability of this browser **/
  channel: BrowserChannel
  /** ... **/
}

So this:

cypress/packages/launcher/lib/browsers.ts

Lines 8 to 60 in c15e8e1

	export const browsers: Browser[] = [
	{
	name: 'chrome',
	family: 'chrome',
	displayName: 'Chrome',
	versionRegex: /Google Chrome (\S+)/,
	profile: true,
	binary: ['google-chrome', 'chrome', 'google-chrome-stable'],
	},
	{
	name: 'chromium',
	family: 'chrome',
	displayName: 'Chromium',
	versionRegex: /Chromium (\S+)/,
	profile: true,
	binary: ['chromium-browser', 'chromium'],
	},
	{
	name: 'canary',
	family: 'chrome',
	displayName: 'Canary',
	versionRegex: /Google Chrome Canary (\S+)/,
	profile: true,
	binary: 'google-chrome-canary',
	},
	{
	name: 'firefox',
	family: 'firefox',
	displayName: 'Firefox',
	info: firefoxInfo,
	versionRegex: /Firefox (\S+)/,
	profile: true,
	binary: 'firefox',
	},
	{
	name: 'firefoxDeveloperEdition',
	family: 'firefox',
	displayName: 'Firefox Developer Edition',
	info: firefoxInfo,
	versionRegex: /Firefox Developer Edition (\S+)/,
	profile: true,
	binary: 'firefox-developer-edition',
	},
	{
	name: 'firefoxNightly',
	family: 'firefox',
	displayName: 'Firefox Nightly',
	info: firefoxInfo,
	versionRegex: /Firefox Nightly (\S+)/,
	profile: true,
	binary: 'firefox-nightly',
	},
	]

Would become this:

export const browsers: Browser[] = [
  {
    name: 'chrome',
    family: 'chromium',
    channel: 'stable',
    displayName: 'Chrome',
    versionRegex: /Google Chrome (\S+)/,
    profile: true,
    binary: ['google-chrome', 'chrome', 'google-chrome-stable'],
  },
  {
    name: 'chromium',
    family: 'chromium',
    channel: 'dev',
    displayName: 'Chromium',
    versionRegex: /Chromium (\S+)/,
    profile: true,
    binary: ['chromium-browser', 'chromium'],
  },
  {
    name: 'chrome',
    family: 'chromium',
    channel: 'canary',
    displayName: 'Canary',
    versionRegex: /Google Chrome Canary (\S+)/,
    profile: true,
    binary: 'google-chrome-canary',
  },
  {
    name: 'firefox',
    family: 'firefox',
    channel: 'stable',
    displayName: 'Firefox',
    info: firefoxInfo,
    versionRegex: /Firefox (\S+)/,
    profile: true,
    binary: 'firefox',
  },
  {
    name: 'firefox',
    family: 'firefox',
    channel: 'dev',
    displayName: 'Firefox Developer Edition',
    info: firefoxInfo,
    versionRegex: /Firefox Developer Edition (\S+)/,
    profile: true,
    binary: 'firefox-developer-edition',
  },
  {
    name: 'firefox',
    family: 'firefox',
    channel: 'nightly',
    displayName: 'Firefox Nightly',
    info: firefoxInfo,
    versionRegex: /Firefox Nightly (\S+)/,
    profile: true,
    binary: 'firefox-nightly',
  },
]

Microsoft Edge #5433 would look like this:

  {
    name: 'edge',
    family: 'chromium',
    channel: 'stable',
    displayName: 'Edge',
    versionRegex: /** ... **/,
    profile: /** ... **/,
    binary: /** ... **/,
  },

electron would it's family be set to chromium, and existing code will be updated to assert on name. Since it needs to be treated differently from normal Chromium-based browsers, but isChromiumBased would still be true.

This has the advantage of making filtering easy to do:

// not a real API
Cypress.isBrowser({ name: 'edge' })
Cypress.isBrowser({ family: 'firefox' })
Cypress.isBrowser("foo") // same as { name: 'foo' }

[flotwig]

As part of this, the logic for selecting browsers to be launched will be updated.

• --browser browserName launches browserName with channel = stable
• --browser browserName:channel launches browserName with channel = channel
• --browser canary has been aliased to chrome:canary for backwards compatibility

[cypress-bot]

The code for this is done in cypress-io/cypress#6254, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[flotwig]

Weird, GitHub didn't pick up on the "closes" from the PR...

[flotwig]

Released in 4.0.0.