Update BlobStorage to use Azure.Storage.Blobs #1564

tedvanderveen · 2021-03-24T15:36:34Z

Use the v.12 version of the Azure Storage SDK to replace the now deprecated Microsoft.Azure.Storage.Blob nuget packages

See also #944

…Azure.Storage.Blob

tedvanderveen · 2021-03-24T15:44:19Z

core/Piranha.Azure.BlobStorage/BlobStorageExtensions.cs

    /// <param name="naming">How uploaded media files should be named</param>
    /// <param name="scope">The optional service scope. Default is singleton</param>
    /// <returns>The service collection</returns>
    public static IServiceCollection AddPiranhaBlobStorage(
        this IServiceCollection services,
-        StorageCredentials credentials,


This constitutes the main breaking change when moving to the v.12 Azure SDK, as the StorageCredentials class is no longer available.

mikaellindemann · 2021-03-25T09:34:36Z

core/Piranha.Azure.BlobStorage/BlobStorage.cs

            _naming = naming;
+            _storage.CreateIfNotExists(PublicAccessType.Blob);


Does this create a request towards Azure? If so I would recommend keeping the async variant as was before.

@mikaellindemann this should not be inside the constructor, agree. On the other hand, the method IStorage.OpenAsync() would not be a proper place either. Maybe an idea to add a method IStorage.InitializeAsync() where initial plumbing and checks can be performed?

When using Azure.Storage.Blobs assembly classes, there is no real concept of "sessions".

@mikaellindemann this now moved to:
https://github.com/PiranhaCMS/piranha.core/pull/1564/files#diff-1d62fb7d41884231bb1421e147495f8cd812a633cde9981b64684e29639056c4R164

My point was that if it does asynchronous operations (IO being one of them) then it should be an asynchronous function. I didn't check what is behind CreateIfNotExists, but since ExistsAsync and CreateAsync was in use before, I guess that CreateIfNotExists is waiting on the asynchronous operation behind the scenes.

Not sure if I encouraged this change you have made, sorry if I did, but now you have introduced a breaking change in the storage extension point of Piranha. Also, you have limited any storage implementation not to be session based.

Wouldn't it make sense to keep the storage and session implementation as was, such that a BlobContainerClient was the underlying session for a BlobStorage? (Tbh. I don't know the details of IStorage, IStorageSession and Azure BlobStorage, so maybe this is a bad suggestion).

@mikaellindemann I reversed most of those breaking changes. Guess I was a bit too enthousiastic. Please take a second look at the result.

And with regards to that CreateIfNotExists, it's about ensuring the parent Storage Container is available. So this should optimally be part of the App Init chaining.

And with Azure.Storage.Blobs assembly there is no real concept of sessions.
The BlobContainerClient is maintained as a singleton via DI / BlobStorage class. And BlobClient class instances are lightweight and are instantiated from the BlobContainerClient.

@mikaellindemann I have now reverted any breaking changes to existing interfaces. And reverted all changes to the Piranha.Local.FileStorage source.
What remains now inside this PR:

the move to the Azure SDK v.12 using the recommended Azure.Storage.Blobs Nuget packages

Add the interface IInitializable to optionally indicate that a class implements Init() method, which is then called via App.cs

tedvanderveen · 2021-03-25T15:37:56Z

core/Piranha.Local.FileStorage/FileStorage.cs

-            {
-                return (IStorageSession)new FileStorageSession(this, _basePath, _baseUrl, _naming);
-            });
+            return Task.FromResult<IStorageSession>(this);


@mikaellindemann this should make things better scalable.

# Conflicts: # core/Piranha/IStorageSession.cs

Add check if IMediaService instance implements IInitializable

sander1095 · 2021-09-14T13:02:59Z

Hello! what is the state of this?

tidyui · 2021-09-14T13:39:44Z

The PR was opened after 9.0 was release, and as it contains breaking changes we cant release it until 10.0 which is scheduled for November with the release of .NET 6

tedvanderveen · 2021-09-19T09:45:22Z

Other option could be to introduce new Piranha Nuget package with name
Piranha.Azure.StorageBlobs that depends on this new Azure SDK version? And mark existing storage integration packages as deprecated with release of Piranha version 10? So users can move to new package at own pace.

sander1095 · 2021-09-22T15:52:52Z

What breaking changes does it contain? Do you perhaps mean the InitializeAsync() bit?

If the only breaking changes are related to this package AND we can continue using Piranha 9, why must it wait?

If we increase the MAJOR version of this package to indicate it is a breaking change, and later on increase MINOR (or PATCH) for the 10.0 version bump, we can already release it?

sander1095 · 2021-09-22T15:58:37Z

@tedvanderveen I like the idea of being able to use the new Azure SDK NOW... But I think creating an extra package for just 2 months would be a bit much.

If you really wanted to, you could try and just put the code from this PR into your project and have it work that way?

People might get confused about what package they need (example: The current Azure SDK situation)
Docs needs updating, and updating again when v10 is out.
When people want to upgrade from the old package to the new one, they need to install a different package. Might be confusing!

tidyui · 2021-10-08T09:31:08Z

I will merge this into master shortly as 9.2 has been released and we're working on 10.0 for .NET6. It's highly likely that we will release an alpha-package soon, but please remember that this will target net6.0 and use the RC1 packages from Microsoft as well, so it won't be compatible with the currently released version of Piranha.

tidyui · 2021-10-08T13:27:59Z

core/Piranha.Azure.BlobStorage/BlobStorage.cs

-                return $"{ _containerUrl }/{ GetResourceName(media, id, true) }";
-            }
-            return null;
+            return string.IsNullOrWhiteSpace(id) ? default : $"{_blobContainerClient.Uri.AbsoluteUri}/{GetResourceName(media, id, true)}";


This method is no longer checking that media != null, and in GetResourceName() there is an access to media.Id without checking for null values either. But I can fix this after merge.

Use Azure.Storage.Blobs Nuget packge to replace deprecated Microsoft.…

107416d

…Azure.Storage.Blob

tedvanderveen commented Mar 24, 2021

View reviewed changes

tedvanderveen added 4 commits March 25, 2021 09:03

Add missing PiranhaServiceBuilder extension method

5d0eff1

Remove unused Nuget package

17a8945

Add extension method check for success HTTP Status code

465bc65

Optimize code

b2591fe

mikaellindemann reviewed Mar 25, 2021

View reviewed changes

tedvanderveen added 9 commits March 25, 2021 13:10

Add interface IInitializable to make Init() available in select places

c923859

Use IInitializable and IInitializable.Init() to transpile Init calls

0e46ed1

Merge IStorageSession and IStorage

51f9122

Move Media.Init() call to App class

48d849f

Modify docs

4ae3be6

Fix

0d64de5

Correct order of code

25c9b10

Reverse some of the breaking changes

682a890

Remove duplicate empty line (make CodeFactor test pass)

69e6973

tedvanderveen commented Mar 25, 2021

View reviewed changes

tedvanderveen and others added 7 commits March 25, 2021 16:41

Remove unused using refs

dbba1b7

Undo changes to Piranha.Local.FileStorage

1ad80e5

Undo changes to IStorageSession

a7efc1c

Undo changes

d9dcf2a

Restore IStorageSession.cs

daa90a3

Merge branch 'master' of https://github.com/tedvanderveen/piranha.core

00a155f

# Conflicts: # core/Piranha/IStorageSession.cs

Revert changes to IMediaService

a881b58

Add check if IMediaService instance implements IInitializable

sander1095 mentioned this pull request Sep 14, 2021

Update Azure Blob Storage integration to the new Azure.Storage.Blobs libraries #1716

Closed

tidyui reviewed Oct 8, 2021

View reviewed changes

tidyui merged commit ad4d354 into PiranhaCMS:master Oct 8, 2021

tidyui changed the title ~~Use Azure.Storage.Blobs Nuget package to replace deprecated Microsoft.Azure.Storage.Blob~~ Update BlobStorage to use Azure.Storage.Blobs Oct 8, 2021

tidyui added this to the Version 10.0 milestone Oct 8, 2021

tidyui added this to In progress in Version 10.0 via automation Oct 8, 2021

tidyui moved this from In progress to Done in Version 10.0 Oct 8, 2021

tidyui assigned tedvanderveen Oct 8, 2021

tidyui added a commit that referenced this pull request Oct 9, 2021

Added null check for media in BlobStorage. See #1564

a8c6afd

dozer75 mentioned this pull request Jan 28, 2022

Media.PublicUrl is wrong when using BlobStorage #1815

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update BlobStorage to use Azure.Storage.Blobs #1564

Update BlobStorage to use Azure.Storage.Blobs #1564

tedvanderveen commented Mar 24, 2021 •

edited

Loading

tedvanderveen Mar 24, 2021

mikaellindemann Mar 25, 2021

tedvanderveen Mar 25, 2021 •

edited

Loading

tedvanderveen Mar 25, 2021

mikaellindemann Mar 25, 2021

tedvanderveen Mar 25, 2021

tedvanderveen Mar 25, 2021

tedvanderveen Mar 25, 2021

tedvanderveen Mar 26, 2021

tedvanderveen Mar 25, 2021

sander1095 commented Sep 14, 2021

tidyui commented Sep 14, 2021

tedvanderveen commented Sep 19, 2021 •

edited

Loading

sander1095 commented Sep 22, 2021

sander1095 commented Sep 22, 2021

tidyui commented Oct 8, 2021

tidyui Oct 8, 2021

		_naming = naming;
		_storage.CreateIfNotExists(PublicAccessType.Blob);

Update BlobStorage to use Azure.Storage.Blobs #1564

Update BlobStorage to use Azure.Storage.Blobs #1564

Conversation

tedvanderveen commented Mar 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tedvanderveen Mar 25, 2021 • edited Loading

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

sander1095 commented Sep 14, 2021

tidyui commented Sep 14, 2021

tedvanderveen commented Sep 19, 2021 • edited Loading

sander1095 commented Sep 22, 2021

sander1095 commented Sep 22, 2021

tidyui commented Oct 8, 2021

Choose a reason for hiding this comment

tedvanderveen commented Mar 24, 2021 •

edited

Loading

tedvanderveen Mar 25, 2021 •

edited

Loading

tedvanderveen commented Sep 19, 2021 •

edited

Loading