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

feedback

Browse Source 
Signed-off-by: jrusso1020 <jrusso@brex.com>
This commit is contained in:
jrusso1020
2021-05-17 09:52:00 -04:00
parent 65e6c45410
commit 14ed269407
15 changed files with 35 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend-common/api-report.md
+4 -4
View File
@@ -32,7 +32,7 @@ import { Writable } from 'stream';
// @public (undocumented)
export class AzureUrlReader implements UrlReader {
constructor(integration: AzureIntegration, deps: {
treeResponseFactory: IReadTreeResponseFactory;
treeResponseFactory: ReadTreeResponseFactory;
});
// (undocumented)
static factory: ReaderFactory;
@@ -49,7 +49,7 @@ export class AzureUrlReader implements UrlReader {
// @public
export class BitbucketUrlReader implements UrlReader {
constructor(integration: BitbucketIntegration, deps: {
treeResponseFactory: IReadTreeResponseFactory;
treeResponseFactory: ReadTreeResponseFactory;
});
// (undocumented)
static factory: ReaderFactory;
@@ -214,7 +214,7 @@ export class Git {
// @public
export class GithubUrlReader implements UrlReader {
constructor(integration: GitHubIntegration, deps: {
treeResponseFactory: IReadTreeResponseFactory;
treeResponseFactory: ReadTreeResponseFactory;
credentialsProvider: GithubCredentialsProvider;
});
// (undocumented)
@@ -232,7 +232,7 @@ export class GithubUrlReader implements UrlReader {
// @public (undocumented)
export class GitlabUrlReader implements UrlReader {
constructor(integration: GitLabIntegration, deps: {
treeResponseFactory: IReadTreeResponseFactory;
treeResponseFactory: ReadTreeResponseFactory;
});
// (undocumented)
static factory: ReaderFactory;
packages/backend-common/src/reading/AzureUrlReader.test.ts
+2 -2
View File
@@ -29,11 +29,11 @@ import path from 'path';
import { NotModifiedError } from '@backstage/errors';
import { getVoidLogger } from '../logging';
import { AzureUrlReader } from './AzureUrlReader';
import { ReadTreeResponseFactory } from './tree';
import { DefaultReadTreeResponseFactory } from './tree';
const logger = getVoidLogger();
const treeResponseFactory = ReadTreeResponseFactory.create({
const treeResponseFactory = DefaultReadTreeResponseFactory.create({
config: new ConfigReader({}),
});
packages/backend-common/src/reading/AzureUrlReader.ts
+2 -2
View File
@@ -29,7 +29,7 @@ import { Readable } from 'stream';
import { NotFoundError, NotModifiedError } from '@backstage/errors';
import { stripFirstDirectoryFromPath } from './tree/util';
import {
IReadTreeResponseFactory,
ReadTreeResponseFactory,
ReaderFactory,
ReadTreeOptions,
ReadTreeResponse,
@@ -50,7 +50,7 @@ export class AzureUrlReader implements UrlReader {
constructor(
private readonly integration: AzureIntegration,
private readonly deps: { treeResponseFactory: IReadTreeResponseFactory },
private readonly deps: { treeResponseFactory: ReadTreeResponseFactory },
) {}
async read(url: string): Promise<Buffer> {
packages/backend-common/src/reading/BitbucketUrlReader.test.ts
+2 -2
View File
@@ -28,9 +28,9 @@ import os from 'os';
import path from 'path';
import { NotModifiedError } from '@backstage/errors';
import { BitbucketUrlReader } from './BitbucketUrlReader';
import { ReadTreeResponseFactory } from './tree';
import { DefaultReadTreeResponseFactory } from './tree';
const treeResponseFactory = ReadTreeResponseFactory.create({
const treeResponseFactory = DefaultReadTreeResponseFactory.create({
config: new ConfigReader({}),
});
packages/backend-common/src/reading/BitbucketUrlReader.ts
+2 -2
View File
@@ -29,7 +29,7 @@ import { Readable } from 'stream';
import { NotFoundError, NotModifiedError } from '@backstage/errors';
import { stripFirstDirectoryFromPath } from './tree/util';
import {
IReadTreeResponseFactory,
ReadTreeResponseFactory,
ReaderFactory,
ReadTreeOptions,
ReadTreeResponse,
@@ -56,7 +56,7 @@ export class BitbucketUrlReader implements UrlReader {
constructor(
private readonly integration: BitbucketIntegration,
private readonly deps: { treeResponseFactory: IReadTreeResponseFactory },
private readonly deps: { treeResponseFactory: ReadTreeResponseFactory },
) {
const {
host,
packages/backend-common/src/reading/FetchUrlReader.test.ts
+2 -2
View File
@@ -19,7 +19,7 @@ import { msw } from '@backstage/test-utils';
import { setupServer } from 'msw/node';
import { getVoidLogger } from '../logging';
import { FetchUrlReader } from './FetchUrlReader';
import { ReadTreeResponseFactory } from './tree';
import { DefaultReadTreeResponseFactory } from './tree';
describe('FetchUrlReader', () => {
const worker = setupServer();
@@ -45,7 +45,7 @@ describe('FetchUrlReader', () => {
},
}),
logger: getVoidLogger(),
treeResponseFactory: ReadTreeResponseFactory.create({
treeResponseFactory: DefaultReadTreeResponseFactory.create({
config: new ConfigReader({}),
}),
});
packages/backend-common/src/reading/GithubUrlReader.test.ts
+2 -2
View File
@@ -35,9 +35,9 @@ import {
GhTreeResponse,
GithubUrlReader,
} from './GithubUrlReader';
import { ReadTreeResponseFactory } from './tree';
import { DefaultReadTreeResponseFactory } from './tree';
const treeResponseFactory = ReadTreeResponseFactory.create({
const treeResponseFactory = DefaultReadTreeResponseFactory.create({
config: new ConfigReader({}),
});
packages/backend-common/src/reading/GithubUrlReader.ts
+2 -2
View File
@@ -27,7 +27,7 @@ import { Minimatch } from 'minimatch';
import { Readable } from 'stream';
import { NotFoundError, NotModifiedError } from '@backstage/errors';
import {
IReadTreeResponseFactory,
ReadTreeResponseFactory,
ReaderFactory,
ReadTreeOptions,
ReadTreeResponse,
@@ -65,7 +65,7 @@ export class GithubUrlReader implements UrlReader {
constructor(
private readonly integration: GitHubIntegration,
private readonly deps: {
treeResponseFactory: IReadTreeResponseFactory;
treeResponseFactory: ReadTreeResponseFactory;
credentialsProvider: GithubCredentialsProvider;
},
) {
packages/backend-common/src/reading/GitlabUrlReader.test.ts
+2 -2
View File
@@ -24,7 +24,7 @@ import os from 'os';
import path from 'path';
import { getVoidLogger } from '../logging';
import { GitlabUrlReader } from './GitlabUrlReader';
import { ReadTreeResponseFactory } from './tree';
import { DefaultReadTreeResponseFactory } from './tree';
import { NotModifiedError, NotFoundError } from '@backstage/errors';
import {
GitLabIntegration,
@@ -33,7 +33,7 @@ import {
const logger = getVoidLogger();
const treeResponseFactory = ReadTreeResponseFactory.create({
const treeResponseFactory = DefaultReadTreeResponseFactory.create({
config: new ConfigReader({}),
});
packages/backend-common/src/reading/GitlabUrlReader.ts
+2 -2
View File
@@ -27,7 +27,7 @@ import { Readable } from 'stream';
import { NotFoundError, NotModifiedError } from '@backstage/errors';
import { stripFirstDirectoryFromPath } from './tree/util';
import {
IReadTreeResponseFactory,
ReadTreeResponseFactory,
ReaderFactory,
ReadTreeOptions,
ReadTreeResponse,
@@ -50,7 +50,7 @@ export class GitlabUrlReader implements UrlReader {
constructor(
private readonly integration: GitLabIntegration,
private readonly deps: { treeResponseFactory: IReadTreeResponseFactory },
private readonly deps: { treeResponseFactory: ReadTreeResponseFactory },
) {}
async read(url: string): Promise<Buffer> {
packages/backend-common/src/reading/GoogleGcsUrlReader.test.ts
+2 -2
View File
@@ -16,7 +16,7 @@
import { ConfigReader, JsonObject } from '@backstage/config';
import { getVoidLogger } from '../logging';
import { ReadTreeResponseFactory } from './tree';
import { DefaultReadTreeResponseFactory } from './tree';
import { GoogleGcsUrlReader } from './GoogleGcsUrlReader';
import { UrlReaderPredicateTuple } from './types';
@@ -25,7 +25,7 @@ describe('GcsUrlReader', () => {
return GoogleGcsUrlReader.factory({
config: new ConfigReader(config),
logger: getVoidLogger(),
treeResponseFactory: ReadTreeResponseFactory.create({
treeResponseFactory: DefaultReadTreeResponseFactory.create({
config: new ConfigReader({}),
}),
});
packages/backend-common/src/reading/UrlReaders.ts
+4 -2
View File
@@ -22,7 +22,7 @@ import { AzureUrlReader } from './AzureUrlReader';
import { BitbucketUrlReader } from './BitbucketUrlReader';
import { GithubUrlReader } from './GithubUrlReader';
import { GitlabUrlReader } from './GitlabUrlReader';
import { ReadTreeResponseFactory } from './tree';
import { DefaultReadTreeResponseFactory } from './tree';
import { FetchUrlReader } from './FetchUrlReader';
import { GoogleGcsUrlReader } from './GoogleGcsUrlReader';
@@ -44,7 +44,9 @@ export class UrlReaders {
*/
static create({ logger, config, factories }: CreateOptions): UrlReader {
const mux = new UrlReaderPredicateMux();
const treeResponseFactory = ReadTreeResponseFactory.create({ config });
const treeResponseFactory = DefaultReadTreeResponseFactory.create({
config,
});
for (const factory of factories ?? []) {
const tuples = factory({ config, logger: logger, treeResponseFactory });
packages/backend-common/src/reading/tree/ReadTreeResponseFactory.ts
+4 -4
View File
@@ -19,14 +19,14 @@ import { Config } from '@backstage/config';
import {
ReadTreeResponse,
FromArchiveOptions,
IReadTreeResponseFactory,
ReadTreeResponseFactory,
} from '../types';
import { TarArchiveResponse } from './TarArchiveResponse';
import { ZipArchiveResponse } from './ZipArchiveResponse';
export class ReadTreeResponseFactory implements IReadTreeResponseFactory {
static create(options: { config: Config }): ReadTreeResponseFactory {
return new ReadTreeResponseFactory(
export class DefaultReadTreeResponseFactory implements ReadTreeResponseFactory {
static create(options: { config: Config }): DefaultReadTreeResponseFactory {
return new DefaultReadTreeResponseFactory(
options.config.getOptionalString('backend.workingDirectory') ??
os.tmpdir(),
);
packages/backend-common/src/reading/tree/index.ts
+1 -1
View File
@@ -14,4 +14,4 @@
* limitations under the License.
*/
export { ReadTreeResponseFactory } from './ReadTreeResponseFactory';
export { DefaultReadTreeResponseFactory } from './ReadTreeResponseFactory';
packages/backend-common/src/reading/types.ts
+2 -2
View File
@@ -39,7 +39,7 @@ export type UrlReaderPredicateTuple = {
export type ReaderFactory = (options: {
config: Config;
logger: Logger;
treeResponseFactory: IReadTreeResponseFactory;
treeResponseFactory: ReadTreeResponseFactory;
}) => UrlReaderPredicateTuple[];
/**
@@ -117,7 +117,7 @@ export type FromArchiveOptions = {
filter?: (path: string) => boolean;
};
export interface IReadTreeResponseFactory {
export interface ReadTreeResponseFactory {
fromTarArchive(options: FromArchiveOptions): Promise<ReadTreeResponse>;
fromZipArchive(options: FromArchiveOptions): Promise<ReadTreeResponse>;
}