awilix 5.0.1 → 6.0.0

package/README.md

@@ -53,7 +53,7 @@ written in [TypeScript](http://typescriptlang.org). **Make IoC great again!**
     - [`container.build()`](#containerbuild)
     - [`container.dispose()`](#containerdispose)
 - [Universal Module (Browser Support)](#universal-module-browser-support)
-- [Contributing](#contributing)
+  - [Contributing](#contributing)
 - [What's in a name?](#whats-in-a-name)
 - [Author](#author)
 
@@ -351,8 +351,12 @@ modes are available on `awilix.InjectionMode`
   ```
 
 - `InjectionMode.CLASSIC`: Parses the function/constructor parameters, and
-  matches them with registrations in the container. _Don't use this if you
-  minify your code!_
+  matches them with registrations in the container. `CLASSIC` mode has a 
+  slightly higher initialization cost as it has to parse the function/class 
+  to figure out the dependencies at the time of registration, however resolving 
+  them will be **much faster** than when using `PROXY`. _Don't use `CLASSIC` if 
+  you minify your code!_ We recommend using `CLASSIC` in Node and `PROXY` in 
+  environments where minification is needed.
 
   ```js
   class UserService {
@@ -363,7 +367,8 @@ modes are available on `awilix.InjectionMode`
   }
   ```
 
-  Additionally, if the class has a base class but does not report any dependencies, the base class dependencies are passed in.
+  Additionally, if the class has a base class but does not declare a constructor of its own, Awilix
+  simply invokes the base constructor with whatever dependencies it requires.
 
   ```js
   class Car {
@@ -373,9 +378,8 @@ modes are available on `awilix.InjectionMode`
   }
 
   class Porsche extends Car {
-    constructor() {
-      super(...arguments)
-      console.log(arguments[0]) // whatever "engine" is
+    vroom() {
+      console.log(this.engine) // whatever "engine" is
     }
   }
   ```
@@ -1064,7 +1068,8 @@ Args:
   pass the name through as-is. The 2nd parameter is a full module descriptor.
 - `opts.resolverOptions`: An `object` passed to the resolvers. Used to configure
   the lifetime, injection mode and more of the loaded modules.
-- `opts.esModules`: Loads modules using Node's native ES modules. This is only supported on Node 14.0+ and should only be used if you're using the [Native Node ES modules](https://nodejs.org/api/esm.html)
+- `opts.esModules`: Loads modules using Node's native ES modules. This is only 
+  supported on Node 14.0+ and should only be used if you're using the [Native Node ES modules](https://nodejs.org/api/esm.html)
 
 Example:
 
@@ -1337,16 +1342,9 @@ because they depend on Node-specific packages.
 - Safari >= 10
 - Internet Explorer is not supported
 
-# Contributing
+## Contributing
 
-Clone repo, run `npm install` to install all dependencies, run `npm run build` to create an initial build, and then
-`npm run test -- --watchAll` to start writing code.
-
-For code coverage, run `npm run cover`.
-
-If you submit a PR, please aim for 100% code coverage and no linting errors.
-Travis will fail if there are linting errors. Thank you for considering
-contributing. :)
+Please see our [contributing.md](./CONTRIBUTING.md)
 
 # What's in a name?
 

package/lib/awilix.browser.js

@@ -416,7 +416,7 @@ function createTokenizer(source) {
  * Determines if the given character is a whitespace character.
  *
  * @param  {string}  ch
- * @return {Boolean}
+ * @return {boolean}
  */
 function isWhiteSpace(ch) {
     switch (ch) {
@@ -430,7 +430,7 @@ function isWhiteSpace(ch) {
 /**
  * Determines if the specified character is a string quote.
  * @param  {string}  ch
- * @return {Boolean}
+ * @return {boolean}
  */
 function isStringQuote(ch) {
     switch (ch) {
@@ -494,7 +494,7 @@ function last(arr) {
  * Determines if the given function is a class.
  *
  * @param  {Function} fn
- * @return {Boolean}
+ * @return {boolean}
  */
 function isClass(fn) {
     /*tslint:disable-next-line*/
@@ -521,7 +521,7 @@ function isClass(fn) {
  * @param  {Any} val
  * Any value to check if it's a function.
  *
- * @return {Boolean}
+ * @return {boolean}
  * true if the value is a function, false otherwise.
  */
 function isFunction(val) {
@@ -585,8 +585,9 @@ var InjectionMode = {
  * @param {string} source
  * The source of a function to extract the parameter list from
  *
- * @return {Array<Parameter>}
- * Returns an array of parameters.
+ * @return {Array<Parameter> | null}
+ * Returns an array of parameters, or `null` if no
+ * constructor was found for a class.
  */
 function parseParameterList(source) {
     var _a = createTokenizer(source), _next = _a.next, done = _a.done;
@@ -597,6 +598,11 @@ function parseParameterList(source) {
         switch (t.type) {
             case 'class':
                 skipUntilConstructor();
+                // If we didn't find a constructor token, then we know that there
+                // are no dependencies in the defined class.
+                if (!isConstructorToken()) {
+                    return null;
+                }
                 // Next token is the constructor identifier.
                 nextToken();
                 break;
@@ -676,6 +682,7 @@ function parseParameterList(source) {
     }
     /**
      * Determines if the current token represents a constructor, and the next token after it is a paren
+     * @return {boolean}
      */
     function isConstructorToken() {
         return t.type === 'ident' && t.value === 'constructor';
@@ -893,7 +900,7 @@ function wrapWithLocals(container, locals) {
  */
 function createInjectorProxy(container, injector) {
     var locals = injector(container);
-    var allKeys = uniq(__spreadArray(__spreadArray([], Reflect.ownKeys(container.cradle)), Reflect.ownKeys(locals)));
+    var allKeys = uniq(__spreadArray(__spreadArray([], Reflect.ownKeys(container.cradle), true), Reflect.ownKeys(locals)));
     // TODO: Lots of duplication here from the container proxy.
     // Need to refactor.
     var proxy = new Proxy({}, {
@@ -1027,29 +1034,30 @@ function generateResolve(fn, dependencyParseTarget) {
 }
 /**
  * Parses the dependencies from the given function.
- * If it's a class and has an extends clause, and no reported dependencies, attempt to parse it's super constructor.
+ * If it's a class that extends another class, and it does
+ * not have a defined constructor, attempt to parse it's super constructor.
  */
 function parseDependencies(fn) {
     var result = parseParameterList(fn.toString());
-    if (result.length > 0) {
-        return result;
-    }
-    var parent = Object.getPrototypeOf(fn);
-    if (typeof parent === 'function' && parent !== Function.prototype) {
-        // Try to parse the parent
-        return parseDependencies(parent);
+    if (!result) {
+        // No defined constructor for a class, check if there is a parent
+        // we can parse.
+        var parent = Object.getPrototypeOf(fn);
+        if (typeof parent === 'function' && parent !== Function.prototype) {
+            // Try to parse the parent
+            return parseDependencies(parent);
+        }
+        return [];
     }
     return result;
 }
 
 /**
  * Family tree symbol.
- * @type {Symbol}
  */
 var FAMILY_TREE = Symbol('familyTree');
 /**
  * Roll Up Registrations symbol.
- * @type {Symbol}
  */
 var ROLL_UP_REGISTRATIONS = Symbol('rollUpRegistrations');
 /**
@@ -1061,7 +1069,7 @@ var ROLL_UP_REGISTRATIONS = Symbol('rollUpRegistrations');
  * @param {string} options.injectionMode
  * The mode used by the container to resolve dependencies. Defaults to 'Proxy'.
  *
- * @return {object}
+ * @return {AwilixContainer<T>}
  * The container.
  */
 function createContainer(options, parentContainer) {
@@ -1072,9 +1080,6 @@ function createContainer(options, parentContainer) {
     // an error occurs, we have something to present
     // to the poor developer who fucked up.
     var resolutionStack = [];
-    // For performance reasons, we store
-    // the rolled-up registrations when starting a resolve.
-    var computedRegistrations = null;
     // Internal registration store for this container.
     var registrations = {};
     /**
@@ -1088,7 +1093,7 @@ function createContainer(options, parentContainer) {
         /**
          * The `get` handler is invoked whenever a get-call for `container.cradle.*` is made.
          *
-         * @param  {object} target
+         * @param  {object} _target
          * The proxy target. Irrelevant.
          *
          * @param  {string} name
@@ -1097,14 +1102,14 @@ function createContainer(options, parentContainer) {
          * @return {*}
          * Whatever the resolve call returns.
          */
-        get: function (target, name) { return resolve(name); },
+        get: function (_target, name) { return resolve(name); },
         /**
          * Setting things on the cradle throws an error.
          *
          * @param  {object} target
          * @param  {string} name
          */
-        set: function (_target, name, value) {
+        set: function (_target, name) {
             throw new Error("Attempted setting property \"" + name + "\" on container cradle - this is not allowed.");
         },
         /**
@@ -1138,8 +1143,9 @@ function createContainer(options, parentContainer) {
             register: register,
             build: build,
             resolve: resolve,
-            has: has,
-            dispose: dispose
+            hasRegistration: hasRegistration,
+            dispose: dispose,
+            getRegistration: getRegistration
         },
         /* removed in browser build */
         // tslint:disable-next-line
@@ -1164,12 +1170,15 @@ function createContainer(options, parentContainer) {
     /**
      * Used by util.inspect (which is used by console.log).
      */
-    function inspect(depth, opts) {
+    function inspect() {
         return "[AwilixContainer (" + (parentContainer ? 'scoped, ' : '') + "registrations: " + Object.keys(container.registrations).length + ")]";
     }
     /**
      * Rolls up registrations from the family tree.
-     * This is cached until `bustCache` clears it.
+     *
+     * This can get pretty expensive. Only used when
+     * iterating the cradle proxy, which is not something
+     * that should be done in day-to-day use, mostly for debugging.
      *
      * @param {boolean} bustCache
      * Forces a recomputation.
@@ -1177,19 +1186,13 @@ function createContainer(options, parentContainer) {
      * @return {object}
      * The merged registrations object.
      */
-    function rollUpRegistrations(bustCache) {
-        if (bustCache === void 0) { bustCache = false; }
-        if (computedRegistrations && !bustCache) {
-            return computedRegistrations;
-        }
-        computedRegistrations = __assign(__assign({}, (parentContainer &&
-            parentContainer[ROLL_UP_REGISTRATIONS](bustCache))), registrations);
-        return computedRegistrations;
+    function rollUpRegistrations() {
+        return __assign(__assign({}, (parentContainer && parentContainer[ROLL_UP_REGISTRATIONS]())), registrations);
     }
     /**
      * Used for providing an iterator to the cradle.
      */
-    function registrationNamesIterator() {
+    function cradleIterator() {
         var registrations, _a, _b, _i, registrationName;
         return __generator(this, function (_c) {
             switch (_c.label) {
@@ -1228,14 +1231,12 @@ function createContainer(options, parentContainer) {
      */
     function register(arg1, arg2) {
         var obj = nameValueToObject(arg1, arg2);
-        var keys = __spreadArray(__spreadArray([], Object.keys(obj)), Object.getOwnPropertySymbols(obj));
+        var keys = __spreadArray(__spreadArray([], Object.keys(obj), true), Object.getOwnPropertySymbols(obj));
         for (var _i = 0, keys_1 = keys; _i < keys_1.length; _i++) {
             var key = keys_1[_i];
             var value = obj[key];
             registrations[key] = value;
         }
-        // Invalidates the computed registrations.
-        computedRegistrations = null;
         return container;
     }
     /**
@@ -1245,6 +1246,22 @@ function createContainer(options, parentContainer) {
     function inspectCradle() {
         return '[AwilixContainer.cradle]';
     }
+    /**
+     * Recursively gets a registration by name if it exists in the
+     * current container or any of its' parents.
+     *
+     * @param name {string | symbol} The registration name.
+     */
+    function getRegistration(name) {
+        var resolver = registrations[name];
+        if (resolver) {
+            return resolver;
+        }
+        if (parentContainer) {
+            return parentContainer.getRegistration(name);
+        }
+        return null;
+    }
     /**
      * Resolves the registration with the given name.
      *
@@ -1259,13 +1276,9 @@ function createContainer(options, parentContainer) {
      */
     function resolve(name, resolveOpts) {
         resolveOpts = resolveOpts || {};
-        if (!resolutionStack.length) {
-            // Root resolve busts the registration cache.
-            rollUpRegistrations(true);
-        }
         try {
             // Grab the registration by name.
-            var resolver = computedRegistrations[name];
+            var resolver = getRegistration(name);
             if (resolutionStack.indexOf(name) > -1) {
                 throw new AwilixResolutionError(name, resolutionStack, 'Cyclic dependencies detected.');
             }
@@ -1278,20 +1291,20 @@ function createContainer(options, parentContainer) {
                 return createContainer;
             }
             if (!resolver) {
-                // The following checks ensure that console.log on the cradle does not
-                // throw an error (issue #7).
-                if (name === 'inspect') {
-                    return inspectCradle;
-                }
-                // Edge case: Promise unwrapping will look for a "then" property and attempt to call it.
-                // Return undefined so that we won't cause a resolution error. (issue #109)
-                if (name === 'then') {
-                    return undefined;
-                }
-                // When using `Array.from` or spreading the cradle, this will
-                // return the registration names.
-                if (name === Symbol.iterator) {
-                    return registrationNamesIterator;
+                // Checks for some edge cases.
+                switch (name) {
+                    // The following checks ensure that console.log on the cradle does not
+                    // throw an error (issue #7).
+                    case 'inspect':
+                        return inspectCradle;
+                    // Edge case: Promise unwrapping will look for a "then" property and attempt to call it.
+                    // Return undefined so that we won't cause a resolution error. (issue #109)
+                    case 'then':
+                        return undefined;
+                    // When using `Array.from` or spreading the cradle, this will
+                    // return the registration names.
+                    case Symbol.iterator:
+                        return cradleIterator;
                 }
                 if (resolveOpts.allowUnregistered) {
                     return undefined;
@@ -1356,8 +1369,8 @@ function createContainer(options, parentContainer) {
      * @return {boolean}
      * Whether or not the registration exists.
      */
-    function has(name) {
-        return name in rollUpRegistrations();
+    function hasRegistration(name) {
+        return !!getRegistration(name);
     }
     /**
      * Given a registration, class or function, builds it up and returns it.