Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs and cleanup #3

Merged
merged 2 commits into from
Aug 10, 2016
Merged

Docs and cleanup #3

merged 2 commits into from
Aug 10, 2016

Conversation

bajtos
Copy link
Member

@bajtos bajtos commented Aug 1, 2016

1) API cleanup

Rename "per-request-context" middleware to shorter "per-request".

Introduce "LoopBackContext.perRequest" as a shortcut for way too long
"loopback-context/server/middlewar/per-request"

2) Add big fat warning to README

The module node-continuation-local-storage is known to have many problems, see e.g. issue #59. As a result, loopback-context does not work in many situations, as can be seen from issues reported in LoopBack's issue tracker.

We recommend AGAINST using this module.

If you are running on Node v6, you can try the new alternative cls-hooked.

@raymondfeng @ritch please review

Connect to strongloop-internal/scrum-loopback#989.

bajtos added 2 commits August 1, 2016 15:23
Rename "per-request-context" middleware to shorter "per-request".

Introduce "LoopBackContext.perRequest" as a shortcut for way too long
  "loopback-context/server/middlewar/per-request"
Recommend against using this module.

**We recommend AGAINST using this module.**

If you are running on Node v6, you can try the new alternative
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need another alternative that doesn't use CLS at all.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need another alternative that doesn't use CLS at all.

Agreed!

@ritch
Copy link
Member

ritch commented Aug 9, 2016

LGTM

@crandmck we'll need to update the docs to mention this module.

@bajtos bajtos merged commit 2a5d4d1 into master Aug 10, 2016
@bajtos bajtos deleted the docs-and-cleanup branch August 10, 2016 08:44
@bajtos bajtos removed the #review label Aug 10, 2016
@bajtos
Copy link
Member Author

bajtos commented Aug 10, 2016

@crandmck I edited https://docs.strongloop.com/display/APIC/Using+current+context myself. PTAL and make any improvements as you deem it fit.

@crandmck
Copy link

Thanks for doing that @bajtos! I'll make an edit pass.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants