Implement API backlog

[bajiat]

Related to #482

Note: even though the wireframe contains labels / tags for backlog items, they are not in the scope of this task. That will be a continuation task.

Definition of done

• API backlog items are stored in collection.
• API backlog collection has a schema.
  • Schema contains 'foreign key' field 'apiBackendId`
  • apiBackendId field contains unique ID of any given API Backend
  • apiBackendId field uses regEx: SimpleSchema.RegEx.Id for validation
• API backlog schema contains all relevant fields included in UI wireframe.
• API backlog input form exists.
• API Backlog is associated with each API Backend
  • Backlog has defined route (e.g. /api/{{ _id }}/backlog
• API managers can submit backlog items for their managed API Backends.
• API managers can update backlog items for their managed API Backends.
• API managers can delete backlog items for their managed API Backends.

[brylie]

@baijat, should we move this issue back to Backlog?

[bajiat]

@frenchbread Would you be interested in this task? Brylie's rough estimate was 5-8 hours.

[frenchbread]

Self-assigned.

[frenchbread]

Did some good progress so far:

• Created layout for backlog items
• Added form for adding new backlog items
• Priority label for each backlog item
• Remove backlog item functionality
• Sorting by priority & date added

Screenshot of backlog items list:

Screenshot of backlog form (stays in modal window):

ToDo:

• Deal with AutoForm with FlashMessages integration (was not able to set it up on go..). Would be cool to have some help from @elnzv since he worked with in when coding API Feedback feature.
• Replace privileges (insert, update, remove) from admin to managers.

Working branch: feature/api-backlog.

Also, if i'm misunderstanding, @brylie, should each backlog item be attached to specific API Backend?

[bajiat]

@frenchbread Good work!

The entire backlog should be for one API backend. And consequently each item in that backlog for that particular API backend.

The purpose is to communicate what changes are planned to that particular API and the backlog is managed by the API manager.

(Did this answer your question?)

[brylie]

@frenchbread yes, each API Backend has its own backlog. I have updated the definition of done do include specific details about how to link the API Backlog and API Backend, as well as details about routing. My apologies for the omissions.

[brylie]

Also note, the API Managers can only manage (add, update, delete) items in API Backlogs for their own API Backends. This can be done by comparing the apiBackend.managersId array to make sure it contains the API Manager user ID.

[brylie]

Here is an example helper function you can use:

    // Get user ID
    var userId = Meteor.user()._id;

    // Get API Backend ID
    var backendId = // you will need to determine how to get the API Backend ID
    // Depending on the context, this could come from the router, template, or database operation (e.g. `allow.update`).

    // Get API Backend (only managerIds field is necessary)
    var backend = ApiBackends.findOne(backendId, {fields: {managerIds: 1}});

    // Get the backend manager IDs
    var managerIds = backend.managerIds;

    // Check if user ID is in manager IDs
    var userCanEdit = _.contains(managerIds, userId);

[frenchbread]

@brylie @bajiat Thanks for info & updated def. of done. Now it's more clear.

[bajiat]

@frenchbread Any updates on this task?

[frenchbread]

@bajiat Almost finished this one. Just need to add inline comments describing the code.

[frenchbread]

Created PR #757. This is quite heavy one so I would suggest that couple of @apinf/developers review it.

For testing & playing with it, navigate to view-api-backend page. There should be a "Backlog" button.

Design implementation was not a part of this issue, so probably would need to create another one which is going to relate to #643.

[bajiat]

@frenchbread Hi, have you had a chance to look at Brylie's feedback on the PR?

[frenchbread]

@bajiat I am on it. After some refactoring & renaming was not able to run a project. Figuring out why stuff does not work..

[brylie]

@frenchbread are you getting any errors? I am available for pair programming here.

[brylie]

Try the basic stuff first, start with the foundation and work up to higher level things. E.g.

1. reset Meteor
2. rename the collection
3. refactor the template
4. try the collection helper
5. refactor template helpers to use collection helper

[frenchbread]

@brylie Did not get any errors, backlog items were not able to load. Seems to be an issue with subscription/publication namings.

[brylie]

OK, what are you naming the publication?

[frenchbread]

@brylie It's ApiBacklogItems.

[brylie]

@frenchbread is the branch working now? I can present at the review meeting.

[frenchbread]

@brylie yes, it works.

[brylie]

@frenchbread please focus on finalizing this branch today. The testing task is lower priority.