Priorities for the Foundations team

User Stories

This section contains the story cards for the above.

AJAX Track

Inline status editing

Story Points:

As a Launchpad developer,
I want a way to associate an inline widget with the rendered element of a status field in view;
so that I can easily add inline editing to any enum field.

Notes:

Inline multi-line editing

Story Points: 5

As a Launchpad developer,
I want a way to associate an inline widget with the rendered element of a multi-line text field in view;
so that I can easily add inline editing to text field.

Notes:

• Might contain dynamic sizing.

Inline autocomplete widget

Story Points:

As a Launchpad developer,
I want a way to associate an inline widget with the rendered element of a vocabulary field in view;
so that I can easily add inline editing to any Choice field using a HugeVocabulary.

Automatic JavaScript test running

Story Points: 5

As a Launchpad developer,
I want my Javascript tests automatically run by PQM on merge;
so that I can prevent regressions in Javascript code.

Notes:

• ec2test integration.
• Need to run firefox headless.
• Probably use the yuitest reporting.
• Need to write a "testrunner" around windmill.
• Add to buildbot.

Widget Instrumentation API

Story Points:

As a Launchpad developer,
I want a standard API to record user behavior;
so that usability metric can be recorded for the widget I write.

API Track

API: Field Resource

Story Points:

As an AJAX webservice client,
I want to be able to retrieve the HTML representation of field of a resource;
so that I can selectively update a page content dynamically.

lazr.restful

Story Points:

As a Zope developer,
I want to download lazr.webservice from the Cheeseshop;
so that I can add easily a REST webservice to my Zope application.

Notes:

lazr.restfulclient

Story Points:

As Python developer,
I want to download lazr.restfulclient from the Cheeseshop;
so that I can add easily create a python frontend to my lazr.restful-based web service.

Notes:

API: Field Resource Vocabulary

Story Points: 3

As a webservice client,
I want to be able to the valid values of field vocabulary;
so that I present the list of valid values to the client.

Notes:

• Close-up representation of field.
• Only for JS-benefit.
• No need for WADL because of JS.

API: Field Resource Vocabulary Search

Story Points: 8

As a webservice client,
I want to be able to make queries on a field resource vocabulary;
so that I can present a search form to select valid values in an AJAX client.

Notes:

• Searching with a maximum (no batching).
• Custom operation.
• WADL representation.
• Launchpadlib integration.
• JS integration.

API: Factory Optimization

Story Points:

As webservice client,
I want the server to send me the created object representation when I use a factory operation;
so that I don't have to make another request to retrieve the created object.

DELETE resource

Story Points: 3

As a developer,
I can annotate one of an interface's methods to be the method invoked when the client makes a DELETE request to the appropriate kind of resource;
so that the way to delete resources is consistent.

Notes:

• The DELETE request has the effect of irrevocably removing the underlying object from view through the interface. Attempts to access this object will subsequently result in a 404 error.

delete() method in launchpadlib

Story Points: 1

As a launchpadlib user,
I can delete a resource by calling the delete() method on the appropriate object.

Notes:

• Resources supporting DELETE will be shown in the WADL file as having a <method> tag with a name of "DELETE".

Expose factory methods for scoped collections

Story Points: 8

As a developer,
I can annotate a method of an interface to be the method invoked when the client makes a POST request to a scoped collection;
so that the way to use a factory is consistent across resources.

Notes:

• Needs to represent scoped collection as resources in WADL.

Expose factories as POST to collection

Story Points: 5

As a developer,
I can annotate one of a FooSet interface's methods to be the method invoked when the client makes a POST request;
so that the way to use a factory is consistent across resoureces.

Notes:

• `PersonSet` POST must include a description of whether you're creating a person or team; or, we must expose seperate collections for people and teams, and you POST to the appropriate one.
• Updating existing Set to annotate default factory.

Make it possible for the default GET on a collection to take optional arguments

Story Points: 5

As a developer,
I want operation parameters to be supported in the default GET method for a collection;
so that users can use the same HTTP operation to retrieve all of the collection or a filtered subset.

Notes:

• add methods to eg. IPersonSet that work with this system
• add a method to launchpadlib
• update the generated adapter find() signature and implementation

API Versioning

Story Points: 20

As a developer,
I want to be able to annotate certain aspects of the API as being removed from a particular version onward;
so that I can make backward incompatible change.

Notes:

{{{ @export_factory_method_as('new_team', version=3) def new_team_all(...): }}}

• Only necessary when we need to break backwards compatibility
• what can be versioned: resource type, operations, fields.
• list of ordered version number.

OpenID Track

SSO Authentication available during upgrade

Story Points: 3

As a Launchpad SSO user,
I want to be able to log in when Launchpad is going through maintenance;
so that my other services aren't affected by the monthly Launchpad down-time.

Account Creation

Story Points: 5

As a Landscape User,
when I registered an account on the SSO service, I don't want a Launchpad profile page created for me,
so that my anonimity is preserved.

Notes:

• Update the creation process to not create Account.
• Modify the Launchpad login process to create a LP profile.
• Make sure that Launchpad copes with account-only user who are browsing Launchpad (consider them anonymous).

Read-only Launchpad

Story Points: 3

As a Launchpad user,
I want to be able to browse launchpad during an upgrade;
so that I can continue to read information.

Notes:

• Detect unavailability and use Retry and DBPolicy to handle fail-over.
• Error messages on write and master not-available.
• No need to persist the failover situation since it is likely to only delay writes that are going to fail.
• Librarian should also be available.

UbuntuOne OpenID Server

Story Points:

As a UbuntuOne manager,
I want to run a separate Launchpad OpenID server;
so that I can use OpenID for my applications using a consistent brand.

Launchpad Uses UbuntuOne OpenID

Story Points:

As a Canonical sysadmin,
I want Launchpad to use openid to authenticate its users through UbuntuOne;
so that there is a single authentication system in Canonical.

Launchpad OpenID

Story Points:

As a Launchpad user,
I want to be able to register OpenID accounts I own in Launchpad and uses it to log in Lauchpad for non-privileged operation;
so that I can uses Launchpad without having to create an account on UbuntuOne.

Export GPG keys through OpenId

Story Points: 1

As a relaying party,
I want to be able to retrieve GPG keys associated with the user during openid authentication;
so that I can pre-populate their account information.

Notes:

• Define a sreg extension.
• Not much point in going to openid.ax for this.

Infrastructure Track

Use zc.buildout for deployment

Story Points: 8

As a Launchpad developer,
I want to be able to add a CheeseShop python library by adding a simple dependency to our configuration;
so that I can use and deploy easily non-packaged python library without involving IS.

Notes:

• Unpackaged eggs.
• Maintain a binary cache in version control (so that eggs are not fetched over the package.)
• Only packages not changed from upstream and already in the cheeseshop

Initial Tree layout improvements

Story Points: 3

As a Launchpad developer,
I want to be able to find the files related to a particular application in a common directory;
so that I can easily see the boundaries of each application.

Notes:

• Moving existing directory by applications.

ec2run

Story Points: 3

As a Launchpad developer,
I want a script that will fire an EC2 instance with a running instance of Launchpad based on a specified branch;
so that reviewers can preview the branch without downloading the branch.

Notes:

Sanitized DB Dump

Story Points: 2

As a Launchpad developer,
I want a sanitized production DB dump available;
so that I can preview my branches using real-world data and do more sensible performance testing.

Notes:

Two-way buildbot communication

Story Points: 3

As a LOSA,
I want the buildbot slave to accept connection from the master instead of contacting the master;
so that the network rules are safer to configure.

lazr.oops

Story Points: 13

As python web developer,
I want to download lazr.oops from the Cheeseshop;
so that I can have detailed diagnostic reports of problems on my web application.

Notes:

• Documentation.
• Extract the OOPS system from Launchpad
• Refactor oops tools and system for extensible format (integrate changes from Landscape and ubunet)
• lp:ubunet-pqm-team/ubunet/wsgi-oops
• Make pluggable extension for database logging.
• Setup-tools and all release-related stuff.

Support Privacy in Batch Navigator

Story Points:

As a Launchpad developer,
I want the BatchNavigator to filter out objects that the user doesn't have permission to;
so that it gives a coherent view of the set and that I don't have to filter out the objects in the view.

Notes:

• bug #324550

Security Cache API

Story Points:

As a Launchpad developer,
I want an API to declare to the security policy that the user has a specific permission on a set of objects;
so that it doesn't need to check for the permission again and improve performance.

Notes:

• bug #324546

Page Inventory

Story Points:

As a Launchpad developer,
I want an automatic inventory of the pages published by Launchpad;
so that I can track pages that needs updating or that I want to get rid of.

Site-wide notifications

Story Points: 8

As a Launchpad administrator,
I want to be able to post notifications to users that they will see on every page and can acknowledge;
so that I can announce downtime and other general service-related announcement.

Notes:

• Simple on/off setting.
• Acknowledgment in database.

Simple graphing/plotting framework

Story Points: 8

As a mailing list user,
I want to see the number of mailing list posts over time in a graph;
so that I can have an idea of the number of emails I might get when subscribing to the list.

Notes:

• Server-side generation or client-side? (use cases for both)
• Hard work in generating and cleaning up the data.
• Cron script parse the archive.
• Though not a perfect use-case for sparklines the concept is the same in that we need graph creation support.

Wiki markup engine

Story Points: 20

As a Launchpad user,
I want to be able to enter wiki-like syntax to have rich-text formatting in project description (as well as bug, questions, and comments);
So that I can use typography to convey emphasis and format code-samples properly

Notes:

• How users will discover?
• Requires content-type.
• Preview button?
• Full-text indexing?
• How will the markup come out in the web service or +text?

Nominating spam by users

Story Points: 5

As a Launchpad user,
I want to be able to report any user-editable content as SPAM;
so that Launchpad admins can remove it.

Notes:

• Button sends an email with who clicked the button and the link to the content.
• Standard button on IUserGeneratedContent pages, which fire an event. As a start, the event subscriber will just send an email to a specific team / email
• Mark all spammable content objects and integrate the button in the templates.

Spam control (via qualification mechanisms)

Story Points: ??

As Launchpad,
I ask every new non-qualified users to enter a captcha on every form;
so that robots cannot post SPAM automatically.

Notes:

• Might hinder LP use.
• How is somebody qualified?

LP Connection Limiting

Story Points: ??

As a XXX,
I want XXX;
so that XXX.

Notes:

• We should adapt some code that gustavo wrote for landscape to limit the connections that are accepted from the network into the webapp based on the size of the queue of connections waiting for app threads. That will keep launchpad responsive even in situations that look like the one described by tom in bug 224623.

GPG-activated accounts

Story Points: ??

As a XXX,
I want XXX;
so that XXX.

Notes:

• Allowing for people with GPG keys to be considered valid even without them actually having passwords.

Easy A-B Testing

Story Points:

As a launchpad developer,
I want to be able to configure two different views to be served from the same URL, each user receiving a random one;
so that I can easily do A-B testing.

Notes:

• Need to record in the log which view was used in each request case.