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

backend-common: merge GitlabReaderProcessor functionality into GitlabUrlReader

Browse Source
This commit is contained in:
Patrik Oldsberg
2020-10-02 15:50:49 +02:00
parent f50a233a4f
commit 1e97419d30
3 changed files with 71 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend-common/src/reading/GitlabReaderProcessor.ts
-89
View File
@@ -1,89 +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 { LocationSpec } from '@backstage/catalog-model';
import fetch from 'node-fetch';
import * as result from './results';
import { LocationProcessor, LocationProcessorEmit } from './types';
export class GitlabReaderProcessor implements LocationProcessor {
async readLocation(
location: LocationSpec,
optional: boolean,
emit: LocationProcessorEmit,
): Promise<boolean> {
if (location.type !== 'gitlab') {
return false;
}
try {
const url = this.buildRawUrl(location.target);
const response = await fetch(url.toString());
if (response.ok) {
const data = await response.buffer();
emit(result.data(location, data));
} else {
const message = `${location.target} could not be read as ${url}, ${response.status} ${response.statusText}`;
if (response.status === 404) {
if (!optional) {
throw result.notFoundError(location, message);
}
} else {
throw result.generalError(location, message);
}
}
} catch (e) {
const message = `Unable to read ${location.type} ${location.target}, ${e}`;
emit(result.generalError(location, message));
}
return true;
}
// Converts
// from: https://gitlab.example.com/a/b/blob/master/c.yaml
// to: https://gitlab.example.com/a/b/raw/master/c.yaml
private buildRawUrl(target: string): URL {
try {
const url = new URL(target);
const [empty, userOrOrg, repoName, , ...restOfPath] = url.pathname
.split('/')
// for the common case https://gitlab.example.com/a/b/-/blob/master/c.yaml
.filter(path => path !== '-');
if (
empty !== '' ||
userOrOrg === '' ||
repoName === '' ||
!restOfPath.join('/').match(/\.yaml$/)
) {
throw new Error('Wrong GitLab URL');
}
// Replace 'blob' with 'raw'
url.pathname = [empty, userOrOrg, repoName, 'raw', ...restOfPath].join(
'/',
);
return url;
} catch (e) {
throw new Error(`Incorrect url: ${target}, ${e}`);
}
}
}
packages/backend-common/src/reading/GitlabUrlReader.test.ts
+28 -2
View File
@@ -35,7 +35,7 @@ describe('GitlabUrlReader', () => {
},
]);
it('should build raw api', () => {
it('should build project urls', () => {
const processor = new GitlabUrlReader(
readConfig(createConfig(undefined))[0],
);
@@ -69,7 +69,33 @@ describe('GitlabUrlReader', () => {
for (const test of tests) {
if (test.url) {
expect(processor.buildRawUrl(test.target, 12345).toString()).toEqual(
expect(
processor.buildProjectUrl(test.target, 12345).toString(),
).toEqual(test.url.toString());
} else {
throw new Error(
'This should not have happened. Either err or url should have matched.',
);
}
}
});
it('should build raw urls', () => {
const processor = new GitlabUrlReader(
readConfig(createConfig(undefined))[0],
);
const tests = [
{
target: 'https://gitlab.example.com/a/b/blob/master/c.yaml',
url: new URL('https://gitlab.example.com/a/b/raw/master/c.yaml'),
err: undefined,
},
];
for (const test of tests) {
if (test.url) {
expect(processor.buildRawUrl(test.target).toString()).toEqual(
test.url.toString(),
);
} else {
packages/backend-common/src/reading/GitlabUrlReader.ts
+43 -3
View File
@@ -68,8 +68,16 @@ export class GitlabUrlReader implements UrlReader {
}
async read(url: string): Promise<Buffer> {
const projectID = await this.getProjectID(url);
const builtUrl = this.buildRawUrl(url, projectID);
// TODO(Rugvip): merged the old GitlabReaderProcessor in here and used
// the existence of /~/blob/ to switch the logic. Don't know if this
// makes sense and it might require some more work.
let builtUrl: URL;
if (url.includes('/-/blob/')) {
const projectID = await this.getProjectID(url);
builtUrl = this.buildProjectUrl(url, projectID);
} else {
builtUrl = this.buildRawUrl(url);
}
let response: Response;
try {
@@ -89,9 +97,41 @@ export class GitlabUrlReader implements UrlReader {
throw new Error(message);
}
// Converts
// from: https://gitlab.example.com/a/b/blob/master/c.yaml
// to: https://gitlab.example.com/a/b/raw/master/c.yaml
buildRawUrl(target: string): URL {
try {
const url = new URL(target);
const [empty, userOrOrg, repoName, ...restOfPath] = url.pathname
.split('/')
// for the common case https://gitlab.example.com/a/b/-/blob/master/c.yaml
.filter(path => path !== '-');
if (
empty !== '' ||
userOrOrg === '' ||
repoName === '' ||
!restOfPath.join('/').match(/\.yaml$/)
) {
throw new Error('Wrong GitLab URL');
}
// Replace 'blob' with 'raw'
url.pathname = [empty, userOrOrg, repoName, 'raw', ...restOfPath].join(
'/',
);
return url;
} catch (e) {
throw new Error(`Incorrect url: ${target}, ${e}`);
}
}
// convert https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath
// to https://gitlab.com/api/v4/projects/<PROJECTID>/repository/files/filepath?ref=branch
buildRawUrl(target: string, projectID: Number): URL {
buildProjectUrl(target: string, projectID: Number): URL {
try {
const url = new URL(target);