SciCat Dataset widget #427

omkar-ethz · 2025-03-26T14:05:04Z

Overview

This PR implements a widget that displays a user-selected dataset from SciCat. An interceptor is implemented to detect a call to scicat backend, and if unauthorized, to fetch a scicat token for the OIDC user.

Implementation details

We use support added in SciCatProject/scicat-backend-next#1714 and pass scilog as clientId and the current path as returnURL to SciCat (to /auth/oidc/login). SciCat then returns the access token to <scilog-frontend>/auth-callback (configured as successURL for clientId scilog in SciCat i.e. OIDC_SCILOG_SUCCESS_URL) along with the passed returnUrl. The AuthCallback component in Scilog then stores the scicat token and routes the frontend to /returnUrl.

A first implementation of Dataset viewer is added, along with link to the corresponding dataset page in SciCat.

Added dependency on scicat-sdk-ts-fetch to get typing support for Scicat backend calls.

JIRA issues addressed

Testing

Added tests for AuthInterceptor and AuthCallbackComponent.

…t viewer widget

minottic · 2025-04-03T14:24:42Z

@omkar-ethz I have had a first preliminary look, I'll have better feedback in the next days. Something I am not sure I understand why is auth-callback a component? Isn't it enough to be a service or guard?

minottic

Thanks! some small comments + I don't fully get why auth-callback needs to be a component

minottic · 2025-04-08T14:19:23Z

scilog/src/app/core/auth-services/auth.interceptor.ts

+              if (!this.isRequestToSciCatBackend(err.url)) {
+                logout();
+              } else {
+                window.location.href = `${this.serverSettingsService.getSciCatServerAddress()}/api/v3/auth/oidc?client=scilog&returnURL=${


maybe this URLs should be composed in the config service?

Composing this in server settings service now.

minottic · 2025-04-08T14:31:54Z

scilog/src/app/core/dataset.service.ts

should the login be part of the dataset service too? The SDK does not have functions for the HTTP calls?

The dataset service is mainly responsible for fetching data with AJAX (i.e. API) requests, whereas login is a browser redirect. For API requests, the SDK provides Fetch API based HTTP calls, but then it bypasses Angular's interceptor chain. @scicatproject/scicat-sdk-ts-angular provides an Angular HttpClient compatible SDK, but the current scilog Angular version (i.e. v15) is not compatible with minimum required version (v16).

After an Angular upgrade, we can consider using the angular SDK, as it's done in SciCat. We can also consider generating an SDK for SciLog backend calls. Created a discussion to track this: #430

minottic · 2025-04-08T14:36:48Z

scilog/src/app/logbook/widgets/scicat-viewer/scicat-viewer.component.ts

+    });
+
+    this.datasetService.getDatasets().subscribe((data: DatasetSummary[]) => {
+      this.datasetSummary = data.sort(


I think one could add sorting on the server side

Agree that would be more efficient, done!

minottic · 2025-04-08T14:37:25Z

scilog/src/app/logbook/widgets/scicat-viewer/scicat-viewer.component.ts

+  }
+
+  get scicatDatasetUrl(): string {
+    return `${this.serverSettingsService.getScicatFrontendBaseUrl()}/datasets/${encodeURIComponent(


I think it would be clear if all URLs were composed in the dataset service or using the SDK

Good point, moved this URL creation to DatasetService.

minottic · 2025-04-08T14:43:18Z

scilog/src/app/core/auth-services/auth.interceptor.ts

+                logout();
+              } else {
+                window.location.href = `${this.serverSettingsService.getSciCatServerAddress()}/api/v3/auth/oidc?client=scilog&returnURL=${
+                  window.location.pathname + window.location.search


maybe use fstrings consistently

Thanks, refactored this to getScicatLoginUrl(...) method in serverSettingsService.

minottic · 2025-04-08T14:47:10Z

scilog/src/app/core/auth-services/auth.interceptor.ts


-    const idToken = localStorage.getItem("id_token");
+  private handle_request(handler: HttpHandler, req: HttpRequest<any>) {


I am not super convinced the login to scicat should be part of the interceptor, rather than invoked at component creation of the scicat widget

As discussed offline, the interceptor handles the case of SciCat session timing out, and re-logging in the user. As this logic is needed in the interceptor anyway, we let the interceptor also handle the initial login.

minottic · 2025-04-08T14:49:33Z

scilog/src/app/logbook/widgets/scicat-viewer/scicat-viewer.component.html

@@ -0,0 +1,62 @@
+<div *ngIf="scicatUser; else unauthenticated">
+  <p>Your SciCat userId is {{ scicatUser.id }}.</p>


can we maybe put the same name the user sees when logged in scicat in the avatar?

Thanks, changed to Hello {{scicatUser.username}}

minottic · 2025-04-08T14:58:33Z

scilog/src/app/core/dataset.service.ts

+    private serverSettingsService: ServerSettingsService
+  ) {}
+
+  getDatasets(): Observable<DatasetSummary[]> {


isn't there the risk to get too many results here?

Added explicit limit of 100 datasets to this call, and created an issue to handle pagination/infinite scroll + linking on proposal ID: #429

…get based on AppConfig

omkar-ethz · 2025-04-22T13:58:30Z

Thanks! some small comments + I don't fully get why auth-callback needs to be a component

As discussed offline, SciCat needs a fixed URL for OIDC_SCILOG_SUCCESS_URL e.g. https://scilog-frontend.ch/auth-callback to return the access token to. This is better than allowing a dynamic route because we can keep the /auth-callback route simple and free of scripts that could potentially leak the acess-token. The dynamic aspect is handled by the returnURL parameter instead, which SciLog passes before logging in to https://scicat-backend.ch/api/v3/auth/oidc and SciCat passes back to /auth-callback after login in a query parameter. Hence, we make /auth-callback a dedicated component.

Another small addition in this revision: as discussed, to cope with V3-V4 migration, we made the scicat widget configurable using scicat.scicatWidgetEnabled config key.

omkar-ethz requested a review from minottic March 26, 2025 14:05

omkar-ethz marked this pull request as draft March 26, 2025 14:10

omkar-ethz force-pushed the scicat-widget branch from a96d518 to 2239ae0 Compare March 26, 2025 14:40

Add support to get scicat token for an OIDC user. Add a scicat datase…

f67c03c

…t viewer widget

omkar-ethz force-pushed the scicat-widget branch from 2239ae0 to f67c03c Compare March 26, 2025 15:55

omkar-ethz marked this pull request as ready for review March 26, 2025 16:01

minottic reviewed Apr 8, 2025

View reviewed changes

omkar-ethz self-assigned this Apr 14, 2025

Addressing PR comments: some refactoring and enable/disable scicatWid…

c8051de

…get based on AppConfig

omkar-ethz requested a review from minottic April 22, 2025 13:59

minottic approved these changes Apr 28, 2025

View reviewed changes

omkar-ethz merged commit c7be028 into main Apr 28, 2025
1 check passed

omkar-ethz deleted the scicat-widget branch April 28, 2025 12:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SciCat Dataset widget #427

SciCat Dataset widget #427

omkar-ethz commented Mar 26, 2025 •

edited

Loading

minottic commented Apr 3, 2025

minottic left a comment

minottic Apr 8, 2025

omkar-ethz Apr 22, 2025

minottic Apr 8, 2025

omkar-ethz Apr 22, 2025

minottic Apr 8, 2025

omkar-ethz Apr 22, 2025

minottic Apr 8, 2025

omkar-ethz Apr 22, 2025

minottic Apr 8, 2025

omkar-ethz Apr 22, 2025

minottic Apr 8, 2025

omkar-ethz Apr 22, 2025

minottic Apr 8, 2025

omkar-ethz Apr 22, 2025

minottic Apr 8, 2025

omkar-ethz Apr 22, 2025

omkar-ethz commented Apr 22, 2025


		const idToken = localStorage.getItem("id_token");
		private handle_request(handler: HttpHandler, req: HttpRequest<any>) {

		@@ -0,0 +1,62 @@
		<div *ngIf="scicatUser; else unauthenticated">
		<p>Your SciCat userId is {{ scicatUser.id }}.</p>

SciCat Dataset widget #427

SciCat Dataset widget #427

Conversation

omkar-ethz commented Mar 26, 2025 • edited Loading

Overview

Implementation details

JIRA issues addressed

Testing

minottic commented Apr 3, 2025

minottic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

omkar-ethz commented Apr 22, 2025

omkar-ethz commented Mar 26, 2025 •

edited

Loading