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

imp(core, websockets): Effect interface naming #97

Merged
merged 5 commits into from Jan 30, 2019

Conversation

Projects
1 participant
@JozefFlakus
Copy link
Member

commented Jan 26, 2019

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[x] Naming correction

What is the new behavior?

  1. Corrected Effect naming conventions:
  • @marblejs/core
    • Effect -> HttpEffect
    • Middleware -> HttpMiddlewareEffect
    • ErrorEffect -> HttpErrorEffect
    • ServerEffect -> HttpServerEffect
  • @marblejs/websockets
    • WebSocketEffect -> WsEffect
    • WebSocketMiddleware -> WsMiddlewareEffect
    • WebSocketErrorEffect -> WsErrrorEffect
    • WebSocketConnectionEffect -> WsConnectionEffect
  1. Created reusable Effect interface for extending defined protocols, like: HttpEffect or WsEffect

Does this PR introduce a breaking change?

[x] Yes
[ ] No

@JozefFlakus JozefFlakus added this to the 2.0.0 milestone Jan 26, 2019

@JozefFlakus JozefFlakus self-assigned this Jan 26, 2019

@JozefFlakus JozefFlakus added this to In progress in @marblejs/next via automation Jan 26, 2019

@JozefFlakus JozefFlakus requested a review from krzysztof-miemiec Jan 26, 2019

@JozefFlakus

This comment has been minimized.

Copy link
Member Author

commented Jan 26, 2019

@krzysztof-miemiec should we also keep the same naming convention for middleware related effects?
For example, should we change HttpMiddleware into HttpMiddlewareEffect, in order to have the naming like: {protocol}{type}Effect

@codecov

This comment has been minimized.

Copy link

commented Jan 27, 2019

Codecov Report

Merging #97 into next will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@         Coverage Diff         @@
##           next    #97   +/-   ##
===================================
  Coverage   100%   100%           
===================================
  Files        76     76           
  Lines       961    961           
  Branches     85     85           
===================================
  Hits        961    961
Impacted Files Coverage Δ
packages/websockets/src/error/ws-error.handler.ts 100% <ø> (ø) ⬆️
packages/core/src/http.interface.ts 100% <ø> (ø) ⬆️
packages/core/src/index.ts 100% <ø> (ø) ⬆️
packages/core/src/server/server.factory.ts 100% <ø> (ø) ⬆️
packages/websockets/src/error/ws-error.provider.ts 100% <ø> (ø) ⬆️
...ages/websockets/src/listener/websocket.listener.ts 100% <ø> (ø) ⬆️
packages/core/src/error/error.effect.ts 100% <100%> (ø) ⬆️
packages/core/src/listener/http.listener.ts 100% <100%> (ø) ⬆️
packages/middleware-jwt/src/jwt.middleware.ts 100% <100%> (ø) ⬆️
packages/middleware-body/src/index.ts 100% <100%> (ø) ⬆️
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5cdcedf...d306836. Read the comment docs.

@JozefFlakus JozefFlakus merged commit e888138 into next Jan 30, 2019

2 checks passed

Travis CI - Pull Request Build Passed
Details
codecov/patch 100% of diff hit (target 100%)
Details

@marblejs/next automation moved this from In progress to Done Jan 30, 2019

@JozefFlakus JozefFlakus deleted the imp/next/Effects-naming branch Jan 30, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.