Housekeeping: Move types from viewmodel to entities

Housekeeping: Moved entities from `view-model/page-did.d.ts` to entities Housekeeping: moved widget types to a new file in entities Housekeeping: Moved infrastructure types for charts Moved the infrastructure types for charts in widgets to the component-library, mirroring the structure of the StreamedTable `types.d.ts` file. Housekeeping: Moved RSE Types to Entity from viewmodels.
rucio · Sep 18, 2023 · 6762900 · 6762900
1 parent 2121282
commit 6762900
Show file tree

Hide file tree

Showing 17 changed files with 107 additions and 101 deletions.
diff --git a/src/component-library/Pages/DID/PageDIDMetadata.tsx b/src/component-library/Pages/DID/PageDIDMetadata.tsx
@@ -3,7 +3,7 @@ import { H3 } from "../../Text/Headings/H3";
 import { BoolTag } from "../../Tags/BoolTag";
 import { AvailabilityTag } from "../../Tags/AvailabilityTag";
 import { DIDTypeTag } from "../../Tags/DIDTypeTag";
-import { DIDType } from "@/lib/core/entity/rucio";
+import { DIDType, DIDKeyValuePair } from "@/lib/core/entity/rucio";
 import { NullTag } from "../../Tags/NullTag";
 
 // misc packages, react
@@ -14,7 +14,6 @@ import { twMerge } from "tailwind-merge"
 import { DIDAvailability } from "@/lib/core/entity/rucio"
 import { TableFilterString } from "../../StreamedTables/TableFilterString";
 import { DIDKeyValuePairsDataViewModel } from "@/lib/infrastructure/data/view-model/did";
-import { DIDKeyValuePair } from "@/lib/infrastructure/data/view-model/page-did";
 import { NormalTable } from "@/component-library/StreamedTables/NormalTable";
 
 export const PageDIDMetadata = (

diff --git a/src/component-library/Pages/Dashboard/Dashboard.tsx b/src/component-library/Pages/Dashboard/Dashboard.tsx
@@ -6,7 +6,7 @@ import { Checkbox } from "../../Button/Checkbox";
 import { WidgetOngoingrules } from "./Widgets/WidgetOngoingrules";
 import { RoleTag } from "../../Tags/RoleTag";
 import { Role } from "@/lib/core/entity/account";
-import { Ongoingrules, Usedquota } from "@/lib/infrastructure/data/view-model/widgets";
+import { Ongoingrules, Usedquota } from "@/lib/core/entity/widgets";
 import { WidgetUsedquota } from "./Widgets/WidgetUsedquota";
 import { useState, useEffect } from "react";
 import { Heading } from "../Helpers/Heading";

diff --git a/src/component-library/Pages/Dashboard/Widgets/WidgetOngoingrules.tsx b/src/component-library/Pages/Dashboard/Widgets/WidgetOngoingrules.tsx
@@ -11,7 +11,8 @@ import {
     Tooltip,
     Legend,
 } from 'chart.js';
-import { ChartData, Ongoingrules } from "@/lib/infrastructure/data/view-model/widgets";
+import { ChartData } from "../types";
+import { Ongoingrules } from "@/lib/core/entity/widgets";
 import {
     createColumnHelper, getCoreRowModel, getPaginationRowModel, useReactTable,
     Row, Column, getSortedRowModel

diff --git a/src/component-library/Pages/Dashboard/Widgets/WidgetUsedquota.tsx b/src/component-library/Pages/Dashboard/Widgets/WidgetUsedquota.tsx
@@ -1,5 +1,5 @@
 import { H4 } from "@/component-library/Text/Headings/H4";
-import { Usedquota } from "@/lib/infrastructure/data/view-model/widgets";
+import { Usedquota } from "@/lib/core/entity/widgets";
 import { twMerge } from "tailwind-merge";
 import { Chart as ChartJS, ArcElement, Tooltip, Legend } from 'chart.js';
 import { Pie } from 'react-chartjs-2';

diff --git a/src/component-library/Pages/Dashboard/types.d.ts b/src/component-library/Pages/Dashboard/types.d.ts
@@ -0,0 +1,16 @@
+
+/*
+* Widget Generics
+* These types are used to type a generic widget -> think of them as table column defs.
+*/
+export type ChartBasicDataset = {
+    label: string,
+    data: any[],
+    backgroundColor?: string, // Hex
+}
+
+export type ChartData<T extends ChartBasicDataset> = {
+    labels: string[],
+    datasets: T[],
+}
+
diff --git a/src/component-library/StreamedTables/NormalTable.stories.tsx b/src/component-library/StreamedTables/NormalTable.stories.tsx
@@ -2,7 +2,7 @@ import { StoryFn, Meta } from "@storybook/react";
 import { createColumnHelper } from "@tanstack/react-table";
 import { fixtureDIDKeyValuePair } from "test/fixtures/table-fixtures";
 import { NormalTable as N } from "./NormalTable";
-import { DIDKeyValuePair } from "@/lib/infrastructure/data/view-model/page-did";
+import { DIDKeyValuePair } from "@/lib/core/entity/rucio";
 import { TableFilterString } from "./TableFilterString";
 import { DIDAvailability, DIDType } from "@/lib/core/entity/rucio";
 import { twMerge } from "tailwind-merge";

diff --git a/src/lib/core/dto/did-dto.ts b/src/lib/core/dto/did-dto.ts
@@ -1,6 +1,5 @@
 import { BaseDTO, BaseStreamableDTO } from '@/lib/sdk/dto'
-import { DID, DIDMeta } from '@/lib/core/entity/rucio'
-import { DIDKeyValuePair, DIDRules } from '@/lib/infrastructure/data/view-model/page-did'
+import { DID, DIDKeyValuePair, DIDMeta, DIDRules } from '@/lib/core/entity/rucio'
 
 /**
  * Data Transfer Object for ListDIDsEndpoint

diff --git a/src/lib/core/entity/rucio.ts b/src/lib/core/entity/rucio.ts
@@ -23,6 +23,21 @@ export enum DIDAvailability {
     UNKNOWN = "Unknown",
 }
 
+export type DIDDatasetReplicas = {
+    rse: string;
+    rseblocked: RSEBlockState;
+    availability: boolean;
+    available_files: number;
+    available_bytes: number;
+    creation_date: DateISO;
+    last_accessed: DateISO;
+}
+
+// these are general key-value pairs including the metadata
+export type DIDKeyValuePair = { key: string; value: string | number | boolean | null }
+export type DIDKeyValuePairsData = {
+    data: DIDKeyValuePair[]
+}
 
 // copied from deployed rucio UI
 export type DIDMeta = {
@@ -47,6 +62,36 @@ export type DIDMeta = {
     filesize: number | null
 }
 
+export type DIDRules = {
+    id: string;
+    name: string;
+    state: RuleState;
+    account: string;
+    subscription?: {name: string, account: string}; // name and account together are unique for a subscription
+    last_modified: DateISO;
+}
+
+// File replica states for file DIDs
+export type FilereplicaState = {
+    rse: string
+    state: ReplicaState
+}
+
+// File replica states for dataset DIDs
+// stores summary information on the file replica states of the files within
+// a dataset DID: how many files are in each state
+// currently not in use since we only display scopenames
+export type FilereplicaStateD = {
+    scope: string,
+    name: string,
+    available: number,
+    unavailable: number,
+    copying: number,
+    being_deleted: number,
+    bad: number,
+    temporary_unavailable: number,
+}
+
 // results of web::flaskapi:v1::rses::RSEAccountUsageLimit::get
 export type RSEAccountUsageLimit = {
     rse_id: string;
@@ -155,6 +200,35 @@ export type RSE = {
     staging_area: boolean;
 }
 
+export type RSEProtocol = {
+    rseid: string,
+    scheme: string,
+    hostname: string,
+    port: number,
+    prefix: string,
+    impl: string,
+    priorities_lan: {
+        read: number,
+        write: number,
+        delete: number
+    },
+    priorities_wan: {
+        read: number,
+        write: number,
+        delete: number,
+        tpc: number,
+        tpcwrite: number,
+        tpcread: number,
+    },
+    updated_at: DateISO,
+    created_at: DateISO,
+}
+
+export type RSEAttribute = {
+    key: string,
+    value: string| DateISO | number | boolean | null,
+}
+
 /*
 ================================================================================
 ========================= ENUMS and DISCRETE TYPES =============================

diff --git a/...frastructure/data/view-model/widgets.d.ts → src/lib/core/entity/widgets.ts b/...frastructure/data/view-model/widgets.d.ts → src/lib/core/entity/widgets.ts
@@ -1,18 +1,3 @@
-/*
-* Widget Generics
-* These types are used to type a generic widget -> think of them as table column defs.
-*/
-export type ChartBasicDataset = {
-    label: string,
-    data: any[],
-    backgroundColor?: string, // Hex
-}
-
-export type ChartData<T extends ChartBasicDataset> = {
-    labels: string[],
-    datasets: T[],
-}
-
 /*
 * Widget Types
 * These types are used to type a specific widget -> they correspond to a table row

diff --git a/src/lib/core/usecase-models/did-keyvaluepairs-usecase-models.ts b/src/lib/core/usecase-models/did-keyvaluepairs-usecase-models.ts
@@ -1,4 +1,4 @@
-import { DIDKeyValuePair, DIDKeyValuePairsData } from "@/lib/infrastructure/data/view-model/page-did";
+import { DIDKeyValuePair, DIDKeyValuePairsData } from "../entity/rucio";
 import { BaseErrorResponseModel, BaseResponseModel } from "@/lib/sdk/usecase-models";
 
 export interface DIDKeyValuePairsDataRequest {

diff --git a/src/lib/core/usecase-models/list-did-rules-usecase-models.ts b/src/lib/core/usecase-models/list-did-rules-usecase-models.ts
@@ -1,4 +1,4 @@
-import { DIDRules } from "@/lib/infrastructure/data/view-model/page-did";
+import { DIDRules } from "../entity/rucio";
 import { BaseErrorResponseModel, BaseResponseModel } from "@/lib/sdk/usecase-models";
 
 export interface ListDIDRulesRequest {

diff --git a/src/lib/infrastructure/data/view-model/did.ts b/src/lib/infrastructure/data/view-model/did.ts
@@ -1,6 +1,8 @@
-import { DID, DIDLong, DIDMeta, DIDType, ReplicaState, RuleState } from "@/lib/core/entity/rucio";
+import {
+    DID, DIDLong, DIDMeta, DIDType, ReplicaState, RuleState,   DIDRules, DIDKeyValuePairsData,
+    FilereplicaState, FilereplicaStateD, DIDDatasetReplicas
+} from "@/lib/core/entity/rucio";
 import { BaseViewModel } from "@/lib/sdk/view-models";
-import { DIDRules, DIDDatasetReplicas, FilereplicaState, FilereplicaStateD, DIDKeyValuePairsData } from "./page-did";
 
 export interface DIDViewModel extends DID, BaseViewModel {}
 export interface DIDLongViewModel extends DIDLong, BaseViewModel {}

diff --git a/src/lib/infrastructure/data/view-model/page-did.d.ts b/src/lib/infrastructure/data/view-model/page-did.d.ts
@@ -2,47 +2,5 @@ import { DateISO, ReplicaState, RSEBlockState } from "@/lib/core/entity/rucio"
 import { RuleState } from "@/lib/core/entity/rucio"
 import { ObjectFlags } from "typescript"
 
-// File replica states for file DIDs
-export type FilereplicaState = {
-    rse: string
-    state: ReplicaState
-}
 
-// File replica states for dataset DIDs
-// stores summary information on the file replica states of the files within
-// a dataset DID: how many files are in each state
-export type FilereplicaStateD = {
-    scope: string,
-    name: string,
-    available: number,
-    unavailable: number,
-    copying: number,
-    being_deleted: number,
-    bad: number,
-    temporary_unavailable: number,
-}
 
-export type DIDDatasetReplicas = {
-    rse: string;
-    rseblocked: RSEBlockState;
-    availability: boolean;
-    available_files: number;
-    available_bytes: number;
-    creation_date: DateISO;
-    last_accessed: DateISO;
-}
-
-// these are general key-value pairs including the metadata
-export type DIDKeyValuePair = { key: string; value: string | number | boolean | null }
-export type DIDKeyValuePairsData = {
-    data: DIDKeyValuePair[]
-}
-
-export type DIDRules = {
-    id: string;
-    name: string;
-    state: RuleState;
-    account: string;
-    subscription?: {name: string, account: string}; // name and account together are unique for a subscription
-    last_modified: DateISO;
-}
diff --git a/src/lib/infrastructure/data/view-model/rse.ts b/src/lib/infrastructure/data/view-model/rse.ts
@@ -1,35 +1,7 @@
 import { DateISO } from "@/lib/core/entity/rucio"
 import { BaseViewModel } from "@/lib/sdk/view-models"
-import { RSE, RSEAccountUsageLimit } from "@/lib/core/entity/rucio"
+import { RSE, RSEAttribute, RSEAccountUsageLimit, RSEProtocol } from "@/lib/core/entity/rucio"
 
-export type RSEProtocol = {
-    rseid: string,
-    scheme: string,
-    hostname: string,
-    port: number,
-    prefix: string,
-    impl: string,
-    priorities_lan: {
-        read: number,
-        write: number,
-        delete: number
-    },
-    priorities_wan: {
-        read: number,
-        write: number,
-        delete: number,
-        tpc: number,
-        tpcwrite: number,
-        tpcread: number,
-    },
-    updated_at: DateISO,
-    created_at: DateISO,
-}
-
-export type RSEAttribute = {
-    key: string,
-    value: string| DateISO | number | boolean | null,
-}
 
 export interface RSEViewModel extends RSE, BaseViewModel {}
 

diff --git a/src/lib/infrastructure/gateway/did-gateway/endpoints/get-did-keyvaluepairs-endpoint.ts b/src/lib/infrastructure/gateway/did-gateway/endpoints/get-did-keyvaluepairs-endpoint.ts
@@ -1,5 +1,5 @@
 import { DIDKeyValuePairsDTO } from "@/lib/core/dto/did-dto";
-import { DIDKeyValuePair } from "@/lib/infrastructure/data/view-model/page-did";
+import { DIDKeyValuePair } from "@/lib/core/entity/rucio";
 import { BaseEndpoint } from "@/lib/sdk/gateway-endpoints";
 import { HTTPRequest } from "@/lib/sdk/http";
 import { Response } from "node-fetch";

diff --git a/test/fixtures/table-fixtures.ts b/test/fixtures/table-fixtures.ts
@@ -12,7 +12,7 @@ import { SubscriptionRuleStatesViewModel, SubscriptionViewModel } from '@/lib/in
 import { BaseViewModel } from '@/lib/sdk/view-models';
 import { DIDDatasetReplicasViewModel, DIDKeyValuePairsDataViewModel, DIDLongViewModel, DIDMetaViewModel, DIDRulesViewModel, DIDViewModel, FilereplicaStateDViewModel, FilereplicaStateViewModel } from '@/lib/infrastructure/data/view-model/did';
 import { RuleMetaViewModel, RulePageLockEntryViewModel, RuleViewModel } from '@/lib/infrastructure/data/view-model/rule';
-import { DIDKeyValuePair } from '@/lib/infrastructure/data/view-model/page-did';
+import { DIDKeyValuePair } from '@/lib/core/entity/rucio';
 
 export function mockUseComDOM<T extends BaseViewModel>(data: T[]): UseComDOM<T> {
     return {

diff --git a/test/fixtures/widget-fixtures.ts b/test/fixtures/widget-fixtures.ts
@@ -1,4 +1,4 @@
-import { Ongoingrules, Usedquota } from "@/lib/infrastructure/data/view-model/widgets";
+import { Ongoingrules, Usedquota } from "@/lib/core/entity/widgets";
 import { faker } from "@faker-js/faker";
 import { createRSEName } from "./table-fixtures";