Fix for #68, added utility functions, more descriptive error messages #71

tejashah88 · 2017-02-05T20:44:52Z

No description provided.

dblock · 2017-02-05T22:34:49Z

First, we should make a hard rule not to take this kind of stuff without tests. If it helps, you can add a root property and test the output.

Secondly, manipulating paths this way is potentially error prone - path.normalize seems to be designed exactly for this purpose, so why not use it?

dblock · 2017-02-05T22:35:13Z

package.json

-    "mocha": "^2.3.4",
-    "chai": "^3.4.1",
-    "supertest": "^2.0.1",
+    "mocha": "^3.2.0",


I previously downgraded some dependencies here to make things work with older versions of node. Surpried this works.

mreinstein · 2017-02-06T07:13:03Z

use a module for this. Do not write custom code to deal with pathing, separators, etc.

dblock · 2017-02-06T11:17:41Z

This can go in the next release, no rush.

dblock · 2017-02-06T19:17:38Z

I realize this is used for cosmetic display purposes only, so I think we can live without tests for it. I still believe these urls should be combined with something like https://www.npmjs.com/package/url-join.

I fixed the places where we combine paths with + in #72.

tejashah88 · 2017-02-06T20:15:10Z

I was actually going to change the intent of the PR. Right now, we have a bunch of repetitive code, specifically with loading the modules and other files, and I was thinking that it'd make more sense to make a small utils file that contains any/all helper functions. I'll update the PR in a couple of hours.

dblock · 2017-02-06T20:21:11Z

If you don't mind looking/merging #72 first before it becomes a big conflict ...

…etter error messages

dblock · 2017-02-07T12:44:39Z

index.js

@@ -26,13 +26,13 @@ var appServer = function(config) {
    app_dir: 'apps'
  };

-  self.config = defaults(config, defaultOptions);
+  self.config = utils.defaults(config, defaultOptions);


This is a wrapper for a require, seems unnecessary as it provides no additional value.

I just moved defaults in utils.js since it is technically a 'utility' function. I can move it back though.

dblock · 2017-02-07T12:47:32Z

index.js

      if (!pkg || !pkg.main || !pkg.name) {
        self.error("   failed to load " + package_json);
        return;
      }

-      var main = fs.realpathSync(path.join(app_dir, dir, pkg.main));
-      if (!fs.existsSync(main) || !fs.statSync(main).isFile()) {
+      var main = path.join(__dirname, app_dir, dir, pkg.main);


This inserts __dirname, which is a change in behavior from a previous version. At the very least it needs to be documented in both README and UPGRADING.

Yea, I did do some testing and it is kind of a breaking change. I'll open a new issue in the meantime.

dblock · 2017-02-07T12:47:43Z

index.js

      });
    };
    server_files(server_dir).forEach(function(file) {
-      file = fs.realpathSync(path.join(server_dir, file));
+      file = path.join(__dirname, server_dir, file);


Same as above with __dirname.

dblock · 2017-02-07T12:48:09Z

index.js

-          var privateKey = fs.readFileSync(privateKeyFile, 'utf8');
-          var certificate = fs.readFileSync(certificateFile, 'utf8');
+        if (utils.isValidFile(privateKeyFile) && utils.isValidFile(certificateFile)) {
+          var privateKey = utils.readFile(privateKeyFile, 'utf8');


readFile doesn't take two parameters, the utf8 is implied.

Good catch. Thanks!

dblock · 2017-02-07T12:49:04Z

package.json

@@ -20,21 +20,23 @@
  "license": "MIT",
  "dependencies": {
    "alexa-app": "^3.0.0",
-    "alexa-verifier-middleware": "^0.1.8",
+    "alexa-verifier-middleware": "^0.1.9",


I don't think this is a required change, the library works fine with 0.1.8, doesn't it?

Actually, since alexa-app already uses alexa-verifier-middleware already, it will probably be removed.

dblock · 2017-02-07T12:50:55Z

package.json

    "bluebird": "^3.4.7",
    "body-parser": "~1.16.0",
    "ejs": "~2.5.5",
    "express": "~4.14.1",
    "hotswap": "^1.1.0",
-    "lodash.defaults": "^4.2.0"
+    "lodash.defaults": "^4.2.0",
+    "lodash.endswith": "^4.2.1",


These aren't used, posix. is better.

Good catch. Thanks!

dblock · 2017-02-07T12:52:15Z

test/test-utils.js

+var utils = require("../utils");
+
+describe("Utilities testing", function() {
+  it("checks the integrity of the utilities", function() {


IMO this isn't a useful test. The actual calls matter, while the fact that these functions are declared seems superfluous.

dblock · 2017-02-07T12:52:58Z

test/test-utils.js

+chai.config.includeStack = true;
+var utils = require("../utils");
+
+describe("Utilities testing", function() {


In BDD you describe what "things are" and "how they behave", instead of what you're doing. So this should just be Utils.

dblock · 2017-02-07T12:53:19Z

test/test-utils.js

+    ]);
+  });
+
+  describe("File verification tests", function() {


isValidFile

Do you mean that it should be describe("isValidFile", function() {?

Yes, because it describes the functionality of that function. If you want to be fancy you can add a period in front of it :) Some people do #isValidFile or .isValidFile

dblock · 2017-02-07T12:56:29Z

utils.js

+
+var defaults = require("lodash.defaults");
+
+// Utility functions


The comment here isn't helpful. It's pretty clear that utils declares utility functions. However you can document each individual function if you want.

dblock · 2017-02-08T12:21:44Z

RELEASING.md

@@ -27,13 +27,13 @@ Modify the "Stable Release" section in [README.md](README.md). Change the text t
 ```
 ## Stable Release

-You're reading the documentation for the stable release of alexa-app-server, 2.4.0.
+You're reading the documentation for the stable release of alexa-app-server, 3.0.1.


Since these are examples I never change them, but no big deal.

dblock · 2017-02-08T12:26:09Z

CHANGELOG.md

@@ -2,6 +2,7 @@

 ### 3.0.1 (Next)

+* [#71](https://github.com/alexa-js/alexa-app-server/pull/71): Fixed [#68](https://github.com/alexa-js/alexa-app-server/issues/68), added utility functions, more descriptive error messages - [@tejashah88](https://github.com/tejashah88).


What's important in changelog is to describe the actual fix to be helpful for the person reading it. So for example:

* [#71](https://github.com/alexa-js/alexa-app-server/pull/71), [#68](https://github.com/alexa-js/alexa-app-server/issues/68): Fixed log output containing multiple slashes - [@tejashah88](https://github.com/tejashah88).

dblock · 2017-02-08T12:30:04Z

Merged via 2be0f02.

Fix #68: Deal with multiple slashes in normalizedRoot

d207c0f

tejashah88 requested a review from dblock February 5, 2017 20:44

tejashah88 mentioned this pull request Feb 5, 2017

Deal with multiple slashes in normalizedRoot #68

Closed

added some lodash functions to keep compatibility with nodejs v0.12

da41623

dblock reviewed Feb 5, 2017

View reviewed changes

tejashah88 added 2 commits February 6, 2017 23:13

separated comonly used functions into utils.js + testing utilities, b…

e8a8285

…etter error messages

Merge branch 'master' into master

f05471c

tejashah88 changed the title ~~Fix #68: Deal with multiple slashes in normalizedRoot~~ Fix #68: Deal with multiple slashes in normalizedRoot, added utility functions Feb 7, 2017

tejashah88 changed the title ~~Fix #68: Deal with multiple slashes in normalizedRoot, added utility functions~~ Fix for #68, added utility functions, more descriptive error messages Feb 7, 2017

dblock requested changes Feb 7, 2017

View reviewed changes

tejashah88 added 3 commits February 7, 2017 21:52

minor fixes

0957761

Merge remote-tracking branch 'upstream/master'

6572ca6

tweaked RELEASING and UPGRADING, added to CHANGELOG

39baf0c

dblock approved these changes Feb 8, 2017

View reviewed changes

dblock closed this Feb 8, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix for #68, added utility functions, more descriptive error messages #71

Fix for #68, added utility functions, more descriptive error messages #71

tejashah88 commented Feb 5, 2017

dblock commented Feb 5, 2017

dblock Feb 5, 2017 •

edited

Loading

mreinstein commented Feb 6, 2017

dblock commented Feb 6, 2017

dblock commented Feb 6, 2017

tejashah88 commented Feb 6, 2017

dblock commented Feb 6, 2017

dblock Feb 7, 2017

tejashah88 Feb 7, 2017

dblock Feb 7, 2017

tejashah88 Feb 8, 2017

dblock Feb 7, 2017

dblock Feb 7, 2017

tejashah88 Feb 7, 2017

dblock Feb 7, 2017

tejashah88 Feb 8, 2017

dblock Feb 7, 2017

tejashah88 Feb 7, 2017

dblock Feb 7, 2017

dblock Feb 7, 2017 •

edited

Loading

dblock Feb 7, 2017

tejashah88 Feb 8, 2017

dblock Feb 8, 2017

dblock Feb 7, 2017

dblock Feb 8, 2017

dblock Feb 8, 2017

dblock commented Feb 8, 2017


		var defaults = require("lodash.defaults");

		// Utility functions

		@@ -2,6 +2,7 @@

		### 3.0.1 (Next)

		* [#71](https://github.com/alexa-js/alexa-app-server/pull/71): Fixed [#68](https://github.com/alexa-js/alexa-app-server/issues/68), added utility functions, more descriptive error messages - [@tejashah88](https://github.com/tejashah88).

Fix for #68, added utility functions, more descriptive error messages #71

Fix for #68, added utility functions, more descriptive error messages #71

Conversation

tejashah88 commented Feb 5, 2017

dblock commented Feb 5, 2017

dblock Feb 5, 2017 • edited Loading

Choose a reason for hiding this comment

mreinstein commented Feb 6, 2017

dblock commented Feb 6, 2017

dblock commented Feb 6, 2017

tejashah88 commented Feb 6, 2017

dblock commented Feb 6, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dblock Feb 7, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dblock commented Feb 8, 2017

dblock Feb 5, 2017 •

edited

Loading

dblock Feb 7, 2017 •

edited

Loading