Support Zarr as a STAC cloud-optimised media type (#62838) #63358

captaincoordinates · 2025-09-26T21:02:47Z

Description

Incorporates the following changes.

sip

Updated sip.in files by running sipify_all.sh script (which generates some changes not directly triggered by this change).

Cloud-Optimised

Recognised Zarr as a cloud-optimised media type in QgsStacAsset logic and added Zarr handling logic in the uri function to correctly prefix STAC Asset hrefs with ZARR:/vsicurl/ so that Zarr STAC Assets can be added as layers.

Assets in Browser Pane

Added a further nesting beneath STAC Items in the Browser pane showing assets. This allows individual cloud-optimised STAC Assets to be drag-dropped into the Layers pane. Previously only STAC Items could be drag-dropped into the Layers pane if they contained at least one cloud-optimised STAC Asset, at which point all of the STAC Item's cloud-optimised STAC Assets were added to the Layers pane. This change adds greater flexibility and better supports STAC Items with many cloud-optimised STAC Assets.

Note

As part of this change logic to generate HTML representations of STAC Assets for STAC Items' Details modal was extracted to a separate function so that individual STAC Assets can have their own Details modal.

Downloadable Assets

Added QgsStacAsset::isDownloadable to determine if assets should provide a download option. Zarr assets should not be offered for download as the STAC Asset's href points to a directory rather than a data file or archive. Zarr download attempts in QGIS will either fail with 4xx or download a directory listing response.

DRY

Removed duplication in STAC Asset handling logic.

Note

Prior to this change logic in the QgsStacAsset class was duplicated in QgsStacItemItem and this change includes a DRY consolidation. The QgsStacAsset class's formatName function and uri function were effecitvely duplicated in the QgsStacItemItem class's mimeUris function. The QgsStacItemItem has been changed to reference the consolidated logic. Commit fa4192dbe9bda7c4aa721500ca9f8ca0523abaa6 added auth handling to QgsStacItemItem::mimeUris but not to QgsStacAsset::uri. This DRY consolidation implements the same auth handling in QgsStacAsset::uri, which is why the PR shows that function being edited.

captaincoordinates · 2025-09-26T22:00:52Z

~~I'm working on fixing the layout issues, pre-commit was not working for some of these commits~~

Layout issues addressed

github-actions · 2025-09-26T22:05:39Z

🪟 Windows Qt6 builds

Download Windows Qt6 builds of this PR for testing.
(Built from commit 1e7e899)

🍎 MacOS Qt6 builds

Download MacOS Qt6 builds of this PR for testing.
This installer is not signed, control+click > open the app to avoid the warning
(Built from commit 1e7e899)

m-kuhn · 2025-09-29T10:46:40Z

python/core/auto_generated/stac/qgsstacasset.sip.in

 Returns a uri for the asset if it is a cloud optimized file like COG or
+COPC, empty auth configuration
+
+.. versionadded:: 3.42


@m-kuhn I believe 3.42 is the correct version here. This .sip.in change resulted from pre-commit hooks executing on my change, though my change did not modify this function. The commit that added this function (here) did not update .sip.in files, and my change was the first time these files were updated for this behaviour. Presumably the previous author did not execute pre-commit hooks.

However - the following function, an overload of this function that accepts a QString parameter, is new and should reference 4.0. I will make this change shortly.

src/core/stac/qgsstacasset.cpp

m-kuhn · 2025-09-29T10:51:08Z

src/core/stac/qgsstacitem.cpp

-  QString html = QStringLiteral( "<html><head></head>\n<body>\n" );
-
-  html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Item" ) );
+  QString html = QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Item" ) );


should Item be translated?

@m-kuhn this is a good question. The previous implementation did not translate the string, and also "Item" is a specific term in the STAC specification and I am not sure if STAC intends for it to be translated.

As the string was not previously translated, and other STAC terms such as "Collection" and "Links" are not translated, my preference would be to address this question in a separate issue if necessary.

+1 to not translate stac entity names, at least not yet.

src/gui/stac/qgsstacobjectdetailsdialog.cpp

Co-authored-by: Matthias Kuhn <matthias@opengis.ch>

captaincoordinates · 2025-09-29T20:24:32Z

@m-kuhn thanks for your input. I've made requested changes and responded where I wasn't sure a change was necessary.

uclaros · 2025-09-30T09:43:49Z

src/gui/stac/qgsstacobjectdetailsdialog.h

+
  private:
    QString mAuthcfg;
+    void setContent( QString bodyHtml, QString thumbnailHtml );


Suggested change

void setContent( QString bodyHtml, QString thumbnailHtml );

void setContent( const QString &bodyHtml, const QString &thumbnailHtml );

uclaros · 2025-09-30T09:48:55Z

src/gui/stac/qgsstacobjectdetailsdialog.h

+#include "qgsstacasset.h"
 #include "qgsstacobject.h"


Let's forward-declare both QgsStacAsset and QgsStacObject instead of including

uclaros · 2025-09-30T10:02:06Z

src/gui/stac/qgsstacobjectdetailsdialog.cpp

+  QString thumbnailHtml;
+  if ( isThumbnailAsset( stacAsset ) )
+  {
+    thumbnailHtml = thumbnailHtmlContent( stacAsset );
+  }
+  QString bodyHtml = stacAsset->toHtml( assetId );


Suggested change

QString thumbnailHtml;

if ( isThumbnailAsset( stacAsset ) )

{

thumbnailHtml = thumbnailHtmlContent( stacAsset );

}

QString bodyHtml = stacAsset->toHtml( assetId );

const QString thumbnailHtml = isThumbnailAsset( stacAsset ) ? thumbnailHtmlContent( stacAsset ) : QString();

const QString bodyHtml = stacAsset->toHtml( assetId );

uclaros · 2025-09-30T10:02:27Z

src/gui/stac/qgsstacobjectdetailsdialog.cpp

+  QString thumbnailHtml = thumbnails.join( QString() );
+  QString bodyHtml = stacObject->toHtml();


Suggested change

QString thumbnailHtml = thumbnails.join( QString() );

QString bodyHtml = stacObject->toHtml();

const QString thumbnailHtml = thumbnails.join( QString() );

const QString bodyHtml = stacObject->toHtml();

uclaros · 2025-09-30T11:06:21Z

src/gui/stac/qgsstacdataitemguiprovider.cpp

-      QAction *actionDownload = new QAction( tr( "Download Assets…" ), menu );
-      connect( actionDownload, &QAction::triggered, this, [itemItem, context] { downloadAssets( itemItem, context ); } );
-      menu->addAction( actionDownload );
+      int downloadableAssets = 0;


You can replace the int with a bool hasDownloadableAssets and break the iteration at first downloadable asset occurrance

uclaros · 2025-09-30T11:08:22Z

src/core/stac/qgsstacitem.cpp

-  QString html = QStringLiteral( "<html><head></head>\n<body>\n" );
-
-  html += QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Item" ) );
+  QString html = QStringLiteral( "<h1>%1</h1>\n<hr>\n" ).arg( QLatin1String( "Item" ) );


+1 to not translate stac entity names, at least not yet.

uclaros · 2025-09-30T11:17:05Z

src/core/stac/qgsstacdataitems.cpp

+    mStacAsset( asset ),
+    mName( name )
+{
+  mIconName = QStringLiteral( "mActionPropertiesWidget.svg" );


I think we need a separate icon for assets

uclaros · 2025-09-30T11:28:57Z

src/core/stac/qgsstacdataitems.cpp

+    // create any assets beneath the item, so that they can be individually drag-dropped as layers if compatible
+    i->populate( true );


Why pre populate all assets for all items?
Should we not wait for the user to expand the Item?

uclaros · 2025-09-30T11:36:02Z

src/core/stac/qgsstacdataitems.h

+    bool hasDragEnabled() const override;
+    QgsMimeDataUtils::UriList mimeUris() const override;
+    bool equal( const QgsDataItem *other ) override;
+    QVariant sortKey() const override { return QStringLiteral( "4 %1" ).arg( mName ); }


I wonder if 4 might cause some unexpected sorting as the QgsStacFetchMoreItem which should always be last, has 3 as a sort key.

uclaros · 2025-09-30T13:21:22Z

src/core/stac/qgsstacasset.h

+    /**
+     * Returns a uri for the asset if it is a cloud optimized file like COG or COPC
+     * \since QGIS 4.0
+     */
+    QgsMimeDataUtils::Uri uri( const QString &authcfg ) const;


I don't think QgsStacAsset should have such method. This class should just be a container class for the stac asset properties.
It would be the caller's responsibility to add the authcfg to the URI based on the provider (the current approach of just appending authcfg=... is a bit naive).
Maybe something like:

QgsProviderMetadata *md = QgsProviderRegistry::instance()->providerMetadata( uri.providerKey ); QVariantMap map = md->decodeUri( uri.uri ); map[ QStringLiteral( "authcfg" ) ] = authcfg; uri.uri = md.encodeUri( map );

??
Maybe it could be a void QgsMimeDataUtils::Uri::setAuthCfg( const QString &authcfg );?
What do you think?

github-actions bot added this to the 4.0.0 milestone Sep 26, 2025

captaincoordinates force-pushed the 62838-zarr-co-media-type-stac-04 branch from 9a713a7 to 8c623f4 Compare September 26, 2025 22:59

m-kuhn reviewed Sep 29, 2025

View reviewed changes

src/core/stac/qgsstacasset.cpp Outdated Show resolved Hide resolved

m-kuhn reviewed Sep 29, 2025

View reviewed changes

src/core/stac/qgsstacasset.cpp Show resolved Hide resolved

m-kuhn reviewed Sep 29, 2025

View reviewed changes

src/gui/stac/qgsstacobjectdetailsdialog.cpp Outdated Show resolved Hide resolved

captaincoordinates force-pushed the 62838-zarr-co-media-type-stac-04 branch from ad157e1 to f6de369 Compare September 29, 2025 20:21

captaincoordinates and others added 12 commits September 29, 2025 13:22

feat(qgis#62838): recognise Zarr as cloud-optimised

337ec4c

feat(qgis#62838): refactor duplicated logic

88d224f

feat(qgis#62838): updated tests for Zarr as cloud optimized

e396939

feat(qgis#62838): list assets under items

3aca600

feat(qgis#62838): asset context menu

29e33c0

feat(qgis#62838): support single asset downloads

bb3ed1e

fixed 'since' version comments

71867e5

feat(qgis#62838): added missing auth in asset uri call

18e7b2c

feat(qgis#62838): cleaned up showDetails logic

31b4ccc

feat(qgis#62838): const ref for authcfg

0a5c968

Co-authored-by: Matthias Kuhn <matthias@opengis.ch>

feat(qgis#62838): no explicit assignment

4409d07

Co-authored-by: Matthias Kuhn <matthias@opengis.ch>

feat(qgis#62838): PR feedback

1e7e899

captaincoordinates force-pushed the 62838-zarr-co-media-type-stac-04 branch from f6de369 to 1e7e899 Compare September 29, 2025 20:22

uclaros reviewed Sep 30, 2025

View reviewed changes

	void setContent( QString bodyHtml, QString thumbnailHtml );
	void setContent( const QString &bodyHtml, const QString &thumbnailHtml );

		QString thumbnailHtml = thumbnails.join( QString() );
		QString bodyHtml = stacObject->toHtml();

		// create any assets beneath the item, so that they can be individually drag-dropped as layers if compatible
		i->populate( true );

Uh oh!

Support Zarr as a STAC cloud-optimised media type (#62838) #63358

Are you sure you want to change the base?

Support Zarr as a STAC cloud-optimised media type (#62838) #63358

Uh oh!

Conversation

captaincoordinates commented Sep 26, 2025

Description

sip

Cloud-Optimised

Assets in Browser Pane

Downloadable Assets

DRY

Uh oh!

captaincoordinates commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🪟 Windows Qt6 builds

🍎 MacOS Qt6 builds

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

captaincoordinates commented Sep 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

captaincoordinates commented Sep 26, 2025 •

edited

Loading

github-actions bot commented Sep 26, 2025 •

edited

Loading