Merge pull request #11 from astrohelm/dev

Isolation v2.1.0

Author: shuritch

CHANGELOG.md

@@ -2,9 +2,16 @@
 
 ## [Unreleased][unreleased]
 
+## [2.1.0][] - 2024-01-13 / 2024-03-18
+
+- Updated packages
+- Grammar fixes
+- Contextify micro task mode fixed
+- New timeout test case
+
 ## [2.0.0][] - 2023-12-12
 
-- Majure release
+- Major release
 - Stable API
 - Documentation enhancement
 - Renamed access property for realm
@@ -62,7 +69,7 @@
 ## [1.3.0][] - 2023-10-26
 
 - Renamed from isolation -> isolation
-- Inhanced documentation
+- Enhanced documentation
 
 ## [1.2.0][] - 2023-10-25
 
@@ -86,17 +93,17 @@
      isolation.require.script('./my-path/to/script.js');
      isolation.require.dir('./my-path/to');
      ```
-  2. New access controll feature, see access updates
+  2. New access control feature, see access updates
 - Access updates, now this option work for both sandbox and reader, you need to provide function
   ```js
   const option = { access: pathOrModule => pathOrModule === 'fs' || pathOrModule.endsWith('.js') };
   isolation.execute('module.exports = require("fs")');
   isolation.read('./path/to/script.js');
-  // But you still can controll them by each own function
+  // But you still can control them by each own function
   const option = {
     access: {
-      internal: path => true, // Reader controll
-      sandbox: module => {}, // Sandbox require controll
+      internal: path => true, // Reader control
+      sandbox: module => {}, // Sandbox require control
     },
   };
   ```
@@ -127,7 +134,8 @@
 - Quality of life improvements
 - Massive README update, documentation improvement
 
-[unreleased]: https://github.com/astrohelm/isolation/compare/v2.0.0...HEAD
+[unreleased]: https://github.com/astrohelm/isolation/compare/v2.1.0...HEAD
+[2.1.0]: https://github.com/astrohelm/isolation/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/astrohelm/isolation/compare/v1.0.0...v2.0.0
 [1.9.0]: https://github.com/astrohelm/isolation/compare/v1.8.0...v1.9.0
 [1.8.0]: https://github.com/astrohelm/isolation/compare/v1.7.0...v1.8.0

README.md

@@ -10,7 +10,7 @@ issues. Also, isolation prevents global scope and prototypes pollution.
 
 > [!TIP]
 >
-> ## **Possible usecase**
+> ## **Possible use case**
 >
 > May be useful as routing loader, if some loaded route makes an error while runtime, you may
 > recreate it - to prevent memory leaks. Another worlds, with this library you can create
@@ -149,7 +149,7 @@ provide your custom variables to the context without requiring any module.
 
 > [!TIP]
 >
-> Remember to reuse your contexts. This will encrease performance of your application. To help you
+> Remember to reuse your contexts. This will increase performance of your application. To help you
 > with this we have default contexts:
 
 ### **Context example**
@@ -280,19 +280,19 @@ console.log(result); // Output: Isolation.js Works !
 
 </h2>
 
-| Option           | Possible                                       | Default                          | Description                                                                                          |
-| ---------------- | ---------------------------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| **type**         | iso&nbsp;\|&nbsp;cjs                           | cjs                              | Type&nbsp;of&nbsp;script&nbsp;handling, see [syntax types](#module-types)                            |
-| **ctx**          | object                                         | -                                | Realm&nbsp;context, see [Context API](#context-api)                                                  |
-| **filename**     | string                                         | ISO                              | Name&nbsp;of&nbsp;the&nbsp;module&nbsp;, also it is global variable **\_\_filename** for root realm  |
-| **dir**          | string                                         | process.cwd()                    | Module&nbsp;directory&nbsp;, also it is global varibale **\_\_dirname** and realm require startpoint |
-| **npmIsolation** | boolean                                        | false                            | Controls&nbsp;npm&nbsp;modules&nbsp;isolation                                                        |
-| **access**       | [Access](./types/options.d.ts#L51)             | -                                | Isolation&nbsp;restrictions, see [Access API](#reader-api)                                           |
-| **prepare**      | boolean                                        | false                            | Reader&nbsp;would'nt&nbsp;execute script for you                                                     |
-| **flat**         | boolean                                        | false                            | Reader&nbsp;will&nbsp;flat&nbsp;nested&nbsp;scripts                                                  |
-| **depth**        | boolean&nbsp;\|&nbsp;number                    | true                             | Restricts&nbsp;dir&nbsp;reading&nbsp;depth                                                           |
-| **script**       | [ScriptOptions](./types/options.d.ts#L63)      | -                                | Configuration&nbsp;for VM.Script initialization                                                      |
-| **run**          | [RunningCodeOptions](./types/options.d.ts#L62) | {&nbsp;timeout:&nbsp;1000&nbsp;} | Configuration&nbsp;for VM.Script execution                                                           |
+| Option           | Possible                                       | Default                          | Description                                                                                           |
+| ---------------- | ---------------------------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------- |
+| **type**         | iso&nbsp;\|&nbsp;cjs                           | cjs                              | Type&nbsp;of&nbsp;script&nbsp;handling, see [syntax types](#module-types)                             |
+| **ctx**          | object                                         | -                                | Realm&nbsp;context, see [Context API](#context-api)                                                   |
+| **filename**     | string                                         | ISO                              | Name&nbsp;of&nbsp;the&nbsp;module&nbsp;, also it is global variable **\_\_filename** for root realm   |
+| **dir**          | string                                         | process.cwd()                    | Module&nbsp;directory&nbsp;, also it is global variable **\_\_dirname** and realm require start point |
+| **npmIsolation** | boolean                                        | false                            | Controls&nbsp;npm&nbsp;modules&nbsp;isolation                                                         |
+| **access**       | [Access](./types/options.d.ts#L51)             | -                                | Isolation&nbsp;restrictions, see [Access API](#reader-api)                                            |
+| **prepare**      | boolean                                        | false                            | Reader&nbsp;would'nt&nbsp;execute script for you                                                      |
+| **flat**         | boolean                                        | false                            | Reader&nbsp;will&nbsp;flat&nbsp;nested&nbsp;scripts                                                   |
+| **depth**        | boolean&nbsp;\|&nbsp;number                    | true                             | Restricts&nbsp;dir&nbsp;reading&nbsp;depth                                                            |
+| **script**       | [ScriptOptions](./types/options.d.ts#L63)      | -                                | Configuration&nbsp;for VM.Script initialization                                                       |
+| **run**          | [RunningCodeOptions](./types/options.d.ts#L62) | {&nbsp;timeout:&nbsp;1000&nbsp;} | Configuration&nbsp;for VM.Script execution                                                            |
 
 <h2 align="center">Copyright & contributors</h2>
 

SECURITY.md

@@ -10,7 +10,7 @@ var contextify = module.exports = (ctx, mode = false) => {
   if (isContext(ctx)) return ctx;
   return createContext(ctx, {
     ...contextify.OPTIONS,
-    preventEscape: mode ? 'afterEvaluate' : '',
+    microtaskMode: mode ? 'afterEvaluate' : undefined,
   });
 };
 

lib/context/index.js

@@ -20,7 +20,7 @@ async function file(path, { prepare, ...estimated } = {}) {
 
 const JS_EXT = /^\.[cme]?js$/;
 const READ_OPTS = { withFileTypes: true };
-const futher = (max, depth) => max === true || (typeof max === 'number' && depth + 1 <= max);
+const further = (max, depth) => max === true || (typeof max === 'number' && depth + 1 <= max);
 function dir(src, options = {}) {
   const { depth: max = true, flat = false, access } = options;
   const isAllow = checkAccess.bind(null, 'reader', access);
@@ -32,7 +32,7 @@ function dir(src, options = {}) {
     const storage = flat ? scripts : {};
     await Promise.all(files.map(async f => {
       var isDir = f.isDirectory(), name = f.name, path = join(src, name);
-      if ((isDir && !futher(max, depth)) || !isAllow(path)) return;
+      if ((isDir && !further(max, depth)) || !isAllow(path)) return;
       if (isDir && flat) return void await pull(path, depth + 1);
       var ext = extname(name), key = base(name, ext.match(JS_EXT) ? ext : '');
       storage[key] = await (isDir ? pull(path, depth + 1) : file(path, options));