Jest compatibility API: expect.toHaveProperty does not support array index

[trivikr]

Describe the bug

Jest compatibility API: expect.toHaveProperty does not support array index

Reproduction

Jest

Succeeds in jest@29.4.1

const obj = { fruits: ["apple", "banana", "orange"] };

test("toHaveProperty", () => {
  expect(obj).toHaveProperty(["fruits", 0], "apple");
})

Docs: https://jestjs.io/docs/expect#tohavepropertykeypath-value

Vitest

Fails with vitest@0.28.4

import { expect, test } from "vitest";

const obj = { fruits: ["apple", "banana", "orange"] };

test("toHaveProperty", () => {
  expect(obj).toHaveProperty(["fruits", 0], "apple");
})

Error thrown:

$  FAIL  example.spec.js > toHaveProperty
TypeError: key.replace is not a function
 ❯ example.spec.js:6:15
      4| 
      5| test("toHaveProperty", () => {
      6|   expect(obj).toHaveProperty(["fruits", 0], "apple");
       |               ^
      7| })

Docs: https://vitest.dev/api/expect.html#tohaveproperty

System Info

npmPackages:
    vitest: ^0.28.4 => 0.28.4

Used Package Manager

npm

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
• The provided reproduction is a minimal reproducible example of the bug.

[trivikr]

This issue was noticed while writing expect comparison tests in vitest-codemod
trivikr/vitest-codemod@8f89939 (#76)

[sheremet-va]

Does it work with index as a string?

[trivikr]

Does it work with index as a string?

It works with index as a string

import { expect, test } from "vitest";

const obj = { fruits: ["apple", "banana", "orange"] };

test("toHaveProperty", () => {
  expect(obj).toHaveProperty(["fruits", "0"], "apple");
})

 DEV  v0.28.4 /Users/trivikram/workspace/test

 ✓ example.spec.js (1)

 Test Files  1 passed (1)
      Tests  1 passed (1)
   Start at  08:53:40
   Duration  197ms (transform 45ms, setup 0ms, collect 5ms, tests 1ms)

[trivikr]

The bug is on line 283 of jest-expect.ts

vitest/packages/expect/src/jest-expect.ts

Line 283 in aa1aa4d

args[0] = args[0].map(key => key.replace(/([.[\]])/g, '\\$1')).join('.')

It assumes all values in the array are strings.

[trivikr]

One fix would be coercing key to String primitive before running replace on it.

 args[0] = args[0].map(key => String(key).replace(/([.[\]])/g, '\\$1')).join('.') 

[trivikr]

One fix would be coercing key to String primitive before running replace on it.

Example fix posted at #2808