refactor: code

Author: alexander-akait

README.md

@@ -198,9 +198,9 @@ middleware(compiler, { outputFileSystem: myOutputFileSystem });
 `webpack-dev-middleware` also provides convenience methods that can be use to
 interact with the middleware at runtime:
 
-### `close(callback)`
+### `close(callback?)`
 
-Instructs a webpack-dev-middleware instance to stop watching for file changes.
+Instructs `webpack-dev-middleware` instance to stop watching for file changes.
 
 ### Parameters
 
@@ -210,14 +210,14 @@ Type: `Function`
 
 A function executed once the middleware has stopped watching.
 
-### `invalidate()`
+### `invalidate(callback?)`
 
 Instructs a webpack-dev-middleware instance to recompile the bundle.
 e.g. after a change to the configuration.
 
 ```js
 const webpack = require('webpack');
-const compiler = webpack({ ... });
+const compiler = webpack();
 const middleware = require('webpack-dev-middleware');
 const instance = middleware(compiler);
 
@@ -233,6 +233,14 @@ setTimeout(() => {
 }, 1000);
 ```
 
+### Parameters
+
+#### callback
+
+Type: `Function`
+
+A function executed once the middleware has invalidated.
+
 ### `waitUntilValid(callback)`
 
 Executes a callback function when the compiler bundle is valid, typically after
@@ -244,12 +252,12 @@ compilation.
 
 Type: `Function`
 
-A function executed when the bundle becomes valid. If the bundle is
-valid at the time of calling, the callback is executed immediately.
+A function executed when the bundle becomes valid.
+If the bundle is valid at the time of calling, the callback is executed immediately.
 
 ```js
 const webpack = require('webpack');
-const compiler = webpack({ ... });
+const compiler = webpack();
 const middleware = require('webpack-dev-middleware');
 const instance = middleware(compiler);
 
@@ -260,22 +268,23 @@ instance.waitUntilValid(() => {
 });
 ```
 
-### `getFilenameFromUrl(context, url)`
+### `getFilenameFromUrl(url)`
 
-Get filename from url.
+Get filename from URL.
 
 ```js
 const webpack = require('webpack');
-const compiler = webpack({ ... });
+const compiler = webpack();
 const middleware = require('webpack-dev-middleware');
 const instance = middleware(compiler);
 
 app.use(instance);
 
-const processRequest = (req, res) => {
-  const filename = instance.getFilenameFromUrl(instance.contex, req.url);
-  console.log(`filename is ${filename}`)
-}
+instance.waitUntilValid(() => {
+  const filename = instance.getFilenameFromUrl('/bundle.js');
+
+  console.log(`Filename is ${filename}`);
+});
 ```
 
 ## Known Issues

src/index.js

@@ -77,6 +77,8 @@ export default function wdm(compiler, options = {}) {
   const instance = middleware(context);
 
   // API
+  instance.getFilenameFromUrl = (url) => getFilenameFromUrl(context, url);
+
   instance.waitUntilValid = (callback = noop) => {
     ready(context, callback);
   };
@@ -93,7 +95,5 @@ export default function wdm(compiler, options = {}) {
 
   instance.context = context;
 
-  instance.getFilenameFromUrl = getFilenameFromUrl;
-
   return instance;
 }

src/utils/getFilenameFromUrl.js

@@ -12,17 +12,18 @@ export default function getFilenameFromUrl(context, url) {
   const { options } = context;
   const paths = getPaths(context);
 
-  let filename;
+  let foundFilename;
   let urlObject;
 
   try {
     // The `url` property of the `request` is contains only  `pathname`, `search` and `hash`
     urlObject = memoizedParse(url, false, true);
   } catch (_ignoreError) {
-    return filename;
+    return;
   }
 
   for (const { publicPath, outputPath } of paths) {
+    let filename;
     let publicPathObject;
 
     try {
@@ -62,6 +63,8 @@ export default function getFilenameFromUrl(context, url) {
       }
 
       if (fsStats.isFile()) {
+        foundFilename = filename;
+
         break;
       } else if (
         fsStats.isDirectory() &&
@@ -83,11 +86,13 @@ export default function getFilenameFromUrl(context, url) {
         }
 
         if (fsStats.isFile()) {
+          foundFilename = filename;
+
           break;
         }
       }
     }
   }
 
-  return filename;
+  return foundFilename;
 }

test/api.test.js

@@ -1,3 +1,5 @@
+import path from 'path';
+
 import express from 'express';
 import connect from 'connect';
 import webpack, { Stats } from 'webpack';
@@ -372,6 +374,56 @@ describe.each([
       });
     });
 
+    describe('getFilenameFromUrl method', () => {
+      beforeEach((done) => {
+        compiler = getCompiler(webpackConfig);
+
+        instance = middleware(compiler);
+
+        app = framework();
+        app.use(instance);
+
+        listen = app.listen((error) => {
+          if (error) {
+            return done(error);
+          }
+
+          return done();
+        });
+      });
+
+      afterEach((done) => {
+        if (instance.context.watching.closed) {
+          if (listen) {
+            listen.close(done);
+          } else {
+            done();
+          }
+
+          return;
+        }
+
+        instance.close(() => {
+          if (listen) {
+            listen.close(done);
+          } else {
+            done();
+          }
+        });
+      });
+
+      it('should work', (done) => {
+        instance.waitUntilValid(() => {
+          expect(instance.getFilenameFromUrl('/unknown.unknown')).toBeUndefined();
+          expect(instance.getFilenameFromUrl('/bundle.js')).toBe(
+            path.join(webpackConfig.output.path, '/bundle.js')
+          );
+
+          done();
+        });
+      });
+    });
+
     describe('close method', () => {
       beforeEach((done) => {
         compiler = getCompiler(webpackConfig);