Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

4.0 KB
Raw Blame
/**
 * Copyright 2023-present DreamNum Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import type { Dependency } from '@univerjs/core';
import type { IMessageProtocol } from '@univerjs/rpc';
import type { ChildProcess, Serializable } from 'node:child_process';
import { IConfigService, ILogService, Inject, Injector, merge, Plugin } from '@univerjs/core';
import {
    ChannelService,
    DataSyncPrimaryController,
    IRemoteSyncService,
    IRPCChannelService,
    RemoteSyncPrimaryService,
} from '@univerjs/rpc';
import { fork } from 'node:child_process';
import { Observable, shareReplay } from 'rxjs';
import type { IUniverRPCNodeMainConfig } from './config/config';
import pkg from '../package.json';
import { defaultPluginMainThreadConfig, PLUGIN_CONFIG_KEY_MAIN_THREAD } from './config/config';

export class UniverRPCNodeMainPlugin extends Plugin {
    static override pluginName = 'UNIVER_RPC_NODE_MAIN_PLUGIN';
    static override packageName = pkg.name;
    static override version = pkg.version;

    private _child: ChildProcess | null = null;

    constructor(
        private readonly _config: Partial<IUniverRPCNodeMainConfig> = defaultPluginMainThreadConfig,
        @Inject(Injector) protected readonly _injector: Injector,
        @IConfigService private readonly _configService: IConfigService
    ) {
        super();

        // Manage the plugin configuration.
        const { ...rest } = merge(
            {},
            defaultPluginMainThreadConfig,
            this._config
        );
        this._configService.setConfig(PLUGIN_CONFIG_KEY_MAIN_THREAD, rest);
    }

    override onStarting(): void {
        const { workerSrc } = this._config;
        if (!workerSrc) {
            throw new Error('[UniverRPCNodeMainPlugin] workerSrc is required for UniverRPCNodeMainPlugin');
        }

        const [messageProtocol, child] = createNodeMessagePortOnMain(this._injector, workerSrc);

        const dependencies: Dependency[] = [
            [IRPCChannelService, {
                useFactory: function createChannelService() {
                    return new ChannelService(messageProtocol);
                },
            }],
            [DataSyncPrimaryController],
            [IRemoteSyncService, { useClass: RemoteSyncPrimaryService }],
        ];

        dependencies.forEach((dependency) => this._injector.add(dependency));

        this._injector.get(DataSyncPrimaryController);
        this._child = child;
    }

    override dispose(): void {
        super.dispose();

        if (this._child) {
            try {
                this._child.kill();
            } catch (e) {
                console.error('Failed to kill child process:', e);
            }
            this._child = null;
        }
    }
}

function createNodeMessagePortOnMain(injector: Injector, path: string): [IMessageProtocol, ChildProcess] {
    const logService = injector.get(ILogService);

    const child = fork(path);
    child.on('spawn', () => logService.log('Child computing process spawned!'));
    child.on('error', (error) => logService.error(error));

    const messageProtocol: IMessageProtocol = {
        send(message: unknown): void {
            child.send(message as Serializable);
        },
        onMessage: new Observable<unknown>((subscriber) => {
            const handler = (message: unknown) => {
                subscriber.next(message);
            };

            child.on('message', handler);
            return () => child.off('message', handler);
        }).pipe(shareReplay({ bufferSize: 1, refCount: true })),
    };

    return [messageProtocol, child];
}