@fluid-tools/fetch-tool 2.74.0-370705 → 2.80.0

package/src/fluidFetchArgs.ts

@@ -47,7 +47,7 @@ const optionsArray = [
 	["--loginHint", "login hint for the user with document access."],
 ];
 
-function printUsage() {
+function printUsage(): void {
 	console.log("Usage: fluid-fetch [options] URL");
 	console.log("URL: <ODSP URL>|<Routerlicious URL>");
 	console.log("Options:");
@@ -66,7 +66,7 @@ export function setArguments(values: {
 	dumpSnapshotStats?: boolean;
 	dumpSnapshotTrees?: boolean;
 	overWrite?: boolean;
-}) {
+}): void {
 	paramSaveDir = values.saveDir;
 	paramURL = values.paramURL;
 	dumpMessages = values.dumpMessages ?? dumpMessages;
@@ -76,7 +76,7 @@ export function setArguments(values: {
 	overWrite = values.overWrite ?? overWrite;
 }
 
-export function parseArguments() {
+export function parseArguments(): void {
 	for (let i = 2; i < process.argv.length; i++) {
 		const arg = process.argv[i];
 		switch (arg) {
@@ -157,7 +157,7 @@ export function parseArguments() {
 	checkArgs();
 }
 
-function parseStrArg(i: number, name: string) {
+function parseStrArg(i: number, name: string): string {
 	if (i + 1 >= process.argv.length) {
 		console.error(`ERROR: Missing ${name}`);
 		printUsage();
@@ -165,7 +165,7 @@ function parseStrArg(i: number, name: string) {
 	}
 	return process.argv[i + 1];
 }
-function parseIntArg(i: number, name: string, allowZero: boolean) {
+function parseIntArg(i: number, name: string, allowZero: boolean): number {
 	if (i + 1 >= process.argv.length) {
 		console.error(`ERROR: Missing ${name}`);
 		printUsage();
@@ -181,7 +181,7 @@ function parseIntArg(i: number, name: string, allowZero: boolean) {
 	return paramNumber;
 }
 
-function checkArgs() {
+function checkArgs(): void {
 	if (paramSnapshotVersionIndex !== undefined) {
 		paramNumSnapshotVersions = Math.max(
 			paramSnapshotVersionIndex + 1,

package/src/fluidFetchInit.ts

@@ -4,7 +4,10 @@
  */
 
 import type { IRequest } from "@fluidframework/core-interfaces";
-import type { IResolvedUrl } from "@fluidframework/driver-definitions/internal";
+import type {
+	IDocumentService,
+	IResolvedUrl,
+} from "@fluidframework/driver-definitions/internal";
 import type {
 	IPublicClientConfig,
 	IOdspAuthRequestInfo,
@@ -31,7 +34,7 @@ async function initializeODSPCore(
 	odspResolvedUrl: IOdspResolvedUrl,
 	server: string,
 	clientConfig: IPublicClientConfig,
-) {
+): Promise<IDocumentService | undefined> {
 	const { driveId, itemId } = odspResolvedUrl;
 
 	connectionInfo = {
@@ -52,7 +55,9 @@ async function initializeODSPCore(
   item:   ${itemId}
   docId:  ${docId}`);
 
-	const getStorageTokenStub = async (options: OdspResourceTokenFetchOptions) => {
+	const getStorageTokenStub = async (
+		options: OdspResourceTokenFetchOptions,
+	): Promise<string> => {
 		return resolveWrapper(
 			async (authRequestInfo: IOdspAuthRequestInfo) => {
 				if (
@@ -68,7 +73,7 @@ async function initializeODSPCore(
 		);
 	};
 	// eslint-disable-next-line @typescript-eslint/promise-function-async
-	const getWebsocketTokenStub = (_options: OdspResourceTokenFetchOptions) =>
+	const getWebsocketTokenStub = (_options: OdspResourceTokenFetchOptions): Promise<string> =>
 		Promise.resolve("");
 	const odspDocumentServiceFactory = new odsp.OdspDocumentServiceFactory(
 		getStorageTokenStub,
@@ -86,7 +91,7 @@ async function initializeR11s(
 	server: string,
 	pathname: string,
 	r11sResolvedUrl: IResolvedUrl,
-) {
+): Promise<IDocumentService | undefined> {
 	const path = pathname.split("/");
 	let tenantId: string;
 	let documentId: string;
@@ -108,7 +113,7 @@ async function initializeR11s(
 	};
 
 	if (localDataOnly) {
-		return;
+		return undefined;
 	}
 
 	console.log(`Connecting to r11s: tenantId=${tenantId} id:${documentId}`);
@@ -159,7 +164,7 @@ async function resolveUrl(url: string): Promise<IResolvedInfo | undefined> {
 	return undefined;
 }
 
-export async function fluidFetchInit(urlStr: string) {
+export async function fluidFetchInit(urlStr: string): Promise<IDocumentService | undefined> {
 	const resolvedInfo = await resolveUrl(urlStr);
 	if (resolvedInfo === undefined) {
 		throw new Error(`Unknown URL ${urlStr}`);

package/src/fluidFetchMessages.ts

@@ -33,7 +33,7 @@ async function* loadAllSequencedMessages(
 	documentService?: IDocumentService,
 	dir?: string,
 	files?: string[],
-) {
+): AsyncGenerator<ISequencedDocumentMessage[]> {
 	let lastSeq = 0;
 	// flag for mismatch between last sequence number read and new one to be read
 	let seqNumMismatch = false;
@@ -210,10 +210,10 @@ async function* loadAllSequencedMessages(
 }
 
 async function* saveOps(
-	gen, // AsyncGenerator<ISequencedDocumentMessage[]>,
+	gen: AsyncGenerator<ISequencedDocumentMessage[]>,
 	dir: string,
 	files: string[],
-) {
+): AsyncGenerator<ISequencedDocumentMessage[]> {
 	// Split into 100K ops
 	const chunk = 100 * 1000;
 
@@ -287,7 +287,7 @@ async function* saveOps(
 export async function fluidFetchMessages(
 	documentService?: IDocumentService,
 	saveDir?: string,
-) {
+): Promise<void> {
 	const messageStats = dumpMessageStats || dumpMessages;
 	if (!messageStats && (saveDir === undefined || documentService === undefined)) {
 		return;

package/src/fluidFetchSharePoint.ts

@@ -113,7 +113,7 @@ async function resolveDriveItemByServerRelativePath(
 	server: string,
 	serverRelativePath: string,
 	clientConfig: IPublicClientConfig,
-) {
+): Promise<IOdspDriveItem> {
 	return resolveWrapper<IOdspDriveItem>(
 		// eslint-disable-next-line @typescript-eslint/promise-function-async
 		(authRequestInfo) =>
@@ -127,7 +127,7 @@ async function resolveChildrenByDriveItem(
 	server: string,
 	folderDriveItem: IOdspDriveItem,
 	clientConfig: IPublicClientConfig,
-) {
+): Promise<IOdspDriveItem[]> {
 	return resolveWrapper<IOdspDriveItem[]>(
 		// eslint-disable-next-line @typescript-eslint/promise-function-async
 		(authRequestInfo) => getChildrenByDriveItem(folderDriveItem, server, authRequestInfo),
@@ -140,7 +140,7 @@ export async function getSharepointFiles(
 	server: string,
 	serverRelativePath: string,
 	recurse: boolean,
-) {
+): Promise<IOdspDriveItem[]> {
 	const fileInfo = await resolveDriveItemByServerRelativePath(
 		server,
 		serverRelativePath,
@@ -177,7 +177,11 @@ export async function getSharepointFiles(
 	return files;
 }
 
-export async function getSingleSharePointFile(server: string, drive: string, item: string) {
+export async function getSingleSharePointFile(
+	server: string,
+	drive: string,
+	item: string,
+): Promise<IOdspDriveItem> {
 	return resolveWrapper<IOdspDriveItem>(
 		// eslint-disable-next-line @typescript-eslint/promise-function-async
 		(authRequestInfo) => getDriveItemFromDriveAndItem(server, drive, item, authRequestInfo),

package/src/fluidFetchSnapshot.ts

@@ -66,7 +66,7 @@ function fetchBlobs(
 	tree: ISnapshotTree,
 	storage: IDocumentStorageService,
 	blobIdMap: Map<string, number>,
-) {
+): IFetchedBlob[] {
 	const result: IFetchedBlob[] = [];
 	for (const [item, blobId] of Object.entries(tree.blobs)) {
 		const treePath = `${prefix}${item}`;
@@ -150,12 +150,15 @@ async function fetchBlobsFromSnapshotTree(
 	return result;
 }
 
-function getDumpFetchedData(fetchedData: IFetchedData[]) {
+function getDumpFetchedData(fetchedData: IFetchedData[]): IFetchedData[] {
 	const sorted = fetchedData.sort((a, b) => a.treePath.localeCompare(b.treePath));
 	return sorted.filter((item) => !isFetchedTree(item) || !item.patched);
 }
 
-async function dumpSnapshotTreeVerbose(name: string, fetchedData: IFetchedData[]) {
+async function dumpSnapshotTreeVerbose(
+	name: string,
+	fetchedData: IFetchedData[],
+): Promise<void> {
 	let size = 0;
 	const sorted = getDumpFetchedData(fetchedData);
 
@@ -214,7 +217,11 @@ async function dumpSnapshotTree(
 	return { blobCountNew, blobCount: sorted.length, size, sizeNew };
 }
 
-async function saveSnapshot(name: string, fetchedData: IFetchedData[], saveDir: string) {
+async function saveSnapshot(
+	name: string,
+	fetchedData: IFetchedData[],
+	saveDir: string,
+): Promise<void> {
 	const outDir = `${saveDir}/${name}/`;
 	const mkdir = util.promisify(fs.mkdir);
 
@@ -255,7 +262,10 @@ async function saveSnapshot(name: string, fetchedData: IFetchedData[], saveDir:
 	);
 }
 
-async function fetchBlobsFromVersion(storage: IDocumentStorageService, version: IVersion) {
+async function fetchBlobsFromVersion(
+	storage: IDocumentStorageService,
+	version: IVersion,
+): Promise<IFetchedData[]> {
 	const tree = await reportErrors(
 		`getSnapshotTree ${version.id}`,
 		storage.getSnapshotTree(version),
@@ -266,7 +276,7 @@ async function fetchBlobsFromVersion(storage: IDocumentStorageService, version:
 	return fetchBlobsFromSnapshotTree(storage, tree);
 }
 
-async function reportErrors<T>(message: string, res: Promise<T>) {
+async function reportErrors<T>(message: string, res: Promise<T>): Promise<T> {
 	try {
 		return await res;
 	} catch (error) {
@@ -278,7 +288,7 @@ async function reportErrors<T>(message: string, res: Promise<T>) {
 export async function fluidFetchSnapshot(
 	documentService?: IDocumentService,
 	saveDir?: string,
-) {
+): Promise<void> {
 	if (
 		!dumpSnapshotStats &&
 		!dumpSnapshotTrees &&