Files
SCM-Manager/scm-ui/ui-api/src/diff.ts
René Pfeuffer 84c8e02bf1 Feature Partial Diff (#1581)
With this pull request, diffs for Git are loaded in chunks. This means, that for diffs with a lot of files only a part of them are loaded. In the UI a button will be displayed to load more. In the REST API, the number of files can be specified. This only works for diffs, that are delivered as "parsed" diffs. Currently, this is only available for Git.

Co-authored-by: Sebastian Sdorra <sebastian.sdorra@cloudogu.com>
2021-03-12 13:52:17 +01:00

87 lines
2.7 KiB
TypeScript

/*
* MIT License
*
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import parser from "gitdiff-parser";
import { useInfiniteQuery } from "react-query";
import { apiClient } from "./apiclient";
import { Diff, Link } from "@scm-manager/ui-types";
type UseDiffOptions = {
limit?: number;
};
export const useDiff = (link: string, options: UseDiffOptions = {}) => {
let initialLink = link;
if (options.limit) {
initialLink = `${initialLink}?limit=${options.limit}`;
}
const { isLoading, error, data, isFetchingNextPage, fetchNextPage } = useInfiniteQuery<Diff, Error, Diff>(
["link", link],
({ pageParam }) => {
return apiClient.get(pageParam || initialLink).then(response => {
const contentType = response.headers.get("Content-Type");
if (contentType && contentType.toLowerCase() === "application/vnd.scmm-diffparsed+json;v=2") {
return response.json();
} else {
return response
.text()
.then(parser.parse)
.then(data => {
return {
files: data,
partial: false,
_links: {}
};
});
}
});
},
{
getNextPageParam: lastPage => (lastPage._links.next as Link)?.href
}
);
return {
isLoading,
error,
isFetchingNextPage,
fetchNextPage: () => {
fetchNextPage();
},
data: merge(data?.pages)
};
};
const merge = (diffs?: Diff[]): Diff | undefined => {
if (!diffs || diffs.length === 0) {
return;
}
const joinedFiles = diffs.flatMap(diff => diff.files);
return {
...diffs[diffs.length - 1],
files: joinedFiles
};
};