IntelliJ Background task indicator doesn't disappear after task finishes

Answered

Created June 18, 2019 04:33

Hello, I am building a plugin that downloads files from a remote server, I use Task. Backgroundable and ProgressManager.getInstance().run() so we can have several parallel downloads (download takes 1-20 seconds). When I start multiple background tasks I can see a progress bar and task count at the bottom, but sometimes the progress bar doesn't disappear for a random task after it's completed (doesn't dissapear for one task only). I use distinguish names for each task.

An example of a progress bar that never disappears:

My code looks following:

ProgressManager.getInstance().run(new Task.Backgroundable(systemLogToolWindow.getProject(), "Downloading " + thisNode.name) {
    public void run(@NotNull ProgressIndicator progressIndicator) {
        // start your process
        // Here goes my downloading steps, where I update some UI icons on when start and fginish downloading

        // Finished
        progressIndicator.setFraction(1.0);
        progressIndicator.setText("finished");
        progressIndicator.cancel();
    }
});

1) Please be so kind as to help in solving the issue

2) Also is there any API to get a list of all running background task with the ability to stop any of it.

Thank you in advance

9 comments

Yann Cebron

Created June 18, 2019 08:49

Why did you put

progressIndicator.cancel();

Please always post full code, not just snippets.

2111311792

Created June 18, 2019 09:34

Yann,

Thank you for your answer.
I use cancel() method at the end to ensure that the status bar is removed (I might not fully understand API, so please correct me if I am wrong).

The full code would look like:

ProgressManager.getInstance().run(new Task.Backgroundable(systemLogToolWindow.getProject(), "Downloading " + thisNode.name) {
    public void run(@NotNull ProgressIndicator progressIndicator) {
        // start your process
        socket.getSysLogFile(getFullHostString(), getSystemPath());

        // Finished
        progressIndicator.setFraction(1.0);
        progressIndicator.setText("finished");
        progressIndicator.cancel();
    }
});

where socket.getSysLogFile:

public void getSysLogFile(String fileName, String localPathToFile) {
    OutputStream output = null;
    LogNotification notification = new LogNotification("Error", "Fail to Download File:  " + fileName, NotificationType.ERROR);
    try {
        output = logAppService.getSysLogFile(socketId, fileName);
    } catch (java.lang.OutOfMemoryError e) {
        LOG.info(e.getMessage());
        IOUtils.closeQuietly(output);
        notification.notify(project);
        return;
    }

    // saving to file
    ByteArrayInputStream inputStream = null;
    Scanner sc = null;
    PrintWriter pw = null;
    try {
        inputStream = new ByteArrayInputStream(((ByteArrayOutputStream) output).toByteArray());
        sc = new Scanner(inputStream, "UTF-8");
        pw = new PrintWriter(new FileWriter(localPathToFile));
        while (sc.hasNextLine()) {
            String logLine = sc.nextLine();
            pw.write(logLine);
            pw.println();
        }
    } catch (IOException e) {
        LOG.info(e.getMessage());
        notification.notify(project);
    } finally {
        IOUtils.closeQuietly(sc);
        IOUtils.closeQuietly(inputStream);
        IOUtils.closeQuietly(output);
        IOUtils.closeQuietly(pw);
    }
}

Yann Cebron

Created June 18, 2019 09:38

cancel() call is used to interrupt running task, not to finish/notify finish. Please remove it.

2111311792

Created June 18, 2019 09:40

Got it, will remove. Do you know why sometimes task indicator doesn't disappear after task finishes? Also is there any API to get a list of all running background tasks?