deprecate EntityName, introduce CompoundEntityRef

deprecate getEntityName, introduce getCompoundEntityRef

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2022-03-02 21:26:22 +01:00
parent 80d2674a31
commit 36aa63022b
84 changed files with 393 additions and 268 deletions
@@ -15,7 +15,7 @@
*/
import { CatalogApi } from '@backstage/catalog-client';
import { Entity, EntityName } from '@backstage/catalog-model';
import { Entity, CompoundEntityRef } from '@backstage/catalog-model';
import { ConfigReader } from '@backstage/config';
import {
DefaultJenkinsInfoProvider,
@@ -163,7 +163,7 @@ describe('DefaultJenkinsInfoProvider', () => {
getEntityByName: jest.fn(),
} as any as jest.Mocked<CatalogApi>;
const entityRef: EntityName = {
const entityRef: CompoundEntityRef = {
kind: 'Component',
namespace: 'foo',
name: 'bar',
@@ -17,7 +17,7 @@
import { CatalogApi } from '@backstage/catalog-client';
import {
Entity,
EntityName,
CompoundEntityRef,
stringifyEntityRef,
} from '@backstage/catalog-model';
import { Config } from '@backstage/config';
@@ -27,7 +27,7 @@ export interface JenkinsInfoProvider {
/**
* The entity to get the info about.
*/
entityRef: EntityName;
entityRef: CompoundEntityRef;
/**
* A specific job to get. This is only passed in when we know about a job name we are interested in.
*/
@@ -182,7 +182,7 @@ export class DefaultJenkinsInfoProvider implements JenkinsInfoProvider {
}
async getInstance(opt: {
entityRef: EntityName;
entityRef: CompoundEntityRef;
jobFullName?: string;
}): Promise<JenkinsInfo> {
// load entity
@@ -18,7 +18,7 @@ import { createServiceBuilder } from '@backstage/backend-common';
import { Server } from 'http';
import { Logger } from 'winston';
import { createRouter } from './router';
import { EntityName } from '@backstage/catalog-model';
import { CompoundEntityRef } from '@backstage/catalog-model';
import { JenkinsInfo } from './jenkinsInfoProvider';
export interface ServerOptions {
@@ -35,7 +35,9 @@ export async function startStandaloneServer(
const router = await createRouter({
logger,
jenkinsInfoProvider: {
async getInstance(_: { entityRef: EntityName }): Promise<JenkinsInfo> {
async getInstance(_: {
entityRef: CompoundEntityRef;
}): Promise<JenkinsInfo> {
return { baseUrl: 'https://example.com/', jobFullName: 'build-foo' };
},
},