azure-mock 4.0.0 → 4.1.0

package/dist/index.d.ts

@@ -10,6 +10,8 @@ import { CreateTableEntityResponse, GetAccessPolicyResponse, GetTableEntityRespo
 //#region src/constants.d.ts
 export declare const BLOB_NOT_FOUND_ERROR_CODE = "BlobNotFound";
 export declare const BLOB_NOT_FOUND_MESSAGE = "The specified blob does not exist.";
+export declare const CONDITION_NOT_MET_ERROR_CODE = "ConditionNotMet";
+export declare const CONDITION_NOT_MET_MESSAGE = "The condition specified using HTTP conditional header(s) is not met.";
 export declare const MOCK_BLOB_BASE_URL = "https://mockaccount.blob.core.windows.net";
 export declare const MOCK_QUEUE_BASE_URL = "https://mockaccount.queue.core.windows.net";
 export declare const MOCK_SEARCH_BASE_URL = "https://mockaccount.search.windows.net";
@@ -39,7 +41,7 @@ export declare class MockBlobBatchClient implements BlobBatchClient {
    * underlying MockContainerDatabase, and builds a response object that reports
    * which deletions succeeded and which failed (e.g. for blobs that didn't exist).
    */
-  deleteBlobs(urls: string[], credential: AnonymousCredential | StorageSharedKeyCredential, _options?: BlobDeleteOptions): Promise<BlobBatchDeleteBlobsResponse>;
+  deleteBlobs(urls: string[], credential: AnonymousCredential | StorageSharedKeyCredential, options?: BlobDeleteOptions): Promise<BlobBatchDeleteBlobsResponse>;
   getContainer(containerName: string): MapValue<typeof MockContainerDatabase>;
 }
 //#endregion
@@ -1234,4 +1236,5 @@ export declare const MockContainerBlobMetadataDatabase: Map<string, Record<strin
 //#endregion
 //#region src/store/MockEventGridDatabase.d.ts
 export declare const MockEventGridDatabase: Map<string, EventGridEvent<unknown>[]>;
-//#endregion
+//#endregion
+export {};

package/dist/index.js

@@ -1,18 +1,27 @@
-import { ID_SEPARATOR, InvalidOperationError, Operation, chunk, exhaustiveGuard, getDecodedUriComponent, getOrCreate, getResult, html, noop, streamToText, takeOne } from "@esposter/shared";
+import { ID_SEPARATOR, InvalidOperationError, Operation, checkIsDeepEqual, chunk, exhaustiveGuard, getDecodedUriComponent, getOrCreate, getResult, html, noop, streamToText, takeOne } from "@esposter/shared";
 import { toHttpHeadersLike } from "@azure/core-http-compat";
 import { RestError, createHttpHeaders, createPipelineRequest } from "@azure/core-rest-pipeline";
 import { AnonymousCredential } from "@azure/storage-blob";
 import { Readable } from "node:stream";
 import { AZURE_MAX_PAGE_SIZE, AZURE_MAX_QUEUE_VISIBILITY_TIMEOUT_MS, BinaryOperator, deserializeClause, deserializeKey, getTableNullClause, serializeClauses } from "@esposter/azure";
-import deepEqual from "fast-deep-equal";
 //#region src/constants.ts
 const BLOB_NOT_FOUND_ERROR_CODE = "BlobNotFound";
 const BLOB_NOT_FOUND_MESSAGE = "The specified blob does not exist.";
+const CONDITION_NOT_MET_ERROR_CODE = "ConditionNotMet";
+const CONDITION_NOT_MET_MESSAGE = "The condition specified using HTTP conditional header(s) is not met.";
 const MOCK_BLOB_BASE_URL = "https://mockaccount.blob.core.windows.net";
 const MOCK_QUEUE_BASE_URL = "https://mockaccount.queue.core.windows.net";
 const MOCK_SEARCH_BASE_URL = "https://mockaccount.search.windows.net";
 const MOCK_TABLE_BASE_URL = "https://mockaccount.table.core.windows.net";
 //#endregion
+//#region src/models/shared/NotImplementedError.ts
+var NotImplementedError = class extends Error {
+	constructor(name) {
+		super(`${name} is not implemented in the mock`);
+		this.name = "NotImplementedError";
+	}
+};
+//#endregion
 //#region src/services/container/getMockBlobKey.ts
 const getMockBlobKey = (containerName, blobName) => `${encodeURIComponent(containerName)}${ID_SEPARATOR}${encodeURIComponent(blobName)}`;
 //#endregion
@@ -76,14 +85,17 @@ const getBlobUrlParts = (url) => {
 	};
 };
 //#endregion
-//#region src/models/shared/NotImplementedError.ts
-var NotImplementedError = class extends Error {
-	constructor(name) {
-		super(`${name} is not implemented in the mock`);
-		this.name = "NotImplementedError";
-	}
+//#region src/services/container/constants.ts
+const MOCK_BLOB_SEEDED_DATE = /* @__PURE__ */ new Date(-864e13);
+const MOCK_BLOB_SEEDED_PROPERTIES = {
+	createdOn: MOCK_BLOB_SEEDED_DATE,
+	etag: "\"seeded\"",
+	lastModified: MOCK_BLOB_SEEDED_DATE
 };
 //#endregion
+//#region src/services/container/readMockBlobDates.ts
+const readMockBlobDates = (containerName, blobName) => MockContainerBlobDatesDatabase.get(getMockBlobKey(containerName, blobName)) ?? MOCK_BLOB_SEEDED_PROPERTIES;
+//#endregion
 //#region src/services/container/toWebResourceLike.ts
 const toWebResourceLike = (request) => ({
 	abortSignal: request.abortSignal,
@@ -131,7 +143,10 @@ var MockBlobBatchClient = class {
 	* underlying MockContainerDatabase, and builds a response object that reports
 	* which deletions succeeded and which failed (e.g. for blobs that didn't exist).
 	*/
-	deleteBlobs(urls, credential, _options) {
+	deleteBlobs(urls, credential, options) {
+		const { ifUnmodifiedSince, ...unsupportedConditions } = options?.conditions ?? {};
+		const unsupportedConditionName = Object.entries(unsupportedConditions).find(([, value]) => value !== void 0)?.[0];
+		if (unsupportedConditionName !== void 0) return Promise.reject(new NotImplementedError(`deleteBlobs with ${unsupportedConditionName}`));
 		const subResponses = [];
 		let subResponsesSucceededCount = 0;
 		let subResponsesFailedCount = 0;
@@ -143,6 +158,11 @@ var MockBlobBatchClient = class {
 				continue;
 			}
 			const { blobName, containerName } = urlParts;
+			if (this.#checkIsModifiedSince(containerName, blobName, ifUnmodifiedSince)) {
+				subResponses.push(this.#createFailedSubResponse(credential, 412, CONDITION_NOT_MET_ERROR_CODE, CONDITION_NOT_MET_MESSAGE));
+				subResponsesFailedCount++;
+				continue;
+			}
 			if (deleteMockBlob(containerName, blobName)) {
 				subResponses.push({
 					_request: {
@@ -175,6 +195,9 @@ var MockBlobBatchClient = class {
 	getContainer(containerName) {
 		return getMockContainer(containerName);
 	}
+	#checkIsModifiedSince(containerName, blobName, ifUnmodifiedSince) {
+		return ifUnmodifiedSince !== void 0 && getMockContainer(containerName).has(blobName) && readMockBlobDates(containerName, blobName).lastModified > ifUnmodifiedSince;
+	}
 	#createFailedSubResponse(credential, status, errorCode, statusMessage) {
 		return {
 			_request: {
@@ -201,17 +224,6 @@ var MockRestError = class extends RestError {
 //#region src/services/container/getBlobUrl.ts
 const getBlobUrl = (containerName, blobName) => `${MOCK_BLOB_BASE_URL}/${containerName}/${blobName.split("/").map((segment) => encodeURIComponent(segment)).join("/")}`;
 //#endregion
-//#region src/services/container/constants.ts
-const MOCK_BLOB_SEEDED_DATE = /* @__PURE__ */ new Date(-864e13);
-const MOCK_BLOB_SEEDED_PROPERTIES = {
-	createdOn: MOCK_BLOB_SEEDED_DATE,
-	etag: "\"seeded\"",
-	lastModified: MOCK_BLOB_SEEDED_DATE
-};
-//#endregion
-//#region src/services/container/readMockBlobDates.ts
-const readMockBlobDates = (containerName, blobName) => MockContainerBlobDatesDatabase.get(getMockBlobKey(containerName, blobName)) ?? MOCK_BLOB_SEEDED_PROPERTIES;
-//#endregion
 //#region src/services/container/storeMockBlobWrite.ts
 const storeMockBlobWrite = (containerName, blobName, isExisting) => {
 	const key = getMockBlobKey(containerName, blobName);
@@ -290,9 +302,11 @@ var MockBlobClient = class {
 	}
 	download() {
 		const buffer = this.container.get(this.name);
+		if (!buffer) throw new MockRestError(BLOB_NOT_FOUND_MESSAGE, 404);
 		return Promise.resolve({
-			_response: createMockResponse(buffer ? 200 : 404),
-			readableStreamBody: buffer ? Readable.from(buffer) : void 0
+			_response: createMockResponse(200),
+			etag: readMockBlobDates(this.containerName, this.name).etag,
+			readableStreamBody: Readable.from(buffer)
 		});
 	}
 	downloadToBuffer() {
@@ -436,7 +450,11 @@ var MockBlockBlobClient = class extends MockBlobClient {
 		storeMockBlobWrite(this.containerName, this.name, this.container.has(this.name));
 		storeMockBlobMetadata(this.containerName, this.name, options?.metadata);
 		this.container.set(this.name, buffer);
-		return { _response: createMockResponse(201) };
+		const { etag } = readMockBlobDates(this.containerName, this.name);
+		return {
+			_response: createMockResponse(201),
+			etag
+		};
 	}
 	uploadBrowserData() {
 		throw new NotImplementedError(this.uploadBrowserData.name);
@@ -865,7 +883,7 @@ var MockQueueClient = class {
 //#region src/services/filter/checkIsNullClause.ts
 const checkIsNullClause = (clause) => {
 	const tableNullClause = getTableNullClause(clause.key);
-	return deepEqual(clause, tableNullClause);
+	return checkIsDeepEqual(clause, tableNullClause);
 };
 //#endregion
 //#region src/services/filter/compare.ts
@@ -1233,28 +1251,12 @@ var MockTableClient = class {
 		const existingEntity = this.table.get(key);
 		if (!existingEntity) throw new MockRestError("The specified resource does not exist.", 404);
 		this.#assertEtag(existingEntity.etag, etag);
-		if (mode === "Merge") this.table.set(key, {
-			...existingEntity,
-			...entity,
-			etag: this.#getEtag()
-		});
-		else this.table.set(key, {
-			...entity,
-			etag: this.#getEtag()
-		});
+		this.#writeEntity(key, entity, mode, existingEntity);
 	}
 	#applyUpsert(entity, mode = "Merge") {
 		const key = this.#getCompositeKey(entity.partitionKey, entity.rowKey);
 		const existingEntity = this.table.get(key);
-		if (existingEntity && mode === "Merge") this.table.set(key, {
-			...existingEntity,
-			...entity,
-			etag: this.#getEtag()
-		});
-		else this.table.set(key, {
-			...entity,
-			etag: this.#getEtag()
-		});
+		this.#writeEntity(key, entity, mode, existingEntity);
 	}
 	#assertEtag(existingEtag, etag) {
 		if (etag !== void 0 && etag !== "*" && etag !== existingEtag) throw new MockRestError("The update condition specified in the request was not satisfied.", 412);
@@ -1271,6 +1273,17 @@ var MockTableClient = class {
 			etag: entity.etag ?? this.#getEtag()
 		};
 	}
+	#writeEntity(key, entity, mode, existingEntity) {
+		if (existingEntity && mode === "Merge") this.table.set(key, {
+			...existingEntity,
+			...entity,
+			etag: this.#getEtag()
+		});
+		else this.table.set(key, {
+			...entity,
+			etag: this.#getEtag()
+		});
+	}
 };
 //#endregion
 //#region src/models/webPubSub/MockWebPubSubServiceClient.ts
@@ -1290,4 +1303,4 @@ const applyFilter = (documents, clauses) => {
 	return documents.filter((document) => predicate(document));
 };
 //#endregion
-export { BLOB_NOT_FOUND_ERROR_CODE, BLOB_NOT_FOUND_MESSAGE, MOCK_BLOB_BASE_URL, MOCK_BLOB_SEEDED_DATE, MOCK_BLOB_SEEDED_PROPERTIES, MOCK_QUEUE_BASE_URL, MOCK_SEARCH_BASE_URL, MOCK_TABLE_BASE_URL, MockBlobBatchClient, MockBlobClient, MockBlockBlobClient, MockContainerBlobDatesDatabase, MockContainerBlobMetadataDatabase, MockContainerClient, MockContainerDatabase, MockEventGridDatabase, MockEventGridPublisherClient, MockQueueClient, MockQueueDatabase, MockRestError, MockSearchClient, MockSearchDatabase, MockServiceBusDatabase, MockServiceBusSender, MockTableClient, MockTableDatabase, MockWebPubSubServiceClient, NotImplementedError, applyFilter, bodyToBuffer, checkIsNullClause, checkIsReadableStream, compare, compareByCompositeKey, createFilterPredicate, createMockResponse, deleteMockBlob, getAzureErrorXml, getBlobItemXml, getBlobPrefixXml, getBlobUrl, getBlobUrlParts, getListBlobsSegmentResponse, getListBlobsXml, getMockBlobKey, getMockContainer, getMockQueueMessageItem, getMockSasUrl, readMockBlobDates, readMockBlobMetadata, storeMockBlobMetadata, storeMockBlobWrite, toWebResourceLike };
+export { BLOB_NOT_FOUND_ERROR_CODE, BLOB_NOT_FOUND_MESSAGE, CONDITION_NOT_MET_ERROR_CODE, CONDITION_NOT_MET_MESSAGE, MOCK_BLOB_BASE_URL, MOCK_BLOB_SEEDED_DATE, MOCK_BLOB_SEEDED_PROPERTIES, MOCK_QUEUE_BASE_URL, MOCK_SEARCH_BASE_URL, MOCK_TABLE_BASE_URL, MockBlobBatchClient, MockBlobClient, MockBlockBlobClient, MockContainerBlobDatesDatabase, MockContainerBlobMetadataDatabase, MockContainerClient, MockContainerDatabase, MockEventGridDatabase, MockEventGridPublisherClient, MockQueueClient, MockQueueDatabase, MockRestError, MockSearchClient, MockSearchDatabase, MockServiceBusDatabase, MockServiceBusSender, MockTableClient, MockTableDatabase, MockWebPubSubServiceClient, NotImplementedError, applyFilter, bodyToBuffer, checkIsNullClause, checkIsReadableStream, compare, compareByCompositeKey, createFilterPredicate, createMockResponse, deleteMockBlob, getAzureErrorXml, getBlobItemXml, getBlobPrefixXml, getBlobUrl, getBlobUrlParts, getListBlobsSegmentResponse, getListBlobsXml, getMockBlobKey, getMockContainer, getMockQueueMessageItem, getMockSasUrl, readMockBlobDates, readMockBlobMetadata, storeMockBlobMetadata, storeMockBlobWrite, toWebResourceLike };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azure-mock",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "A library that contains azure mock classes.",
   "keywords": [
     "azure",
@@ -53,18 +53,17 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@esposter/azure": "4.0.0",
-    "@esposter/shared": "4.0.0",
-    "fast-deep-equal": "^3.1.3"
+    "@esposter/azure": "4.1.0",
+    "@esposter/shared": "4.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.5",
-    "@esposter/configuration": "4.0.0",
+    "@esposter/configuration": "4.1.0",
     "publint": "^0.3.25",
-    "tsdown": "^0.23.0",
+    "tsdown": "^0.23.1",
     "type-fest": "^5.10.0",
     "typedoc": "^0.28.20",
-    "vitest": "^5.0.3"
+    "vitest": "^5.0.4"
   },
   "peerDependencies": {
     "@azure/core-http-compat": "^2.5.0",
@@ -79,5 +78,5 @@
   "inlinedDependencies": {
     "type-fest": "5.10.0"
   },
-  "gitHead": "7667bc8c9a2b4e9dcacd6b845ee8cc9951250ae7"
+  "gitHead": "68de4c22fa7591bf6f6cc0fab2c9a906d8c4d71a"
 }