Merge branch 'main' into refactor-decorate-nav-item

arjunlalb · web-flow · commit 1048eca20819 · 2021-07-07T10:53:34.000+05:30
diff --git a/projects/common/src/feature/feature.guard.test.ts b/projects/common/src/feature/feature.guard.test.ts
@@ -5,14 +5,14 @@ import { patchRouterNavigateForTest, runFakeRxjs } from '@hypertrace/test-utils'
 import { createServiceFactory, mockProvider } from '@ngneat/spectator/jest';
 import { Observable, of } from 'rxjs';
 import { map } from 'rxjs/operators';
+import { HtRoute } from '../navigation/ht-route';
 import { NavigationService } from '../navigation/navigation.service';
-import { TraceRoute } from '../navigation/trace-route';
 import { FeatureGuard } from './feature.guard';
 import { FeatureStateResolver } from './state/feature-state.resolver';
 import { FeatureState } from './state/feature.state';
 
 describe('Feature Guard', () => {
-  const buildRouteForFeatures = (features: string[]): TraceRoute => ({
+  const buildRouteForFeatures = (features: string[]): HtRoute => ({
     data: {
       features: features
     }
diff --git a/projects/common/src/feature/feature.guard.ts b/projects/common/src/feature/feature.guard.ts
@@ -2,8 +2,8 @@ import { Injectable } from '@angular/core';
 import { ActivatedRouteSnapshot, CanActivate, CanLoad, UrlSegment, UrlTree } from '@angular/router';
 import { Observable, of } from 'rxjs';
 import { catchError, map, tap } from 'rxjs/operators';
+import { HtRoute } from '../navigation/ht-route';
 import { NavigationService } from '../navigation/navigation.service';
-import { TraceRoute } from '../navigation/trace-route';
 import { FeatureStateResolver } from './state/feature-state.resolver';
 import { FeatureState } from './state/feature.state';
 
@@ -14,7 +14,7 @@ export class FeatureGuard implements CanLoad, CanActivate {
     private readonly featureStateResolver: FeatureStateResolver
   ) {}
 
-  public canLoad(route: TraceRoute, segments: UrlSegment[]): Observable<boolean> {
+  public canLoad(route: HtRoute, segments: UrlSegment[]): Observable<boolean> {
     // TODO as of ng8, canLoad has been pretty neglected. Doesn't have access to query params or returning a url tree
     // Https://github.com/angular/angular/issues/30633  https://github.com/angular/angular/issues/28306
     // For now, we'll work around by ignoring query params and doing a direct redirect
@@ -44,7 +44,7 @@ export class FeatureGuard implements CanLoad, CanActivate {
     );
   }
 
-  private checkRouteValidity(route: TraceRoute): Observable<boolean> {
+  private checkRouteValidity(route: HtRoute): Observable<boolean> {
     return this.getCombinedFeatureState(this.getFeaturesForRoute(route)).pipe(
       catchError(() => of(FeatureState.Disabled)),
       map(state => state !== FeatureState.Disabled)
@@ -55,7 +55,7 @@ export class FeatureGuard implements CanLoad, CanActivate {
     return this.featureStateResolver.getCombinedFeatureState(features);
   }
 
-  private getFeaturesForRoute(route: TraceRoute): string[] {
+  private getFeaturesForRoute(route: HtRoute): string[] {
     return (route.data && route.data.features) || [];
   }
 }
diff --git a/projects/common/src/navigation/ht-route-data.ts b/projects/common/src/navigation/ht-route-data.ts
@@ -1,7 +1,7 @@
 import { Observable } from 'rxjs';
 import { Breadcrumb } from './breadcrumb';
 
-export interface RouteData {
+export interface HtRouteData {
   breadcrumb?: Breadcrumb | Observable<Breadcrumb>;
   features?: string[];
 }
diff --git a/projects/common/src/navigation/ht-route.ts b/projects/common/src/navigation/ht-route.ts
@@ -0,0 +1,7 @@
+import { Route } from '@angular/router';
+import { HtRouteData } from './ht-route-data';
+
+export interface HtRoute extends Route {
+  data?: HtRouteData;
+  children?: HtRoute[];
+}
diff --git a/projects/common/src/navigation/navigation.service.ts b/projects/common/src/navigation/navigation.service.ts
@@ -19,7 +19,7 @@ import { from, Observable, of } from 'rxjs';
 import { distinctUntilChanged, filter, map, share, skip, startWith, switchMap, take } from 'rxjs/operators';
 import { isEqualIgnoreFunctions, throwIfNil } from '../utilities/lang/lang-utils';
 import { Dictionary } from '../utilities/types/types';
-import { TraceRoute } from './trace-route';
+import { HtRoute } from './ht-route';
 
 @Injectable({ providedIn: 'root' })
 export class NavigationService {
@@ -224,7 +224,7 @@ export class NavigationService {
   public getRouteConfig(
     path: string[],
     relativeTo: ActivatedRoute = this.getCurrentActivatedRoute()
-  ): TraceRoute | undefined {
+  ): HtRoute | undefined {
     const childRoutes =
       relativeTo === this.rootRoute() ? this.router.config : relativeTo.routeConfig && relativeTo.routeConfig.children;
 
@@ -255,7 +255,7 @@ export class NavigationService {
     return this.router.routerState.root;
   }
 
-  public currentRouteConfig(): TraceRoute {
+  public currentRouteConfig(): HtRoute {
     return throwIfNil(this.getCurrentActivatedRoute().routeConfig);
   }
 
@@ -325,7 +325,7 @@ export class NavigationService {
     });
   }
 
-  private findRouteConfig(path: string[], routes: TraceRoute[]): TraceRoute | undefined {
+  private findRouteConfig(path: string[], routes: HtRoute[]): HtRoute | undefined {
     if (path.length === 0) {
       return undefined;
     }
@@ -342,7 +342,7 @@ export class NavigationService {
     return this.router.routerState.snapshot.root.queryParamMap;
   }
 
-  private findMatchingRoute(pathSegment: string, routes: TraceRoute[]): TraceRoute | undefined {
+  private findMatchingRoute(pathSegment: string, routes: HtRoute[]): HtRoute | undefined {
     return routes
       .filter(
         // First, filter to anything that potentially matches
diff --git a/projects/common/src/navigation/trace-route.ts b/projects/common/src/navigation/trace-route.ts
diff --git a/projects/common/src/public-api.ts b/projects/common/src/public-api.ts
@@ -81,8 +81,8 @@ export * from './utilities/memoize/memoize.pipe';
 // Navigation
 export * from './navigation/breadcrumb';
 export * from './navigation/navigation.service';
-export * from './navigation/route-data';
-export * from './navigation/trace-route';
+export * from './navigation/ht-route-data';
+export * from './navigation/ht-route';
 
 // Operations
 export * from './utilities/operations/operation-utilities';
diff --git a/projects/components/src/breadcrumbs/breadcrumbs.service.test.ts b/projects/components/src/breadcrumbs/breadcrumbs.service.test.ts
@@ -1,5 +1,5 @@
 import { IconType } from '@hypertrace/assets-library';
-import { Breadcrumb, NavigationService, RouteData } from '@hypertrace/common';
+import { Breadcrumb, HtRouteData, NavigationService } from '@hypertrace/common';
 import { runFakeRxjs } from '@hypertrace/test-utils';
 import { createServiceFactory, mockProvider } from '@ngneat/spectator/jest';
 import { NEVER, Observable, of, throwError } from 'rxjs';
@@ -118,6 +118,6 @@ interface ActivatedRouteSnapshotBuildData {
 
 interface ActivatedRouteSnapshotMock {
   pathFromRoot: ActivatedRouteSnapshotMock[];
-  data: RouteData;
+  data: HtRouteData;
   url: { path: string }[];
 }
diff --git a/projects/distributed-tracing/src/pages/spans/span-list.page.module.ts b/projects/distributed-tracing/src/pages/spans/span-list.page.module.ts
@@ -1,13 +1,13 @@
 import { CommonModule } from '@angular/common';
 import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
-import { TraceRoute } from '@hypertrace/common';
+import { HtRoute } from '@hypertrace/common';
 import { NavigableDashboardModule } from '../../shared/dashboard/dashboard-wrapper/navigable-dashboard.module';
 import { TracingDashboardModule } from '../../shared/dashboard/tracing-dashboard.module';
 import { SpanListPageComponent } from './span-list.page.component';
 import { spanListDashboard } from './span-list.page.dashboard';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: '',
     component: SpanListPageComponent
diff --git a/projects/distributed-tracing/src/pages/trace-detail/trace-detail.page.module.ts b/projects/distributed-tracing/src/pages/trace-detail/trace-detail.page.module.ts
@@ -1,7 +1,7 @@
 import { CommonModule } from '@angular/common';
 import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
-import { FormattingModule, TraceRoute } from '@hypertrace/common';
+import { FormattingModule, HtRoute } from '@hypertrace/common';
 import {
   CopyShareableLinkToClipboardModule,
   DownloadJsonModule,
@@ -20,7 +20,7 @@ import { TraceSequenceComponent } from './sequence/trace-sequence.component';
 import { traceSequenceDashboard } from './sequence/trace-sequence.dashboard';
 import { TraceDetailPageComponent } from './trace-detail.page.component';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: `:${TraceDetailPageComponent.TRACE_ID_PARAM_NAME}`,
     component: TraceDetailPageComponent,
diff --git a/projects/observability/src/pages/api-trace-detail/api-trace-detail.page.module.ts b/projects/observability/src/pages/api-trace-detail/api-trace-detail.page.module.ts
@@ -1,7 +1,7 @@
 import { CommonModule } from '@angular/common';
 import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
-import { FormattingModule, TraceRoute } from '@hypertrace/common';
+import { FormattingModule, HtRoute } from '@hypertrace/common';
 import {
   ButtonModule,
   CopyShareableLinkToClipboardModule,
@@ -18,7 +18,7 @@ import { ApiTraceLogsComponent } from './logs/api-trace-logs.component';
 import { ApiTraceSequenceComponent } from './sequence/api-trace-sequence.component';
 import { apiTraceSequenceDashboard } from './sequence/api-trace-sequence.dashboard';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: `:${ApiTraceDetailPageComponent.TRACE_ID_PARAM_NAME}`,
     component: ApiTraceDetailPageComponent,
diff --git a/src/app/home/home.module.ts b/src/app/home/home.module.ts
@@ -1,15 +1,15 @@
 import { CommonModule } from '@angular/common';
 import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
-import { TraceRoute } from '@hypertrace/common';
+import { HtRoute } from '@hypertrace/common';
 import { NavigableDashboardModule } from '@hypertrace/distributed-tracing';
 import { ObservabilityDashboardModule } from '@hypertrace/observability';
 import { TotalErrorsLabelDataSourceModule } from './data/label/total-errors-label-data-source.module';
 import { ObserveSystemRadarDataSourceModule } from './data/system/observe-system-radar-data-source.module';
 import { HomeComponent } from './home.component';
 import { homeDashboard } from './home.dashboard';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: '',
     component: HomeComponent
diff --git a/src/app/routes/application-flow/application-flow-routing.module.ts b/src/app/routes/application-flow/application-flow-routing.module.ts
@@ -1,10 +1,10 @@
 import { RouterModule } from '@angular/router';
 
 import { NgModule } from '@angular/core';
-import { TraceRoute } from '@hypertrace/common';
+import { HtRoute } from '@hypertrace/common';
 import { ApplicationFlowComponent, ApplicationFlowModule } from '@hypertrace/observability';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: '',
     component: ApplicationFlowComponent
diff --git a/src/app/routes/backends/backend-detail/backend-detail-routing.module.ts b/src/app/routes/backends/backend-detail/backend-detail-routing.module.ts
@@ -1,4 +1,4 @@
-import { TraceRoute } from '@hypertrace/common';
+import { HtRoute } from '@hypertrace/common';
 
 import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
@@ -10,7 +10,7 @@ import {
   BackendTraceListComponent
 } from '@hypertrace/observability';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: '',
     component: BackendDetailComponent,
diff --git a/src/app/routes/backends/backends-routing.module.ts b/src/app/routes/backends/backends-routing.module.ts
@@ -1,15 +1,15 @@
 import { RouterModule } from '@angular/router';
 
 import { NgModule } from '@angular/core';
-import { TraceRoute } from '@hypertrace/common';
+import { HtRoute } from '@hypertrace/common';
 import {
   BackendDetailBreadcrumbResolver,
   BackendDetailService,
   BackendListComponent,
   BackendListModule
 } from '@hypertrace/observability';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: '',
     component: BackendListComponent
diff --git a/src/app/routes/endpoints/endpoint-detail/endpoint-detail-routing.module.ts b/src/app/routes/endpoints/endpoint-detail/endpoint-detail-routing.module.ts
@@ -1,4 +1,4 @@
-import { TraceRoute } from '@hypertrace/common';
+import { HtRoute } from '@hypertrace/common';
 
 import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
@@ -10,7 +10,7 @@ import {
   ApiTraceListComponent
 } from '@hypertrace/observability';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: '',
     component: ApiDetailComponent,
diff --git a/src/app/routes/endpoints/endpoint-routing.module.ts b/src/app/routes/endpoints/endpoint-routing.module.ts
@@ -1,14 +1,14 @@
 import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
-import { TraceRoute } from '@hypertrace/common';
+import { HtRoute } from '@hypertrace/common';
 import {
   ApiDetailBreadcrumbResolver,
   ApiDetailService,
   EndpointListComponent,
   EndpointListModule
 } from '@hypertrace/observability';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: '',
     component: EndpointListComponent
diff --git a/src/app/routes/explorer/explorer-routing.module.ts b/src/app/routes/explorer/explorer-routing.module.ts
@@ -1,11 +1,11 @@
 import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
-import { TraceRoute } from '@hypertrace/common';
+import { HtRoute } from '@hypertrace/common';
 import { FilterBuilderLookupService } from '@hypertrace/components';
 import { MetadataService } from '@hypertrace/distributed-tracing';
 import { ExplorerComponent, ExplorerDashboardBuilder, ExplorerModule } from '@hypertrace/observability';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: '',
     component: ExplorerComponent
diff --git a/src/app/routes/root-routing.module.ts b/src/app/routes/root-routing.module.ts
@@ -1,12 +1,12 @@
 import { NgModule } from '@angular/core';
 import { PreloadAllModules, RouterModule } from '@angular/router';
 import { IconType } from '@hypertrace/assets-library';
-import { ExternalUrlNavigator, TraceRoute } from '@hypertrace/common';
+import { ExternalUrlNavigator, HtRoute } from '@hypertrace/common';
 import { NotFoundComponent, NotFoundModule } from '@hypertrace/components';
 import { ObservabilityIconType } from '@hypertrace/observability';
 import { ApplicationFrameComponent } from '../application-frame/application-frame.component';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: '',
     children: [
diff --git a/src/app/routes/services/service-detail/service-detail-routing.module.ts b/src/app/routes/services/service-detail/service-detail-routing.module.ts
@@ -1,4 +1,4 @@
-import { TraceRoute } from '@hypertrace/common';
+import { HtRoute } from '@hypertrace/common';
 
 import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
@@ -11,7 +11,7 @@ import {
   ServiceTraceListComponent
 } from '@hypertrace/observability';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: '',
     component: ServiceDetailComponent,
diff --git a/src/app/routes/services/services-routing.module.ts b/src/app/routes/services/services-routing.module.ts
@@ -1,6 +1,6 @@
 import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
-import { TraceRoute } from '@hypertrace/common';
+import { HtRoute } from '@hypertrace/common';
 import {
   ApiDetailBreadcrumbResolver,
   ApiDetailService,
@@ -10,7 +10,7 @@ import {
   ServiceListModule
 } from '@hypertrace/observability';
 
-const ROUTE_CONFIG: TraceRoute[] = [
+const ROUTE_CONFIG: HtRoute[] = [
   {
     path: '',
     component: ServiceListComponent
diff --git a/src/app/shared/navigation/navigation.component.ts b/src/app/shared/navigation/navigation.component.ts
@@ -1,7 +1,7 @@
 import { ChangeDetectionStrategy, Component } from '@angular/core';
 import { ActivatedRoute } from '@angular/router';
 import { IconType } from '@hypertrace/assets-library';
-import { NavigationService, PreferenceService } from '@hypertrace/common';
+import { HtRoute, NavigationService, PreferenceService } from '@hypertrace/common';
 import { NavItemConfig, NavItemType } from '@hypertrace/components';
 import { ObservabilityIconType } from '@hypertrace/observability';
 import { Observable } from 'rxjs';
@@ -87,4 +87,24 @@ export class NavigationComponent {
   public onViewToggle(collapsed: boolean): void {
     this.preferenceService.set(NavigationComponent.COLLAPSED_PREFERENCE, collapsed);
   }
+
+  private decorateNavItem(navItem: NavItemConfig): NavItemConfig {
+    if (navItem.type !== NavItemType.Link) {
+      return { ...navItem };
+    }
+    const features = navItem.matchPaths
+      .map(path => this.navigationService.getRouteConfig([path], this.activatedRoute))
+      .filter((maybeRoute): maybeRoute is HtRoute => maybeRoute !== undefined)
+      .flatMap(route => this.getFeaturesForRoute(route))
+      .concat(navItem.features || []);
+
+    return {
+      ...navItem,
+      features: uniq(features)
+    };
+  }
+
+  private getFeaturesForRoute(route: HtRoute): string[] {
+    return (route.data && route.data.features) || [];
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`import { Observable } from 'rxjs';`
`2`	`2`	`import { Breadcrumb } from './breadcrumb';`
`3`	`3`
`4`		`-export interface RouteData {`
	`4`	`+export interface HtRouteData {`
`5`	`5`	`breadcrumb?: Breadcrumb \| Observable<Breadcrumb>;`
`6`	`6`	`features?: string[];`
`7`	`7`	`}`