search

hapijs / glue

Server composer for hapi.js
Other
245 stars 62 forks source link

No documentation on new schema #60

Closed tanepiper closed 8 years ago

tanepiper commented 8 years ago

Joi of Jois, today when I deployed our API server it broke.

After digging around and some time debugging I found that plugins is no longer a property we can use in a config file, but some kind of new registrations array where you have to pass in each plugin as as an object, and a new options layout too.

Can you PLEASE document the Glue schema, and going forward advise of any changes as major is this.

tanepiper commented 8 years ago

Apologies, saw the new API docs - just had a rather frustrating morning with the new version of Glue.....

devinivy commented 8 years ago

Joi of Jois

:P

Yes, glue came out with a new major version, which indicates that there are breaking changes. The new glue manifest format makes the order of plugin registration to be well-defined and more transparent to the developer :)

Not sure if this was the problem, but it might be worth making sure that your package.json doesn't permit multiple major versions of a single module.

Marsup commented 8 years ago

Just wondering, how can you see that only when deploying ? Don't you test locally before ?

tanepiper commented 8 years ago

@Marsup @devinivy In the package.json "glue": "^2.4.0", was set, so I have no idea why it broken when I deployed. But when starting up the server was getting Joi errors. Took a while to dig around and find that it was the internal manifest, and from that the new API.

I'll most likely set the package.json to a tilde for try enforce only minor updates.

@devinivy I would say that while the API docs are there, there is no clear upgrade path specified in the release notes or readme (something like https://github.com/rackt/redux/releases/tag/v3.1.0). It was quite a fundamental schema change, and even reading the docs it still isn't clear if you need to pass in plugin options (no route/label options) that you have to use the plugin.register format.

lock[bot] commented 4 years ago

This thread has been automatically locked due to inactivity. Please open a new issue for related bugs or questions following the new issue template instructions.