feat(dh): apollo data source

apps/dh/api-dh/source/DataHub.WebApi.Tests/Snapshots/SchemaTests.ChangeTest.verified.graphql

@@ -172,6 +172,24 @@ type CalculationProgress {
   status: ProgressStatus!
 }
 
+"A connection to a list of items."
+type CalculationsConnection {
+  "Information to aid in pagination."
+  pageInfo: PageInfo!
+  "A list of edges."
+  edges: [CalculationsEdge!]
+  "A flattened list of the nodes."
+  nodes: [Calculation!]
+}
+
+"An edge in a connection."
+type CalculationsEdge {
+  "A cursor for use in pagination."
+  cursor: String!
+  "The item at the end of the edge."
+  node: Calculation!
+}
+
 type CancelScheduledCalculationPayload {
   boolean: Boolean
 }
@@ -405,6 +423,18 @@ type OrganizationAuditedChangeAuditLogDto {
   previousValue: String
 }
 
+"Information about pagination in a connection."
+type PageInfo {
+  "Indicates whether more edges exist following the set defined by the clients arguments."
+  hasNextPage: Boolean!
+  "Indicates whether more edges exist prior the set defined by the clients arguments."
+  hasPreviousPage: Boolean!
+  "When paginating backwards, the cursor to continue."
+  startCursor: String
+  "When paginating forwards, the cursor to continue."
+  endCursor: String
+}
+
 type Permission {
   userRoles: [UserRoleDto!]!
   id: Int!
@@ -447,7 +477,7 @@ type Query {
   filteredActors: [Actor!]!
   selectionActors: [SelectionActorDto!]!
   calculationById(id: UUID!): Calculation!
-  calculations(input: CalculationQueryInput!): [Calculation!]!
+  calculations(input: CalculationQueryInput! filter: String "Returns the first _n_ elements from the list." first: Int "Returns the elements in the list that come after the specified cursor." after: String "Returns the last _n_ elements from the list." last: Int "Returns the elements in the list that come before the specified cursor." before: String order: [CalculationSortInput!]): CalculationsConnection
   latestBalanceFixing(period: DateRange!): Calculation @deprecated(reason: "Use `latestCalculation` instead")
   latestCalculation(period: DateRange! calculationType: CalculationType!): Calculation
   esettServiceStatus: [ReadinessStatusDto!]!
@@ -712,6 +742,17 @@ input CalculationQueryInput {
   period: DateRange
 }
 
+"An immutable calculation."
+input CalculationSortInput {
+  "Defines the wholesale calculation type"
+  calculationType: SortEnumType
+  isInternalCalculation: SortEnumType
+  executionTime: SortEnumType
+  status: SortEnumType
+  period: SortEnumType
+  executionType: SortEnumType
+}
+
 input CancelScheduledCalculationInput {
   calculationId: UUID!
 }
@@ -1208,6 +1249,11 @@ enum SortDirection {
   DESCENDING
 }
 
+enum SortEnumType {
+  ASC
+  DESC
+}
+
 enum UserAuditedChange {
   FIRST_NAME
   LAST_NAME

apps/dh/api-dh/source/DataHub.WebApi.Tests/TestServices/GraphQLTestService.cs

@@ -43,6 +43,7 @@ public GraphQLTestService()
             .AddMutationConventions(applyToAllMutations: true)
             .AddMutationType<Mutation>()
             .AddTypes()
+            .AddSorting()
             .BindRuntimeType<NodaTime.Interval, DateRangeType>()
             .Services
             .AddSingleton(WholesaleClientV3Mock.Object)

apps/dh/api-dh/source/DataHub.WebApi/DataHub.WebApi.csproj

@@ -34,11 +34,11 @@ limitations under the License.
   </PropertyGroup>
 
   <Target Name="NSwag" AfterTargets="PostBuildEvent" Condition="'$(Configuration)' == 'Debug'">
-    <Exec WorkingDirectory="$(ProjectDir)" EnvironmentVariables="ASPNETCORE_ENVIRONMENT=Development" Command="$(NSwagExe_Net80) run Clients/Wholesale/V3/nswag.json /variables:Configuration=$(Configuration)" Condition="!Exists('Clients/Wholesale/V3/swagger.json')"/>
-    <Exec WorkingDirectory="$(ProjectDir)" EnvironmentVariables="ASPNETCORE_ENVIRONMENT=Development" Command="$(NSwagExe_Net80) run Clients/EDI/B2CWebApi/V1/nswag.json /variables:Configuration=$(Configuration)" Condition="!Exists('Clients/EDI/B2CWebApi/V1/swagger.json')"/>
-    <Exec WorkingDirectory="$(ProjectDir)" EnvironmentVariables="ASPNETCORE_ENVIRONMENT=Development" Command="$(NSwagExe_Net80) run Clients/ESettExchange/V1/nswag.json /variables:Configuration=$(Configuration) &amp;&amp; powershell -File default-api-version-param.ps1 Clients/ESettExchange/V1/ESettExchangeClient.cs &amp;&amp; dotnet build" Condition="!Exists('Clients/ESettExchange/V1/swagger.json')"/>
-    <Exec WorkingDirectory="$(ProjectDir)" EnvironmentVariables="ASPNETCORE_ENVIRONMENT=Development" Command="$(NSwagExe_Net80) run Clients/ImbalancePrices/V1/nswag.json /variables:Configuration=$(Configuration) &amp;&amp; powershell -File default-api-version-param.ps1 Clients/ImbalancePrices/V1/ImbalancePricesClient.cs &amp;&amp; dotnet build" Condition="!Exists('Clients/ImbalancePrices/V1/swagger.json')"/>
-    <Exec WorkingDirectory="$(ProjectDir)" EnvironmentVariables="ASPNETCORE_ENVIRONMENT=Development" Command="$(NSwagExe_Net80) run Clients/MarketParticipant/V1/nswag.json /variables:Configuration=$(Configuration) &amp;&amp; powershell -File default-api-version-param.ps1 Clients/MarketParticipant/V1/MarketParticipantClient.cs &amp;&amp; dotnet build" Condition="!Exists('Clients/MarketParticipant/V1/swagger.json')"/>
+    <Exec WorkingDirectory="$(ProjectDir)" EnvironmentVariables="ASPNETCORE_ENVIRONMENT=Development" Command="$(NSwagExe_Net80) run Clients/Wholesale/V3/nswag.json /variables:Configuration=$(Configuration)" Condition="!Exists('Clients/Wholesale/V3/swagger.json')" />
+    <Exec WorkingDirectory="$(ProjectDir)" EnvironmentVariables="ASPNETCORE_ENVIRONMENT=Development" Command="$(NSwagExe_Net80) run Clients/EDI/B2CWebApi/V1/nswag.json /variables:Configuration=$(Configuration)" Condition="!Exists('Clients/EDI/B2CWebApi/V1/swagger.json')" />
+    <Exec WorkingDirectory="$(ProjectDir)" EnvironmentVariables="ASPNETCORE_ENVIRONMENT=Development" Command="$(NSwagExe_Net80) run Clients/ESettExchange/V1/nswag.json /variables:Configuration=$(Configuration) &amp;&amp; powershell -File default-api-version-param.ps1 Clients/ESettExchange/V1/ESettExchangeClient.cs &amp;&amp; dotnet build" Condition="!Exists('Clients/ESettExchange/V1/swagger.json')" />
+    <Exec WorkingDirectory="$(ProjectDir)" EnvironmentVariables="ASPNETCORE_ENVIRONMENT=Development" Command="$(NSwagExe_Net80) run Clients/ImbalancePrices/V1/nswag.json /variables:Configuration=$(Configuration) &amp;&amp; powershell -File default-api-version-param.ps1 Clients/ImbalancePrices/V1/ImbalancePricesClient.cs &amp;&amp; dotnet build" Condition="!Exists('Clients/ImbalancePrices/V1/swagger.json')" />
+    <Exec WorkingDirectory="$(ProjectDir)" EnvironmentVariables="ASPNETCORE_ENVIRONMENT=Development" Command="$(NSwagExe_Net80) run Clients/MarketParticipant/V1/nswag.json /variables:Configuration=$(Configuration) &amp;&amp; powershell -File default-api-version-param.ps1 Clients/MarketParticipant/V1/MarketParticipantClient.cs &amp;&amp; dotnet build" Condition="!Exists('Clients/MarketParticipant/V1/swagger.json')" />
   </Target>
 
   <Target Name="PostBuild" AfterTargets="PostBuildEvent">
@@ -51,6 +51,7 @@ limitations under the License.
     <PackageReference Include="HotChocolate.AspNetCore" Version="13.9.0" />
     <PackageReference Include="HotChocolate.AspNetCore.Authorization" Version="13.9.0" />
     <PackageReference Include="HotChocolate.AspNetCore.CommandLine" Version="13.9.0" />
+    <PackageReference Include="HotChocolate.Data" Version="13.9.0" />
     <PackageReference Include="HotChocolate.Diagnostics" Version="13.9.0" />
     <PackageReference Include="HotChocolate.Types.Analyzers" Version="13.9.0">
       <PrivateAssets>all</PrivateAssets>

apps/dh/api-dh/source/DataHub.WebApi/GraphQL/Query/CalculationQuery.cs

@@ -26,10 +26,28 @@ public async Task<CalculationDto> GetCalculationByIdAsync(
         [Service] IWholesaleClient_V3 client) =>
         await client.GetCalculationAsync(id);
 
+    [UsePaging]
+    [UseSorting]
     public async Task<IEnumerable<CalculationDto>> GetCalculationsAsync(
         CalculationQueryInput input,
-        [Service] IWholesaleClient_V3 client) =>
-        await client.QueryCalculationsAsync(input);
+        string? filter,
+        [Service] IWholesaleClient_V3 client)
+    {
+        if (string.IsNullOrWhiteSpace(filter))
+        {
+            return await client.QueryCalculationsAsync(input);
+        }
+
+        try
+        {
+            var calculationId = Guid.Parse(filter);
+            return [await client.GetCalculationAsync(calculationId)];
+        }
+        catch (Exception)
+        {
+            return [];
+        }
+    }
 
     [GraphQLDeprecated("Use `latestCalculation` instead")]
     public async Task<CalculationDto?> GetLatestBalanceFixingAsync(

apps/dh/api-dh/source/DataHub.WebApi/GraphQL/Subscription/CalculationSubscription.cs

@@ -22,27 +22,22 @@ namespace Energinet.DataHub.WebApi.GraphQL.Subscription;
 
 public class Subscription
 {
-    public IObservable<CalculationDto> OnCalculationProgressAsync(
-        CalculationQueryInput input,
+    public IObservable<CalculationDto> OnCalculationUpdatedAsync(
         [Service] ITopicEventReceiver eventReceiver,
         [Service] IWholesaleClient_V3 client,
         CancellationToken cancellationToken)
     {
-        var states = input.States ?? [];
         var calculationIdStream = eventReceiver
-            .Observe<Guid>(nameof(Mutation.Mutation.CreateCalculationAsync), cancellationToken);
-
-        // Prevent starting a subscription for calculations that are not in progress
-        if (states.Length > 0 && !states.Any(IsInProgress))
-        {
-            return Observable.Empty<CalculationDto>();
-        }
+          .Observe<Guid>(nameof(Mutation.Mutation.CreateCalculationAsync), cancellationToken);
 
         // Filter the list of states to only include those that are in progress
-        var inProgressCalculations = input with { States = states.Where(IsInProgress).ToArray() };
+        var input = new CalculationQueryInput()
+        {
+            States = Enum.GetValues<CalculationOrchestrationState>().Where(IsInProgress).ToArray(),
+        };
 
         return Observable
-            .FromAsync(() => client.QueryCalculationsAsync(inProgressCalculations))
+            .FromAsync(() => client.QueryCalculationsAsync(input))
             .SelectMany(calculations => calculations)
             .Select(calculation => calculation.CalculationId)
             .Merge(calculationIdStream)
@@ -55,8 +50,8 @@ public IObservable<CalculationDto> OnCalculationProgressAsync(
                 .TakeUntil(calculation => !IsInProgress(calculation.OrchestrationState)));
     }
 
-    [Subscribe(With = nameof(OnCalculationProgressAsync))]
-    public CalculationDto CalculationProgress([EventMessage] CalculationDto calculation) =>
+    [Subscribe(With = nameof(OnCalculationUpdatedAsync))]
+    public CalculationDto CalculationUpdated([EventMessage] CalculationDto calculation) =>
         calculation;
 
     public bool IsInProgress(CalculationOrchestrationState state) =>

apps/dh/api-dh/source/DataHub.WebApi/GraphQL/Types/Calculation/CalculationSortType.cs

@@ -0,0 +1,36 @@
+// Copyright 2020 Energinet DataHub A/S
+//
+// Licensed under the Apache License, Version 2.0 (the "License2");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using Energinet.DataHub.WebApi.Clients.Wholesale.v3;
+using Energinet.DataHub.WebApi.GraphQL.Enums;
+using HotChocolate.Data.Sorting;
+
+namespace Energinet.DataHub.WebApi.GraphQL.Types.Calculation;
+
+public class CalculationSortType : SortInputType<CalculationDto>
+{
+    protected override void Configure(ISortInputTypeDescriptor<CalculationDto> descriptor)
+    {
+        descriptor.Name("CalculationSortInput");
+        descriptor.BindFieldsExplicitly();
+        descriptor.Field(f => f.CalculationType);
+        descriptor.Field(f => f.IsInternalCalculation);
+        descriptor.Field(f => f.ExecutionTimeStart ?? f.ScheduledAt).Name("executionTime");
+        descriptor.Field(f => f.OrchestrationState).Name("status");
+        descriptor.Field(f => f.PeriodStart).Name("period");
+        descriptor
+            .Field(f => f.IsInternalCalculation ? CalculationExecutionType.Internal : CalculationExecutionType.External)
+            .Name("executionType");
+    }
+}

apps/dh/api-dh/source/DataHub.WebApi/Registration/GraphQLRegistrationExtensions.cs

@@ -17,6 +17,7 @@
 using Energinet.DataHub.WebApi.GraphQL.Scalars;
 using Energinet.DataHub.WebApi.GraphQL.Subscription;
 using HotChocolate.Execution.Configuration;
+using HotChocolate.Types.Pagination;
 using NodaTime;
 
 namespace Energinet.DataHub.WebApi.Registration;
@@ -35,6 +36,13 @@ public static IRequestExecutorBuilder AddGraphQLServices(this IServiceCollection
             .AddMutationType<Mutation>()
             .AddSubscriptionType<Subscription>()
             .AddTypes()
-            .BindRuntimeType<Interval, DateRangeType>();
+            .AddSorting()
+            .BindRuntimeType<Interval, DateRangeType>()
+            .SetPagingOptions(new PagingOptions
+            {
+                RequirePagingBoundaries = true,
+                MaxPageSize = 250,
+                IncludeTotalCount = true,
+            });
     }
 }

codegen.ts

@@ -14,6 +14,7 @@ const config: CodegenConfig = {
         'typed-document-node',
         'typescript-msw',
         '@homebound/graphql-typescript-scalar-type-policies',
+        'libs/dh/shared/feature-graphql-codegen/dist/apollo-data-source.js',
       ],
       config: {
         nonOptionalTypename: true,

libs/dh/admin/feature-user-roles/src/lib/overview/dh-roles-overview-table.component.ts

@@ -113,7 +113,7 @@ export class DhRolesTabTableComponent implements OnChanges, AfterViewInit {
 
   ngOnChanges() {
     this.dataSource.data = this.roles();
-    this.dataSource.paginator = this.paginator()?.instance;
+    this.dataSource.paginator = this.paginator()?.instance();
     this.updateFilteredAndSortedData();
   }
 
@@ -122,7 +122,7 @@ export class DhRolesTabTableComponent implements OnChanges, AfterViewInit {
       this.updateFilteredAndSortedData();
     });
 
-    this.dataSource.paginator = this.paginator()?.instance;
+    this.dataSource.paginator = this.paginator()?.instance();
 
     this.dataSource.sortingDataAccessor = (data, header) =>
       header === 'marketRole'

libs/dh/globalization/assets-localization/src/assets/i18n/da.json

@@ -901,7 +901,7 @@
       "emptyMessage": "Prøv at ændre dine søgeindstillinger",
       "errorTitle": "{{shared.error.title}}",
       "errorMessage": "{{shared.error.message}}",
-      "search": "Søg",
+      "search": "Søg på ID",
       "new": "Ny beregning",
       "scheduledCalculationTooltip": "Det faktiske tidspunkt kan afvige fra det planlagte tidspunkt",
       "create": {

libs/dh/globalization/assets-localization/src/assets/i18n/en.json

@@ -902,7 +902,7 @@
       "emptyMessage": "Try changing the search criteria",
       "errorTitle": "{{shared.error.title}}",
       "errorMessage": "{{shared.error.message}}",
-      "search": "Search",
+      "search": "Search by ID",
       "new": "New calculation",
       "scheduledCalculationTooltip": "The actual time may differ from the scheduled time",
       "create": {

libs/dh/shared/data-access-mocks/src/lib/wholesale.ts

@@ -606,7 +606,21 @@ function getCalculations() {
     } else {
       await delay(mswConfig.delay);
       return HttpResponse.json({
-        data: { __typename: 'Query', calculations: mockedCalculations },
+        data: {
+          __typename: 'Query',
+          calculations: {
+            __typename: 'CalculationsConnection',
+            pageInfo: {
+              __typename: 'PageInfo',
+              hasNextPage: true,
+              hasPreviousPage: false,
+              startCursor: 'startCursor',
+              endCursor: 'endCursor',
+            },
+            totalCount: mockedCalculations.length,
+            nodes: mockedCalculations,
+          },
+        },
       });
       //return res(ctx.status(404), ctx.delay(300));
     }

libs/dh/shared/domain/project.json

@@ -20,6 +20,8 @@
       "executor": "nx:run-commands",
       "cache": true,
       "inputs": [
+        "{workspaceRoot}/codegen.ts",
+        "{workspaceRoot}/libs/dh/shared/feature-graphql-codegen/**/*.js",
         "{workspaceRoot}/libs/**/*.graphql",
         "!{projectRoot}/src/lib/generated/graphql.ts"
       ],
@@ -30,6 +32,8 @@
       "executor": "nx:run-commands",
       "cache": false,
       "inputs": [
+        "{workspaceRoot}/codegen.ts",
+        "{workspaceRoot}/libs/dh/shared/util-apollo/src/lib/codegen.js",
         "{workspaceRoot}/libs/**/*.graphql",
         "!{projectRoot}/src/lib/generated/graphql.ts"
       ],

libs/dh/shared/feature-graphql-codegen/.eslintrc.json

@@ -0,0 +1,36 @@
+{
+  "extends": ["../../../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*", "dist/**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "extends": [
+        "plugin:@nx/angular",
+        "plugin:@angular-eslint/template/process-inline-templates"
+      ],
+      "rules": {
+        "@angular-eslint/directive-selector": [
+          "error",
+          {
+            "type": "attribute",
+            "prefix": "dh",
+            "style": "camelCase"
+          }
+        ],
+        "@angular-eslint/component-selector": [
+          "error",
+          {
+            "type": "element",
+            "prefix": "dh",
+            "style": "kebab-case"
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.html"],
+      "extends": ["plugin:@nx/angular-template"],
+      "rules": {}
+    }
+  ]
+}

libs/dh/shared/feature-graphql-codegen/README.md

@@ -0,0 +1,17 @@
+# Graphql Codegen
+
+This library is for custom GraphQL Codegen plugins.
+
+## Development
+
+Paths to plugins are specificed in the `codegen.ts` file. These files must be in CommonJS
+format, which is why this project has a custom `build` target. When the desired changes
+have been made to the TypeScript file, run the below command to generate the CommonJS
+file in the `dist` folder:
+
+```sh
+bun nx run dh-shared-feature-graphql-codegen:build 
+```
+
+_For convenience and a simpler setup, the contents of the `dist` folder is intentionally
+checked into source control._