Introducing bmo.js!

I decided I should finally figure out how to create and consume promises with the Add-on SDK, so I wrote this module to play around with them a bit.

bmo.js exposes a few functions to other addons:

bmo.bug() lets you receive a bug object from Bugzilla's REST API. Pass in a bug's ID, and you'll get back all of the bug object's default properties for that bug. You can optionally pass in a comma-delimited string of the properties you want it to return. 

// Look up bug 123456, only return the id and summary fields
var bug = require("./bmo").bug(123456, "id,summary");
// Define what happens when the promise resolves
bug.then(function success(bug) { console.log(bug.summary); });

bmo.search() lets you receive the results of a bug search, normally an object filled with bug objects. This function takes an object with JSON properties for your search parameters:

// Search for all Add-on SDK bugs with a P4 priorityvar search = require("./bmo").search({"product": "Add-on SDK", "priority": "P4"});search.then(function success(results) { for(i in results) { doSomething(results[i]); } });

bmo.count() lets you receive the count of bugs returned from a search query. The first parameter is the search object, just like from bmo.search(). You can optionally pass in up to three separate fields for the bug counts to be broken into.

If no fields are used, the promise resolves directly to the bug count.

var count = require("./bmo").count({"product": "Add-on SDK", "priority": "P4"});
count.then(function success(counts) { /* counts == 26, or something like that */ });

If any of the fields are presented, the promise resolves to an object with multiple properties: data will be an array of the broken down bug counts, and you will have up to three additional properties, depending on how many fields you included: x_labels, y_labels, and z_labels, which will each be an array of descriptors based on those fields.

// Get the count of all P4 SDK bugs, broken down by severity
var count = require("./bmo").count({"product": "Add-on SDK", "priority": "P4"}, "severity");
count.then(function success(counts) {
// counts.data == [23,1,2]
// counts.x_label == [normal,minor,enhancement]
});

bmo.comments() lets you receive all comment objects from a given bug ID.

// Get all comments from bug 722597
var comments = require("./bmo").comments(722597);
comments.then(function success(comments) {
for(i in comments) {
doSomething(comments[i]);
}
});

This is all very early work, there's no authentication involved, so private bugs are not accessible, and everything is read-only, so you can't change bugs from it. This might change in the future, in addition to more querying features being added.

Many thanks to Irakli for helping me figure out what I was doing wrong while trying to consume the promises. Without his help, I'd still be stuck trying to play around with the promises, instead of actually writing the functions in the module.

Oct 02, 2012

After much pestering from both Jeff and myself, Builder was finally able to pick up the fix yesterday so that the SDK it claimed as 1.10 really truly actually WAS 1.10. It somehow managed to slip a full week after the fix was created and accepted before it actually got pushed to the production server.

Ugh.

On a happier note, I finally had some free time to work on one of my SDK-based addons (RTSE Lite) (code on Github) when all of the planets were aligned properly and both my ISP (Comcast) and the site (roosterteeth.com) that my addon modifies were not down or broken. (Seriously. Every single time I tried to work on it in the last two weeks, either Comcast was flaky, or the site was down.)

I repacked it with SDK 1.10 (locally, not on Builder, for a few reasons), and added support for using the hotkeys module to ease making posts on Rooster Teeth in the site's forums and in the messaging/journaling/comment systems. The site uses BBCode tags for marking up text formatting, and the hotkeys I added provide an easy way to insert the various BBCode tags into a post, taking into account that part of the text in the textbox might be selected.

I have plans for adding more hotkeys to the extension related to the post/comment creation/editing process that could do things like bringing up panels for fine-grained control over the link and color tags. but that'll have to wait for another day.

Releasing SDK 1.10

I got to release the new update to the Add-on SDK this last Tuesday. Jeff Griffiths was on a vacation leading up to the release, so the tasks he usually does for the releases got split up between other people on the team.

We tweaked the usual schedule a bit to make up for the fact that we were all doing some things that we usually didn't do, though I think that we should be doing it this way from now on, if possible, because it makes the actual release day a lot less hectic.

On Tuesday, September 11, I tagged and pushed the second SDK 1.10 release candidate build.

Dave Townsend blessed it as our final candidate build the next day, and I proceeded to tag and push the final SDK 1.10 to the servers. After merging 1.10 to the release branch in the repository, I ran the AMO validator hashing script and issued a pull request to AMO so that AMO would accept addons built using SDK 1.10 as valid extensions.

I then posted to the bug that tracked getting the Addon Builder site updated to using SDK 1.10 with a link to the final 1.10 tag in our repository.

Working with the AMO people, we made sure that the updates to the validator hashes and the 1.10 documentation were scheduled to be pushed live on Thursday September 13 so everything would be ready for the official release on the following Tuesday.

I spent some time on Wednesday and Thursday talking with the Builder people to make sure that the changes to Builder were set to be pushed in a timely fashion. We also pushed 1.10 to the Builder development server to make sure that everything was working correctly before pushing it to the production server on Tuesday.

On Friday, I built an empty extension using the final SDK 1.10 bits and uploaded it to the AMO validator to make sure that the validator changes had been pushed live (and actually worked), and everything was working fine for that. I also verified that the Builder-dev instance had 1.10 added and it was usable, and then tried to make sure that everything was properly set for Tuesday's push to the production server.

On Tuesday September 18, after double-checking with Dave, Irakli and Will that we were good to proceed with the actual release, I set the correct permissions for the 1.10 zip and tarball files so that people could download them, updated the "latest" redirects for those files, and Will announced the release.

I then checked the production Builder site to see if 1.10 was pushed live, but it wasn't. Pinging people on IRC didn't really get much response. (It was late in the day for the Americas at this point, and some of the relevant people for Builder are over in Europe, so it was the middle of the night for them.) I left it alone for the night, choosing to pester about it earlier on the following day.

On Wednesday September 19, I resumed pestering, and found that the people in IT that have permissions to push to production respond much quicker having bugs assigned to them for the various tasks you need them to do than they do when you just ping on IRC or CC them to the relevant bugs. We were able to get 1.10 pushed to production Builder later that day, and all was right with the world again.

Except...

Except that after Jeff returned from his vacation, he discovered that Builder believed SDK 1.10 was older than SDK 1.2 (because 1.2 minus 1.10 is a positive number, basically), so the various checks in Builder for displaying only the XX most recent SDK releases in the dropdown were suddenly displaying a lot more old releases than they should have been. This issue was discovered on Friday, and there's an implied "no live pushes" rule for Fridays (since then you have to deal with fallout from the push over the weekend when less people are around), so the fix for it wasn't pushed until Monday September 24. Which really isn't a big deal, since Builder still was defaulting to 1.10 for new addons.

Things I learned from this:

  • Getting the final release candidate built, tested, and blessed on the Tuesday/Wednesday of the week prior to the actual release is really helpful. It lets us get the validator and Builder changes set up long before the deadlines for each of them are close. We should do it like that from now on.
  • The documentation for getting the amo-validator and Builder repositories up and running really assumes that the reader knows what they're doing, and has a computer with most/all of the prerequisites already installed. Doing some of these tasks for the first time this cycle was a learning experience on its own.
  • Builder is still the weak point in our release process. As a somewhat-external group from the core Jetpack team, it's harder to get things coordinated (and we can't just push what we need pushed when we want it to be pushed). We need to get much more coordination between everyone involved, much earlier in each release cycle.

What can we do?

  • Make sure the amo-validator and flightdeck repositories have correct documentation for an outsider to know what needs to be done to update them correctly.

  • Assign bugs to specific people in IT and give a description of what needs to be pushed or run when you want them to push/run something for you. Don't just file a bug in their product/component in Bugzilla or CC them on the bug and assume that they know what to do and when to do it. After you do that, then you can ping them on IRC to see if they're available to do things immediately.
  • In the week prior to the actual release, talk with the people who are in charge of doing things we need done, to make sure that they know that the release is coming up. Maybe they can do the actual assigning of bugs from the previous bullet point for us to make sure that the assigned person will actually be around at the times when we need the tasks done.
  • Long term, we need to continue with the plans to land the SDK into Firefox so that Builder could just become a simple IDE and repository backend for people developing SDK-based addons. That way we don't need to go through with all of this hassle every six weeks.