Debugging REST API in InterSystems IRIS

Discussion

Evgeny Shvarov · 10 hr ago

Hi developers!

How do you debug implementation code in .impl classes of REST.API in InterSystems IRIS?

Especially if you don't have access to globals, so no things like:

Set ^AAA="here we are"

not possible in this case.

Suppose I have the following signature of the REST.API method called as POST and containing JSON. :

ClassMethod submitForm(formData As %Stream.Object) As %Stream.Object
{

return formData

}

Can I debug "line by line" or "command by command"?

Can I return anything to the browser's console? Or into any IRIS expected place, which is relatively easy to check?

What are my options?

Please, share your experience?

Discussion (7)2

Robert Cemper · 9 hr ago

3 variants come to my mind

write to Systrem message.log

 set %evgeny=$io
 open 1 use 1 write !,"Was in my REST code",! close 1
 use %evgeny

If you have a terminal session LOCK ^%EVGENY --- And into your code, add this simple loop
```
 for  LOCK +^%EVGENY QUIT:$TEST   HANG 0.5
```
Now your method loops, and you can attach with any external debugger. Releasing the LOCK from Terminal does the "un-freeze"

0 0

Evgeny Shvarov · 6 hr ago

Thanks @Robert Cemper ! As always - many options! Will try all

0 0

Brett Saviano · 8 hr ago

1 0

Evgeny Shvarov · 6 hr ago

Thanks @Brett Saviano ! I'll give it a try

0 0

You can create and log exceptions so that they show up in the application error logs in the SMP. That's how I prefer to do things.

0 0

Evgeny Shvarov · 6 hr ago

Thanks @David Hockenbroch ! Is it like @Robert Cemper suggests with Do LOG^%ETN()?

0 0

Eduard Lebedyuk · 4 hr ago

If you need to look at request/session/response - add this to any part of your REST handler:

set %response.ContentType = "html"
do ##class(%CSP.Utils).DisplayAllObjects()
return $$$OK

Here are some other tools available: part 1, part 2.

0 0