Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: get container after Workbench is mounted #848

Merged
merged 5 commits into from
Mar 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/controller/__tests__/layout.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ const layoutController = container.resolve(LayoutController);
const layoutService = container.resolve(LayoutService);

describe('The layout controller', () => {
test('Should support to listen to the Workbench did mount event', () => {
const mockFn = jest.fn();
layoutService.onWorkbenchDidMount(mockFn);
layoutController.onWorkbenchDidMount();

expect(mockFn).toBeCalled();
});

test('Should support to execute onPaneSizeChange', () => {
const original = layoutService.setPaneSize;
const mockFn = jest.fn();
Expand Down
6 changes: 6 additions & 0 deletions src/controller/layout.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@ import 'reflect-metadata';
import { container, singleton } from 'tsyringe';
import { Controller } from 'mo/react/controller';
import { ILayoutService, LayoutService } from 'mo/services';
import { LayoutEvents } from 'mo/model/workbench/layout';

export interface ILayoutController extends Partial<Controller> {
onWorkbenchDidMount?: () => void;
onPaneSizeChange?: (splitPanePos: number[]) => void;
onHorizontalPaneSizeChange?: (horizontalSplitPanePos: number[]) => void;
}
Expand All @@ -26,4 +28,8 @@ export class LayoutController extends Controller implements ILayoutController {
public onHorizontalPaneSizeChange = (horizontalSplitPanePos: number[]) => {
this.layoutService.setHorizontalPaneSize(horizontalSplitPanePos);
};

public onWorkbenchDidMount = () => {
this.layoutService.emit(LayoutEvents.OnWorkbenchDidMount);
};
}
4 changes: 4 additions & 0 deletions src/model/workbench/layout.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ export enum MenuBarMode {
vertical = 'vertical',
}

export enum LayoutEvents {
OnWorkbenchDidMount = 'workbench.didMount',
}

export interface ViewVisibility {
hidden: boolean;
}
Expand Down
6 changes: 3 additions & 3 deletions src/provider/create.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export interface IConfigProps {
defaultLocale?: string;
}

namespace stanalone {
namespace standalone {
let instance: InstanceService | null = null;

/**
Expand All @@ -37,12 +37,12 @@ namespace stanalone {
}

export default function create(config: IConfigProps) {
return stanalone.create(config);
return standalone.create(config);
}

/**
* Do NOT call it in production, ONLY used for test cases
*/
export function clearInstance() {
stanalone.clearInstance();
standalone.clearInstance();
}
11 changes: 10 additions & 1 deletion src/services/__tests__/layoutService.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ID_APP } from 'mo/common/id';
import { MenuBarMode, Position } from 'mo/model/workbench/layout';
import { LayoutEvents, MenuBarMode, Position } from 'mo/model/workbench/layout';
import 'reflect-metadata';
import { container } from 'tsyringe';
import { LayoutService } from '../workbench';
Expand Down Expand Up @@ -143,5 +143,14 @@ describe('The layout service', () => {
layoutService.setAuxiliaryBar((pre) => !pre);
expect(layoutService.getState().auxiliaryBar.hidden).toBe(true);
});

test('Should support to listen to the Workbench did mount event', () => {
const mockFn = jest.fn();
layoutService.onWorkbenchDidMount(mockFn);

layoutService.emit(LayoutEvents.OnWorkbenchDidMount);

expect(mockFn).toBeCalled();
});
});
});
6 changes: 5 additions & 1 deletion src/services/instanceService.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,11 @@ export default class InstanceService
this.emit(InstanceHookKind.beforeLoad);
molecule.extension.load(others);

molecule.monacoService.initWorkspace(molecule.layout.container!);
molecule.layout.onWorkbenchDidMount(() => {
molecule.monacoService.initWorkspace(
molecule.layout.container!
);
});
this.rendered = true;
}

Expand Down
10 changes: 10 additions & 0 deletions src/services/workbench/layoutService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
Position,
LayoutModel,
MenuBarMode,
LayoutEvents,
} from 'mo/model/workbench/layout';
import { MenuBarEvent } from 'mo/model/workbench/menuBar';

Expand Down Expand Up @@ -87,6 +88,11 @@ export interface ILayoutService extends Component<ILayout> {
* Reset all layout data as default value
*/
reset(): void;
/**
* Listen to the workbench did mount event
* @param callback callback function
*/
onWorkbenchDidMount(callback: Function): void;
}

@singleton()
Expand All @@ -101,6 +107,10 @@ export class LayoutService
this.state = container.resolve(LayoutModel);
}

public onWorkbenchDidMount(callback: Function): void {
this.subscribe(LayoutEvents.OnWorkbenchDidMount, callback);
}

public get container() {
// Make sure to get the latest dom element.
this._container = document.getElementById(ID_APP) || document.body;
Expand Down
8 changes: 7 additions & 1 deletion src/workbench/workbench.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import 'reflect-metadata';
import React from 'react';
import React, { useEffect } from 'react';
import { container } from 'tsyringe';

import {
Expand Down Expand Up @@ -60,6 +60,7 @@ export function WorkbenchView(props: IWorkbench & ILayout & ILayoutController) {
sidebar,
statusBar,
onPaneSizeChange,
onWorkbenchDidMount,
onHorizontalPaneSizeChange,
splitPanePos,
horizontalSplitPanePos,
Expand Down Expand Up @@ -122,6 +123,11 @@ export function WorkbenchView(props: IWorkbench & ILayout & ILayoutController) {
hideStatusBar
);

useEffect(() => {
// call onWorkbenchDidMount after the first render
onWorkbenchDidMount?.();
}, []);

return (
<div id={ID_APP} className={appClassName} tabIndex={0}>
<div className={workbenchFinalClassName}>
Expand Down
38 changes: 28 additions & 10 deletions stories/workbench/0-Workbench.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,35 @@ moInstance.onBeforeInit(() => {
molecule.builtin.inactiveModule('activityBarData');
});

export const IDEDemo = () => moInstance.render(<Workbench />);

IDEDemo.story = {
name: 'Workbench',
export default {
title: 'Workbench',
};

if (module.hot) {
module.hot.accept();
}
export const NormalWorkbench = () => moInstance.render(<Workbench />);

export default {
title: 'Workbench',
component: IDEDemo,
export const EmbeddedWorkbench = () => {
return (
<div
style={{
position: 'absolute',
width: '100%',
height: '100%',
top: 0,
left: 0,
}}
>
<h1 style={{ textAlign: 'center', lineHeight: '40px' }}>
Embedded
</h1>
<div
style={{
position: 'relative',
width: '100%',
height: 'calc(100% - 40px)',
}}
>
{moInstance.render(<Workbench />)}
</div>
</div>
);
};