Schemata Demo Jan. 2020

[wwerner]

This issue ...

• describes the demo flow
• tracks the progress of open tasks

@VaughnVernon, @kbastani: Feel free to review & add to the list below.

Components

• P - Producer: Provides schemata via HTTP API
• C - Consumer: Pulls code generated from schemata via the API and builds upon it
• U - Schemata UI:
• M - Maven Plugin for schemata integration

Demo Flow

To be checked once this is possible, keep unchecked if there are still things to implement; ideally reference corresponding issue/PR.

P1:

• U: Create Org/Unit/Context/Schema
• P: Push schema version via the API -> Allow for pushing new schema versions #104
• U: Review pushed schema version
  • U: Update the description & view the rendered markdown
  • U: Generate & view code
  • U: Publish the version
• C: Pull code of the schema version created before from the API
• U: Deprecate the schema version
• C: Pull code, verify a warning is shown and code is available -> Support pulling schema versions by reference #118, Validate schema version state xoom-build-plugins#6
• U: Remove the schema version
• C: Pull code, verify a an error is shown and no code is available -> Support pulling schema versions by reference #118, Validate schema version state xoom-build-plugins#6
• Provide http calls for preparation & each step as setup and fallback
  • Create O/U/C/S -> Allow for pushing new schema versions #104
  • Push schema version -> Allow for pushing new schema versions #104
  • Update description -> a29dbe6
  • Retrieve code
  • Publish, deprecate, remove schema version -> a29dbe6
• Provide example projects in vlingo-examples -> Schemata integration example xoom-examples#44
  • Include schema status validation in example -> Add schema lifecycle to schemata integration example xoom-examples#45

P2 (as this depends on the API supporting push/pull):

• M, P: Push schema from src/main/vlingo/schemata (or src/main/resources/vlingo?) from a maven project using vlingo-build-plugins -> vlingo-schemata pull/push schema mojos xoom-build-plugins#2

• M, C: Pull code in a maven project using vlingo-build-plugins in the generate-sources phase and put them into target/generated-sources -> vlingo-schemata pull/push schema mojos xoom-build-plugins#2

• P: Make incompatible changes to first schema, try to publish as new minor version -> [Domain] Review semantic version validation rules #75

  • P: verify that publication fails
  • P: Publish again as new major version
  • P: verify sucessful publication

• Include semantic validation in example

Known issues that could impact the demo:

• [API] Schemata containing simple types cannot be retrieved via the API #98
• [Compiler] Implement the TypeResolver interface in SchemaVersionQueriesActor to resolve types #89
• [API] Return http error if requested code cannot be compiled #77

[VaughnVernon]

@wwerner Good checklist. Please also add major version backward compatibility check when new version with same major version added.

Disallowed

• No removed attributes
• No renamed attributes
• No type change on attributes
• No reordering of attributes

Allowed

• Additive only attributes with no name clashes

[wwerner]

Demo done & went well, closing this now.