Adding seal endpoint for Append Blob issue #810 by matt-lethargic · Pull Request #2553 · Azure/Azurite

matt-lethargic · 2025-05-16T16:21:06Z

This pull request introduces support for sealing append blobs in the Azure Blob Storage emulator this should solve issue #810 . Key changes include implementing the sealBlob functionality across the metadata store layers, updating the AppendBlobHandler to handle the seal operation, and adding tests to validate the new behavior.

Append Blob Sealing Feature:

New sealBlob Method in Metadata Stores:
- Added the sealBlob method to the IBlobMetadataStore interface to support sealing append blobs. (src/blob/persistence/IBlobMetadataStore.ts, src/blob/persistence/IBlobMetadataStore.tsR1143-R1162)
- Implemented the sealBlob method in LokiBlobMetadataStore to update blob properties and enforce validation rules. (src/blob/persistence/LokiBlobMetadataStore.ts, src/blob/persistence/LokiBlobMetadataStore.tsR3517-R3559)
- Implemented the sealBlob method in SqlBlobMetadataStore to handle the operation in SQL-based metadata storage. (src/blob/persistence/SqlBlobMetadataStore.ts, src/blob/persistence/SqlBlobMetadataStore.tsR3549-R3618)
Update to AppendBlobHandler:
- Added the seal method in AppendBlobHandler to process the seal operation by interacting with the metadata store and returning appropriate responses. (src/blob/handlers/AppendBlobHandler.ts, src/blob/handlers/AppendBlobHandler.tsR229-R261)
- Updated the blob properties to include the isSealed flag, defaulting to false for new append blobs. (src/blob/handlers/AppendBlobHandler.ts, src/blob/handlers/AppendBlobHandler.tsL71-R72)

Testing Enhancements:

New Test Cases for Sealing:
- Added tests to validate the sealing of append blobs, including scenarios for successful sealing, blob not found, invalid blob type, and verification of sealed properties. (tests/blob/apis/appendblob.test.ts, tests/blob/apis/appendblob.test.tsR682-R735)

Miscellaneous:

New NPM Script:
- Added a new test script test:append to specifically run tests for append blob APIs. (package.json, package.jsonR317)

blueww · 2025-05-20T03:22:55Z

tests/blob/apis/appendblob.test.ts

+    assert.deepStrictEqual(resultAfter.isSealed, true);
+  });
+
+  it("Seal append blob get blob properties @loki", async () => {


Seal blob will make blob read-only, please add the implementation and test case, make the error aligned with product azure. (Or we will have customer issue.)

Should have addressed this, please detail anything that I have now missed :-)

blueww · 2025-05-20T03:24:07Z

@EmmaZhu
Would you please help to review this PR?

blueww · 2025-05-20T03:28:08Z

src/blob/persistence/SqlBlobMetadataStore.ts

+   * @throws StorageErrorFactory.getBlobNotFound
+   * @returns 
+   */
+  public async sealBlob(


Append blob is actually not supported on SQL for azurite.
So implement SQL for this might won't take any effect.

Should I remove and throw a not implemented exception?

Please remove it to avoid confusing.

Now throw "NotImplementedinSQLError"

matt-lethargic · 2025-05-21T07:55:13Z

I have now added all the functionality relating to sealing an append blob according to the documentation, especially the remarks section of the append blob docs. I've assumed the latest version of the API. If there is any functionality I've missed please feel free to detail and I'll amend.

blueww · 2025-05-22T06:53:50Z

tests/blob/apis/blob.test.ts

+
+    const result_startcopy = await destBlobClient.beginCopyFromURL(
+      sourceBlobClient.url, {
+      sealBlob: true,


Per this doc, sealblob should only work for append blob in copy.
So not sure why add this test case.
https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob?tabs=microsoft-entra-id#:~:text=This%20header%20is%20valid%20for%20append%20blobs%20only

Removed this test case and put a check in the copy to only copy isSealed for an appendblob

blueww · 2025-05-22T06:57:13Z

package.json

    "test": "npm run lint && cross-env NODE_TLS_REJECT_UNAUTHORIZED=0 mocha --require ts-node/register --no-timeouts --grep @loki --recursive --exit tests/**/*.test.ts tests/**/**/*.test.ts",
    "test:in-memory": "npm run lint && cross-env AZURITE_TEST_INMEMORYPERSISTENCE=1 NODE_TLS_REJECT_UNAUTHORIZED=0 mocha --require ts-node/register --no-timeouts --grep @loki --recursive --exit tests/**/*.test.ts tests/**/**/*.test.ts",
    "test:blob": "npm run lint && cross-env NODE_TLS_REJECT_UNAUTHORIZED=0 mocha --require ts-node/register --no-timeouts --grep @loki --recursive --exit tests/blob/*.test.ts tests/blob/**/*.test.ts",
+    "test:append": "npm run lint && cross-env NODE_TLS_REJECT_UNAUTHORIZED=0 mocha --require ts-node/register --no-timeouts --grep @loki --recursive --exit tests/blob/apis/appendblob.test.ts",


Why add a new test command? Would you like to remove it?
If you only run to run test in a single file, you can open the file , and run "Current Mocha TS File - Loki" as below picture.

removed, my bad didn't mean to commit this

blueww · 2025-05-26T07:18:15Z

tests/blob/apis/container.test.ts

    }
  });

+  it("should list append blobs in container with sealed property @loki @sql", async () => {


Please fix the test failure.
The append blob related case should not run on SQL.

matt-lethargic · 2025-06-03T08:26:26Z

Hey @blueww is there any movement on this? I should have addressed all of the issues now.

blueww · 2025-06-03T08:34:10Z

Thanks for your patient!

Just back from vacation. Has a lot of items to handle.
Will try to take a look this this or next week.

matt-lethargic · 2025-06-17T16:09:02Z

@blueww can we get this sorted soon?

blueww · 2025-06-18T08:22:10Z

/azp run

matt-lethargic added 2 commits May 16, 2025 17:16

Adding seal endpoint for Append Blob

8567182

Adding change log

b85976f

matt-lethargic changed the title ~~Adding seal endpoint for Append Blob~~ Adding seal endpoint for Append Blob issue #810 May 16, 2025

blueww reviewed May 20, 2025

View reviewed changes

blueww requested a review from EmmaZhu May 20, 2025 03:24

blueww reviewed May 20, 2025

View reviewed changes

Adding and testing all append blob seal functionality

c0bfbd6

blueww reviewed May 22, 2025

View reviewed changes

Addressing PR issues

612df15

blueww reviewed May 26, 2025

View reviewed changes

removing redundant test

e0dc388

blueww approved these changes Jun 18, 2025

View reviewed changes

blueww merged commit e20f867 into Azure:main Jun 18, 2025
35 checks passed

This was referenced Aug 14, 2025

Azurite doesn't support seal append blob #810

Closed

Azurite doesn't support sealed blobs? #2582

Closed

Conversation

matt-lethargic commented May 16, 2025

Append Blob Sealing Feature:

Testing Enhancements:

Miscellaneous:

Uh oh!

blueww May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blueww commented May 20, 2025

Uh oh!

blueww May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

matt-lethargic commented May 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blueww May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

matt-lethargic commented Jun 3, 2025

Uh oh!

blueww commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

matt-lethargic commented Jun 17, 2025

Uh oh!

blueww commented Jun 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

blueww May 20, 2025 •

edited

Loading

blueww May 20, 2025 •

edited

Loading

blueww May 22, 2025 •

edited

Loading

blueww commented Jun 3, 2025 •

edited

Loading