Potential ExtToolOutputNodeModel/View changes broke our logging views

jpfeuffer · July 28, 2021, 12:43pm

Hi,

we are inheriting from ExtToolOutputNodeModel and use

                setExternalOutput(executor.getToolOutput());
                setExternalErrorOutput(executor.getToolErrorOutput());

to display the output of the tool in the views.

However since KNIME 4.4 we only see the following:

What happened?

Best wishes,
Julianus

gab1one · July 28, 2021, 2:12pm

Hi @jpfeuffer,

Looks like your code is running into an exception, that is causing these lines:

github.com

knime/knime-base/blob/master/org.knime.base/src/org/knime/base/node/util/exttool/ExtToolOutputNodeView.java#L207

    
      
          
          
    try {
                  // insertString is thread safe
                  doc.insertString(doc.getEndPosition().getOffset(), s, null);
                  doc.insertString(doc.getEndPosition().getOffset(), "\n", null);
                  m_numOfLines++;
                  if (m_numOfLines > CommandExecution.MAX_OUTLINES_STORED) {
                      removefirstLine();
                  }
              } catch (BadLocationException e) {
                  m_output.setText(m_output.getText() + "\n[...and more]");
                  m_numOfLines++;
                  return;
              }
          }
          
          
private void removefirstLine() {
              PlainDocument doc = (PlainDocument)m_output.getDocument();
          
          
    int maxPos = doc.getEndPosition().getOffset();
              boolean done = false;

So you can investigate with a breakpoint there.

best,
Gabriel

jpfeuffer · July 28, 2021, 3:03pm

Hi Gabriel,

Right in the beginning, when the Document is empty, this returns 1.
The length of the document is of course 0.
→ Exception

By the way, your non-labs External Tool node has the same problem, I just double-checked.

In most of the code snippets around the web, people use doc.getLength() or doc.getEndPosition().getOffset() - 1.

Not sure if the JDK “fixed” something here from 8 to 11.

P.S.: In case you guys make some changes there, it would be cool if the API for adding single lines (kind of used in the View itself) would be exposed publicly in the model somehow It would be a bit more efficient than setting the whole text everytime. As long as it does not invalidate any internal state or preconditions of course.

Best,
Julianus

jpfeuffer · July 29, 2021, 10:26am

See the corresponding fixes in SonarQube (since I did not find any report on the change in Java).

gab1one · August 2, 2021, 8:47am

Hi @jpfeuffer,

Thank you for reporting this, I was able to verify this issue and apply a fix. It should be released with the next bugfix release.

best,
Gabriel

system · August 9, 2021, 8:48am

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.