@scm-manager/ui-api 2.36.1 → 2.36.2-20220522-120507

package/src/base.ts

@@ -1,120 +0,0 @@
-/*
- * 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 { HalRepresentation, IndexResources, Link } from "@scm-manager/ui-types";
-import { useQuery } from "react-query";
-import { apiClient } from "./apiclient";
-import { useLegacyContext } from "./LegacyContext";
-import { MissingLinkError, UnauthorizedError } from "./errors";
-import { requiredLink } from "./links";
-
-export type ApiResult<T> = {
-  isLoading: boolean;
-  error: Error | null;
-  data?: T;
-};
-
-export type ApiResultWithFetching<T> = ApiResult<T> & {
-  isFetching: boolean;
-};
-
-export type DeleteFunction<T> = (entity: T) => void;
-
-export const useIndex = (): ApiResult<IndexResources> => {
-  const legacy = useLegacyContext();
-  return useQuery<IndexResources, Error>("index", () => apiClient.get("/").then((response) => response.json()), {
-    onSuccess: (index) => {
-      // ensure legacy code is notified
-      if (legacy.onIndexFetched) {
-        legacy.onIndexFetched(index);
-      }
-    },
-    refetchOnMount: false,
-    retry: (failureCount, error) => {
-      // The index resource returns a 401 if the access token expired.
-      // This only happens once because the error response automatically invalidates the cookie.
-      // In this event, we have to try the request once again.
-      return error instanceof UnauthorizedError && failureCount === 0;
-    },
-  });
-};
-
-export const useIndexLink = (name: string): string | undefined => {
-  const { data } = useIndex();
-  if (!data) {
-    throw new Error("could not find index data");
-  }
-  const linkObject = data._links[name] as Link;
-  if (linkObject && linkObject.href) {
-    return linkObject.href;
-  }
-};
-
-export const useIndexLinks = () => {
-  const { data } = useIndex();
-  if (!data) {
-    throw new Error("could not find index data");
-  }
-  return data._links;
-};
-
-export const useRequiredIndexLink = (name: string): string => {
-  const link = useIndexLink(name);
-  if (!link) {
-    throw new MissingLinkError(`Could not find link ${name} in index resource`);
-  }
-  return link;
-};
-
-export const useVersion = (): string => {
-  const { data } = useIndex();
-  if (!data) {
-    throw new Error("could not find index data");
-  }
-  const { version } = data;
-  if (!version) {
-    throw new Error("could not find version in index data");
-  }
-  return version;
-};
-
-export const useIndexJsonResource = <T>(name: string): ApiResult<T> => {
-  const link = useIndexLink(name);
-  return useQuery<T, Error>(name, () => apiClient.get(link!).then((response) => response.json()), {
-    enabled: !!link,
-  });
-};
-
-export const useJsonResource = <T>(entity: HalRepresentation, name: string, key: string[]): ApiResult<T> =>
-  useQuery<T, Error>(key, () => apiClient.get(requiredLink(entity, name)).then((response) => response.json()));
-
-export function fetchResourceFromLocationHeader(response: Response) {
-  const location = response.headers.get("Location");
-  if (!location) {
-    throw new Error("Server does not return required Location header");
-  }
-  return apiClient.get(location);
-}
-
-export const getResponseJson = (response: Response) => response.json();

package/src/branches.test.ts

@@ -1,234 +0,0 @@
-/*
- * 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 { Branch, BranchCollection, Repository } from "@scm-manager/ui-types";
-import fetchMock from "fetch-mock-jest";
-import { renderHook } from "@testing-library/react-hooks";
-import createWrapper from "./tests/createWrapper";
-import createInfiniteCachingClient from "./tests/createInfiniteCachingClient";
-import { useBranch, useBranches, useCreateBranch, useDeleteBranch } from "./branches";
-import { act } from "react-test-renderer";
-
-describe("Test branches hooks", () => {
-  const repository: Repository = {
-    namespace: "hitchhiker",
-    name: "heart-of-gold",
-    type: "hg",
-    _links: {
-      branches: {
-        href: "/hog/branches"
-      }
-    }
-  };
-
-  const develop: Branch = {
-    name: "develop",
-    revision: "42",
-    lastCommitter: { name: "trillian" },
-    _links: {
-      delete: {
-        href: "/hog/branches/develop"
-      }
-    }
-  };
-
-  const feature: Branch = {
-    name: "feature/something-special",
-    revision: "42",
-    lastCommitter: { name: "trillian" },
-    _links: {
-      delete: {
-        href: "/hog/branches/feature%2Fsomething-special"
-      }
-    }
-  };
-
-  const branches: BranchCollection = {
-    _embedded: {
-      branches: [develop]
-    },
-    _links: {}
-  };
-
-  const queryClient = createInfiniteCachingClient();
-
-  beforeEach(() => {
-    queryClient.clear();
-  });
-
-  afterEach(() => {
-    fetchMock.reset();
-  });
-
-  describe("useBranches tests", () => {
-    const fetchBrances = async () => {
-      fetchMock.getOnce("/api/v2/hog/branches", branches);
-
-      const { result, waitFor } = renderHook(() => useBranches(repository), {
-        wrapper: createWrapper(undefined, queryClient)
-      });
-      await waitFor(() => {
-        return !!result.current.data;
-      });
-
-      return result.current.data;
-    };
-
-    it("should return branches", async () => {
-      const branches = await fetchBrances();
-      expect(branches).toEqual(branches);
-    });
-
-    it("should add branches to cache", async () => {
-      await fetchBrances();
-
-      const data = queryClient.getQueryData<BranchCollection>([
-        "repository",
-        "hitchhiker",
-        "heart-of-gold",
-        "branches"
-      ]);
-      expect(data).toEqual(branches);
-    });
-  });
-
-  describe("useBranch tests", () => {
-    const fetchBranch = async (name: string, branch: Branch) => {
-      fetchMock.getOnce("/api/v2/hog/branches/" + encodeURIComponent(name), branch);
-
-      const { result, waitFor } = renderHook(() => useBranch(repository, name), {
-        wrapper: createWrapper(undefined, queryClient)
-      });
-
-      expect(result.error).toBeUndefined();
-
-      await waitFor(() => {
-        return !!result.current.data;
-      });
-
-      return result.current.data;
-    };
-
-    it("should return branch", async () => {
-      const branch = await fetchBranch("develop", develop);
-      expect(branch).toEqual(develop);
-    });
-
-    it("should escape branch name", async () => {
-      const branch = await fetchBranch("feature/something-special", feature);
-      expect(branch).toEqual(feature);
-    });
-  });
-
-  describe("useCreateBranch tests", () => {
-    const createBranch = async () => {
-      fetchMock.postOnce("/api/v2/hog/branches", {
-        status: 201,
-        headers: {
-          Location: "/hog/branches/develop"
-        }
-      });
-
-      fetchMock.getOnce("/api/v2/hog/branches/develop", develop);
-
-      const { result, waitForNextUpdate } = renderHook(() => useCreateBranch(repository), {
-        wrapper: createWrapper(undefined, queryClient)
-      });
-
-      await act(() => {
-        const { create } = result.current;
-        create({ name: "develop", parent: "main" });
-        return waitForNextUpdate();
-      });
-
-      return result.current;
-    };
-
-    it("should create branch", async () => {
-      const { branch } = await createBranch();
-      expect(branch).toEqual(develop);
-    });
-
-    it("should cache created branch", async () => {
-      await createBranch();
-
-      const branch = queryClient.getQueryData<Branch>([
-        "repository",
-        "hitchhiker",
-        "heart-of-gold",
-        "branch",
-        "develop"
-      ]);
-      expect(branch).toEqual(develop);
-    });
-
-    it("should invalidate cached branches list", async () => {
-      queryClient.setQueryData(["repository", "hitchhiker", "heart-of-gold", "branches"], branches);
-      await createBranch();
-
-      const queryState = queryClient.getQueryState(["repository", "hitchhiker", "heart-of-gold", "branches"]);
-      expect(queryState!.isInvalidated).toBe(true);
-    });
-  });
-
-  describe("useDeleteBranch tests", () => {
-    const deleteBranch = async () => {
-      fetchMock.deleteOnce("/api/v2/hog/branches/develop", {
-        status: 204
-      });
-
-      const { result, waitForNextUpdate } = renderHook(() => useDeleteBranch(repository), {
-        wrapper: createWrapper(undefined, queryClient)
-      });
-
-      await act(() => {
-        const { remove } = result.current;
-        remove(develop);
-        return waitForNextUpdate();
-      });
-
-      return result.current;
-    };
-
-    it("should delete branch", async () => {
-      const { isDeleted } = await deleteBranch();
-      expect(isDeleted).toBe(true);
-    });
-
-    it("should delete branch cache", async () => {
-      queryClient.setQueryData(["repository", "hitchhiker", "heart-of-gold", "branch", "develop"], develop);
-      await deleteBranch();
-
-      const queryState = queryClient.getQueryState(["repository", "hitchhiker", "heart-of-gold", "branch", "develop"]);
-      expect(queryState).toBeUndefined();
-    });
-
-    it("should invalidate cached branches list", async () => {
-      queryClient.setQueryData(["repository", "hitchhiker", "heart-of-gold", "branches"], branches);
-      await deleteBranch();
-
-      const queryState = queryClient.getQueryState(["repository", "hitchhiker", "heart-of-gold", "branches"]);
-      expect(queryState!.isInvalidated).toBe(true);
-    });
-  });
-});

package/src/branches.ts

@@ -1,201 +0,0 @@
-/*
- * 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 {
-  Branch,
-  BranchCollection,
-  BranchCreation,
-  BranchDetails,
-  BranchDetailsCollection,
-  Link,
-  NamespaceAndName,
-  Repository
-} from "@scm-manager/ui-types";
-import { requiredLink } from "./links";
-import { useInfiniteQuery, useMutation, useQuery, useQueryClient } from "react-query";
-import { ApiResult, ApiResultWithFetching } from "./base";
-import { branchQueryKey, repoQueryKey } from "./keys";
-import { apiClient } from "./apiclient";
-import { concat } from "./urls";
-import { useEffect } from "react";
-
-export const useBranches = (repository: Repository): ApiResult<BranchCollection> => {
-  const queryClient = useQueryClient();
-  const link = requiredLink(repository, "branches");
-  return useQuery<BranchCollection, Error>(
-    repoQueryKey(repository, "branches"),
-    () => apiClient.get(link).then(response => response.json()),
-    {
-      onSuccess: () => {
-        return queryClient.invalidateQueries(branchDetailsQueryKey(repository));
-      }
-    }
-    // we do not populate the cache for a single branch,
-    // because we have no pagination for branches and if we have a lot of them
-    // the population slows us down
-  );
-};
-
-export const useBranch = (repository: Repository, name: string): ApiResultWithFetching<Branch> => {
-  const link = requiredLink(repository, "branches");
-  return useQuery<Branch, Error>(branchQueryKey(repository, name), () =>
-    apiClient.get(concat(link, encodeURIComponent(name))).then(response => response.json())
-  );
-};
-
-function chunkBranches(branches: Branch[]) {
-  const chunks: Branch[][] = [];
-  const chunkSize = 5;
-  let chunkIndex = 0;
-  for (const branch of branches) {
-    if (!chunks[chunkIndex]) {
-      chunks[chunkIndex] = [];
-    }
-    chunks[chunkIndex].push(branch);
-    if (chunks[chunkIndex].length >= chunkSize) {
-      chunkIndex = chunkIndex + 1;
-    }
-  }
-  return chunks;
-}
-
-const branchDetailsQueryKey = (repository: NamespaceAndName, branch: string | undefined = undefined) => {
-  let branchName;
-  if (!branch) {
-    branchName = "_";
-  } else {
-    branchName = branch;
-  }
-  return [...repoQueryKey(repository), "branch-details", branchName];
-};
-
-export const useBranchDetailsCollection = (repository: Repository, branches: Branch[]) => {
-  const link = requiredLink(repository, "branchDetailsCollection");
-  const chunks = chunkBranches(branches);
-  const queryClient = useQueryClient();
-
-  const { data, isLoading, error, fetchNextPage } = useInfiniteQuery<
-    BranchDetailsCollection,
-    Error,
-    BranchDetailsCollection
-  >(
-    branchDetailsQueryKey(repository),
-    ({ pageParam = 0 }) => {
-      const encodedBranches = chunks[pageParam]?.map(b => encodeURIComponent(b.name)).join("&branches=");
-      return apiClient.get(concat(link, `?branches=${encodedBranches}`)).then(response => response.json());
-    },
-    {
-      getNextPageParam: (lastPage, allPages) => {
-        if (allPages.length >= chunks.length) {
-          return undefined;
-        }
-        return allPages.length;
-      },
-      onSuccess: newData => {
-        newData.pages
-          .flatMap(d => d._embedded?.branchDetails)
-          .filter(d => !!d)
-          .forEach(d => queryClient.setQueryData(branchDetailsQueryKey(repository, d!.branchName), () => d));
-      }
-    }
-  );
-
-  useEffect(() => {
-    fetchNextPage();
-  }, [data, fetchNextPage]);
-
-  return {
-    data: data?.pages?.map(d => d._embedded?.branchDetails).flat(1),
-    isLoading,
-    error
-  };
-};
-
-export const useBranchDetails = (repository: Repository, branch: Branch) => {
-  const link = (branch._links.details as Link).href;
-  const queryKey = branchDetailsQueryKey(repository, branch.name);
-  return useQuery<BranchDetails, Error>(queryKey, () => apiClient.get(link).then(response => response.json()));
-};
-
-const createBranch = (link: string) => {
-  return (branch: BranchCreation) => {
-    return apiClient
-      .post(link, branch, "application/vnd.scmm-branchRequest+json;v=2")
-      .then(response => {
-        const location = response.headers.get("Location");
-        if (!location) {
-          throw new Error("Server does not return required Location header");
-        }
-        return apiClient.get(location);
-      })
-      .then(response => response.json());
-  };
-};
-
-export const useCreateBranch = (repository: Repository) => {
-  const queryClient = useQueryClient();
-  const link = requiredLink(repository, "branches");
-  const { mutate, isLoading, error, data } = useMutation<Branch, Error, BranchCreation>(createBranch(link), {
-    onSuccess: async branch => {
-      queryClient.setQueryData(branchQueryKey(repository, branch), branch);
-      await queryClient.invalidateQueries(repoQueryKey(repository, "branches"));
-    }
-  });
-  return {
-    create: (branch: BranchCreation) => mutate(branch),
-    isLoading,
-    error,
-    branch: data
-  };
-};
-
-export const useDeleteBranch = (repository: Repository) => {
-  const queryClient = useQueryClient();
-  const { mutate, isLoading, error, data } = useMutation<unknown, Error, Branch>(
-    branch => {
-      const deleteUrl = (branch._links.delete as Link).href;
-      return apiClient.delete(deleteUrl);
-    },
-    {
-      onSuccess: async (_, branch) => {
-        queryClient.removeQueries(branchQueryKey(repository, branch));
-        await queryClient.invalidateQueries(repoQueryKey(repository, "branches"));
-      }
-    }
-  );
-  return {
-    remove: (branch: Branch) => mutate(branch),
-    isLoading,
-    error,
-    isDeleted: !!data
-  };
-};
-
-type DefaultBranch = { defaultBranch: string };
-
-export const useDefaultBranch = (repository: Repository): ApiResult<DefaultBranch> => {
-  const link = requiredLink(repository, "defaultBranch");
-  return useQuery<DefaultBranch, Error>(branchQueryKey(repository, "__default-branch"), () =>
-    apiClient.get(link).then(response => response.json())
-  );
-};