Skip to content

Commit

Permalink
refactor(router-lite): route definition configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
@Sayan751
Sayan751 committed Mar 28, 2023
1 parent 06a05be commit eba6d61
Show file tree
Hide file tree
Showing 7 changed files with 101 additions and 73 deletions.
9 changes: 2 additions & 7 deletions packages/router-lite/src/component-agent.ts
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { ILogger } from '@aurelia/kernel';
import type { ICustomElementController, IHydratedController, ICustomElementViewModel, ILifecycleHooks, LifecycleHooksLookup } from '@aurelia/runtime-html';

import type { RouteDefinition } from './route-definition';
import type { RouteDefinitionConfiguration } from './route-definition';
import type { RouteNode } from './route-tree';
import { IRouteContext } from './route-context';
import {
Expand All @@ -15,7 +15,7 @@ import { IRouteConfig } from './route';
import type { RouterOptions } from './options';

export interface IRouteViewModel extends ICustomElementViewModel {
getRouteConfig?(parentDefinition: RouteDefinition | null, routeNode: RouteNode | null): IRouteConfig | Promise<IRouteConfig>;
getRouteConfig?(parentDefinition: RouteDefinitionConfiguration | null, routeNode: RouteNode | null): IRouteConfig | Promise<IRouteConfig>;
canLoad?(params: Params, next: RouteNode, current: RouteNode | null): boolean | NavigationInstruction | NavigationInstruction[] | Promise<boolean | NavigationInstruction | NavigationInstruction[]>;
loading?(params: Params, next: RouteNode, current: RouteNode | null): void | Promise<void>;
canUnload?(next: RouteNode | null, current: RouteNode): boolean | Promise<boolean>;
Expand Down Expand Up @@ -44,7 +44,6 @@ export class ComponentAgent<T extends IRouteViewModel = IRouteViewModel> {
public constructor(
public readonly instance: T,
public readonly controller: ICustomElementController<T>,
public readonly definition: RouteDefinition,
public readonly routeNode: RouteNode,
public readonly ctx: IRouteContext,
private readonly routerOptions: RouterOptions,
Expand Down Expand Up @@ -224,8 +223,4 @@ export class ComponentAgent<T extends IRouteViewModel = IRouteViewModel> {
}
b.pop();
}

public toString(): string {
return `CA(ctx:'${this.ctx.friendlyPath}',c:'${this.definition.component!.name}')`;
}
}
61 changes: 31 additions & 30 deletions packages/router-lite/src/route-context.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ export class RouteContext {
private readonly logger: ILogger;
private readonly hostControllerProvider: InstanceProvider<ICustomElementController>;
/** @internal */
public readonly _recognizer: RouteRecognizer<RouteDefinition | Promise<RouteDefinition>>;
public readonly _recognizer: RouteRecognizer<RouteDefinitionConfiguration | Promise<RouteDefinitionConfiguration>>;
private _childRoutesConfigured: boolean = false;

private readonly _navigationModel: NavigationModel | null;
Expand All @@ -174,7 +174,7 @@ export class RouteContext {
viewportAgent: ViewportAgent | null,
public readonly parent: IRouteContext | null,
public readonly component: CustomElementDefinition,
public readonly definition: RouteDefinition,
public readonly definition: RouteDefinitionConfiguration,
public readonly parentContainer: IContainer,
private readonly _router: IRouter,
) {
Expand Down Expand Up @@ -224,13 +224,13 @@ export class RouteContext {
this.processDefinition(definition);
}

private processDefinition(definition: RouteDefinition): void {
private processDefinition(routeDefinitionConfiguration: RouteDefinitionConfiguration): void {
const promises: Promise<void>[] = [];
const allPromises: Promise<void>[] = [];
const childrenRoutes = definition._directConfiguration?.routes ?? noRoutes;
const childrenRoutes = routeDefinitionConfiguration.routes ?? noRoutes;
const len = childrenRoutes.length;
if (len === 0) {
const getRouteConfig = (definition.component?.Type.prototype as IRouteViewModel)?.getRouteConfig;
const getRouteConfig = (routeDefinitionConfiguration.component?.Type.prototype as IRouteViewModel)?.getRouteConfig;
this._childRoutesConfigured = getRouteConfig == null ? true : typeof getRouteConfig !== 'function';
return;
}
Expand All @@ -244,14 +244,14 @@ export class RouteContext {
promises.push(p);
allPromises.push(p);
} else {
const rdResolution = RouteDefinition.resolve(childRoute, definition, null, this) as [RouteDefinition, RouteDefinitionConfiguration] | Promise<[RouteDefinition, RouteDefinitionConfiguration]>;
const rdResolution = RouteDefinition.resolve(childRoute, routeDefinitionConfiguration, null, this);
if (rdResolution instanceof Promise) {
if (!isPartialChildRouteConfig(childRoute) || childRoute.path == null) throw new Error(`Invalid route config. When the component property is a lazy import, the path must be specified.`);
for (const path of ensureArrayOfStrings(childRoute.path)) {
this.$addRoute(path, childRoute.caseSensitive ?? false, rdResolution.then(([def]) => def));
this.$addRoute(path, childRoute.caseSensitive ?? false, rdResolution);
}
const idx = this.childRoutes.length;
const p = rdResolution.then(([, rdConfig]) => {
const p = rdResolution.then((rdConfig) => {
return this.childRoutes[idx] = rdConfig;
});
this.childRoutes.push(p);
Expand All @@ -260,13 +260,12 @@ export class RouteContext {
}
allPromises.push(p.then(noop));
} else {
const rdConfig = routeDef._directConfiguration;
for (const path of rdConfig?.path ?? emptyArray) {
this.$addRoute(path, rdConfig!.caseSensitive, routeDef);
for (const path of rdResolution.path ?? emptyArray) {
this.$addRoute(path, rdResolution.caseSensitive, rdResolution);
}
this.childRoutes.push(routeDef);
this.childRoutes.push(rdResolution);
if (hasNavModel) {
navModel.addRoute(routeDef);
navModel.addRoute(rdResolution);
}
}
}
Expand Down Expand Up @@ -414,9 +413,8 @@ export class RouteContext {
routeDef => this.processDefinition(routeDef)
);
return onResolve(task, () => {
const definition = RouteDefinition.resolve(componentInstance.constructor as Constructable, parentDefinition, null) as RouteDefinition;
const controller = Controller.$el(container, componentInstance, hostController.host, null);
const componentAgent = new ComponentAgent(componentInstance, controller, definition, routeNode, this, this._router.options);
const componentAgent = new ComponentAgent(componentInstance, controller, routeNode, this, this._router.options);

this.hostControllerProvider.dispose();

Expand Down Expand Up @@ -451,7 +449,7 @@ export class RouteContext {
// eslint-disable-next-line @typescript-eslint/no-this-alias
let _current: IRouteContext = this;
let _continue = true;
let result: RecognizedRoute<RouteDefinition | Promise<RouteDefinition>> | null = null;
let result: RecognizedRoute<RouteDefinitionConfiguration | Promise<RouteDefinitionConfiguration>> | null = null;
while (_continue) {
result = _current._recognizer.recognize(path);
if (result === null) {
Expand All @@ -474,17 +472,16 @@ export class RouteContext {
private addRoute(routeable: Exclude<Routeable, Promise<IModule>>): void | Promise<void>;
private addRoute(routeable: Routeable): void | Promise<void> {
this.logger.trace(`addRoute(routeable:'${routeable}')`);
return onResolve(RouteDefinition.resolve(routeable, this.definition, null, this), routeDef => {
const rdConfig = routeDef._directConfiguration;
for (const path of rdConfig?.path ?? emptyArray) {
this.$addRoute(path, rdConfig!.caseSensitive, routeDef);
return onResolve(RouteDefinition.resolve(routeable, this.definition, null, this), rdConfig => {
for (const path of rdConfig.path ?? emptyArray) {
this.$addRoute(path, rdConfig.caseSensitive, rdConfig);
}
this._navigationModel?.addRoute(routeDef);
this.childRoutes.push(routeDef);
this._navigationModel?.addRoute(rdConfig);
this.childRoutes.push(rdConfig);
});
}

private $addRoute(path: string, caseSensitive: boolean, handler: RouteDefinition | Promise<RouteDefinition>): void {
private $addRoute(path: string, caseSensitive: boolean, handler: RouteDefinitionConfiguration | Promise<RouteDefinitionConfiguration>): void {
this._recognizer.add({
path,
caseSensitive,
Expand Down Expand Up @@ -534,18 +531,22 @@ export class RouteContext {
public generateViewportInstruction(instruction: NavigationInstruction | EagerInstruction): PathGenerationResult | null {
if (!isEagerInstruction(instruction)) return null;
const component = instruction.component;
let def: RouteDefinition | undefined;
let def: RouteDefinitionConfiguration[] | undefined;
let throwError: boolean = false;
if (component instanceof RouteDefinition) {
def = component;
if (component instanceof RouteDefinitionConfiguration) {
def = [component];
throwError = true;
} else if (typeof component === 'string') {
def = (this.childRoutes as RouteDefinition[]).find(x => x._directConfiguration?.id === component);
const $rdConfig = (this.childRoutes as RouteDefinitionConfiguration[]).find(x => x.id === component);
if ($rdConfig === void 0) return null;
def = [$rdConfig];
} else if ((component as ITypedNavigationInstruction_string).type === NavigationInstructionType.string) {
def = (this.childRoutes as RouteDefinition[]).find(x => x._directConfiguration?.id === (component as ITypedNavigationInstruction_string).value);
const $rdConfig = (this.childRoutes as RouteDefinitionConfiguration[]).find(x => x.id === (component as ITypedNavigationInstruction_string).value);
if ($rdConfig === void 0) return null;
def = [$rdConfig];
} else {
// as the component is ensured not to be a promise in here, the resolution should also be synchronous
def = RouteDefinition.resolve(component, null, null, this) as RouteDefinition;
def = RouteDefinition.resolve(component, null, null, this);
}
if (def === void 0) return null;

Expand Down Expand Up @@ -677,7 +678,7 @@ function isCustomElementDefinition(value: ResourceDefinition): value is CustomEl

export class $RecognizedRoute {
public constructor(
public readonly route: RecognizedRoute<RouteDefinition | Promise<RouteDefinition>>,
public readonly route: RecognizedRoute<RouteDefinitionConfiguration | Promise<RouteDefinitionConfiguration>>,
public readonly residue: string | null,
) { }

Expand Down

0 comments on commit eba6d61

Please sign in to comment.