paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 49 Packages Projects Releases Wiki Activity

Fix review comments

Browse Source 
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
This commit is contained in:
Dominik Henneke
2021-04-20 17:04:25 +02:00
parent 40d1e11cf3
commit 091b3f7363
9 changed files with 118 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/fossa/src/api/FossaClient.test.ts
+64
View File
@@ -287,6 +287,70 @@ describe('FossaClient', () => {
);
});
it('should handle multiple pages', async () => {
server.use(
rest.get(`${mockBaseUrl}/fossa/projects`, (req, res, ctx) => {
const page = req.url.searchParams.get('page');
if (page === '0') {
return res(
ctx.json(
[...Array(1000)].map(() => ({
locator: 'custom+8736/our-service',
title: 'our-service-2',
default_branch: 'develop',
revisions: [
{
updatedAt: '2020-01-01T00:00:00Z',
dependency_count: 160,
unresolved_licensing_issue_count: 5,
unresolved_issue_count: 100,
},
],
})),
),
);
}
return res(
ctx.json([
{
locator: 'custom+8736/our-service',
title: 'our-service',
default_branch: 'develop',
revisions: [
{
updatedAt: '2020-01-01T00:00:00Z',
dependency_count: 160,
unresolved_licensing_issue_count: 5,
unresolved_issue_count: 100,
},
],
},
]),
);
}),
);
const summary = await client.getFindingSummaries(['our-service']);
expect(summary).toEqual(
new Map<string, FindingSummary>([
[
'our-service',
{
timestamp: '2020-01-01T00:00:00Z',
issueCount: 5,
dependencyCount: 160,
projectDefaultBranch: 'develop',
projectUrl:
'https://app.fossa.com/projects/custom%2B8736%2Four-service',
},
],
]),
);
});
it('should handle empty result', async () => {
server.use(
rest.get(`${mockBaseUrl}/fossa/projects`, (_req, res, ctx) => {
plugins/fossa/src/api/FossaClient.ts
+13 -20
View File
@@ -55,7 +55,7 @@ export class FossaClient implements FossaApi {
private async callApi<T>(
path: string,
query: Record<string, any>,
): Promise<T | undefined> {
): Promise<T> {
const apiUrl = `${await this.discoveryApi.getBaseUrl('proxy')}/fossa`;
const idToken = await this.identityApi.getIdToken();
const response = await fetch(
@@ -75,30 +75,23 @@ export class FossaClient implements FossaApi {
async *getProject(
projectTitles: Set<string>,
): AsyncIterable<{ title: string; summary: FindingSummary }> {
let nextPage = 0;
const pageSize = 1000;
for (;;) {
const projects = await this.limit(
page =>
this.callApi<FossaProjectsResponse[]>('projects', {
count: pageSize,
page,
sort: 'title+',
...(this.organizationId && {
organizationId: this.organizationId,
}),
...(projectTitles.size === 1 && {
title: projectTitles.values().next().value,
}),
for (let page = 0; ; page++) {
const projects = await this.limit(() =>
this.callApi<FossaProjectsResponse[]>('projects', {
count: pageSize,
page,
sort: 'title+',
...(this.organizationId && {
organizationId: this.organizationId,
}),
nextPage++,
...(projectTitles.size === 1 && {
title: projectTitles.values().next().value,
}),
}),
);
if (!projects) {
break;
}
for (const project of projects) {
if (projectTitles.has(project.title) && project.revisions.length > 0) {
const revision = project.revisions[0];
plugins/fossa/src/components/FossaCard/FossaCard.tsx
+3 -3
View File
@@ -32,8 +32,8 @@ import { useAsync } from 'react-use';
import { fossaApiRef } from '../../api';
import {
FOSSA_PROJECT_NAME_ANNOTATION,
useProjectName,
} from '../useProjectName';
getProjectName,
} from '../getProjectName';
const useStyles = makeStyles(theme => ({
numberError: {
@@ -102,7 +102,7 @@ export const FossaCard = ({ variant }: { variant?: InfoCardVariants }) => {
const { entity } = useEntity();
const fossaApi = useApi(fossaApiRef);
const projectTitle = useProjectName(entity);
const projectTitle = getProjectName(entity);
const { value, loading, error } = useAsync(
async () =>
projectTitle ? fossaApi.getFindingSummary(projectTitle) : undefined,
plugins/fossa/src/components/FossaPage/FossaPage.tsx
+8 -3
View File
@@ -45,7 +45,7 @@ import * as React from 'react';
import { useMemo } from 'react';
import { useAsync } from 'react-use';
import { FindingSummary, fossaApiRef } from '../../api';
import { useProjectNames } from '../useProjectNames';
import { getProjectName } from '../getProjectName';
type FossaRow = {
entity: Entity;
@@ -63,7 +63,9 @@ const columns: TableColumn<FossaRow>[] = [
title: 'Name',
field: 'resolved.name',
highlight: true,
render: ({ entity }) => <EntityRefLink entityRef={entity} />,
render: ({ entity }) => (
<EntityRefLink entityRef={entity} defaultKind="Component" />
),
},
{
title: 'Owner',
@@ -170,7 +172,10 @@ export const FossaPage = () => {
});
// get the project names of all entities. the idx of both lists match.
const projectNames = useProjectNames(entities?.items);
const projectNames = useMemo(
() => entities?.items?.map(getProjectName) ?? [],
[entities?.items],
);
// get the summary list
const { value: summaries, loading: summariesLoading } = useAsync(
plugins/fossa/src/components/useProjectName.test.ts → plugins/fossa/src/components/getProjectName.test.ts
+28 -14
View File
@@ -16,23 +16,37 @@
import { Entity } from '@backstage/catalog-model';
import { renderHook } from '@testing-library/react-hooks';
import { useProjectName } from './useProjectName';
describe('useProjectName', () => {
const entity: Entity = {
apiVersion: 'v1',
kind: 'Component',
metadata: {
name: 'test',
annotations: {
'fossa.io/project-name': 'test',
},
},
};
import { getProjectName } from './getProjectName';
describe('getProjectName', () => {
it('should extract the fossa project name', async () => {
const { result } = renderHook(() => useProjectName(entity));
const entity: Entity = {
apiVersion: 'v1',
kind: 'Component',
metadata: {
name: 'test',
annotations: {
'fossa.io/project-name': 'test',
},
},
};
const { result } = renderHook(() => getProjectName(entity));
expect(result.current).toBe('test');
});
it('should return undefined', async () => {
const entity: Entity = {
apiVersion: 'v1',
kind: 'Component',
metadata: {
name: 'test',
},
};
const { result } = renderHook(() => getProjectName(entity));
expect(result.current).toBeUndefined();
});
});
plugins/fossa/src/components/useProjectName.ts → plugins/fossa/src/components/getProjectName.ts
+1 -1
View File
@@ -18,7 +18,7 @@ import { Entity } from '@backstage/catalog-model';
export const FOSSA_PROJECT_NAME_ANNOTATION = 'fossa.io/project-name';
export const useProjectName = (entity: Entity): string | undefined => {
export const getProjectName = (entity: Entity): string | undefined => {
return (
entity?.metadata.annotations?.[FOSSA_PROJECT_NAME_ANNOTATION] ?? undefined
);
plugins/fossa/src/components/useProjectNames.test.ts
-45
View File
@@ -1,45 +0,0 @@
/*
* Copyright 2020 Spotify AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Entity } from '@backstage/catalog-model';
import { renderHook } from '@testing-library/react-hooks';
import { useProjectNames } from './useProjectNames';
describe('useProjectNames', () => {
const entity0: Entity = {
apiVersion: 'v1',
kind: 'Component',
metadata: {
name: 'test',
annotations: {
'fossa.io/project-name': 'test',
},
},
};
const entity1: Entity = {
apiVersion: 'v1',
kind: 'Component',
metadata: {
name: 'test',
},
};
it('should extract the fossa project name', async () => {
const { result } = renderHook(() => useProjectNames([entity0, entity1]));
expect(result.current).toEqual(['test', undefined]);
});
});
plugins/fossa/src/components/useProjectNames.ts
-33
View File
@@ -1,33 +0,0 @@
/*
* Copyright 2020 Spotify AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Entity } from '@backstage/catalog-model';
import { useMemo } from 'react';
import { FOSSA_PROJECT_NAME_ANNOTATION } from './useProjectName';
export const useProjectNames = (
entities: Entity[] | undefined,
): Array<string | undefined> => {
return useMemo(
() =>
entities?.map(
entity =>
entity.metadata.annotations?.[FOSSA_PROJECT_NAME_ANNOTATION] ??
undefined,
) ?? [],
[entities],
);
};