effect-error-pretty.nvim/tests/render_spec.lua at main · rashedInt32/effect-error-pretty.nvim · GitHub

History

379 lines (329 loc) · 17.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

-- Renderer tests. Run with plenary:

-- nvim --headless -u tests/minimal_init.lua \

-- -c "PlenaryBustedDirectory tests/ {minimal_init='tests/minimal_init.lua'}" -c "qa!"

local render = require("effect-error-pretty.render")

local EFFECT = { effect = true }

local function box(message)

return render.artistic({ message = message }, EFFECT)

end

local function line(message)

return render.short({ message = message }, EFFECT)

end

-- Every line of a box has to open with a box character. A soft wrap by the

-- float window is exactly what that check catches: the wrapped half has none.

local function assert_gutters(out)

for idx, l in ipairs(vim.split(out, "\n")) do

local head = vim.fn.strcharpart(l, 0, 1)

local expected = idx == 1 and "╭" or "│"

if idx == #vim.split(out, "\n") then

expected = "╰"

end

assert.are.equal(expected, head, "line " .. idx .. " lost its gutter: " .. l)

end

describe("render.artistic — Effect", function()

it("names the missing service when A holds a function type", function()

-- Regression: the `>` of `=>` used to be counted as a closing bracket, so

-- E and R were swallowed into A and the service was never reported.

local out = box(

"Type 'Effect<(x: number) => string, never, Database>' is not assignable to type 'Effect<(x: number) => string, never, never>'."

)

assert.is_truthy(out:find("Missing Services", 1, true))

assert.is_truthy(out:find("Forgot to provide: Database", 1, true))

assert.is_nil(out:find("A Mismatch", 1, true))

end)

it("names the missing RIn for a Layer of a service interface", function()

local out = box(

"Type 'Layer<{ readonly get: (id: string) => Effect<User, DbError, never>; }, never, Database>' is not assignable to type 'Layer<{ readonly get: (id: string) => Effect<User, DbError, never>; }, never, never>'."

)

assert.is_truthy(out:find("Missing RIn", 1, true))

assert.is_truthy(out:find("Forgot to provide: Database", 1, true))

end)

it("titles Scope Required only for a bare Scope", function()

local out = box("Type 'Effect<string, never, Scope>' is not assignable to type 'Effect<string, never, never>'.")

assert.is_truthy(out:find("Scope Required", 1, true))

assert.is_truthy(out:find("Effect.scoped", 1, true))

end)

it("does not claim Scope Required for a service merely named Scope*", function()

local out = box("Type 'Effect<void, never, ScopeManager>' is not assignable to type 'Effect<void, never, never>'.")

assert.is_nil(out:find("Scope Required", 1, true))

assert.is_truthy(out:find("Missing Services", 1, true))

assert.is_truthy(out:find("Effect.provide", 1, true))

end)

it("explains identical signatures instead of diffing a type against itself", function()

local out = box(

"Type 'Effect<import(\"/app/node_modules/a/node_modules/effect/User\").User, never, never>' is not assignable to type 'Effect<import(\"/app/node_modules/effect/User\").User, never, never>'."

)

assert.is_truthy(out:find("Identical Signatures", 1, true))

assert.is_truthy(out:find("two copies of the same package", 1, true))

end)

it("wraps the Got/Expected signature flush under its label", function()

-- The signature block's indent used to be hardcoded two columns wider than

-- the `│ Got: ` prefix it was supposed to align under.

local out = box(

)

local first, cont = out:match("(│ Got: )[^\n]*\n(│ +)%S")

assert.is_truthy(first)

assert.are.equal(vim.fn.strdisplaywidth(first), vim.fn.strdisplaywidth(cont))

end)

describe("render.artistic — fitting the float", function()

-- Neovim wraps the float at the *window* width, and that wrap carries no

-- gutter. Every line the box emits has to fit, hints included.

local SCOPE_RIDES_ALONG =

"Type 'Effect<Fiber<never, never>, never, MonitorHub | Scope>' is not assignable to type 'Effect<Fiber<never, never>, never, never>'."

local function widths(out)

local max = 0

for _, l in ipairs(vim.split(out, "\n")) do

max = math.max(max, vim.fn.strdisplaywidth(l))

end

return max

end

it("keeps every line inside an explicit width", function()

local out = render.artistic({ message = SCOPE_RIDES_ALONG }, { effect = true, width = 46 })

assert.is_true(widths(out) <= 46, "a line overran 46 cells:\n" .. out)

end)

it("wraps a hint instead of overrunning by a cell", function()

-- "⚡ Hint: Scope also needs Effect.scoped(...)" is 47 cells: one over, and

-- one is enough to lose the gutter on the wrapped half.

local out = render.artistic({ message = SCOPE_RIDES_ALONG }, { effect = true, width = 46 })

assert.is_truthy(out:find("Effect.scoped", 1, true))

assert_gutters(out)

end)

it("still gutters every continuation at the narrowest width", function()

assert_gutters(render.artistic({ message = SCOPE_RIDES_ALONG }, { effect = true, width = 1 }))

end)

it("leaves the default width alone in a normal window", function()

local out = box(SCOPE_RIDES_ALONG)

assert.is_true(widths(out) <= 70)

assert.is_truthy(out:find("│ ⚡ Hint: Scope also needs Effect.scoped(...)", 1, true))

end)

describe("render — channels that never inferred", function()

it("does not ask you to provide `unknown`", function()

-- TS prints `unknown` for a requirement it never resolved. There is no

-- layer to provide, so the provide hint would send you looking for one.

local out = box(

"Argument of type 'Effect<Fiber<never, unknown>, never, unknown>' is not assignable to parameter of type 'Effect<Fiber<never, unknown>, never, never>'."

)

assert.is_truthy(out:find("R Not Inferred", 1, true))

assert.is_nil(out:find("Forgot to provide", 1, true))

assert.is_nil(out:find("Effect.provide", 1, true))

assert.is_truthy(out:find("annotate the effect", 1, true))

end)

it("says the same inline", function()

local out = line(

"Argument of type 'Effect<Fiber<never, unknown>, never, unknown>' is not assignable to parameter of type 'Effect<Fiber<never, unknown>, never, never>'."

)

assert.are.equal("⚠ R never inferred (`unknown`)", out)

end)

it("treats `any` the same way", function()

local out = box("Type 'Effect<void, never, any>' is not assignable to type 'Effect<void, never, never>'.")

assert.is_truthy(out:find("R Not Inferred", 1, true))

assert.is_truthy(out:find("`any`", 1, true))

end)

it("labels the Layer channel RIn", function()

local out = box("Type 'Layer<Database, never, unknown>' is not assignable to type 'Layer<Database, never, never>'.")

assert.is_truthy(out:find("RIn Not Inferred", 1, true))

end)

it("keeps the provide hint when a real service rides along, and flags the rest", function()

local out =

box("Type 'Effect<void, never, Database | unknown>' is not assignable to type 'Effect<void, never, never>'.")

assert.is_truthy(out:find("Forgot to provide: Database", 1, true))

assert.is_nil(out:find("Forgot to provide: Database | unknown", 1, true))

assert.is_truthy(out:find("Effect.provide", 1, true))

assert.is_truthy(out:find("never inferred", 1, true))

end)

it("applies to the error channel too", function()

local out = box("Type 'Effect<void, unknown, never>' is not assignable to type 'Effect<void, never, never>'.")

assert.is_truthy(out:find("E Not Inferred", 1, true))

assert.is_nil(out:find("catchTags", 1, true))

end)

it("applies to the language-service report as well", function()

local out = box("This Effect requires a service that is missing from the expected Effect context: `unknown`.")

assert.is_truthy(out:find("R Not Inferred", 1, true))

assert.is_nil(out:find("Forgot to provide", 1, true))

end)

describe("render.artistic — @effect/language-service", function()

it("renders the Scope box without a signature diff it does not have", function()

local out = box("This Effect requires a service that is missing from the expected Effect context: `Scope`.")

assert.is_truthy(out:find("Scope Required", 1, true))

assert.is_truthy(out:find("Effect.scoped", 1, true))

assert.is_nil(out:find("Got:", 1, true))

end)

it("says provide, and scoped as well, when Scope rides along", function()

local out =

box("This Effect requires a service that is missing from the expected Effect context: `Database | Scope`.")

assert.is_truthy(out:find("Missing Services", 1, true))

assert.is_truthy(out:find("Forgot to provide: Database | Scope", 1, true))

assert.is_truthy(out:find("Effect.provide", 1, true))

assert.is_truthy(out:find("Effect.scoped", 1, true))

end)

it("titles the Layer context box as RIn and hints at Layer.provide", function()

local out = box("Missing 'Database' in the expected Layer context.")

assert.is_truthy(out:find("Missing RIn", 1, true))

assert.is_truthy(out:find("Layer.provide", 1, true))

end)

it("renders unhandled errors with the catchTags hint", function()

local out = box("Missing 'NetworkError' in the expected Effect errors.")

assert.is_truthy(out:find("Unhandled Errors", 1, true))

assert.is_truthy(out:find("Not in E channel: NetworkError", 1, true))

assert.is_truthy(out:find("Effect.catchTags", 1, true))

end)

it("closes every box it opens", function()

for _, msg in ipairs({

"This Effect requires a service that is missing from the expected Effect context: `Scope`.",

"Missing 'Database' in the expected Layer context.",

"Missing 'NetworkError' in the expected Effect errors.",

}) do

local out = box(msg)

assert.are.equal("╭", out:sub(1, #"╭"))

assert.is_truthy(out:find("╰─", 1, true))

end

end)

describe("render — TS2769 overload errors", function()

local NO_OVERLOAD = table.concat({

"No overload matches this call.",

" Overload 1 of 2, '(options?: { readonly teardown?: Teardown | undefined; } | undefined): <E, A>(effect: Effect<A, E, never>) => void', gave the following error.",

" Type 'Effect<Fiber<never, never>, never, Scope>' has no properties in common with type '{ readonly teardown?: Teardown | undefined; }'.",

" Overload 2 of 2, '(effect: Effect<Fiber<never, never>, never, never>, options?: undefined): void', gave the following error.",

" Argument of type 'Effect<Fiber<never, never>, never, Scope>' is not assignable to parameter of type 'Effect<Fiber<never, never>, never, never>'.",

" Type 'Scope' is not assignable to type 'never'.",

}, "\n")

it("boxes the buried Effect report", function()

local out = box(NO_OVERLOAD)

assert.is_truthy(out:find("Scope Required", 1, true))

assert.is_truthy(out:find("Effect.scoped", 1, true))

end)

it("gives the inline line the same verdict", function()

assert.are.equal("◈ Needs Effect.scoped", line(NO_OVERLOAD))

end)

describe("render.artistic — box alignment", function()

-- A wrapped type's continuation lines must begin in the same column as the

-- content of the label that introduced them. Each of these indents was

-- hardcoded per call site, and each was measured against the wrong prefix.

local OBJ = "{ id: string; email: string; profile: { name: string; age: number; country: string; }; }"

local function assert_first_continuation_aligns(out, label_pattern)

local label, cont = out:match("(" .. label_pattern .. "%s+)%S[^\n]*\n(│ +)%S")

assert.is_truthy(label, "no wrapped label found in:\n" .. out)

assert.are.equal(

vim.fn.strdisplaywidth(label),

vim.fn.strdisplaywidth(cont),

"continuation does not align under the label:\n" .. out

)

end

it("aligns the missing_property box (indent was one column short)", function()

local out = box("Property 'preferences' is missing in type '" .. OBJ .. "' but required in type 'User'.")

assert_first_continuation_aligns(out, "│ ◇ In:")

end)

it("aligns the type_mismatch box", function()

local out = box("Type '" .. OBJ .. "' is not assignable to type 'User'.")

assert_first_continuation_aligns(out, "│ ✗ Got:")

end)

it("aligns the tri-channel view (the ROut indent was three columns short)", function()

local out =

box("Type 'Layer<" .. OBJ .. ", DbError, Database>' is not assignable to type 'Layer<void, never, never>'.")

assert_first_continuation_aligns(out, "│ ROut:")

end)

it("budgets the wrap against the prefix so lines stay inside the box", function()

-- The wrap budget used to be a flat 70 that ignored the prefix, so an

-- indented continuation could run ~85 columns wide.

local union =

local out = box("Type '" .. union .. "' is not assignable to type 'number'.")

for _, l in ipairs(vim.split(out, "\n")) do

local w = vim.fn.strdisplaywidth(l)

assert.is_true(w <= 80, ("line runs %d columns: %s"):format(w, l))

end

end)

it("still aligns when the gutter glyph is double-width (ambiwidth=double)", function()

-- `│` is East-Asian ambiguous: one cell normally, two under ambiwidth=double.

local saved = vim.o.ambiwidth

vim.o.ambiwidth = "double"

local ok, err = pcall(function()

local out = box("Type '" .. OBJ .. "' is not assignable to type 'User'.")

assert_first_continuation_aligns(out, "│ ✗ Got:")

end)

vim.o.ambiwidth = saved

assert.is_true(ok, tostring(err))

end)

describe("render.artistic — TypeScript", function()

it("reports both halves of a null-or-undefined", function()

assert.is_truthy(box("Object is possibly 'null' or 'undefined'."):find("null or undefined", 1, true))

end)

it("names the expression for TS18048", function()

assert.is_truthy(box("'user.profile' is possibly 'undefined'."):find("'user.profile' may be undefined", 1, true))

end)

it("renders Not Callable from the continuation line (TS2349)", function()

local out = box("This expression is not callable.\n Type 'String' has no call signatures.")

assert.is_truthy(out:find("Not Callable", 1, true))

assert.is_truthy(out:find("String", 1, true))

end)

it("renders the at-least and range argument-count forms", function()

assert.is_truthy(box("Expected at least 1 arguments, but got 0."):find("expected at least 1", 1, true))

assert.is_truthy(box("Expected 1-2 arguments, but got 3."):find("expected 1-2", 1, true))

end)

describe("render.short", function()

it("reports every diverging channel, not just the first", function()

-- Regression: inline used to print only the R diff, so a user who followed

-- it would provide the services and still be left with the E error.

local out = line(

"Type 'Effect<void, NetworkError | ParseError, Http | Database>' is not assignable to type 'Effect<void, never, never>'."

)

assert.is_truthy(out:find("Http | Database", 1, true))

assert.is_truthy(out:find("NetworkError | ParseError", 1, true))

end)

it("keeps the compact form when a single channel diverges", function()

local out = line("Type 'Effect<void, DbError, Database>' is not assignable to type 'Effect<void, DbError, never>'.")

assert.are.equal("◈ Missing provide: Database", out)

end)

it("truncates on character boundaries, not bytes", function()

-- `é` is the 50th character but occupies bytes 50-51, so a byte-wise

-- :sub(1, 50) keeps only its lead byte and emits invalid UTF-8. If the cut

-- is character-wise the `é` survives whole.

local name = string.rep("A", 49) .. "é" .. string.rep("B", 10)

local out = line("Type '" .. name .. "' is not assignable to type 'number'.")

assert.is_truthy(out:find("é", 1, true), "é was cut in half: " .. out)

assert.is_truthy(out:find("…", 1, true))

end)

it("does not append an ellipsis to a type that was never cut", function()

local out =

line("Type 'import(\"/a/b/c/node_modules/@org/pkg/dist/types\").ShortName' is not assignable to type 'number'.")

assert.are.equal("✗ ShortName → ✓ number", out)

end)

it("covers the kinds the float covers", function()

assert.is_truthy(line("Expected 2 arguments, but got 1."))

assert.is_truthy(line("Cannot assign to 'PI' because it is a constant."))

assert.is_truthy(line("Module '\"fs\"' has no exported member 'nope'."))

assert.is_truthy(line("Variable 'x' is used before being assigned."))

assert.is_truthy(line("This expression is not callable.\n Type 'String' has no call signatures."))

end)

describe("hints agree with their titles", function()

it("does not suggest Effect.scoped when Scope rides along with real services", function()

local out =

box("Type 'Effect<void, never, Scope | Database>' is not assignable to type 'Effect<void, never, never>'.")

assert.is_truthy(out:find("Missing Services", 1, true))

-- Provide handles Database; Scope still needs scoped. Both must be said.

assert.is_truthy(out:find("Effect.provide", 1, true))

assert.is_truthy(out:find("Effect.scoped", 1, true))

end)

it("keeps the import paths visible in the identical-signatures box", function()

local out = box(

"Type 'Effect<import(\"/app/node_modules/a/node_modules/effect/User\").User, never, never>' is not assignable to type 'Effect<import(\"/app/node_modules/effect/User\").User, never, never>'."

)

-- Prettifying these away would leave two lines that read identically. The

-- nested copy is the whole tell, so it has to survive the wrap intact.

assert.is_truthy(out:find("import(", 1, true))

assert.is_truthy(out:find("node_modules/a/node_modules", 1, true))

for _, l in ipairs(vim.split(out, "\n")) do

assert.is_true(vim.fn.strdisplaywidth(l) <= 80)

end

end)

effect-error-pretty.nvim/tests/render_spec.lua at main · rashedInt32/effect-error-pretty.nvim · GitHub

Expand file tree

Breadcrumbs

render_spec.lua

Latest commit

History

Breadcrumbs

render_spec.lua

File metadata and controls