Another short one this week.<\/p>\n
XPIDL<\/a> is what we use to define XPCOM interfaces in Gecko. I think we’re trying to avoid XPCOM where we can, but sometimes you have to work with pre-existing XPCOM interfaces, and, well, you’re just stuck using it unless you want to rewrite what you’re working on.<\/p>\n What I’m working on lately is nsIProfiler, which is the interface to “SPS”, AKA the Gecko Profiler. nsIProfiler allows me to turn profiling on and off with various features, and then retrieve those profiles to send to a file, or to Cleopatra<\/a>1<\/a><\/sup>.<\/p>\n What I’ve been working on recently is Bug 1116188 – [e10s] Stop using sync messages for Gecko profiler<\/a>, which will probably have me adding new methods to nsIProfiler for async retrieval of profiles.<\/p>\n In the past, doing async stuff through XPCOM \/ XPIDL has meant using (or defining a new) callback interface which can be passed as an argument to the async method.<\/p>\n I was just about to go down that road, when ehsan (or was it jrmuizel? One of them, anyhow) suggested that I just pass a DOM Promise back.<\/p>\n I find that Promises are excellent.<\/a> I really like them, and if I could pass a Promise back, that’d be incredible. But I had no idea how to do it.<\/p>\n It turns out that if I can ensure that the async methods are called such that there is a JS context on the stack, I can generate a DOM Promise, and pass it back to the caller as an “nsISupports”. According to ehsan, XPConnect will do the necessary magic so that the caller, upon receiving the return value, doesn’t just get this opaque nsISupports thing, but an actual DOM Promise. This is because, I believe, that DOM Promise is something that is defined via WebIDL<\/a>. I think. I can’t say I fully understand the mechanics of XPConnect2<\/a><\/sup>, but this all sounded wonderful.<\/p>\n I even found an example in our new Service Worker<\/a> code:<\/p>\n From dom\/workers\/ServiceWorkerManager.cpp (I’ve edited the method to highlight the Promise stuff):<\/p>\n Notice that the outparam aPromise is an nsISupports**, and yet, I do believe the caller will end up handling a DOM Promise. Wicked!<\/p>\n Cleopatra is the web application that can be used to browse a profile retrieved via nsIProfiler ↩<\/a><\/p><\/li>\/\/ If we return an error code here, the ServiceWorkerContainer will<\/span><\/code>\r\n\/\/ automatically reject the Promise.<\/span><\/code>\r\nNS_IMETHODIMP<\/a><\/code>\r\nServiceWorkerManager<\/a>::Register<\/a>(nsIDOMWindow* aWindow<\/a>,<\/code>\r\n nsIURI* aScopeURI<\/a>,<\/code>\r\n nsIURI* aScriptURI<\/a>,<\/code>\r\n nsISupports<\/a>** aPromise<\/a>)<\/code>\r\n{<\/code>\r\n AssertIsOnMainThread<\/a>();<\/code>\r\n<\/code>\r\n \/\/ XXXnsm Don't allow chrome callers for now, we don't support chrome<\/span><\/code>\r\n \/\/ ServiceWorkers.<\/span><\/code>\r\n MOZ_ASSERT<\/a>(!nsContentUtils<\/a>::IsCallerChrome<\/a>());<\/code>\r\n<\/code>\r\n nsCOMPtr<\/a><nsPIDOMWindow<\/a>> window<\/a> = do_QueryInterface<\/a>(aWindow<\/a>);<\/code>\r\n<\/code>\r\n \/\/ ...\r\n<\/code>\r\n nsCOMPtr<\/a><nsIGlobalObject<\/a>> sgo<\/a> = do_QueryInterface<\/a>(window<\/a>);<\/code>\r\n ErrorResult<\/a> result<\/a>;<\/code>\r\n nsRefPtr<\/a><Promise<\/a>> promise<\/a> = Promise<\/a>::Create<\/a>(sgo<\/a>, result<\/a>);<\/code>\r\n if<\/span> (result<\/a>.Failed<\/a>()) {<\/code>\r\n return<\/span> result<\/a>.StealNSResult<\/a>();<\/code>\r\n }<\/code>\r\n\r\n \/\/ ...<\/code>\r\n<\/code>\r\n nsRefPtr<\/a><ServiceWorkerResolveWindowPromiseOnUpdateCallback<\/a>> cb<\/a> =<\/code>\r\n new<\/span> ServiceWorkerResolveWindowPromiseOnUpdateCallback<\/a>(window<\/a>, promise<\/a>);<\/code>\r\n<\/code>\r\n nsRefPtr<\/a><ServiceWorkerRegisterJob<\/a>> job<\/a> =<\/code>\r\n new<\/span> ServiceWorkerRegisterJob<\/a>(queue<\/a>, cleanedScope<\/a>, spec<\/a>, cb<\/a>, documentPrincipal<\/a>);<\/code>\r\n queue<\/a>->Append<\/a>(job<\/a>);<\/code>\r\n<\/code>\r\n promise<\/a>.forget<\/a>(aPromise<\/a>);<\/code>\r\n return<\/span> NS_OK<\/a>;<\/code>\r\n}<\/code><\/pre>\n