Error when running the newer devgateway

[dhrumil83]

We updated our code based on the GA features PR.

When running the devgateway, running into this error.
It could be we missed something while porting the code, but it's hard to tell what's missing based on the error.

[2024-12-02 16:05:07.834] [Information] Starting DevGateway...
[2024-12-02 16:05:19.530] [Information] Interactive user AAD token received
[2024-12-02 16:05:19.536] [Information] Registering dev instance...
fail: Microsoft.Extensions.Hosting.Internal.Host[11]
      Hosting failed to start
      Microsoft.Fabric.Relay.Connections.Services.Exceptions.DevInstanceRegistrationFailedException: Dev instance registration call was not successful, HTTP status code: InternalServerError, reason: Internal Server Error, response: {"requestId":"1de37b51-4f8e-490b-85f4-103be2015692","errorCode":"InternalServerError","message":"An error occured"}
         at Microsoft.Fabric.Relay.Connections.Services.PbiSharedClient.RegisterCurrentDevInstanceAsync(WorkloadRegistrationRequest requestBody, Nullable`1 workspaceGuid, Nullable`1 capacityGuid, String accessToken)
         at Microsoft.Fabric.Relay.Connections.DevConnection.RegisterDevInstanceAsync(String userToken)
         at Microsoft.Fabric.Relay.Connections.DevConnection.InitializeAsync()
         at Microsoft.Fabric.Relay.Connections.DevConnection.Microsoft.Extensions.Hosting.IHostedService.StartAsync(CancellationToken cancellationToken)
         at Microsoft.Extensions.Hosting.Internal.Host.<StartAsync>b__15_1(IHostedService service, CancellationToken token)
         at Microsoft.Extensions.Hosting.Internal.Host.ForeachService[T](IEnumerable`1 services, CancellationToken token, Boolean concurrent, Boolean abortOnFirstException, List`1 exceptions, Func`3 operation)
[2024-12-02 16:05:19.899] [Information] Stop  relay listener
[2024-12-02 16:05:19.901] [Information] Stop  relay listener
Unhandled exception. Microsoft.Fabric.Relay.Connections.Services.Exceptions.DevInstanceRegistrationFailedException: Dev instance registration call was not successful, HTTP status code: InternalServerError, reason: Internal Server Error, response: {"requestId":"1de37b51-4f8e-490b-85f4-103be2015692","errorCode":"InternalServerError","message":"An error occured"}
   at Microsoft.Fabric.Relay.Connections.Services.PbiSharedClient.RegisterCurrentDevInstanceAsync(WorkloadRegistrationRequest requestBody, Nullable`1 workspaceGuid, Nullable`1 capacityGuid, String accessToken)
   at Microsoft.Fabric.Relay.Connections.DevConnection.RegisterDevInstanceAsync(String userToken)
   at Microsoft.Fabric.Relay.Connections.DevConnection.InitializeAsync()
   at Microsoft.Fabric.Relay.Connections.DevConnection.Microsoft.Extensions.Hosting.IHostedService.StartAsync(CancellationToken cancellationToken)
   at Microsoft.Extensions.Hosting.Internal.Host.<StartAsync>b__15_1(IHostedService service, CancellationToken token)
   at Microsoft.Extensions.Hosting.Internal.Host.ForeachService[T](IEnumerable`1 services, CancellationToken token, Boolean concurrent, Boolean abortOnFirstException, List`1 exceptions, Func`3 operation)
   at Microsoft.Extensions.Hosting.Internal.Host.<StartAsync>g__LogAndRethrow|15_3(<>c__DisplayClass15_0& )
   at Microsoft.Extensions.Hosting.Internal.Host.StartAsync(CancellationToken cancellationToken)
   at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(IHost host, CancellationToken token)
   at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(IHost host, CancellationToken token)
   at Microsoft.Fabric.Workloads.DevGateway.Program.Main(String[] args)
   at Microsoft.Fabric.Workloads.DevGateway.Program.<Main>(String[] args)

Note: We are trying to run devgateway by downloading the latest updated zip file, and not via docker.

Any suggestions?

[dhrumil83]

Was able to repro this with the workload sample.

Remove the newSection and the corresponding string from the 2 string files(key: NewSection_Custom_Action_Title)
https://github.com/microsoft/Microsoft-Fabric-workload-development-sample/blob/main/Frontend/Package/Product.json#L20-L31

We have not needed newSection use case and have removed it.
Note: The FE checks pass, but devgateway check fails with this.

Run the devgateway and see a similar error as noted above.

[2024-12-03 17:21:11.362] [Information] Starting DevGateway...
[2024-12-03 17:21:23.312] [Information] Interactive user AAD token received
[2024-12-03 17:21:23.319] [Information] Registering dev instance...
fail: Microsoft.Extensions.Hosting.Internal.Host[11]
      Hosting failed to start
      Microsoft.Fabric.Relay.Connections.Services.Exceptions.DevInstanceRegistrationFailedException: Dev instance registration call was not successful, HTTP status code: InternalServerError, reason: Internal Server Error, response: {"requestId":"5c5fca89-cdaa-4339-b5cc-aa30c4ae7a54","errorCode":"InternalServerError","message":"An error occured"}
         at Microsoft.Fabric.Relay.Connections.Services.PbiSharedClient.RegisterCurrentDevInstanceAsync(WorkloadRegistrationRequest requestBody, Nullable`1 workspaceGuid, Nullable`1 capacityGuid, String accessToken)
         at Microsoft.Fabric.Relay.Connections.DevConnection.RegisterDevInstanceAsync(String userToken)
         at Microsoft.Fabric.Relay.Connections.DevConnection.InitializeAsync()
         at Microsoft.Fabric.Relay.Connections.DevConnection.Microsoft.Extensions.Hosting.IHostedService.StartAsync(CancellationToken cancellationToken)
         at Microsoft.Extensions.Hosting.Internal.Host.<StartAsync>b__15_1(IHostedService service, CancellationToken token)
         at Microsoft.Extensions.Hosting.Internal.Host.ForeachService[T](IEnumerable`1 services, CancellationToken token, Boolean concurrent, Boolean abortOnFirstException, List`1 exceptions, Func`3 operation)
[2024-12-03 17:21:23.843] [Information] Stop  relay listener
[2024-12-03 17:21:23.844] [Information] Stop  relay listener
Unhandled exception. Microsoft.Fabric.Relay.Connections.Services.Exceptions.DevInstanceRegistrationFailedException: Dev instance registration call was not successful, HTTP status code: InternalServerError, reason: Internal Server Error, response: {"requestId":"5c5fca89-cdaa-4339-b5cc-aa30c4ae7a54","errorCode":"InternalServerError","message":"An error occured"}
   at Microsoft.Fabric.Relay.Connections.Services.PbiSharedClient.RegisterCurrentDevInstanceAsync(WorkloadRegistrationRequest requestBody, Nullable`1 workspaceGuid, Nullable`1 capacityGuid, String accessToken)
   at Microsoft.Fabric.Relay.Connections.DevConnection.RegisterDevInstanceAsync(String userToken)
   at Microsoft.Fabric.Relay.Connections.DevConnection.InitializeAsync()
   at Microsoft.Fabric.Relay.Connections.DevConnection.Microsoft.Extensions.Hosting.IHostedService.StartAsync(CancellationToken cancellationToken)
   at Microsoft.Extensions.Hosting.Internal.Host.<StartAsync>b__15_1(IHostedService service, CancellationToken token)
   at Microsoft.Extensions.Hosting.Internal.Host.ForeachService[T](IEnumerable`1 services, CancellationToken token, Boolean concurrent, Boolean abortOnFirstException, List`1 exceptions, Func`3 operation)
   at Microsoft.Extensions.Hosting.Internal.Host.<StartAsync>g__LogAndRethrow|15_3(<>c__DisplayClass15_0& )
   at Microsoft.Extensions.Hosting.Internal.Host.StartAsync(CancellationToken cancellationToken)
   at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(IHost host, CancellationToken token)
   at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(IHost host, CancellationToken token)
   at Microsoft.Fabric.Workloads.DevGateway.Program.Main(String[] args)
   at Microsoft.Fabric.Workloads.DevGateway.Program.<Main>(String[] args)

I have not checked all combinations, but devgateway seems to now require a bunch of things in item1.json that were not needed before.
https://github.com/microsoft/Microsoft-Fabric-workload-development-sample/blob/main/Frontend/Package/Item1.json#L14-L80
Note: FE checks pass when these are removed.

This is all we have needed so far in item1.json

{
  "name": "WebMap",
  "displayName": "Item_1_DisplayName",
  "displayNamePlural": "Item_1_DisplayName_Plural",
  "editor": {
    "path": "/ArcGISMaps"
  },
  "icon": {
    "name": "assets/images/WebMap.png"
  },
  "activeIcon": {
    "name": "assets/images/WebMap.png"
  },
  "supportedInMonitoringHub": false
}

Note: I am not running the dev gateway via docker, but how it was before the latest changes.
Have downloaded the latest published on 11/3: https://github.com/microsoft/Microsoft-Fabric-workload-development-sample/blob/main/Frontend/Package/Item1.json#L14-L80

[IdanGoldfarb1989]

Hi,

The issue is on our side, and we are working to fix it.

In the meantime, adding an empty "homePage.newSection" in the product.json file will resolve the issue:
"newSection": {
"customActions": []
},

Regarding the new parts in the item.json, these are intended to integrate with different features. You can refer to the documentation on FE manifests for more details:
Frontend Manifests Documentation

[dhrumil83]

Thanks for the pointer.