@fluidframework/routerlicious-driver 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

package/src/restWrapperBase.ts

@@ -0,0 +1,146 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import type { AxiosRequestConfig, AxiosRequestHeaders } from "axios";
+import { IR11sResponse } from "./restWrapper";
+
+export abstract class RestWrapper {
+	constructor(
+		protected readonly baseurl?: string,
+		protected defaultQueryString: QueryStringType = {},
+		protected readonly maxBodyLength = 1000 * 1024 * 1024,
+		protected readonly maxContentLength = 1000 * 1024 * 1024,
+	) {}
+
+	public async get<T>(
+		url: string,
+		queryString?: QueryStringType,
+		headers?: AxiosRequestHeaders,
+		additionalOptions?: Partial<
+			Omit<
+				AxiosRequestConfig,
+				"baseURL" | "headers" | "maxBodyLength" | "maxContentLength" | "method" | "url"
+			>
+		>,
+	): Promise<IR11sResponse<T>> {
+		const options: AxiosRequestConfig = {
+			...additionalOptions,
+			baseURL: this.baseurl,
+			headers,
+			maxBodyLength: this.maxBodyLength,
+			maxContentLength: this.maxContentLength,
+			method: "GET",
+			url: `${url}${this.generateQueryString(queryString)}`,
+		};
+		return this.request<T>(options, 200);
+	}
+
+	public async post<T>(
+		url: string,
+		requestBody: any,
+		queryString?: QueryStringType,
+		headers?: AxiosRequestHeaders,
+		additionalOptions?: Partial<
+			Omit<
+				AxiosRequestConfig,
+				"baseURL" | "headers" | "maxBodyLength" | "maxContentLength" | "method" | "url"
+			>
+		>,
+	): Promise<IR11sResponse<T>> {
+		const options: AxiosRequestConfig = {
+			...additionalOptions,
+			baseURL: this.baseurl,
+			data: requestBody,
+			headers,
+			maxBodyLength: this.maxBodyLength,
+			maxContentLength: this.maxContentLength,
+			method: "POST",
+			url: `${url}${this.generateQueryString(queryString)}`,
+		};
+		return this.request<T>(options, 201);
+	}
+
+	public async delete<T>(
+		url: string,
+		queryString?: QueryStringType,
+		headers?: AxiosRequestHeaders,
+		additionalOptions?: Partial<
+			Omit<
+				AxiosRequestConfig,
+				"baseURL" | "headers" | "maxBodyLength" | "maxContentLength" | "method" | "url"
+			>
+		>,
+	): Promise<IR11sResponse<T>> {
+		const options: AxiosRequestConfig = {
+			...additionalOptions,
+			baseURL: this.baseurl,
+			headers,
+			maxBodyLength: this.maxBodyLength,
+			maxContentLength: this.maxContentLength,
+			method: "DELETE",
+			url: `${url}${this.generateQueryString(queryString)}`,
+		};
+		return this.request<T>(options, 204);
+	}
+
+	public async patch<T>(
+		url: string,
+		requestBody: any,
+		queryString?: QueryStringType,
+		headers?: AxiosRequestHeaders,
+		additionalOptions?: Partial<
+			Omit<
+				AxiosRequestConfig,
+				"baseURL" | "headers" | "maxBodyLength" | "maxContentLength" | "method" | "url"
+			>
+		>,
+	): Promise<IR11sResponse<T>> {
+		const options: AxiosRequestConfig = {
+			...additionalOptions,
+			baseURL: this.baseurl,
+			data: requestBody,
+			headers,
+			maxBodyLength: this.maxBodyLength,
+			maxContentLength: this.maxContentLength,
+			method: "PATCH",
+			url: `${url}${this.generateQueryString(queryString)}`,
+		};
+		return this.request<T>(options, 200);
+	}
+
+	protected abstract request<T>(
+		options: AxiosRequestConfig,
+		statusCode: number,
+		addNetworkCallProps?: boolean,
+	): Promise<IR11sResponse<T>>;
+
+	protected generateQueryString(queryStringValues?: QueryStringType) {
+		if (this.defaultQueryString || queryStringValues) {
+			const queryStringMap = { ...this.defaultQueryString, ...queryStringValues };
+
+			return getQueryString(queryStringMap);
+		}
+
+		return "";
+	}
+}
+
+/**
+ * Generates query string from the given query parameters.
+ * @param queryParams - Query parameters from which to create a query.
+ */
+export function getQueryString(queryParams: QueryStringType): string {
+	let queryString = "";
+	for (const key of Object.keys(queryParams)) {
+		if (queryParams[key] !== undefined) {
+			const startChar = queryString === "" ? "?" : "&";
+			queryString += `${startChar}${key}=${encodeURIComponent(queryParams[key])}`;
+		}
+	}
+
+	return queryString;
+}
+
+export type QueryStringType = Record<string, string | number | boolean>;

package/src/retriableGitManager.ts

@@ -4,162 +4,85 @@
  */
 
 import type * as git from "@fluidframework/gitresources";
-import type * as protocol from "@fluidframework/protocol-definitions";
 import {
-    IGitManager,
-    IWholeFlatSummary,
-    IWholeSummaryPayload,
-    IWriteSummaryResponse,
+	IWholeSummaryPayload,
+	IWriteSummaryResponse,
 } from "@fluidframework/server-services-client";
 import { runWithRetry } from "@fluidframework/driver-utils";
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { IGitManager } from "./storageContracts";
+import { IR11sResponse } from "./restWrapper";
+import { IWholeFlatSnapshot } from "./contracts";
 
 export class RetriableGitManager implements IGitManager {
-    constructor(
-        private readonly internalGitManager: IGitManager,
-        private readonly logger: ITelemetryLogger,
-    ) {
-    }
-
-    public async getHeader(id: string, sha: string): Promise<protocol.ISnapshotTree> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.getHeader(id, sha),
-            "gitManager_getHeader",
-        );
-    }
-
-    public async getFullTree(sha: string): Promise<any> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.getFullTree(sha),
-            "gitManager_getFullTree",
-        );
-    }
-
-    public async getCommit(sha: string): Promise<git.ICommit> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.getCommit(sha),
-            "gitManager_getCommit",
-        );
-    }
-
-    public async getCommits(sha: string, count: number): Promise<git.ICommitDetails[]> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.getCommits(sha, count),
-            "gitManager_getCommits",
-        );
-    }
-
-    public async getTree(root: string, recursive: boolean): Promise<git.ITree> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.getTree(root, recursive),
-            "gitManager_getTree",
-        );
-    }
-
-    public async getBlob(sha: string): Promise<git.IBlob> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.getBlob(sha),
-            "gitManager_getBlob",
-        );
-    }
-
-    public getRawUrl(sha: string): string {
-        return this.internalGitManager.getRawUrl(sha);
-    }
-
-    public async getContent(commit: string, path: string): Promise<git.IBlob> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.getContent(commit, path),
-            "gitManager_getContent",
-        );
-    }
-
-    public async createBlob(content: string, encoding: string): Promise<git.ICreateBlobResponse> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.createBlob(content, encoding),
-            "gitManager_createBlob",
-        );
-    }
-
-    public async createGitTree(params: git.ICreateTreeParams): Promise<git.ITree> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.createGitTree(params),
-            "gitManager_createGitTree",
-        );
-    }
-
-    public async createTree(files: protocol.ITree): Promise<git.ITree> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.createTree(files),
-            "gitManager_createTree",
-        );
-    }
-
-    public async createCommit(commit: git.ICreateCommitParams): Promise<git.ICommit> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.createCommit(commit),
-            "gitManager_createCommit",
-        );
-    }
-
-    public async getRef(ref: string): Promise<git.IRef> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.getRef(ref),
-            "gitManager_getRef",
-        );
-    }
-
-    public async createRef(branch: string, sha: string): Promise<git.IRef> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.createRef(branch, sha),
-            "gitManager_createRef",
-        );
-    }
-
-    public async upsertRef(branch: string, commitSha: string): Promise<git.IRef> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.upsertRef(branch, commitSha),
-            "gitManager_upsertRef",
-        );
-    }
-
-    public async write(branch: string,
-        inputTree: protocol.ITree,
-        parents: string[],
-        message: string): Promise<git.ICommit> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.write(branch, inputTree, parents, message),
-            "gitManager_write",
-        );
-    }
-
-    public async createSummary(summary: IWholeSummaryPayload): Promise<IWriteSummaryResponse> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.createSummary(summary),
-            "gitManager_createSummary",
-        );
-    }
-
-    public async deleteSummary(softDelete: boolean): Promise<void> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.deleteSummary(softDelete),
-            "gitManager_deleteSummary",
-        );
-    }
-
-    public async getSummary(sha: string): Promise<IWholeFlatSummary> {
-        return this.runWithRetry(
-            async () => this.internalGitManager.getSummary(sha),
-            "gitManager_getSummary",
-        );
-    }
-
-    private async runWithRetry<T>(api: () => Promise<T>, callName: string): Promise<T> {
-        return runWithRetry(
-            api,
-            callName,
-            this.logger,
-            {}, // progress
-        );
-    }
+	constructor(
+		private readonly internalGitManager: IGitManager,
+		private readonly logger: ITelemetryLoggerExt,
+	) {}
+
+	public async getCommits(
+		sha: string,
+		count: number,
+	): Promise<IR11sResponse<git.ICommitDetails[]>> {
+		return this.runWithRetry(
+			async () => this.internalGitManager.getCommits(sha, count),
+			"gitManager_getCommits",
+		);
+	}
+
+	public async getTree(root: string, recursive: boolean): Promise<IR11sResponse<git.ITree>> {
+		return this.runWithRetry(
+			async () => this.internalGitManager.getTree(root, recursive),
+			"gitManager_getTree",
+		);
+	}
+
+	public async getBlob(sha: string): Promise<IR11sResponse<git.IBlob>> {
+		return this.runWithRetry(
+			async () => this.internalGitManager.getBlob(sha),
+			"gitManager_getBlob",
+		);
+	}
+
+	public async createBlob(
+		content: string,
+		encoding: string,
+	): Promise<IR11sResponse<git.ICreateBlobResponse>> {
+		return this.runWithRetry(
+			async () => this.internalGitManager.createBlob(content, encoding),
+			"gitManager_createBlob",
+		);
+	}
+
+	public async createGitTree(params: git.ICreateTreeParams): Promise<IR11sResponse<git.ITree>> {
+		return this.runWithRetry(
+			async () => this.internalGitManager.createGitTree(params),
+			"gitManager_createGitTree",
+		);
+	}
+
+	public async createSummary(
+		summary: IWholeSummaryPayload,
+	): Promise<IR11sResponse<IWriteSummaryResponse>> {
+		return this.runWithRetry(
+			async () => this.internalGitManager.createSummary(summary),
+			"gitManager_createSummary",
+		);
+	}
+
+	public async getSnapshot(sha: string): Promise<IR11sResponse<IWholeFlatSnapshot>> {
+		return this.runWithRetry(
+			async () => this.internalGitManager.getSnapshot(sha),
+			"gitManager_getSummary",
+		);
+	}
+
+	private async runWithRetry<T>(api: () => Promise<T>, callName: string): Promise<T> {
+		return runWithRetry(
+			api,
+			callName,
+			this.logger,
+			{}, // progress
+		);
+	}
 }