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.

Sign up for GitHub

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

fix(server): use regex instead of isAbsoluteUrl #2202

Merged
merged 11 commits into from
Aug 22, 2019
Merged

fix(server): use regex instead of isAbsoluteUrl #2202

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f381ccb
fix(server): use regex instead of isAbsoluteUrl
EslamHiko Aug 16, 2019
fded1d8
fix(server): add checkUrl util & unistall is-absolute-url
EslamHiko Aug 16, 2019
8a827e8
test(server): add tests only
EslamHiko Aug 21, 2019
bf74632
Merge branch 'master' into use-regex-instead-of-is-absolute-url
EslamHiko Aug 21, 2019
cdb65ed
test(server): add more test cases
EslamHiko Aug 21, 2019
5234a39
test(server): add more test cases
EslamHiko Aug 21, 2019
c972787
test: correct tests' values
EslamHiko Aug 21, 2019
1396a98
test: use different port
EslamHiko Aug 21, 2019
75630c5
test: use port variable
EslamHiko Aug 21, 2019
4a6fea4
test: fix lint issue
EslamHiko Aug 21, 2019
b415ede
test: use testServer.start without promises
EslamHiko Aug 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/Server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ class Server {
throw new Error('Watching remote files is not supported.');
} else if (Array.isArray(contentBase)) {
contentBase.forEach((item) => {
if (isAbsoluteUrl(String(item))) {
if (isAbsoluteUrl(String(item)) || typeof item === 'number') {
Copy link
Member

Choose a reason for hiding this comment

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

Why we add typeof item === 'number'?

Copy link
Member Author

Choose a reason for hiding this comment

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

@evilebottnawi it's already blocking number values in options.js accepting only strings, in case in future refactors if we change the type of array items to accept any type we still need it to throw an exception if the array item is number type.

Copy link
Member Author

@EslamHiko EslamHiko Aug 22, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

@evilebottnawi we can remove number type from options.json

  "contentBase": {
      "anyOf": [
        {
          "enum": [false]
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          },
          "minItems": 1
        }
      ]
    },

and remove || typeof item === 'number' checks and update tests to check for the exception "should be {String|Array} (https://webpack.js.org/configuration/dev-server/#devservercontentbase)" in number type cases
what do you think ?

Copy link
Member

Choose a reason for hiding this comment

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

Let's do it next version

throw new Error('Watching remote files is not supported.');
}
this._watch(item);
Expand Down
2 changes: 1 addition & 1 deletion lib/utils/runOpen.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function runOpen(uri, options, log) {
}

const pageUrl =
options.openPage && isAbsoluteUrl(options.openPage)
options.openPage && isAbsoluteUrl(String(options.openPage))
Copy link
Member

Choose a reason for hiding this comment

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

No need this here, if you have problem place let's solve this in other PR

? options.openPage
: `${uri}${options.openPage || ''}`;

Expand Down
25 changes: 24 additions & 1 deletion test/server/contentBase-option.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ describe('contentBase option', () => {
});

describe('testing single & multiple external paths', () => {
afterAll((done) => {
afterEach((done) => {
testServer.close(() => {
done();
});
Expand Down Expand Up @@ -301,6 +301,29 @@ describe('contentBase option', () => {
done();
}
});
it('Should not throw exception (local path with lower case first character)', (done) => {
try {
// eslint-disable-next-line no-unused-vars
server = new Promise((resolve, reject) => {
testServer.start(config, {
contentBase:
Copy link
Member

Choose a reason for hiding this comment

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

Let's add two tests here c:\absolute\path\to\content-base and C:\absolute\path\to\content-base

contentBasePublic.charAt(0).toLowerCase() +
contentBasePublic.substring(1),
watchContentBase: true,
port: 2222,
Copy link
Member

Choose a reason for hiding this comment

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

Don't use the port number directly.

Copy link
Member Author

Choose a reason for hiding this comment

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

if I use port it'll cause listen EADDRINUSE: address already in use 127.0.0.1:8107 error and cause the tests to hang, can I use port+1,port+2 or add new values in ports-map ?

Copy link
Member

@hiroppy hiroppy Aug 21, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Don't add the port number.

diff --git a/test/server/contentBase-option.test.js b/test/server/contentBase-option.test.js
index fe120e5..bcde1e6 100644
--- a/test/server/contentBase-option.test.js
+++ b/test/server/contentBase-option.test.js
@@ -269,10 +269,10 @@ describe('contentBase option', () => {
 
   describe('testing single & multiple external paths', () => {
     afterEach((done) => {
-      testServer.close(() => {
-        done();
-      });
+      testServer.close(done);
     });
+
     it('Should throw exception (string)', (done) => {
       try {
         // eslint-disable-next-line no-unused-vars
@@ -302,71 +302,40 @@ describe('contentBase option', () => {
       }
     });
     it('Should not throw exception (local path with lower case first character)', (done) => {
-      try {
-        // eslint-disable-next-line no-unused-vars
-        server = new Promise((resolve, reject) => {
-          testServer.start(config, {
-            contentBase:
-              contentBasePublic.charAt(0).toLowerCase() +
-              contentBasePublic.substring(1),
-            watchContentBase: true,
-            port: 2222,
-          });
-          resolve(testServer);
-        });
-
-        server.then((testServer) => {
-          testServer.close(() => {
-            done();
-          });
-        });
-      } catch (e) {
-        expect(true).toBe(false);
-      }
+      testServer.start(
+        config,
+        {
+          contentBase:
+            contentBasePublic.charAt(0).toLowerCase() +
+            contentBasePublic.substring(1),
+          watchContentBase: true,
+          port,
+        },
+        done
+      );
     });
     it("Should not throw exception (local path with lower case first character & has '-')", (done) => {
-      try {
-        // eslint-disable-next-line no-unused-vars
-        server = new Promise((resolve, reject) => {
-          testServer.start(config, {
-            contentBase: 'c:\\absolute\\path\\to\\content-base',
-            watchContentBase: true,
-            port: 2223,
-          });
-          resolve(testServer);
-        });
-
-        server.then((testServer) => {
-          testServer.close(() => {
-            done();
-          });
-        });
-      } catch (e) {
-        expect(true).toBe(false);
-      }
+      testServer.start(
+        config,
+        {
+          contentBase: 'c:\\absolute\\path\\to\\content-base',
+          watchContentBase: true,
+          port,
+        },
+        done
+      );
     });
     it("Should not throw exception (local path with upper case first character & has '-')", (done) => {
-      try {
-        // eslint-disable-next-line no-unused-vars
-        server = new Promise((resolve, reject) => {
-          testServer.start(config, {
-            contentBase: 'C:\\absolute\\path\\to\\content-base',
-            watchContentBase: true,
-            port: 2224,
-          });
-          resolve(testServer);
-        });
-
-        server.then((testServer) => {
-          testServer.close(() => {
-            done();
-          });
-        });
-      } catch (e) {
-        expect(true).toBe(false);
-      }
+      testServer.start(
+        config,
+        {
+          contentBase: 'C:\\absolute\\path\\to\\content-base',
+          watchContentBase: true,
+          port,
+        },
+        done
+      );
     });
-
     it('Should throw exception (array)', (done) => {
       try {
         // eslint-disable-next-line no-unused-vars

You can patch this code.

});
resolve(testServer);
});

server.then((testServer) => {
testServer.close(() => {
done();
});
});
} catch (e) {
expect(true).toBe(false);
}
});
it('Should throw exception (array)', (done) => {
try {
// eslint-disable-next-line no-unused-vars
Expand Down