ProjectRevisionHandlerMixin

Mixin

Allows applying changes from one project to another. For method to produce correct results, projects should be isomorphic - they should use same models and store configuration, also data in source and target projects should be identical before changes to the source project are made and applied to the target project. This method is meant to apply changes in real time - as source project is changed, changes should be applied to the target project before it is changed. When changes are applied all changes are committed and project is recalculated, which means target project won't have any local changes after.

Usage:

// Collect changes from first project
const { changes } = projectA;

// Apply changes to second project
await projectB.applyProjectChanges(changes);

Applies an array of revisions to a local project

Initializes revision feature on the project. Calling this API early is required for revisions to work.

Use this method to organize project changes into transactions. Every queue call will create a sequential promise which cannot be interrupted by other queued functions. You can use async functions and await for any promises (including commitAsync) with one exception - you cannot await other queued calls and any other function/promise which awaits queued function. Otherwise, an unresolvable chain of promises will be created.

NOTE: Functions which call this method internally are marked with on-queue tag.

Examples:

// Invalid queue call which hangs promise chain
project.queue(async () => {
    const event = project.getEventStore().getById(1);
    await project.queue(() => {
        event.duration = 2;
        return project.commitAsync();
    })
})

// Valid queue call
project.queue(() => {
    const event = project.getEventStore().getById(1);

    // Consequent queue call will be chained after the current function in the next microtask.
    project.queue(() => {
        event.duration = 2;
        return project.commitAsync();
    })

    // Event duration is not yet changed - this condition is true
    if (event.duration !== 2) { }
})