isolate_manager 6.0.0-rc.25+1

isolate_manager: ^6.0.0-rc.25+1 copied to clipboard

• Add isolate_manager_generator to dev dependencies in the example.

• BREAKING CHANGE:
  • The isolate_manager_generator MUST be added to dev_dependencies to use dart run isolate_manager:generate.
  • Remove all deprecated methods.
• Return non-zero exit code when errors occur during the dart run isolate_manager:generate execution for better error handling in CI/CD pipelines.

• Improve README.

• Rename the QueueStrategys:
  • QueueStrategyUnlimited → UnlimitedStrategy
  • QueueStrategyRemoveNewest → DropNewestStrategy
  • QueueStrategyRemoveOldest → DropOldestStrategy
  • QueueStrategyDiscardIncoming → RejectIncomingStrategy
• Cleanup code.
• Remove .vscode.

• Improve README.

• Update wrap methods to throw UnsupportedImTypeException when wrapping nullable types in ImType, ImList, and ImMap.
• Update tests.
• Improve README.

• The shared worker now only accept the basename of the workerName to compatible with the new generator (since v0.0.6).
• Reorganize test file structures.
• BREADKING CHANGE: Recompile test workers.
• Simplify test flow.

• Add, replace and deprecate the old methods:
  • ImMap.toUnwrappedMap -> ImMap.toDecodedMap
  • ImList.toUnwrappedIterable -> ImList.toDecodedIterable
  • ImList.toUnwrappedList -> ImList.toDecodedList
• Update tests.

• BREAKING CHANGE Replace UnimplementedError with UnsupportedImTypeException in ImType wrapper methods.
• Improve worker function handling to avoid unnecessary wrapping when the worker is not available.
• Add toString() method to ImType subclasses for improved debugging.
• Able to throw and catch UnsupportedImTypeException correctly across io, js and wasm.
• Able to register the custom exceptions (extends IsolateException) that can be safely transferred between isolates.
• Update benchmark for WASM and update the result.
• Improve README.

• Replace IsolateTypes with ImTypes and mark the old ones as deprecated.

• BREAKING CHANGE Refactor ImType to prevent nullable values.

• Replace encode with wrap and decode with unwrap in IsolateType handling across and mark the old ones as deprecated.

• Add some useful methods:

  • ImList: toIterable, toList, toDecodedIterable and toDecodedList.
  • ImMap: toMap and toDecodedMap.

• Improve error handling when sending exception from Worker to main.

• Improve the ImType equality and hash code implementations to replace Equatable.

• Add a converter helper to ensure proper type handling for int, Iterable<int>, Set<int> and List<int> when compiling to WASM.

• Update tests and README.

• Able to run tests on WASM via dart test --platform=chrome --compiler dart2wasm.

• Update the workflows to run test on WASM.

• Fixes an issue in the shared isolate manager that useWorker is true but there is no workerName provided.

• Add new onInit callback to replace onInitial and make it as deprecated.

• Mark initialParameter in the IsolateManager.createCustom as deprecated:

  Before:

  void customIsolateFunction(dynamic params) {
    IsolateManangerFunction.customFunction(
      params,
      onInitial: (controller, initialParams) {
        // Do something here with the `initialParams`.
      },
    );
  }
  
  final isolate = IsolateManager.createCustom<R, P>(
    customIsolateFunction,
    initialParams: 'initialParams',
  );
  

  Now:

  void customIsolateFunction(dynamic params) {
    IsolateManangerFunction.customFunction(
      params,
      onInit: (controller) {
        // Do something here with your own `initialParams` value.
      },
    );
  }
  
  final isolate = IsolateManager.createCustom<R, P>(
    customIsolateFunction,
  );
  

• Improve tests.

• Update README.

• Add runCustomFunction method to support custom isolate execution with optional callback and debug logging
• The workerName now gets the latest mapping value dynamically, avoid the need to recreate the IsolateManager after updates.
• Refactored the codebase to remove redundant streams.
• Rename CustomIsolateFunction to IsolateCustomFunction, update references and mark the old one as deprecated.
• Improve README.

• Refactored multiple components to improve performance.
• Rewrote benchmarks, regenerated JS worker for benchmarks, and updated benchmark results in README.
• Used assert to log messages, enhancing performance in release mode.
• Fixed several typos.

• Fix README typos.

• Add an IsolateManager.runFunction method that automatically applies the appropriate workerName when executing a function.

• Improve README.

• Add an IsolateManager.run method that follows Isolate.run but also supports Web Workers.
• Allow IsolateType to be declared as const.
• Refactor to simplify internal code.
• Strengthen tests.
• Improve the README.
• Improve the Benchmarks.

• Adjust the dependencies.

• Separate the generator into the isolate_manager_generator package.

• Fixed issue that causes subsequent tasks not to be processed after receiving an exception.

• Able to compute a nullable function with a nullable parameter use IsolateManagerShared.

• The IsolateType.encode is now accept the nullable values.

• Add IsolateType to use for function parameters and return types to ensure that type is supported when generating a Worker.
• Add test/bin/run.sh to generate and run all tests locally.
• Use native dartify and jstify to improve perfomances.

• Improve the generator to generate the worker mappings better.
• Update workflows to ensure backward compatibility.

• Correctly parse the dart native arguments (Fixes #36).
• [Experiment] Automatically generate the workerMappings by adding the --worker-mappings-experiment=lib/main.dart flag to the generator.
• The code coverage is now using dart test instead of flutter test so we can correctly test the code on both vm and chrome.
• Improve the performaces by improving the way to detect the IsolateState.
• Improve tests.

• Use very_good_analysis.
• Improve tests.

• Bump the web package to ^1.0.0.
• Bump the analyzer package to ^6.0.0.
• Update the benchmark result.

• BREAKING CHANGE All the JS files MUST BE recompiled by running dart run isolate_manager:generate.
• Improve the data transfer performances between the Worker and the main App by replacing the json with the Map when sending and receiving data.

Although all tests are passed, many things will be refactored before version 6.0.0 is fully released.

• Change the type of the Map from String to dynamic when converting by dartify.
• Add more tests for the Map.

• Able to create a Map function and use it as a Worker instead of using JSON.

• Set the max number of the queued computations.
• Control how a new computation is added and retrieved from the Queue.
• Compute a priority computation (promote a computation to the top of the Queue so it will be compute as soon as possible).

• Able to add options and flags directly into to Dart to Js Compiler.
• Able to print the debug logs for the dart to js compiler (only if the --debug flag is specified).

• Improve README.

• Improve README.

• Update the package web version to support a wider range (">=0.5.1 <2.0.0").

• Bump the web to v1.0.0.
• Update README.

• Stable now.

• Improve README.

• Add IsolateManagerShared to be able to compute the multiple Functions.

• Generate the shared Workers by using the @isolateManagerSharedWorker annotation.

• Able to generate a custom Worker from a customFunction by using the @isolateManagerCustomWorker annotation.

• Improve the README.

• Various improvements and optimizations.

• The generator:

  • The default dart run isolate_manager:generate command will generates both single and shared Workers.
  • Use dart run isolate_manager:generate --single to generate only the single functions (@isolateManagerWorker and @isolateManagerCustomWorker annotations).
  • Use dart run isolate_manager:generate_shared --shared to generate only the shared functions (@isolateManagerSharedWorker annotation).

• This is an rc version because the various improvements may affect some edge cases so I want to make sure it's fully backward-compatible

• Improve README.

• Avoid using static function for the log printer.

• Update the log printer to increase the performances.
• Update benchmark.

• Improve pub score.

• Update some comments and fix some TYPO.
• Rename from benchmarks to benchmark.

• Change the default generated js to level O4 (Default level when using flutter build web).
• Remove try catch to avoid unknown issues.
• Add more test cases and improve tests.
• Update the Worker base code.
• Update missed types.
• Update README.

• Re-organize the README.
• Update the description.

• Add --omit-implicit-checks flag when compiling to js to avoid type check issues.
• Add comments to the IsolateException.
• Update README.

• Bump sdk to ^3.3.0.
• Add a generator to generate the Web Worker by adding the IsolateManagerWorker and isolateManagerWorker annotations (See more in README).
• Implement the call method to the IsolateManager.
• Improve the IsolateManager.create behavior (use a new custom function).
• Improve the type of the customFunction and workerFunction.
• Remove autoInitialize parameter.
• Remove deprecated methods.
• Bring the isolate_contactor to this package to make it lighter and easier to maintain.
• BREAKING CHANGE: All isolate functions MUST be updated and all Workers MUST be recompiled. See the migration guide at the bottom of the README or at the changelog of the version 5.0.0-rc.1.

• Implement the call method.
• Able to generate to WASM with --wasm flag (But unusable right now).

• Fix issue with null initialParams in createCustom.
• Remove unused variable autoMarkAsInitialized and related code in the base.
• Update tests.

• Able to generate static functions (Classs.function => Class.function.js).
• Improve the generator (only generate the needed files to reduce time).
• Improve the generated logs.

• Add a generator to generate the Worker JS by adding the IsolateManagerWorker and isolateManagerWorker annotations.
• Update README.

• Update to improve the score.

• Update the CHANGELOG to show the migration guide.

• Export the IsolateState.
• Update the CHANGELOG to show the migration guide.

• Bring the isolate_contactor to this package and make it lighter and easier to maintain.
• Update the tests.
• Remove unneeded platforms in the example.

• Remove deprecated methods.
• Improve the IsolateManager.create behavior (use a new customFunction).
• Improve the type of the customFunction and workerFunction.

• Update README.
• Update homepage for beta version.

• Bump sdk to ^3.3.0.
• Remove autoInitialize parameter.
• Remove deprecated methods.
• MIGRATION: All isolate functions MUST be update and all Workers MUST be recompiled:
  • If you're using the IsolateManagerFunction.workerFunction, you need to re-generate the JS for the Web Worker (compile from Dart to JS). The IsolateManagerFunction.customFunction will be automatically applied.
  • If you're using the old method, you need to send a initialized signal from an Isolate and a Worker:

    • Custom function of an Isolate: add the controller.initialized(); to the end of the function.

      • Before:

        void customFunction(dynamic params) {
          final controller = IsolateManagerController(params);
          controller.onIsolateMessage.then((value){
            // ...
          });
        }
        

      • After:

        void customFunction(dynamic params) async {
          // Do something sync or async here
        
          final controller = IsolateManagerController(params); 
          controller.onIsolateMessage.then((value){
            // ...
          });
        
          controller.initialized(); // <--
        }
        

    • On the Web Worker: add jsSendMessage(IsolateState.initialized.toJson()); to the end of the main method.

      • Before:

        void main() {
          callbackToStream('onmessage', (MessageEvent e) {
            return js_util.getProperty(e, 'data');
          }).listen((message) {
            // ...
          });  
        }
        

      • After:

        void main() async {
          // Do something sync or async here
        
          callbackToStream('onmessage', (MessageEvent e) {
            return js_util.getProperty(e, 'data');
          }).listen((message) {
            // ...
          });
        
          jsSendMessage(IsolateState.initialized.toJson()); // <--
        }
        

• Export the IsolateState.

• Support WASM.
• Add benchmark tests.
• Deprecate the IsolateFunctionHelper in favor of the IsolateManagerFunction.
• Improve the IsolateManagerFunction.workerFunction.
• [Experiment and Optional] Able to send an initialized signal from the isolate to the main app to ensure that the isolate is ready to receive the messages from the main app. The Migration Steps:
  • Step 1:

    • If you're using the IsolateManagerFunction.workerFunction, you need to re-generate the JS for the Web Worker (compile from Dart to JS). The IsolateManagerFunction.customFunction will be automatically applied.

    • If you're using the old method, you need to send a initialized signal from an Isolate and a Worker:

      • Custom function of an Isolate: add the controller.initialized(); to the end of the function.

        • Before:

          void customFunction(dynamic params) {
            final controller = IsolateManagerController(params);
            controller.onIsolateMessage.then((value){
              // ...
            });
          }
          

        • After:

          void customFunction(dynamic params) async {
            // Do something sync or async here
          
            final controller = IsolateManagerController(params); 
            controller.onIsolateMessage.then((value){
              // ...
            });
          
            controller.initialized(); // <--
          }
          

      • On the Web Worker: add jsSendMessage(IsolateState.initialized.toJson()); to the end of the main method.

        • Before:

          void main() {
            callbackToStream('onmessage', (MessageEvent e) {
              return js_util.getProperty(e, 'data');
            }).listen((message) {
              // ...
            });  
          }
          

        • After:

          void main() async {
            // Do something sync or async here
          
            callbackToStream('onmessage', (MessageEvent e) {
              return js_util.getProperty(e, 'data');
            }).listen((message) {
              // ...
            });
          
            jsSendMessage(IsolateState.initialized.toJson()); // <--
          }
          

    • Step 2: Update the create and createCustom method:

      • Before:

      final isolate = await IsolateManager.create(
        function, 
        workerName: 'function',
      );
      

      • After:

      final isolate = await IsolateManager.create(
        function, 
        workerName: 'function',
        autoInitialize: false, // <--
      );
      

• Bump isolate_contacter to v4.1.0.
• Add a class IsolateFunctionHelper contains customFunction and workerFunction.
• Deprecate the createOwnIsolate in favor of the createCustom.
• Deprecate the isolateWorker in favor of the IsolateFunctionHelper.workerFunction.
• Improve README.

• Fixed the issue that causes the sendMessage to be unable to throw the Exception when the callback is set.
• Easier to create a Worker by using isolateWorker method (Detail in README).
• Remove unused methods of the IsolateManagerController.
• Improve README.
• Improve tests.
• Improve the code coverage.

• Improved README.

• Add fetchAndDecode example.
• Update README to fetchAndDecode.

• Add more complex examples (also for Worker).

• Add example for Worker.
• Update README.

• Update homepage URL.

• Add queuesLength to get the number of the current queuing elements.
• Add ensureStarted to able to wait for the start method to finish when you want to call the start method manually without await and wait for it later.
• Add isStarted to check if the start method is completed or not.

• Add callback parameter to compute method to fully control the final result (Useful when you need to send something like the progress value before sending the final result in the same compute).
• Mark isolateManager.onMessage as deprecated.
• Add example that uses callback parameter to build a progress bar before getting the final result.

• Add sendResultError to IsolateManagerController to make it easier to send the Exception from the Isolate to main app.
• IsolateException parameters are now Object and StackTrace.
• Add parameter type as P and change return type to R.
• Add return type as void to onDispose method.
• Change isolateParams from dynamic to Object?.
• Update tests.
• Update example.

• [Fixes]: The compute method will be failed if user tap on a button that calling it multiple times continuously.
• Improves tests.

• Bumped Dart sdk to >=2.18.0 <4.0.0.

• Add isolates_helper to README.

• Improves README.
• Add IsolateManager.debugLogPrefix to set the prefix debug logs.

• Improve worker.dart imports.
• Use new worker.dart in testing.

• Improve function descriptions.
• Improve README for catching exception with createOwnIsolate.

• Support try-catch block for all platforms including Worker on Web.
• Update worker.dart to support try-catch block.
• Change all the debug logs prefix to [Isolate Mangager].
• Add test for try-catch.
• Increase min SDK to 2.15.0.

• Improve pub scores.

• The method .start() is now optional, the plugin will automatically call this method when using .compute for the first time, so you have 3 way to create the instance:

  1. Basic usage:

  IsolateManager<int> isolateManager = IsolateManager.create(
    fibonacci,
    concurrent: 4,
  );
  
  await isolateManager.start();
  

  2. Use start without await:

  IsolateManager<int> isolateManager = IsolateManager.create(
    fibonacci,
    concurrent: 4,
  );
  
  isolateManager.start();
  

  3. Use start when creating the instance:

  IsolateManager<int> isolateManager = IsolateManager.create(
    fibonacci,
    concurrent: 4,
  )..start();
  

• On Flutter >3.3.0 - @pragma('vm:entry-point') annotation must be added to all methods that you want to use for isolation. Read README for more information.

• [BREADKING CHANGE]: Change the parameter name from numOfIsolates to concurrent.
• Update dependencies.

• Improve README.

• Changes the name from function_name to worker.
• Improves worker.dart form.
• Improves README.

• Fixes issue in restart and stop methods.

• Improve function headers.

• Update function headers.
• Update README.
• Update dependencies.

• Update base function_name.dart to make it works with FutureOr function.
• Add function_name.js to example and create example for it.

• Remove useless await in README.
• Downgrade Dart SDK min version to 2.12.0.

• NO BREAKING CHANGE
• Add Worker for Web platform (real Isolate on Web). Read README for more details.

• Update README

• BREAKING CHANGE: Change isolateFunction parameter of createOwnIsolate method from named to required parameter.
• Added initialParams parameter to createOwnIsolate method.
• Added initialParams getter to IsolateManagerController.
• Bring to stable version.

• Update example

• Initial release