akkartik/driver.love - Change T7QIIGQ6YYTTYCVHVEAZSUQ3O4LYBHGPFL4K6D5TA4BA7PND4EJQC

attempt at better error recovery

I often find that opening up driver.love and sending any message gets my app unwedged. Retrying should be easy. Just press a key.
There's really no reason for the app to become unresponsive while waiting for code changes.

This approach tries to address both. Press any key to retry, or show the error right on the window while I whip out driver.love. You can also copy the message to the clipboard by hitting 'c'.

Drawbacks of this approach:

nobody's going to read the message. I myself didn't notice the default support for copying the error message for months.
more complexity for anyone reading the code to parse. More stuff that can go wrong. Any errors within the handler will crash the app hard. (Though now there's less code in the handler, so maybe this is an improvement on that score.)

The best plan is still to not rely on this too much. Don't ship bugs.

Created by Kartik K. Agaram on April 20, 2023

T7QIIGQ6YYTTYCVHVEAZSUQ3O4LYBHGPFL4K6D5TA4BA7PND4EJQC

Dependencies

In channels

main

Change contents

Replacement in main.lua at line 16 [7.2]

B:BD[6.38] → [5.8:49]

∅:D[5.49] → [6.38:63]

B:BD[6.38] → [6.38:63]

  -- available modes: run, version_check
  Mode = 'version_check'

[6.38]

[6.63]

  -- available modes: run, error
  Mode = 'run'
  Error_message = nil
  Error_count = 0
  -- we'll reuse error mode on load for an initial version check

Replacement in main.lua at line 24 [7.2]

B:BD[6.240] → [6.240:307]

  if array.find(Supported_versions, Version) then
    Mode = 'run'

[6.240]

[6.307]

  if array.find(Supported_versions, Version) == nil then
    Mode = 'error'
    Error_message = ("This app doesn't support version %s; please use version %s. Press any key to try it with this version anyway."):format(Version, Supported_versions[1])
    print(Error_message)
    -- continue initializing everything; hopefully we won't have errors during initialization

Replacement in main.lua at line 148 [7.2]

B:BD[8.1373] → [6.319:664]

  if Mode == 'version_check' then
    love.graphics.setColor(1,1,0)
    love.graphics.rectangle('fill', 30,30, 400,400)
    love.graphics.setColor(0,0,0)
    love.graphics.printf(("This app doesn't support version %s; please use version %s. Press any key to try it with this version anyway."):format(Version, Supported_versions[1]), 40,40, 400)

[8.1373]

[6.664]

  if Mode == 'error' then
    love.graphics.setColor(0,0,1)
    love.graphics.rectangle('fill', 0,0, App.screen.width, App.screen.height)
    love.graphics.setColor(1,1,1)
    love.graphics.printf(Error_message, 40,40, 600)

Replacement in main.lua at line 159 [7.2]

B:BD[8.1398] → [6.682:727]

  if Mode == 'version_check' then return end

[8.1398]

[9.486]

  if Mode == 'error' then return end

Insertion in main.lua at line 166 [7.2]

[10.6105]

[11.7]

  -- listen for commands in both 'error' and 'run' modes

Replacement in main.lua at line 168 [7.2]
∅:D[11.25] → [12.225:263]
B:BD[10.6105] → [12.225:263]
```
  if on.update then on.update(dt) end
```
[11.25]
[10.6137]
```
  if Mode == 'run' then
    if on.update then on.update(dt) end
  end
```
Replacement in main.lua at line 174 [7.2]
B:BD[10.6820] → [6.774:819]
```
  if Mode == 'version_check' then return end
```
[10.6820]
[10.6820]
```
  if Mode == 'error' then return end
```
Replacement in main.lua at line 180 [7.2]
B:BD[10.7006] → [6.820:865]
```
  if Mode == 'version_check' then return end
```
[10.7006]
[10.7006]
```
  if Mode == 'error' then return end
```

Replacement in main.lua at line 186 [7.2]

B:BD[13.39] → [6.866:911]

  if Mode == 'version_check' then return end

[13.39]

  if Mode == 'error' then return end

Replacement in main.lua at line 192 [7.2]
B:BD[10.7176] → [6.912:957]
```
  if Mode == 'version_check' then return end
```
[10.7176]
[10.7176]
```
  if Mode == 'error' then return end
```

Replacement in main.lua at line 207 [7.2]

B:BD[14.8173] → [6.958:1003]

  if Mode == 'version_check' then return end

[14.8173]

[15.188176]

  if Mode == 'error' then
    if chord == 'C-c' then
      love.system.setClipboardText(Error_message)
    end
    return
  end

Replacement in main.lua at line 222 [7.2]
B:BD[8.1512] → [6.1004:1049]
```
  if Mode == 'version_check' then return end
```
[8.1512]
[15.189334]
```
  if Mode == 'error' then return end
```
Replacement in main.lua at line 232 [7.2]
B:BD[16.57] → [6.1050:1084]
```
  if Mode == 'version_check' then
```
[16.57]
[6.1084]
```
  if Mode == 'error' then
```

Replacement in live.lua at line 299 [12.722]

B:BD[12.9968] → [12.9968:10233]

B:BD[12.10233] → [3.9:115]

∅:D[17.105] → [12.10341:10619]

∅:D[3.115] → [12.10341:10619]

B:BD[12.10341] → [12.10341:10619]

  -- draw a pause indicator on screen
  love.graphics.setColor(1,0,0)
  love.graphics.rectangle('fill', 10,10, 3,10)
  love.graphics.rectangle('fill', 16,10, 3,10)
  love.graphics.present()
  -- print stack trace here just in case we ran the app through a terminal
  local stack_trace = debug.traceback('Error: '..tostring(err), --[[stack frame]]2):gsub('\n[^\n]+$', '')
  print(stack_trace)
  print('Look in the driver for options to investigate further.')
  print("(You probably can't close the app window at this point. If you don't have the driver set up, you might need to force-quit.)")
  -- send stack trace to driver and wait for a response

[12.9940]

[18.976]

  Mode = 'error'
  local stack_trace = debug.traceback('Error: ' .. tostring(err), --[[stack frame]]2):gsub('\n[^\n]+$', '')

Replacement in live.lua at line 302 [12.722]

∅:D[11.659] → [12.10654:10675]

∅:D[18.1026] → [12.10654:10675]

B:BD[12.10654] → [12.10654:10675]

B:BD[12.10675] → [18.1027:1064]

B:BD[18.1064] → [2.9:37]

∅:D[2.37] → [12.10700:10752]

∅:D[18.1064] → [12.10700:10752]

B:BD[12.10700] → [12.10700:10752]

  local buf
  repeat
    buf = live.receive_from_driver()
    love.timer.sleep(0.001)
  until buf
  if buf == 'QUIT' then
    return true

[18.1026]

[12.10752]

  Error_message = 'Something is wrong. Sorry!\n\n'..stack_trace..'\n\n'..
    "(Note: function names above don't include outer tables. So functions like on.draw might show up as just 'draw', etc.)\n\n"..
    'Options:\n'..
    '- press "ctrl+c" (without the quotes) to copy this message to your clipboard to send to me: ak@akkartik.com\n'..
    '- press any other key to retry, see if things start working again\n'..
    '- run driver.love to try to fix it yourself. As you do, feel free to ask me questions: ak@akkartik.com\n'
  Error_count = Error_count+1
  if Error_count > 1 then
    Error_message = Error_message..('\n\nThis is error #%d in this session; things will probably not improve in this session. Please copy the message and send it to me: ak@akkartik.com.'):format(Error_count)

Replacement in live.lua at line 312 [12.722]
B:BD[12.10758] → [12.10758:10774]
```
  live.run(buf)
```
[12.10758]
[12.10774]
```
  print(Error_message)
```

attempt at better error recovery

Dependencies

In channels

Change contents

Replacement in main.lua at line 16 [7.2]

Replacement in main.lua at line 24 [7.2]

Replacement in main.lua at line 148 [7.2]

Replacement in main.lua at line 159 [7.2]

Insertion in main.lua at line 166 [7.2]

Replacement in main.lua at line 168 [7.2]

Replacement in main.lua at line 174 [7.2]

Replacement in main.lua at line 180 [7.2]

Replacement in main.lua at line 186 [7.2]

Replacement in main.lua at line 192 [7.2]

Replacement in main.lua at line 207 [7.2]

Replacement in main.lua at line 222 [7.2]

Replacement in main.lua at line 232 [7.2]

Replacement in live.lua at line 299 [12.722]

Replacement in live.lua at line 302 [12.722]

Replacement in live.lua at line 312 [12.722]