Priorities for the Foundations team

User Stories

This section contains the story cards for the above.

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.

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

Tree layout improvements

Story Points: 3

As a Launchpad developer,
I want to be able to find the pagetests related to a particular application;
so that I can easily run the pagetests while I work on an application.

Notes:

• Moving existing directory by applications.

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.

lazr.config

Story Points: 3

As a python developer,
I want to download lazr.config from the Cheeseshop;
so that I can use it for process configuration in my project.

Notes:

• Why not brand it as canonical? Find a top-level package name.
• Missing some documentation.
• Convert setup tools.
• Reorganize project directory structure.
• License? For all of lazr?

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.

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?

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.

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.

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.

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

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.

Export mutators as writable attributes

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 PUT or PATCH request that modifies the value of a particular field;
so that the interface to modify most attributes is consistent.

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.

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".

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.

Inline text editing

Story Points: 3

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

Notes:

{{{ view/bug_title_inlinet_widget bug_title_inline_widget = InlineTextWidget(self.context, 'title') }}}

5 minutes PQM merge Theme

Story Points: 8

As a Launchpad developer,
I want a continuous integration system that will notify me when a commit I made breaks the test suite;
so that I can merge to PQM without running tests.

Notes:

• Need to deploy only known good branch.
• Uses buildbot.

EC2 Test Runner

Story Points: ?

As a Launchpad developer,
I want an easy way to run the test suite on EC2;
so that I can submit a branch to PQM with confidence that the test suite will pass.

Person/Account Separation

Story Points: ?

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.

SSO Authentication available during upgrade

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.

API customized auto-generated adapter

Story Points: Bug: #294858.

As a Launchpad developer,
I want to be able to customize the IEntry and ICollection adapters generated automatically by the annotations,
so that webservice-specific optimization might be made, while retaining the convenience of the annotated API.

Multi-Hit API

Story Points:

As a webservice client,
I want to be able to invoke a particular named operation or setting an attribute to a certain value on a set of objects;
so that mass-change operation can be done efficiently.

Notes:

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.

Automatic JavaScript test running

Story Points:

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:

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

Prepopulating AJAX cache

Story Points: ? Bug: #296456

As a Launchpad programmer,
I want to be able to add objects in the view that will be available from within JavaScript;
so I can present that data or modify it without to have to make an HTTP request.

Entry ETag

Story Points: Bug: 273176

As a Launchpad web service client,
I want to see an entry's ETag in the representation of the entry itself;
so I can make conditional requests on objects that weren't obtained through an individual HTTP request.

LAZR-JS Green Flash

Story Points: Bug:

As a Canonical JS developer,
I want to be able to use a standard green flash animation for
when data has been saved successfully.

Lazr-JS Project Bootstrap

Story Points: Bug:

As a Launchpad developer,
I want to develop, test, and publish JavaScript widgets in the lazr-js project,
so I can share JS components with the rest of Canonical.

Lazr-JS Reference Widget

Story Points: Bug:

As a Canonical JS developer,
I want to have a reference implementation of a inline text editing widget;
so that I have an example on how to write widgets.

Lazr-JS Error Widget

Story Points: Bug:

As a Launchpad user,
I want AJAX errors to be reported to a single widget;
so that I can navigate and retry errors.

Notes:

• See beuno's screenshot.
• Must be available to all widgets.
• Event-driven.