@zk-tech/bedrock 0.0.1 → 0.1.0

package/src/context/context.test.ts

@@ -1,17 +0,0 @@
-import { makeEntryContext, makeUserInputContext } from './context';
-
-describe('context', () => {
-  it('bind', () => {
-    const context = makeEntryContext();
-    expect(context.getValue('lvweb')).toBeUndefined();
-    context.setValue('lvweb', true);
-    expect(context.getValue('lvweb')).toBeTruthy();
-  });
-
-  it('background', () => {
-    const context = makeUserInputContext();
-    context.setValue('lvweb', true);
-    const newContext = context.background();
-    expect(newContext.getValue('lvweb')).toBeUndefined();
-  });
-});

package/src/context/context.ts

@@ -1,60 +0,0 @@
-/**
- * Context类型
- */
-export enum ContextType {
-  // 入口
-  Entry,
-  // 事件
-  Event,
-  // 用户
-  UserInput,
-  // 自定义任务
-  Task,
-}
-
-export class Context {
-  private readonly _store = new Map<string, any>();
-
-  constructor(public readonly type: ContextType = ContextType.Task) {}
-
-  /**
-   * 获取一个纯粹的上下文
-   */
-  background() {
-    return new Context(this.type);
-  }
-
-  /**
-   * 绑定信息
-   */
-  setValue<T>(key: string, value: T) {
-    this._store.set(key, value);
-  }
-
-  /**
-   * 获取信息
-   */
-  getValue<T>(key: string) {
-    return this._store.get(key) as T | undefined;
-  }
-}
-
-export function makeEntryContext() {
-  return new Context(ContextType.Entry);
-}
-
-export function makeEventContext() {
-  return new Context(ContextType.Event);
-}
-
-export function makeUserInputContext() {
-  return new Context(ContextType.UserInput);
-}
-
-export function makeTaskContext() {
-  return new Context(ContextType.Task);
-}
-
-export function makeContext() {
-  return new Context();
-}

package/src/context/index.ts

@@ -1,8 +0,0 @@
-export { Context, ContextType } from './context';
-export {
-  makeEntryContext,
-  makeEventContext,
-  makeUserInputContext,
-  makeTaskContext,
-  makeContext,
-} from './context';

package/src/di/base.ts

@@ -1,73 +0,0 @@
-// service特征标识
-export type BrandedService = { _serviceBrand: undefined };
-
-//
-// 服务唯一标识符（编译时生成）
-// 需要DI进行注入的服务必须拥有该标识符
-// 本质上是一个参数装饰器
-//
-export interface ServiceIdentifier<T> {
-  (...args: any[]): void;
-  type: T;
-}
-
-// 获取服务的视图接口
-export interface ServicesAccessor {
-  get: <T>(id: ServiceIdentifier<T>) => T;
-}
-
-// 服务唯一标识符存储
-const serviceIds = new Map<string, ServiceIdentifier<any>>();
-
-export const DI_TARGET = '$di$target';
-export const DI_DEPENDENCIES = '$di$dependencies';
-
-// 获取某个服务的依赖
-// 因为服务依赖关系会存放在构造函数的属性上
-export function getServiceDependencies(ctor: any): { id: ServiceIdentifier<any>; index: number }[] {
-  return ctor[DI_DEPENDENCIES] || [];
-}
-
-// 更新服务依赖依赖关系
-function setServiceDependency(id: ServiceIdentifier<any>, ctor: any, index: number): void {
-  if (ctor[DI_TARGET] === ctor) {
-    ctor[DI_DEPENDENCIES].push({ id, index });
-  } else {
-    ctor[DI_DEPENDENCIES] = [{ id, index }];
-    ctor[DI_TARGET] = ctor;
-  }
-}
-
-//
-// 创建服务唯一标识符
-// 传入服务ID，返回一个参数装饰器
-// 参数装饰器会记录A需要
-//   const IFooServiceId = createDecorator<FooService>('FooService');
-//
-//   class Bar
-//     constructor(@IFooServiceId a: IFooService)  // IFooService是接口声明
-//
-export function createDecorator<T>(serviceId: string): ServiceIdentifier<T> {
-  if (serviceIds.has(serviceId)) {
-    return serviceIds.get(serviceId)!;
-  }
-
-  const id = function (target: any, key: string, index: number): any {
-    if (arguments.length !== 3) {
-      throw new Error('@IServiceName-decorator can only be used to decorate a parameter');
-    }
-    setServiceDependency(id, target, index);
-  } as any;
-
-  id.toString = () => serviceId;
-
-  serviceIds.set(serviceId, id);
-  return id;
-}
-
-// TODO(niurouwan): 补一下注释和例子
-export function refineServiceDecorator<T1, T extends T1>(
-  serviceIdentifier: ServiceIdentifier<T1>,
-): ServiceIdentifier<T> {
-  return serviceIdentifier as ServiceIdentifier<T>;
-}

package/src/di/container-service.test.ts

@@ -1,179 +0,0 @@
-import { createDecorator } from './base';
-import { InstantiationService as ContainerService, InstantiationService } from './instantiation-service';
-import { ServiceOwnership } from './service-ownership-collection';
-import { ServiceRegistry } from './service-registry';
-
-/**
- * 存在dispose的service1
- */
-class MockService1 {
-  readonly _serviceBrand: undefined;
-
-  constructor(private readonly _fn: () => void) {}
-
-  dispose() {
-    this._fn();
-  }
-}
-const IMockService1 = createDecorator<MockService1>('MockService1');
-
-/**
- * 存在dispose的service2
- */
-class MockService2 {
-  readonly _serviceBrand: undefined;
-
-  constructor(private readonly _fn: () => void) {}
-
-  dispose() {
-    this._fn();
-  }
-}
-const IMockService2 = createDecorator<MockService2>('MockService2');
-
-/**
- * 不存在dispose的service
- */
-class MockService3 {
-  readonly _serviceBrand: undefined;
-
-  constructor(private readonly _fn: () => void) {}
-}
-const IMockService3 = createDecorator<MockService3>('MockService3');
-
-/**
- * reference service
- */
-class MockService4 {
-  readonly _serviceBrand: undefined;
-
-  constructor(private readonly _fn: () => void) {}
-
-  dispose() {
-    this._fn();
-  }
-}
-const IMockService4 = createDecorator<MockService4>('MockService4');
-
-describe('ContainerService', () => {
-  // 单层的dispose
-  it('dispose1', () => {
-    const fn1 = vi.fn();
-    const fn2 = vi.fn();
-    const fn3 = vi.fn();
-
-    const registry = new ServiceRegistry();
-    registry.registerInstance(IMockService1, new MockService1(fn1));
-    registry.registerInstance(IMockService2, new MockService2(fn2));
-    registry.registerInstance(IMockService3, new MockService3(fn3));
-    const containerService = new ContainerService(registry.makeCollection());
-    containerService.dispose();
-
-    expect(fn1).toBeCalled();
-    expect(fn2).toBeCalled();
-    expect(fn3).not.toBeCalled();
-  });
-
-  // 双层的dispose，一起销毁
-  it('dispose2', () => {
-    const fn1 = vi.fn();
-    const fn2 = vi.fn();
-    const fn3 = vi.fn();
-
-    const registry1 = new ServiceRegistry();
-    registry1.registerInstance(IMockService1, new MockService1(fn1));
-    const containerService = new ContainerService(registry1.makeCollection());
-
-    const registry2 = new ServiceRegistry();
-    registry2.registerInstance(IMockService2, new MockService2(fn2));
-    registry2.registerInstance(IMockService3, new MockService3(fn3));
-    const childContainerService = new ContainerService(registry2.makeCollection(), containerService);
-    // eslint-disable-next-line dot-notation, @typescript-eslint/dot-notation
-    expect(containerService['_childs'].has(childContainerService)).toBeTruthy();
-
-    containerService.dispose();
-
-    expect(fn1).toBeCalled();
-    expect(fn2).toBeCalled();
-    expect(fn3).not.toBeCalled();
-    // eslint-disable-next-line dot-notation, @typescript-eslint/dot-notation
-    expect(containerService['_childs'].has(childContainerService)).toBeFalsy();
-  });
-
-  // 双层的dispose，只销毁下一层
-  it('dispose3', () => {
-    const fn1 = vi.fn();
-    const fn2 = vi.fn();
-    const fn3 = vi.fn();
-
-    const registry1 = new ServiceRegistry();
-    registry1.registerInstance(IMockService1, new MockService1(fn1));
-    const containerService = new ContainerService(registry1.makeCollection());
-
-    const registry2 = new ServiceRegistry();
-    registry2.registerInstance(IMockService2, new MockService2(fn2));
-    registry2.registerInstance(IMockService3, new MockService3(fn3));
-    const childContainerService = new ContainerService(registry2.makeCollection(), containerService);
-    // eslint-disable-next-line dot-notation, @typescript-eslint/dot-notation
-    expect(containerService['_childs'].has(childContainerService)).toBeTruthy();
-
-    childContainerService.dispose();
-
-    expect(fn1).not.toBeCalled();
-    expect(fn2).toBeCalled();
-    expect(fn3).not.toBeCalled();
-    // eslint-disable-next-line dot-notation, @typescript-eslint/dot-notation
-    expect(containerService['_childs'].has(childContainerService)).toBeFalsy();
-  });
-
-  // parent是instantiationService，正常dispose
-  it('dispose4', () => {
-    const fn1 = vi.fn();
-    const fn2 = vi.fn();
-    const fn3 = vi.fn();
-
-    const registry1 = new ServiceRegistry();
-    registry1.registerInstance(IMockService1, new MockService1(fn1));
-    const instantiationService = new InstantiationService(registry1.makeCollection());
-
-    const registry2 = new ServiceRegistry();
-    registry2.registerInstance(IMockService2, new MockService2(fn2));
-    registry2.registerInstance(IMockService3, new MockService3(fn3));
-    const containerService = new ContainerService(registry2.makeCollection(), instantiationService);
-
-    containerService.dispose();
-
-    expect(fn1).not.toBeCalled();
-    expect(fn2).toBeCalled();
-    expect(fn3).not.toBeCalled();
-  });
-
-  // reference dispose
-  it('reference dispose', () => {
-    const fn1 = vi.fn();
-    const fn2 = vi.fn();
-    const fn4 = vi.fn();
-
-    const mock4Instance = new MockService4(fn4);
-    const registry1 = new ServiceRegistry();
-    registry1.registerInstance(IMockService1, new MockService1(fn1));
-    registry1.registerInstance(IMockService4, mock4Instance);
-    const containerService = new ContainerService(registry1.makeCollection());
-
-    const registry2 = new ServiceRegistry();
-    registry2.registerInstance(IMockService2, new MockService2(fn2));
-    registry2.registerInstance(IMockService4, mock4Instance, {
-      ownership: ServiceOwnership.Reference,
-    });
-    const childContainerService = new ContainerService(registry2.makeCollection(), containerService);
-    childContainerService.dispose();
-
-    expect(fn1).not.toBeCalled();
-    expect(fn2).toBeCalled();
-    expect(fn4).not.toBeCalled();
-
-    containerService.dispose();
-    expect(fn1).toBeCalled();
-    expect(fn4).toBeCalled();
-  });
-});

package/src/di/context.web.tsx

@@ -1,41 +0,0 @@
-import { createContext, createElement, useContext, useMemo, type ReactElement } from 'react';
-import { lvAssertNotNil } from '@/assert';
-import type { IInstantiationService } from './instantiation-service.interface';
-import type { ServiceIdentifier, ServicesAccessor } from './base';
-
-interface IProps {
-  instantiationService: IInstantiationService;
-  children?: React.ReactNode;
-}
-
-const Context = createContext<IInstantiationService | null>(null);
-
-/**
- * 组件支持依赖注入上下文
- */
-export const InstantiationContext = (props: IProps) => {
-  return createElement(
-    Context.Provider,
-    { value: props.instantiationService },
-    props.children,
-  ) as ReactElement<any, any>;
-};
-
-/**
- * 获取服务的hook
- * @param identifier 服务标识符
- * @returns 对应服务
- */
-export function useService<T>(identifier: ServiceIdentifier<T>): T {
-  const instantiationService = useContext(Context);
-  lvAssertNotNil(instantiationService, 'react components need service context.');
-  const service = useMemo(
-    () =>
-      instantiationService.invokeFunction((servicesAccessor: ServicesAccessor) =>
-        servicesAccessor.get(identifier),
-      ),
-    [instantiationService, identifier],
-  );
-
-  return service;
-}

package/src/di/descriptor.ts

@@ -1,31 +0,0 @@
-//
-// DI中服务描述符，本质上是构造函数的包装
-//
-// 必须提供服务构造函数
-// 支持静态参数
-// 支持配置是否延迟初始化
-//
-export class SyncDescriptor<T> {
-  readonly ctor: new (...args: any[]) => T;
-  readonly staticArguments: any[];
-  readonly supportsDelayedInstantiation: boolean;
-
-  constructor(
-    ctor: new (...args: any[]) => T,
-    staticArguments: any[] = [],
-    supportsDelayedInstantiation = false,
-  ) {
-    this.ctor = ctor;
-    this.staticArguments = staticArguments;
-    this.supportsDelayedInstantiation = supportsDelayedInstantiation;
-  }
-}
-
-//
-// 特化描述符
-// 1. 没有静态参数，没有动态参数，只存在注入参数
-// 2. 默认延迟初始化
-//
-export interface SyncDescriptor0<T> {
-  readonly ctor: new () => T;
-}

package/src/di/idle-value.test.ts

@@ -1,73 +0,0 @@
-import { sleep } from '@/async';
-import { IdleValue } from './idle-value';
-
-class Foo {
-  value = 'public value.';
-
-  private _data = 100;
-  private readonly _mockFn: () => void;
-
-  constructor(mockFn: () => void) {
-    this._mockFn = mockFn;
-  }
-
-  get data() {
-    return this._data;
-  }
-
-  set data(value: number) {
-    this._data = value;
-  }
-
-  test() {
-    this._mockFn();
-  }
-}
-
-describe('idle value', () => {
-  it('initializes during idle time', async () => {
-    const fn = vi.fn();
-    const wrapper = new IdleValue<Foo>(() => new Foo(fn));
-    // Not initialized immediately
-    expect(wrapper.isInitialized).toBe(false);
-
-    expect(fn).not.toBeCalled();
-    expect(wrapper.isInitialized).toBe(false);
-
-    await sleep(500);
-
-    // Must have been initialized asynchronously
-    expect(wrapper.isInitialized).toBe(true);
-
-    // Properties work normally
-    expect(wrapper.value.value).toBe('public value.');
-    // Setters/getters work normally
-    expect(wrapper.value.data).toBe(100);
-    wrapper.value.data = 200;
-    expect(wrapper.value.data).toBe(200);
-    // Method calls work normally
-    wrapper.value.test();
-    expect(fn).toBeCalled();
-  });
-
-  it('initializes immediately due to usage', () => {
-    const fn = vi.fn();
-    const wrapper = new IdleValue<Foo>(() => new Foo(fn));
-    // Not initialized immediately
-    expect(wrapper.isInitialized).toBe(false);
-
-    // Properties work normally
-    expect(wrapper.value.value).toBe('public value.');
-    // Setters/getters work normally
-    expect(wrapper.value.data).toBe(100);
-    wrapper.value.data = 200;
-    expect(wrapper.value.data).toBe(200);
-    // Method calls work normally
-    wrapper.value.test();
-    expect(fn).toBeCalled();
-
-    // Initialized because value was accessed
-    expect(wrapper.isInitialized).toBe(true);
-    // await sleep(500);
-  });
-});

package/src/di/idle-value.ts

@@ -1,63 +0,0 @@
-import { lvSchedulerCallback, PriorityLevel } from '@/scheduler';
-import type { IDisposable } from '@/dispose';
-import { Emitter, type Event } from '@/event';
-
-//
-// 容器类型，存放一个可以延迟初始化的值
-//
-export class IdleValue<T> implements IDisposable {
-  private readonly _executor: () => void;
-  private readonly _handle: IDisposable;
-  private _executorEmitter?: Emitter<[]>;
-
-  private _didRun = false;
-  private _value?: T;
-  private _error: unknown;
-
-  constructor(executor: () => T) {
-    this._executor = () => {
-      try {
-        this._value = executor();
-      } catch (err) {
-        this._error = err;
-        throw err;
-      } finally {
-        this._didRun = true;
-        if (this._value && this._executorEmitter) {
-          this._executorEmitter.fire();
-        }
-      }
-    };
-    this._handle = lvSchedulerCallback(() => this._executor(), {
-      priorityLevel: PriorityLevel.IdlePriority,
-    });
-  }
-
-  get value(): T {
-    // 如果没有run过，dispose之后再立刻执行
-    if (!this._didRun) {
-      this._handle.dispose();
-      this._executor();
-    }
-    if (this._error) {
-      // eslint-disable-next-line @typescript-eslint/no-throw-literal
-      throw this._error;
-    }
-    return this._value!;
-  }
-
-  get isInitialized(): boolean {
-    return this._didRun;
-  }
-
-  get onExecutor(): Event<[]> {
-    if (!this._executorEmitter) {
-      this._executorEmitter = new Emitter<[]>();
-    }
-    return this._executorEmitter.event;
-  }
-
-  dispose(): void {
-    this._handle.dispose();
-  }
-}

package/src/di/index.common.ts

@@ -1,32 +0,0 @@
-export type { BrandedService } from './base';
-export type { ServiceIdentifier } from './base';
-export type { ServicesAccessor } from './base';
-export { createDecorator } from './base';
-export { refineServiceDecorator } from './base';
-
-export { SyncDescriptor } from './descriptor';
-
-export type { GetLeadingNonServiceArgs } from './instantiation-service.interface';
-export { IInstantiationService } from './instantiation-service.interface';
-export { InstantiationService } from './instantiation-service';
-
-// alias进行历史命名兼容
-export { InstantiationService as ContainerService } from './instantiation-service';
-export { IInstantiationService as IContainerService } from './instantiation-service.interface';
-
-export { getService } from './instantiation-service';
-export { InstantiationErrorType } from './instantiation-service';
-
-export type { IServiceCollection } from './service-collection';
-export { ServiceCollection } from './service-collection';
-
-export { ServiceOwnership } from './service-ownership-collection';
-
-export { ServiceRegistry } from './service-registry';
-
-export type { LazyService } from './lazy/type';
-
-export type { ILazyServiceLoader } from './lazy/lazy-service';
-export { LazyServiceLoader } from './lazy/lazy-service';
-
-export { makeLazyServiceIdleLoad } from './lazy/idle-load';

package/src/di/index.ts

@@ -1,2 +0,0 @@
-export * from './index.common';
-export { InstantiationContext, useService } from './context.web';

package/src/di/instantiation-service.interface.ts

@@ -1,46 +0,0 @@
-import type { BrandedService, ServicesAccessor } from './base';
-import { createDecorator } from './base';
-import type { SyncDescriptor0 } from './descriptor';
-import type { ServiceCollection } from './service-collection';
-
-export type GetLeadingNonServiceArgs<TArgs extends any[]> = TArgs extends []
-  ? []
-  : TArgs extends [...infer TFirst, BrandedService]
-    ? GetLeadingNonServiceArgs<TFirst>
-    : TArgs;
-
-export interface IInstantiationService {
-  readonly _serviceBrand: undefined;
-
-  /**
-   * Synchronously creates an instance that is denoted by the descriptor
-   */
-  createInstance: {
-    <T>(descriptor: SyncDescriptor0<T>): T;
-    <Ctor extends new (...args: any[]) => any, R extends InstanceType<Ctor>>(
-      ctor: Ctor,
-      ...args: GetLeadingNonServiceArgs<ConstructorParameters<Ctor>>
-    ): R;
-  };
-
-  /**
-   * Calls a function with a service accessor.
-   */
-  invokeFunction: <R, TS extends any[] = []>(
-    fn: (accessor: ServicesAccessor, ...args: TS) => R,
-    ...args: TS
-  ) => R;
-
-  /**
-   * Creates a child of this service which inherits all current services
-   * and adds/overwrites the given services.
-   */
-  createChild: (services: ServiceCollection) => IInstantiationService;
-
-  /**
-   * 生命周期归属该DI上下文的服务进行销毁
-   */
-  dispose: () => void;
-}
-
-export const IInstantiationService = createDecorator<IInstantiationService>('instantiation');