isolate_manager 5.1.0-rc.1

isolate_manager: ^5.1.0-rc.1 copied to clipboard

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

• 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 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, // <--
    );
    

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();