Skip to content

Service manifest and me json cleanup

temas edited this page Aug 29, 2011 · 4 revisions

Service Manifest and me.json cleanup

Goal

Refactor the me.json usage to only contain true instance data or state information, all other information is copied from the service manifest.

Scoping

  • Removing data from me.json that is redundant to the manifest
  • Allow the manifest data to migrate when no migrate script is necessary
  • Adding the instance handle/id to the app startup input
  • ?? Fixing the few apps that read me.json directly

Acceptance criteria

  • The core locker should be able to use a merged manifest and me.json from a single api call
  • Core locker calls that are using general service info use the new api and not direct me.json reads
  • Starting services are passed their handle/id on stdin

Testing

  • The new api call has unit tests that pass
  • Starting services verifies they receive their handle/id
  • Unit tests verify that changing a manifest and then using the API call has the updated manifest fields

Dependencies

  • Currently blocking Links work from going in to production

List of known tasks

  • Create (or modify the exist serviceInfo) API call to return merged service information
  • Consider all me.json reads to see if they are necessary or can use the merged service info
  • Add handle/id to the startup service info
  • Write the unit tests

Analysis review

Signed off by:

  • ...

Known issues

  • me.json is no longer the master, the manifest is.

Acceptance

  • Demo
  • Have the acceptance criteria been met?
  • Are the tests sufficient?
  • Review known issues
  • Does the implementation meet expectations for code quality and clarity?
  • What considerations are there for deployment to production?
  • Has master been merged in?
Clone this wiki locally