adding flexibility for attaching alexa-app to express #177

bgjehu · Feb 13, 2017

change alexa.express()
so that it takes either an express app or router and attach alexa-app to it under given endpoint.
leave the logic of binding router to app out of the scope of alexa-app/alexa.express()

dblock · Feb 14, 2017

dblock approved these changes Feb 14, 2017 View changes

Needs a better explanation that "flexibility", maybe Express router is now optional?

dblock · Feb 14, 2017

This looks right to me, but I have this feeling that we're missing something, cc: @tejashah88.

@bgjehu Try this against alexa-app-server please, any failing tests?

The PR needs to be rebased, and see my minor comment on CHANGELOG above.

Please add a paragraph to UPGRADING wrt what one should do if they specified both express app and router before.

tejashah88 · Feb 14, 2017

Looks great so far, except for that endpoint does not have any normalization (i.e. ////test is valid).

bgjehu · Feb 14, 2017

@dblock I will work on better explanation on CHANGELOG.md, work on testing with alexa-app-server and updating UPGRADING.md
@tejashah88 I will add the usage of normalization

tejashah88 · Feb 14, 2017

tejashah88 reviewed Feb 14, 2017 View changes

@bgjehu This should be var endpoint = utils.normalizeApiPath(options.endpoint);

bgjehu · Feb 15, 2017

@dblock @tejashah88

clarified changes in CHANGELOG.md
added normalization of param 'endpoint' for alexa.express() with util fn
added upgrading guide for ExpressJS support in UPGRADING.md

not related to the commit, I testedthe new logic with alexa-app-server, swap the alexa-app node_module to my fork for all the examples (including the invalid ones), all test passed. However, not changing anything in alexa-app-server for its package.json is point to alexa-app@3.0.0 instead of 4.0.0. I would apply the associated changes to alexa-app-server once it starts pointing to alexa-app@4.0.0

dblock · Feb 15, 2017

How do all our alexa-app-server tests pass when we're no longer attaching the router to the express instance? :)

bgjehu · Feb 15, 2017

I had made related changes in alexa-app-server/index.js as well before I ran the test. They didn't just pass without changes for the usage of alexa.express() would be different.

tejashah88 · Feb 15, 2017

tejashah88 approved these changes Feb 15, 2017 View changes

tejashah88 · Feb 15, 2017

tejashah88 reviewed Feb 15, 2017 View changes

IMO, the warning message I would have done is something along the lines of "'expressApp' and 'router' are both specified, using 'expressApp'...". Generally, I want to give the user just the warning itself, and if they want to know more about it, they could look up UPGRADING.md for more information.

bgjehu · Feb 15, 2017

bgjehu reviewed Feb 15, 2017 View changes

@tejashah88 would this be better?

@bgjehu Sure. Let's see what @dblock has to say.

I think it should either be an exception or be backward compatible and produce a warning that this behavior is deprecated.

If we ignore router, the user is not getting the behavior from the previous release and we just tell them "sorry, it's not going to work, but we are going to pretend like it does" :)

I actually would prefer a backward compatible version here with a warning, because that allows a lot more flexibility in combining versions of alexa-app-server and alexa-app.

What do you think?

@dblock make sense. Making it backward compatible tonight.

dblock · Feb 15, 2017

dblock reviewed Feb 15, 2017 View changes

That's not what this change does, one of the two is required. So maybe "Express integration now requires either expressApp or router, but not both"?

@dblock thanks for offering the words. I am not good with words and describing things! Will do the changes!

You're doing great, no stress!

dblock · Feb 15, 2017

dblock reviewed Feb 15, 2017 View changes

has to be specified so that alexa-app could be attached to => is required. I think it's clear what that does already from above.

@dblock will do

dblock · Feb 15, 2017

dblock reviewed Feb 15, 2017 View changes

That's not the whole change. Also it's unclear what alexa is, it should be app, and "to be passed in" is redundant. And the next sentence says the same thing. Maybe:

Express.js integration via `app.express()` now requires one of `expresApp` or `router`. When using a router, it will no longer be automatically mounted inside the express app and you may need to implement that outside of this call.

@dblock will do!

dblock · Feb 15, 2017

dblock reviewed Feb 15, 2017 View changes

Lets delete unused functions here? The only one utilized is normalizeApiPath.

@dblock yes sir

dblock · Feb 15, 2017

I made some comments. Sorry to be a pest, I want to make sure we don't break a bunch of users.

bgjehu · Feb 16, 2017

@dblock @tejashah88
Backward compatible tested with alexa-app-server

dblock · Feb 16, 2017

I'm going to merge this, nice work on a spec, too!

I'd appreciate a follow-up pull request that:

Deletes unused functions in utils.
Slightly tweaks UPGRADING to say that the behavior with both is deprecated rather than removed.

dblock · Feb 16, 2017

@tejashah88 Interested in cutting a minor release with this change?

bgjehu · Feb 16, 2017

@dblock there is unused functional in utils? I saw the coverage for utils.js is 100%
will tweaks UPGRADING

dblock · Feb 16, 2017

coverage means there're tests, but half the functions in utils aren't actually used, eg. isValidDirectory, other than by code in those tests

bgjehu · Feb 17, 2017

right right right, silly me. I will double check and remove the unused

tejashah88 · Feb 17, 2017

@dblock We can do a release, however the CHANGELOG states that version 3.1.2 should be released today (2/16/2017).

tejashah88 · Feb 17, 2017

We should either go to 3.1.1 or 4.0.0, or wait until all relevant PRs are merged before deciding.

dblock · Feb 17, 2017

The CHANGELOG is wrong, it shouldn't have been updated. The current release is still 3.1.0.

bgjehu referenced this pull request Feb 13, 2017
Closed
add flexibility for attaching alexa-app to express #176

tejashah88 Added utilities

0b7ac4e

tejashah88 referenced this pull request Feb 14, 2017
Closed
Added utilities #180

bgjehu minor name change from 'util' to 'utils'

All checks have passed
2 successful checks

continuous-integration/travis-ci/pr — The Travis CI build passed

Details

coverage/coveralls — Coverage increased (+0.07%) to 97.977%

Details

016a8cf

bgjehu modified warning message

All checks have passed
2 successful checks

continuous-integration/travis-ci/pr — The Travis CI build passed

Details

coverage/coveralls — Coverage increased (+0.08%) to 97.989%

Details

6b66c00

Jieyi Hu added backward compatible and update documentations

All checks have passed
2 successful checks

continuous-integration/travis-ci/pr — The Travis CI build passed

Details

coverage/coveralls — Coverage increased (+0.09%) to 98.0%

Details

f516611

dblock merged commit b30997f into alexa-js:master Feb 16, 2017
2 checks passed

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

coverage/coveralls Coverage increased (+0.09%) to 98.0%
Details

dblock referenced this pull request Feb 17, 2017
Merged
The next version will be 3.2.0. #186

bgjehu	`flexibility for attaching alexa to express` increase flexibility for attaching alexa to either an express app or router	All checks have failed 2 failing checks continuous-integration/travis-ci/pr — The Travis CI build failed Details coverage/coveralls — Coverage decreased (-4.5%) to 93.373% Details	`bac4131`
bgjehu	`Merge pull request #1 from bgjehu/flexibility-attaching-to-express` flexibility for attaching alexa to express		`3716678`
Jieyi Hu	`bug fix and update tests`	Some checks were not successful 1 failing and 1 successful checks coverage/coveralls — Coverage decreased (-0.02%) to 97.892% Details continuous-integration/travis-ci/pr — The Travis CI build passed Details	`4f18868`
Jieyi Hu	`update CHANGELOG, README, express example and version in package.json`		`5198073`
Jieyi Hu	`Merge remote-tracking branch 'origin/master' into flexibility-attachi…` …ng-to-express # Conflicts: # CHANGELOG.md # package.json		`c8e04f6`
Jieyi Hu	`update test`	Some checks were not successful 1 failing and 1 successful checks coverage/coveralls — Coverage decreased (-0.02%) to 97.892% Details continuous-integration/travis-ci/pr — The Travis CI build passed Details	`ebe293a`
Jieyi Hu	`update CHANGELOG`	Some checks were not successful 1 failing and 1 successful checks coverage/coveralls — Coverage decreased (-0.02%) to 97.892% Details continuous-integration/travis-ci/pr — The Travis CI build passed Details	`29125bf`
bgjehu	`Merge pull request #2 from bgjehu/master` Merge pull request #1 from bgjehu/flexibility-attaching-to-express	Some checks were not successful 1 failing and 1 successful checks coverage/coveralls — Coverage decreased (-0.02%) to 97.892% Details continuous-integration/travis-ci/pr — The Travis CI build passed Details	`b352fb1`

@@ -1,6 +1,7 @@
      ## Changelog
      ### 4.0.0 (Next)
+    +* [#176](https://github.com/alexa-js/alexa-app/pull/176): Added flexibility to attach alexa-app to express app or router - [@bgjehu](https://github.com/bgjehu).

tejashah88	`fixed istanbul in node v0.12 breaking build with non-js files`	All checks have passed 2 successful checks continuous-integration/travis-ci/pr — The Travis CI build passed Details coverage/coveralls — Coverage increased (+0.08%) to 97.989% Details	`109dd7c`
tejashah88	`Merge branch 'flexibility-attaching-to-express' into add-utils`		`61e9633`
bgjehu	`Merge pull request #3 from tejashah88/add-utils` Add utilities	All checks have passed 2 successful checks continuous-integration/travis-ci/pr — The Travis CI build passed Details coverage/coveralls — Coverage increased (+0.06%) to 97.971% Details	`2749c88`

-    -      throw new Error("You must specify an express router to attach.");
+    +    if (options.expressApp && options.router) {
+    +      console.warn("Since alexa-app@4.0.0, you are no longer required to pass both 'expressApp' and 'router'.");
+    +      console.warn("When both passed, 'alexa-app' would be attached to 'expressApp' instance.");

@@ -566,8 +566,7 @@ alexa.app = function(name) {
          }
          if (options.expressApp && options.router) {
-    -      console.warn("Since alexa-app@4.0.0, you are no longer required to pass both 'expressApp' and 'router'.");
-    -      console.warn("When both passed, 'alexa-app' would be attached to 'expressApp' instance.");
+    +      console.warn("Both 'expressApp' and 'router' are specified, attaching to 'expressApp' only.\nMore details on https://github.com/alexa-js/alexa-app/blob/master/UPGRADING.md");

alexa-js/alexa-app

adding flexibility for attaching alexa-app to express #177

bgjehu commented Feb 13, 2017

bgjehu and others added some commits Feb 13, 2017

bgjehu referenced this pull request Feb 13, 2017

add flexibility for attaching alexa-app to express #176

dblock approved these changes Feb 14, 2017 View changes

dblock commented Feb 14, 2017

tejashah88 referenced this pull request Feb 14, 2017

Added utilities #180

tejashah88 commented Feb 14, 2017 • edited

tejashah88 and others added some commits Feb 14, 2017

bgjehu commented Feb 14, 2017

tejashah88 reviewed Feb 14, 2017 View changes

bgjehu commented Feb 15, 2017 • edited

dblock commented Feb 15, 2017

bgjehu commented Feb 15, 2017

tejashah88 approved these changes Feb 15, 2017 View changes

tejashah88 reviewed Feb 15, 2017 View changes

bgjehu reviewed Feb 15, 2017 View changes

dblock reviewed Feb 15, 2017 View changes

dblock reviewed Feb 15, 2017 View changes

dblock reviewed Feb 15, 2017 View changes

dblock reviewed Feb 15, 2017 View changes

dblock commented Feb 15, 2017

bgjehu commented Feb 16, 2017

dblock commented Feb 16, 2017

dblock merged commit `b30997f` into alexa-js:master Feb 16, 2017
2 checks passed

2 checks passed

dblock commented Feb 16, 2017

bgjehu commented Feb 16, 2017

dblock commented Feb 16, 2017 • edited

bgjehu commented Feb 17, 2017

tejashah88 commented Feb 17, 2017 • edited

tejashah88 commented Feb 17, 2017

dblock commented Feb 17, 2017

dblock referenced this pull request Feb 17, 2017

The next version will be 3.2.0. #186

		@@ -0,0 +1,83 @@
		+/jshint expr: true/

alexa-js/alexa-app

adding flexibility for attaching alexa-app to express #177

Conversation

bgjehu commented Feb 13, 2017

bgjehu and others added some commits Feb 13, 2017

All checks have failed

Some checks were not successful

Some checks were not successful

Some checks were not successful

Some checks were not successful

bgjehu referenced this pull request Feb 13, 2017

dblock approved these changes Feb 14, 2017 View changes

dblock commented Feb 14, 2017

tejashah88 referenced this pull request Feb 14, 2017

tejashah88 commented Feb 14, 2017 • edited

tejashah88 and others added some commits Feb 14, 2017

All checks have passed

All checks have passed

bgjehu commented Feb 14, 2017

tejashah88 reviewed Feb 14, 2017 View changes

All checks have passed

bgjehu commented Feb 15, 2017 • edited

All checks have passed

dblock commented Feb 15, 2017

bgjehu commented Feb 15, 2017

tejashah88 approved these changes Feb 15, 2017 View changes

All checks have passed

tejashah88 reviewed Feb 15, 2017 View changes

All checks have passed

bgjehu reviewed Feb 15, 2017 View changes

dblock reviewed Feb 15, 2017 View changes

dblock reviewed Feb 15, 2017 View changes

dblock reviewed Feb 15, 2017 View changes

dblock reviewed Feb 15, 2017 View changes

dblock commented Feb 15, 2017

All checks have passed

bgjehu commented Feb 16, 2017

dblock commented Feb 16, 2017

Hide details View details dblock merged commit b30997f into alexa-js:master Feb 16, 2017 2 checks passed

2 checks passed

dblock commented Feb 16, 2017

bgjehu commented Feb 16, 2017

dblock commented Feb 16, 2017 • edited

bgjehu commented Feb 17, 2017

tejashah88 commented Feb 17, 2017 • edited

tejashah88 commented Feb 17, 2017

dblock commented Feb 17, 2017

dblock referenced this pull request Feb 17, 2017

dblock merged commit `b30997f` into alexa-js:master Feb 16, 2017
2 checks passed