Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 334140 - [server] progress reporting service
Summary: [server] progress reporting service
Status: RESOLVED FIXED
Alias: None
Product: Orion
Classification: ECD
Component: Client (show other bugs)
Version: 0.2   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 0.2   Edit
Assignee: John Arthorne CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 338652 342993
  Show dependency tree
 
Reported: 2011-01-12 12:17 EST by Szymon Brandys CLA
Modified: 2011-09-01 11:41 EDT (History)
7 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Szymon Brandys CLA 2011-01-12 12:17:08 EST
We need to define the progress reporting service and a visual component that displays task progress
Comment 1 John Arthorne CLA 2011-04-01 16:45:17 EDT
I'm making this one specific to the server side, and have opened bug 341673 for the client side portion of this.
Comment 2 John Arthorne CLA 2011-04-05 11:28:15 EDT
I'm working on the server infrastructure for this, but don't have anything in working shape yet. Here is the idea:

 - A long running operation can return a response header indicating the location of a "progress" resource for that operation
 - A client can GET that resource to discover the current state of the long running operation on the server. This resource is currently quite simple:

{
 "PercentComplete":50,
 "Message":"Doing something that takes awhile",
 "Running":true,
 "Id":"UolVNZgDsnMbAoPziYURYZcjp"
}

I expect this resource could also be augmented with a "status" about the result of the operation once it completes. This can be added if/when we come up with a concrete need for it.

From a survey of "progress" UIs in various applications, I think the "message" plus a flag indicating whether it is done is all we will need for most cases. Another technique I have seen is that the progress resource has a Set-Cookie header that contains the message to be displayed. In rare cases we would need some kind of progress bar, so I have added that notion in there for completeness. If we wanted to get fancy we could add things like estimated completion time, etc, but I'd rather keep it simple for now.
Comment 3 John Arthorne CLA 2011-04-08 16:33:04 EDT
The server infrastructure for progress reporting has been released. There is some documentation here:

http://wiki.eclipse.org/Orion/Server_API#progress

I have also converted the Git clone operation to use this mechanism. So, a Git clone request now returns the URL of a progress resource. When the clone has completed the progress resource includes the Location of the clone.

No client side changes yet.
Comment 4 John Arthorne CLA 2011-04-12 16:43:09 EDT
More server side changes:

http://git.eclipse.org/c/e4/org.eclipse.orion.server.git/commit/?id=05c90146aee5262b883658a4c0e8277ba0da8750

The complete progress workflow for git clone is now working.
Comment 5 John Arthorne CLA 2011-04-13 13:43:02 EDT
Marking fixed. We can open more bugs for any further work, but currently don't have any more server side changes planned for M7.