diff --git a/.changeset/cost-insights-wise-moons-crash.md b/.changeset/cost-insights-wise-moons-crash.md
new file mode 100644
index 0000000000..1277911059
--- /dev/null
+++ b/.changeset/cost-insights-wise-moons-crash.md
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-cost-insights': patch
+---
+
+Fixed date calculations incorrectly converting to UTC in some cases. This should be a transparent change.
diff --git a/.changeset/dry-kings-hear.md b/.changeset/dry-kings-hear.md
new file mode 100644
index 0000000000..c877785329
--- /dev/null
+++ b/.changeset/dry-kings-hear.md
@@ -0,0 +1,5 @@
+---
+'@backstage/integration': patch
+---
+
+Fix gitlab handling of paths with spaces
diff --git a/.changeset/four-paws-pull.md b/.changeset/four-paws-pull.md
new file mode 100644
index 0000000000..183b3dc5d7
--- /dev/null
+++ b/.changeset/four-paws-pull.md
@@ -0,0 +1,7 @@
+---
+'@backstage/plugin-catalog-backend': minor
+---
+
+Make use of the `resolveUrl` facility of the `integration` package.
+
+Also rename the `LocationRefProcessor` to `LocationEntityProcessor`, to match the file name. This constitutes an interface change since the class is exported, but it is unlikely to be consumed outside of the package since it sits comfortably with the other default processors inside the catalog builder.
diff --git a/.changeset/late-crews-train.md b/.changeset/late-crews-train.md
new file mode 100644
index 0000000000..00f8f8b6ee
--- /dev/null
+++ b/.changeset/late-crews-train.md
@@ -0,0 +1,6 @@
+---
+'example-app': patch
+'@backstage/plugin-rollbar': patch
+---
+
+Migrated to new composability API, exporting the plugin instance as `rollbarPlugin`, the entity page content as `EntityRollbarContent`, and entity conditional as `isRollbarAvailable`. Updated the `EntityPage` for the `example-app` to include a composite `ErrorsSwitcher` component that works with both `Sentry` & `Rollbar`. Also removed the unused and undocumented `RollbarHome` related components.
diff --git a/.changeset/tame-points-search.md b/.changeset/tame-points-search.md
new file mode 100644
index 0000000000..7fffafc1cf
--- /dev/null
+++ b/.changeset/tame-points-search.md
@@ -0,0 +1,10 @@
+---
+'@backstage/integration': patch
+---
+
+Add a `resolveUrl` method to integrations, that works like the two-argument URL
+constructor. The reason for using this is that Azure have their paths in a
+query parameter, rather than the pathname of the URL.
+
+The implementation is optional (when not present, the URL constructor is used),
+so this does not imply a breaking change.
diff --git a/.changeset/wicked-boxes-taste.md b/.changeset/wicked-boxes-taste.md
new file mode 100644
index 0000000000..3eef04825c
--- /dev/null
+++ b/.changeset/wicked-boxes-taste.md
@@ -0,0 +1,5 @@
+---
+'@backstage/integration': major
+---
+
+#4322 Bitbucket own hosted v5.11.1 branchUrl fix and enabled error tracing… #4347
diff --git a/.changeset/wise-lies-listen.md b/.changeset/wise-lies-listen.md
new file mode 100644
index 0000000000..53f1edea02
--- /dev/null
+++ b/.changeset/wise-lies-listen.md
@@ -0,0 +1,5 @@
+---
+'@backstage/catalog-model': patch
+---
+
+Implement matchEntityWithRef for client side filtering of entities by ref matching
diff --git a/package.json b/package.json
index 758a8ba884..fd130fcbbd 100644
--- a/package.json
+++ b/package.json
@@ -41,7 +41,7 @@
},
"version": "1.0.0",
"devDependencies": {
- "@changesets/cli": "^2.11.0",
+ "@changesets/cli": "^2.14.0",
"@octokit/openapi-types": "^2.2.0",
"@spotify/eslint-config-oss": "^1.0.1",
"@spotify/prettier-config": "^9.0.0",
diff --git a/packages/app/src/components/catalog/EntityPage.tsx b/packages/app/src/components/catalog/EntityPage.tsx
index 0372c8759c..5474afa72c 100644
--- a/packages/app/src/components/catalog/EntityPage.tsx
+++ b/packages/app/src/components/catalog/EntityPage.tsx
@@ -13,6 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
import {
ApiEntity,
Entity,
@@ -64,6 +65,10 @@ import {
isPluginApplicableToEntity as isPagerDutyAvailable,
PagerDutyCard,
} from '@backstage/plugin-pagerduty';
+import {
+ isRollbarAvailable,
+ Router as RollbarRouter,
+} from '@backstage/plugin-rollbar';
import { Router as SentryRouter } from '@backstage/plugin-sentry';
import { EmbeddedDocsRouter as DocsRouter } from '@backstage/plugin-techdocs';
import { Button, Grid } from '@material-ui/core';
@@ -153,6 +158,15 @@ const RecentCICDRunsSwitcher = ({ entity }: { entity: Entity }) => {
);
};
+export const ErrorsSwitcher = ({ entity }: { entity: Entity }) => {
+ switch (true) {
+ case isRollbarAvailable(entity):
+ return ;
+ default:
+ return ;
+ }
+};
+
const ComponentOverviewContent = ({ entity }: { entity: Entity }) => (
@@ -212,9 +226,9 @@ const ServiceEntityPage = ({ entity }: { entity: Entity }) => (
element={}
/>
}
+ path="/errors/*"
+ title="Errors"
+ element={}
/>
(
element={}
/>
}
+ path="/errors/*"
+ title="Errors"
+ element={}
/>
Promise) {
}
describe('UrlReaders', () => {
+ jest.setTimeout(30_000);
+
it(
'should read data from azure',
withRetries(3, async () => {
diff --git a/packages/catalog-model/src/entity/index.ts b/packages/catalog-model/src/entity/index.ts
index 4afb8f5c96..e80e14f7a4 100644
--- a/packages/catalog-model/src/entity/index.ts
+++ b/packages/catalog-model/src/entity/index.ts
@@ -27,6 +27,7 @@ export type {
} from './Entity';
export * from './policies';
export {
+ compareEntityToRef,
getEntityName,
parseEntityName,
parseEntityRef,
diff --git a/packages/catalog-model/src/entity/ref.test.ts b/packages/catalog-model/src/entity/ref.test.ts
index bd7cc9477d..5ca511ee03 100644
--- a/packages/catalog-model/src/entity/ref.test.ts
+++ b/packages/catalog-model/src/entity/ref.test.ts
@@ -16,7 +16,12 @@
import { ENTITY_DEFAULT_NAMESPACE } from './constants';
import { Entity } from './Entity';
-import { parseEntityName, parseEntityRef, serializeEntityRef } from './ref';
+import {
+ compareEntityToRef,
+ parseEntityName,
+ parseEntityRef,
+ serializeEntityRef,
+} from './ref';
describe('ref', () => {
describe('parseEntityName', () => {
@@ -381,4 +386,320 @@ describe('ref', () => {
).toEqual({ kind: 'a', namespace: 'b', name: 'c/x' });
});
});
+
+ describe('compareEntityToRef', () => {
+ const entityWithNamespace: Entity = {
+ apiVersion: 'a',
+ kind: 'K',
+ metadata: {
+ name: 'n',
+ namespace: 'ns',
+ },
+ };
+ const entityWithoutNamespace: Entity = {
+ apiVersion: 'a',
+ kind: 'K',
+ metadata: {
+ name: 'n',
+ },
+ };
+
+ it('handles matching string refs', () => {
+ expect(compareEntityToRef(entityWithNamespace, 'K:ns/n')).toBe(true);
+ expect(compareEntityToRef(entityWithNamespace, 'k:nS/N')).toBe(true);
+ expect(
+ compareEntityToRef(entityWithNamespace, 'K:n', {
+ defaultNamespace: 'ns',
+ }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithNamespace, 'K:n', {
+ defaultNamespace: 'Ns',
+ }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithNamespace, 'ns/n', { defaultKind: 'K' }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithNamespace, 'n', {
+ defaultKind: 'K',
+ defaultNamespace: 'ns',
+ }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithNamespace, 'N', {
+ defaultKind: 'k',
+ defaultNamespace: 'nS',
+ }),
+ ).toBe(true);
+
+ expect(compareEntityToRef(entityWithoutNamespace, 'K:default/n')).toBe(
+ true,
+ );
+ expect(compareEntityToRef(entityWithoutNamespace, 'K:deFault/n')).toBe(
+ true,
+ );
+ expect(
+ compareEntityToRef(entityWithoutNamespace, 'K:n', {
+ defaultNamespace: 'default',
+ }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, 'K:n', {
+ defaultNamespace: 'deFault',
+ }),
+ ).toBe(true);
+ expect(compareEntityToRef(entityWithoutNamespace, 'K:default/n')).toBe(
+ true,
+ );
+ expect(compareEntityToRef(entityWithoutNamespace, 'K:n')).toBe(true);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, 'default/n', {
+ defaultKind: 'K',
+ }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, 'n', {
+ defaultKind: 'K',
+ defaultNamespace: 'default',
+ }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, 'n', {
+ defaultKind: 'K',
+ }),
+ ).toBe(true);
+ });
+
+ it('handles mismatching string refs', () => {
+ expect(compareEntityToRef(entityWithNamespace, 'X:ns/n')).toBe(false);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, 'ns/n', {
+ defaultKind: 'X',
+ }),
+ ).toBe(false);
+
+ expect(compareEntityToRef(entityWithNamespace, 'K:xx/n')).toBe(false);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, 'K:n', {
+ defaultNamespace: 'xx',
+ }),
+ ).toBe(false);
+
+ expect(compareEntityToRef(entityWithNamespace, 'K:ns/x')).toBe(false);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, 'x', {
+ defaultKind: 'K',
+ defaultNamespace: 'ns',
+ }),
+ ).toBe(false);
+ });
+
+ it('handles matching compound refs', () => {
+ expect(
+ compareEntityToRef(entityWithNamespace, {
+ kind: 'K',
+ namespace: 'ns',
+ name: 'n',
+ }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithNamespace, {
+ kind: 'k',
+ namespace: 'Ns',
+ name: 'N',
+ }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(
+ entityWithNamespace,
+ { kind: 'K', name: 'n' },
+ {
+ defaultNamespace: 'ns',
+ },
+ ),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(
+ entityWithNamespace,
+ { namespace: 'ns', name: 'n' },
+ { defaultKind: 'K' },
+ ),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithNamespace, 'n', {
+ defaultKind: 'K',
+ defaultNamespace: 'ns',
+ }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithNamespace, 'N', {
+ defaultKind: 'k',
+ defaultNamespace: 'nS',
+ }),
+ ).toBe(true);
+
+ expect(
+ compareEntityToRef(entityWithoutNamespace, {
+ kind: 'K',
+ namespace: 'default',
+ name: 'n',
+ }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, {
+ kind: 'k',
+ namespace: 'deFault',
+ name: 'N',
+ }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(
+ entityWithoutNamespace,
+ { kind: 'K', name: 'n' },
+ {
+ defaultNamespace: 'default',
+ },
+ ),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, { kind: 'K', name: 'n' }),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(
+ entityWithoutNamespace,
+ { namespace: 'default', name: 'n' },
+ {
+ defaultKind: 'K',
+ },
+ ),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(
+ entityWithoutNamespace,
+ { name: 'n' },
+ {
+ defaultKind: 'K',
+ defaultNamespace: 'default',
+ },
+ ),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(
+ entityWithoutNamespace,
+ { name: 'N' },
+ {
+ defaultKind: 'k',
+ defaultNamespace: 'defAult',
+ },
+ ),
+ ).toBe(true);
+ expect(
+ compareEntityToRef(
+ entityWithoutNamespace,
+ { name: 'n' },
+ {
+ defaultKind: 'K',
+ },
+ ),
+ ).toBe(true);
+ });
+
+ it('handles mismatching compound refs', () => {
+ expect(
+ compareEntityToRef(entityWithNamespace, {
+ kind: 'X',
+ namespace: 'ns',
+ name: 'n',
+ }),
+ ).toBe(false);
+ expect(
+ compareEntityToRef(
+ entityWithNamespace,
+ {
+ namespace: 'ns',
+ name: 'n',
+ },
+ { defaultKind: 'X' },
+ ),
+ ).toBe(false);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, {
+ kind: 'X',
+ namespace: 'default',
+ name: 'n',
+ }),
+ ).toBe(false);
+ expect(
+ compareEntityToRef(
+ entityWithoutNamespace,
+ {
+ namespace: 'default',
+ name: 'n',
+ },
+ { defaultKind: 'X' },
+ ),
+ ).toBe(false);
+
+ expect(
+ compareEntityToRef(entityWithNamespace, {
+ kind: 'K',
+ namespace: 'xx',
+ name: 'n',
+ }),
+ ).toBe(false);
+ expect(
+ compareEntityToRef(
+ entityWithNamespace,
+ {
+ kind: 'K',
+ name: 'n',
+ },
+ { defaultNamespace: 'xx' },
+ ),
+ ).toBe(false);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, {
+ kind: 'K',
+ namespace: 'xx',
+ name: 'n',
+ }),
+ ).toBe(false);
+ expect(
+ compareEntityToRef(
+ entityWithoutNamespace,
+ {
+ kind: 'K',
+ name: 'n',
+ },
+ { defaultNamespace: 'xx' },
+ ),
+ ).toBe(false);
+
+ expect(
+ compareEntityToRef(entityWithNamespace, {
+ kind: 'K',
+ namespace: 'ns',
+ name: 'x',
+ }),
+ ).toBe(false);
+ expect(
+ compareEntityToRef(entityWithoutNamespace, {
+ kind: 'K',
+ namespace: 'default',
+ name: 'x',
+ }),
+ ).toBe(false);
+ expect(
+ compareEntityToRef(
+ entityWithoutNamespace,
+ {
+ kind: 'K',
+ name: 'x',
+ },
+ { defaultNamespace: 'default' },
+ ),
+ ).toBe(false);
+ });
+ });
});
diff --git a/packages/catalog-model/src/entity/ref.ts b/packages/catalog-model/src/entity/ref.ts
index 9f6f175d8d..bf34962d01 100644
--- a/packages/catalog-model/src/entity/ref.ts
+++ b/packages/catalog-model/src/entity/ref.ts
@@ -18,6 +18,27 @@ import { EntityName, EntityRef } from '../types';
import { ENTITY_DEFAULT_NAMESPACE } from './constants';
import { Entity } from './Entity';
+function parseRefString(
+ ref: string,
+): {
+ kind?: string;
+ namespace?: string;
+ name: string;
+} {
+ const match = /^([^:/]+:)?([^:/]+\/)?([^:/]+)$/.exec(ref.trim());
+ if (!match) {
+ throw new TypeError(
+ `Entity reference "${ref}" was not on the form [:][/]`,
+ );
+ }
+
+ return {
+ kind: match[1]?.slice(0, -1),
+ namespace: match[2]?.slice(0, -1),
+ name: match[3],
+ };
+}
+
/**
* Extracts the kind, namespace and name that form the name triplet of the
* given entity.
@@ -121,17 +142,11 @@ export function parseEntityRef(
}
if (typeof ref === 'string') {
- const match = /^([^:/]+:)?([^:/]+\/)?([^:/]+)$/.exec(ref.trim());
- if (!match) {
- throw new Error(
- `Entity reference "${ref}" was not on the form [:][/]`,
- );
- }
-
+ const parsed = parseRefString(ref);
return {
- kind: match[1]?.slice(0, -1) ?? context.defaultKind,
- namespace: match[2]?.slice(0, -1) ?? context.defaultNamespace,
- name: match[3],
+ kind: parsed.kind ?? context.defaultKind,
+ namespace: parsed.namespace ?? context.defaultNamespace,
+ name: parsed.name,
};
}
@@ -196,3 +211,53 @@ export function serializeEntityRef(
return `${kind ? `${kind}:` : ''}${namespace ? `${namespace}/` : ''}${name}`;
}
+
+/**
+ * Compares an entity to either a string reference or a compound reference.
+ *
+ * The comparison is case insensitive, and all of kind, namespace, and name
+ * must match (after applying the optional context to the ref).
+ *
+ * @param entity The entity to match
+ * @param ref A string or compound entity ref
+ * @param context An optional context of default kind and namespace, that apply
+ * to the ref if given
+ * @returns True if matching, false otherwise
+ */
+export function compareEntityToRef(
+ entity: Entity,
+ ref: EntityRef | EntityName,
+ context?: EntityRefContext,
+): boolean {
+ const entityKind = entity.kind;
+ const entityNamespace = entity.metadata.namespace || ENTITY_DEFAULT_NAMESPACE;
+ const entityName = entity.metadata.name;
+
+ let refKind: string | undefined;
+ let refNamespace: string | undefined;
+ let refName: string;
+ if (typeof ref === 'string') {
+ const parsed = parseRefString(ref);
+ refKind = parsed.kind || context?.defaultKind;
+ refNamespace =
+ parsed.namespace || context?.defaultNamespace || ENTITY_DEFAULT_NAMESPACE;
+ refName = parsed.name;
+ } else {
+ refKind = ref.kind || context?.defaultKind;
+ refNamespace =
+ ref.namespace || context?.defaultNamespace || ENTITY_DEFAULT_NAMESPACE;
+ refName = ref.name;
+ }
+
+ if (!refKind || !refNamespace) {
+ throw new Error(
+ `Entity reference or context did not contain kind and namespace`,
+ );
+ }
+
+ return (
+ entityKind.toLowerCase() === refKind.toLowerCase() &&
+ entityNamespace.toLowerCase() === refNamespace.toLowerCase() &&
+ entityName.toLowerCase() === refName.toLowerCase()
+ );
+}
diff --git a/packages/integration/src/ScmIntegrations.test.ts b/packages/integration/src/ScmIntegrations.test.ts
index 69eb6cc367..44e427a5d0 100644
--- a/packages/integration/src/ScmIntegrations.test.ts
+++ b/packages/integration/src/ScmIntegrations.test.ts
@@ -73,4 +73,19 @@ describe('ScmIntegrations', () => {
expect(i.byHost('github.local')).toBe(github);
expect(i.byHost('gitlab.local')).toBe(gitlab);
});
+
+ it('can resolveUrl using fallback', () => {
+ expect(
+ i.resolveUrl({
+ url: '../b.yaml',
+ base: 'https://no-matching-integration.com/x/a.yaml',
+ }),
+ ).toBe('https://no-matching-integration.com/b.yaml');
+ expect(
+ i.resolveUrl({
+ url: 'https://absolute.com/path',
+ base: 'https://no-matching-integration.com/x/a.yaml',
+ }),
+ ).toBe('https://absolute.com/path');
+ });
});
diff --git a/packages/integration/src/ScmIntegrations.ts b/packages/integration/src/ScmIntegrations.ts
index 102273a03b..c20fdcef9c 100644
--- a/packages/integration/src/ScmIntegrations.ts
+++ b/packages/integration/src/ScmIntegrations.ts
@@ -81,4 +81,13 @@ export class ScmIntegrations implements ScmIntegrationRegistry {
.map(i => i.byHost(host))
.find(Boolean);
}
+
+ resolveUrl(options: { url: string; base: string }): string {
+ const resolve = this.byUrl(options.base)?.resolveUrl;
+ if (!resolve) {
+ return new URL(options.url, options.base).toString();
+ }
+
+ return resolve(options);
+ }
}
diff --git a/packages/integration/src/azure/AzureIntegration.test.ts b/packages/integration/src/azure/AzureIntegration.test.ts
index 90c098b637..8a10e40bcf 100644
--- a/packages/integration/src/azure/AzureIntegration.test.ts
+++ b/packages/integration/src/azure/AzureIntegration.test.ts
@@ -41,4 +41,52 @@ describe('AzureIntegration', () => {
expect(integration.type).toBe('azure');
expect(integration.title).toBe('h.com');
});
+
+ describe('resolveUrl', () => {
+ it('works for valid urls', () => {
+ const integration = new AzureIntegration({
+ host: 'dev.azure.com',
+ } as any);
+
+ expect(
+ integration.resolveUrl({
+ url: '../a.yaml',
+ base:
+ 'https://dev.azure.com/organization/project/_git/repository?path=%2Ffolder%2Fcatalog-info.yaml',
+ }),
+ ).toBe(
+ 'https://dev.azure.com/organization/project/_git/repository?path=%2Fa.yaml',
+ );
+
+ expect(
+ integration.resolveUrl({
+ url: './a.yaml',
+ base: 'https://dev.azure.com/organization/project/_git/repository',
+ }),
+ ).toBe(
+ 'https://dev.azure.com/organization/project/_git/repository?path=%2Fa.yaml',
+ );
+
+ expect(
+ integration.resolveUrl({
+ url: 'https://absolute.com/path',
+ base:
+ 'https://dev.azure.com/organization/project/_git/repository?path=%2Fcatalog-info.yaml',
+ }),
+ ).toBe('https://absolute.com/path');
+ });
+
+ it('falls back to regular URL resolution if not in a repo', () => {
+ const integration = new AzureIntegration({
+ host: 'dev.azure.com',
+ } as any);
+
+ expect(
+ integration.resolveUrl({
+ url: './test',
+ base: 'https://dev.azure.com/organization/project/_git',
+ }),
+ ).toBe('https://dev.azure.com/organization/project/test');
+ });
+ });
});
diff --git a/packages/integration/src/azure/AzureIntegration.ts b/packages/integration/src/azure/AzureIntegration.ts
index 446e6a9480..1413b7b343 100644
--- a/packages/integration/src/azure/AzureIntegration.ts
+++ b/packages/integration/src/azure/AzureIntegration.ts
@@ -14,6 +14,7 @@
* limitations under the License.
*/
+import parseGitUrl from 'git-url-parse';
import { basicIntegrations } from '../helpers';
import { ScmIntegration, ScmIntegrationsFactory } from '../types';
import { AzureIntegrationConfig, readAzureIntegrationConfigs } from './config';
@@ -42,4 +43,39 @@ export class AzureIntegration implements ScmIntegration {
get config(): AzureIntegrationConfig {
return this.integrationConfig;
}
+
+ /*
+ * Azure repo URLs on the form with a `path` query param are treated specially.
+ *
+ * Example base URL: https://dev.azure.com/organization/project/_git/repository?path=%2Fcatalog-info.yaml
+ */
+ resolveUrl(options: { url: string; base: string }): string {
+ const { url, base } = options;
+
+ // If we can parse the url, it is absolute - then return it verbatim
+ try {
+ // eslint-disable-next-line no-new
+ new URL(url);
+ return url;
+ } catch {
+ // Ignore intentionally - looks like a relative path
+ }
+
+ const parsed = parseGitUrl(base);
+ const { organization, owner, name, filepath } = parsed;
+
+ // If not an actual file path within a repo, treat the URL as raw
+ if (!organization || !owner || !name) {
+ return new URL(url, base).toString();
+ }
+
+ const path = filepath?.replace(/^\//, '') || '';
+ const mockBaseUrl = new URL(`https://a.com/${path}`);
+ const updatedPath = new URL(url, mockBaseUrl).pathname;
+
+ const newUrl = new URL(base);
+ newUrl.searchParams.set('path', updatedPath);
+
+ return newUrl.toString();
+ }
}
diff --git a/packages/integration/src/bitbucket/core.test.ts b/packages/integration/src/bitbucket/core.test.ts
index 1287ab4d66..22b17d51fa 100644
--- a/packages/integration/src/bitbucket/core.test.ts
+++ b/packages/integration/src/bitbucket/core.test.ts
@@ -125,6 +125,7 @@ describe('bitbucket core', () => {
),
),
);
+
const config: BitbucketIntegrationConfig = {
host: 'bitbucket.mycompany.net',
apiBaseUrl: 'https://api.bitbucket.mycompany.net/rest/api/1.0',
@@ -250,5 +251,40 @@ describe('bitbucket core', () => {
);
expect(defaultBranch).toEqual('main');
});
+
+ it('return default branch for Bitbucket Server for bitbucket version 5.11', async () => {
+ const defaultBranchResponse = {
+ displayId: 'main',
+ };
+ worker.use(
+ rest.get(
+ 'https://api.bitbucket.mycompany.net/rest/api/1.0/projects/backstage/repos/mock/default-branch',
+ (_, res, ctx) =>
+ res(
+ ctx.status(404),
+ ctx.set('Content-Type', 'application/json'),
+ ctx.json(defaultBranchResponse),
+ ),
+ ),
+ rest.get(
+ 'https://api.bitbucket.mycompany.net/rest/api/1.0/projects/backstage/repos/mock/branches/default',
+ (_, res, ctx) =>
+ res(
+ ctx.status(200),
+ ctx.set('Content-Type', 'application/json'),
+ ctx.json(defaultBranchResponse),
+ ),
+ ),
+ );
+ const config: BitbucketIntegrationConfig = {
+ host: 'bitbucket.mycompany.net',
+ apiBaseUrl: 'https://api.bitbucket.mycompany.net/rest/api/1.0',
+ };
+ const defaultBranch = await getBitbucketDefaultBranch(
+ 'https://bitbucket.mycompany.net/projects/backstage/repos/mock/browse/README.md',
+ config,
+ );
+ expect(defaultBranch).toEqual('main');
+ });
});
});
diff --git a/packages/integration/src/bitbucket/core.ts b/packages/integration/src/bitbucket/core.ts
index f5235d8189..8b1d7d6b18 100644
--- a/packages/integration/src/bitbucket/core.ts
+++ b/packages/integration/src/bitbucket/core.ts
@@ -32,11 +32,19 @@ export async function getBitbucketDefaultBranch(
const isHosted = resource === 'bitbucket.org';
// Bitbucket Server https://docs.atlassian.com/bitbucket-server/rest/7.9.0/bitbucket-rest.html#idp184
- const branchUrl = isHosted
+ let branchUrl = isHosted
? `${config.apiBaseUrl}/repositories/${project}/${repoName}`
: `${config.apiBaseUrl}/projects/${project}/repos/${repoName}/default-branch`;
- const response = await fetch(branchUrl, getBitbucketRequestOptions(config));
+ let response = await fetch(branchUrl, getBitbucketRequestOptions(config));
+
+ if (response.status === 404 && !isHosted) {
+ // First try the new format, and then if it gets specifically a 404 it should try the old format
+ // (to support old Atlassian Bitbucket v5.11.1 format )
+ branchUrl = `${config.apiBaseUrl}/projects/${project}/repos/${repoName}/branches/default`;
+ response = await fetch(branchUrl, getBitbucketRequestOptions(config));
+ }
+
if (!response.ok) {
const message = `Failed to retrieve default branch from ${branchUrl}, ${response.status} ${response.statusText}`;
throw new Error(message);
diff --git a/packages/integration/src/gitlab/core.test.ts b/packages/integration/src/gitlab/core.test.ts
index 43fea72e0b..2b4713604c 100644
--- a/packages/integration/src/gitlab/core.test.ts
+++ b/packages/integration/src/gitlab/core.test.ts
@@ -49,23 +49,23 @@ describe('gitlab core', () => {
{
config: configWithNoToken,
url:
- 'https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/my/path/to/file.yaml',
+ 'https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/my/path%20with%20spaces/to/file.yaml',
result:
- 'https://gitlab.com/api/v4/projects/12345/repository/files/my%2Fpath%2Fto%2Ffile.yaml/raw?ref=branch',
+ 'https://gitlab.com/api/v4/projects/12345/repository/files/my%2Fpath%20with%20spaces%2Fto%2Ffile.yaml/raw?ref=branch',
},
{
config: configWithToken,
url:
- 'https://gitlab.example.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/my/path/to/file.yaml',
+ 'https://gitlab.example.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/my/path%20with%20spaces/to/file.yaml',
result:
- 'https://gitlab.example.com/api/v4/projects/12345/repository/files/my%2Fpath%2Fto%2Ffile.yaml/raw?ref=branch',
+ 'https://gitlab.example.com/api/v4/projects/12345/repository/files/my%2Fpath%20with%20spaces%2Fto%2Ffile.yaml/raw?ref=branch',
},
{
config: configWithNoToken,
url:
- 'https://gitlab.com/groupA/teams/teamA/repoA/-/blob/branch/my/path/to/file.yaml', // Repo not in subgroup
+ 'https://gitlab.com/groupA/teams/teamA/repoA/-/blob/branch/my/path%20with%20spaces/to/file.yaml', // Repo not in subgroup
result:
- 'https://gitlab.com/api/v4/projects/12345/repository/files/my%2Fpath%2Fto%2Ffile.yaml/raw?ref=branch',
+ 'https://gitlab.com/api/v4/projects/12345/repository/files/my%2Fpath%20with%20spaces%2Fto%2Ffile.yaml/raw?ref=branch',
},
// Raw URLs
{
diff --git a/packages/integration/src/gitlab/core.ts b/packages/integration/src/gitlab/core.ts
index c1d43c3a46..66b6733f56 100644
--- a/packages/integration/src/gitlab/core.ts
+++ b/packages/integration/src/gitlab/core.ts
@@ -109,7 +109,7 @@ export function buildProjectUrl(target: string, projectID: Number): URL {
'/api/v4/projects',
projectID,
'repository/files',
- encodeURIComponent(filePath.join('/')),
+ encodeURIComponent(decodeURIComponent(filePath.join('/'))),
'raw',
].join('/');
url.search = `?ref=${branch}`;
diff --git a/packages/integration/src/types.ts b/packages/integration/src/types.ts
index d8fb7a14e2..7d5b0fbe74 100644
--- a/packages/integration/src/types.ts
+++ b/packages/integration/src/types.ts
@@ -34,6 +34,18 @@ export interface ScmIntegration {
* differentiate between different integrations.
*/
title: string;
+
+ /**
+ * Works like the two-argument form of the URL constructor, resolving an
+ * absolute or relative URL in relation to a base URL.
+ *
+ * If this method is not implemented, the URL constructor is used instead for
+ * URLs that match this integration.
+ *
+ * @param options.url The (absolute or relative) URL or path to resolve
+ * @param options.base The base URL onto which this resolution happens
+ */
+ resolveUrl?(options: { url: string; base: string }): string;
}
/**
@@ -69,6 +81,15 @@ export interface ScmIntegrationRegistry
bitbucket: ScmIntegrationsGroup;
github: ScmIntegrationsGroup;
gitlab: ScmIntegrationsGroup;
+
+ /**
+ * Works like the two-argument form of the URL constructor, resolving an
+ * absolute or relative URL in relation to a base URL.
+ *
+ * @param options.url The (absolute or relative) URL or path to resolve
+ * @param options.base The base URL onto which this resolution happens
+ */
+ resolveUrl(options: { url: string; base: string }): string;
}
export type ScmIntegrationsFactory = (options: {
diff --git a/plugins/catalog-backend/package.json b/plugins/catalog-backend/package.json
index 264bda0556..cc0a9e412a 100644
--- a/plugins/catalog-backend/package.json
+++ b/plugins/catalog-backend/package.json
@@ -34,6 +34,7 @@
"@backstage/backend-common": "^0.5.1",
"@backstage/catalog-model": "^0.7.0",
"@backstage/config": "^0.1.2",
+ "@backstage/integration": "^0.3.1",
"@octokit/graphql": "^4.5.8",
"@types/express": "^4.17.6",
"@types/ldapjs": "^1.0.9",
diff --git a/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.test.ts b/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.test.ts
index 998dfb62a2..476510d757 100644
--- a/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.test.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.test.ts
@@ -15,30 +15,73 @@
*/
import { LocationSpec } from '@backstage/catalog-model';
-import { toAbsoluteUrl } from './LocationEntityProcessor';
+import { ConfigReader } from '@backstage/config';
+import {
+ ScmIntegrations,
+ ScmIntegrationRegistry,
+} from '@backstage/integration';
import path from 'path';
+import { toAbsoluteUrl } from './LocationEntityProcessor';
describe('LocationEntityProcessor', () => {
describe('toAbsoluteUrl', () => {
it('handles files', () => {
+ const integrations = ({} as unknown) as ScmIntegrationRegistry;
const base: LocationSpec = {
type: 'file',
target: `some${path.sep}path${path.sep}catalog-info.yaml`,
};
- expect(toAbsoluteUrl(base, `.${path.sep}c`)).toBe(
+ expect(toAbsoluteUrl(integrations, base, `.${path.sep}c`)).toBe(
`some${path.sep}path${path.sep}c`,
);
- expect(toAbsoluteUrl(base, `${path.sep}c`)).toBe(`${path.sep}c`);
+ expect(toAbsoluteUrl(integrations, base, `${path.sep}c`)).toBe(
+ `${path.sep}c`,
+ );
});
it('handles urls', () => {
+ const integrations = ScmIntegrations.fromConfig(new ConfigReader({}));
const base: LocationSpec = {
type: 'url',
target: 'http://a.com/b/catalog-info.yaml',
};
- expect(toAbsoluteUrl(base, './c/d')).toBe('http://a.com/b/c/d');
- expect(toAbsoluteUrl(base, 'c/d')).toBe('http://a.com/b/c/d');
- expect(toAbsoluteUrl(base, 'http://b.com/z')).toBe('http://b.com/z');
+ jest.spyOn(integrations, 'resolveUrl');
+
+ expect(toAbsoluteUrl(integrations, base, './c/d')).toBe(
+ 'http://a.com/b/c/d',
+ );
+ expect(toAbsoluteUrl(integrations, base, 'c/d')).toBe(
+ 'http://a.com/b/c/d',
+ );
+ expect(toAbsoluteUrl(integrations, base, 'http://b.com/z')).toBe(
+ 'http://b.com/z',
+ );
+
+ expect(integrations.resolveUrl).toBeCalledTimes(3);
+ });
+
+ it('handles azure urls specifically', () => {
+ const integrations = ScmIntegrations.fromConfig(
+ new ConfigReader({
+ integrations: {
+ azure: [{ host: 'dev.azure.com' }],
+ },
+ }),
+ );
+
+ expect(
+ toAbsoluteUrl(
+ integrations,
+ {
+ type: 'url',
+ target:
+ 'https://dev.azure.com/organization/project/_git/repository?path=%2Fcatalog-info.yaml',
+ },
+ './a.yaml',
+ ),
+ ).toBe(
+ 'https://dev.azure.com/organization/project/_git/repository?path=%2Fa.yaml',
+ );
});
});
});
diff --git a/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts b/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts
index 1c7e13f1c4..f4c8c82957 100644
--- a/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/LocationEntityProcessor.ts
@@ -15,11 +15,16 @@
*/
import { Entity, LocationEntity, LocationSpec } from '@backstage/catalog-model';
+import { ScmIntegrationRegistry } from '@backstage/integration';
+import path from 'path';
import * as result from './results';
import { CatalogProcessor, CatalogProcessorEmit } from './types';
-import path from 'path';
-export function toAbsoluteUrl(base: LocationSpec, target: string): string {
+export function toAbsoluteUrl(
+ integrations: ScmIntegrationRegistry,
+ base: LocationSpec,
+ target: string,
+): string {
try {
if (base.type === 'file') {
if (target.startsWith('.')) {
@@ -27,13 +32,19 @@ export function toAbsoluteUrl(base: LocationSpec, target: string): string {
}
return target;
}
- return new URL(target, base.target).toString();
+ return integrations.resolveUrl({ url: target, base: base.target });
} catch (e) {
return target;
}
}
-export class LocationRefProcessor implements CatalogProcessor {
+type Options = {
+ integrations: ScmIntegrationRegistry;
+};
+
+export class LocationEntityProcessor implements CatalogProcessor {
+ constructor(private readonly options: Options) {}
+
async postProcessEntity(
entity: Entity,
location: LocationSpec,
@@ -47,7 +58,7 @@ export class LocationRefProcessor implements CatalogProcessor {
emit(
result.inputError(
location,
- `LocationRefProcessor cannot handle ${type} type location with target ${location.target} that ends with a path separator`,
+ `LocationEntityProcessor cannot handle ${type} type location with target ${location.target} that ends with a path separator`,
),
);
}
@@ -61,7 +72,11 @@ export class LocationRefProcessor implements CatalogProcessor {
}
for (const maybeRelativeTarget of targets) {
- const target = toAbsoluteUrl(location, maybeRelativeTarget);
+ const target = toAbsoluteUrl(
+ this.options.integrations,
+ location,
+ maybeRelativeTarget,
+ );
emit(result.location({ type, target }, false));
}
}
diff --git a/plugins/catalog-backend/src/ingestion/processors/index.ts b/plugins/catalog-backend/src/ingestion/processors/index.ts
index a7b00d7065..05dd327f0e 100644
--- a/plugins/catalog-backend/src/ingestion/processors/index.ts
+++ b/plugins/catalog-backend/src/ingestion/processors/index.ts
@@ -23,7 +23,7 @@ export { CodeOwnersProcessor } from './CodeOwnersProcessor';
export { FileReaderProcessor } from './FileReaderProcessor';
export { GithubOrgReaderProcessor } from './GithubOrgReaderProcessor';
export { LdapOrgReaderProcessor } from './LdapOrgReaderProcessor';
-export { LocationRefProcessor } from './LocationEntityProcessor';
+export { LocationEntityProcessor } from './LocationEntityProcessor';
export { MicrosoftGraphOrgReaderProcessor } from './MicrosoftGraphOrgReaderProcessor';
export { PlaceholderProcessor } from './PlaceholderProcessor';
export type { PlaceholderResolver } from './PlaceholderProcessor';
diff --git a/plugins/catalog-backend/src/service/CatalogBuilder.ts b/plugins/catalog-backend/src/service/CatalogBuilder.ts
index 938a406e56..f7544ef42e 100644
--- a/plugins/catalog-backend/src/service/CatalogBuilder.ts
+++ b/plugins/catalog-backend/src/service/CatalogBuilder.ts
@@ -26,6 +26,7 @@ import {
Validators,
} from '@backstage/catalog-model';
import { Config } from '@backstage/config';
+import { ScmIntegrations } from '@backstage/integration';
import lodash from 'lodash';
import { Logger } from 'winston';
import {
@@ -46,8 +47,8 @@ import {
HigherOrderOperation,
HigherOrderOperations,
LdapOrgReaderProcessor,
+ LocationEntityProcessor,
LocationReaders,
- LocationRefProcessor,
MicrosoftGraphOrgReaderProcessor,
PlaceholderProcessor,
PlaceholderResolver,
@@ -280,6 +281,7 @@ export class CatalogBuilder {
private buildProcessors(): CatalogProcessor[] {
const { config, logger, reader } = this.env;
+ const integrations = ScmIntegrations.fromConfig(config);
this.checkDeprecatedReaderProcessors();
@@ -306,7 +308,7 @@ export class CatalogBuilder {
MicrosoftGraphOrgReaderProcessor.fromConfig(config, { logger }),
new UrlReaderProcessor({ reader, logger }),
new CodeOwnersProcessor({ reader, logger }),
- new LocationRefProcessor(),
+ new LocationEntityProcessor({ integrations }),
new AnnotateLocationEntityProcessor(),
);
}
diff --git a/plugins/cost-insights/src/utils/change.test.ts b/plugins/cost-insights/src/utils/change.test.ts
index 7cc03caa0b..9516dfe270 100644
--- a/plugins/cost-insights/src/utils/change.test.ts
+++ b/plugins/cost-insights/src/utils/change.test.ts
@@ -76,13 +76,13 @@ describe('getPreviousPeriodTotalCost', () => {
change: changeOf(MockAggregatedDailyCosts),
trendline: trendlineOf(MockAggregatedDailyCosts),
};
- const exclusiveEndDate = '2020-09-30';
+ const inclusiveEndDate = '2020-09-30';
expect(
getPreviousPeriodTotalCost(
mockGroupDailyCost.aggregation,
Duration.P30D,
- exclusiveEndDate,
+ inclusiveEndDate,
),
- ).toEqual(100_000);
+ ).toEqual(96_600);
});
});
diff --git a/plugins/cost-insights/src/utils/change.ts b/plugins/cost-insights/src/utils/change.ts
index 143751fa89..950fbfeb82 100644
--- a/plugins/cost-insights/src/utils/change.ts
+++ b/plugins/cost-insights/src/utils/change.ts
@@ -22,7 +22,6 @@ import {
GrowthType,
MetricData,
Duration,
- DEFAULT_DATE_FORMAT,
DateAggregation,
} from '../types';
import dayjs, { OpUnitType } from 'dayjs';
@@ -73,10 +72,7 @@ export function getPreviousPeriodTotalCost(
inclusiveEndDate: string,
): number {
const dayjsDuration = dayjs.duration(duration);
- const startDate = inclusiveStartDateOf(
- duration,
- dayjs(inclusiveEndDate).add(1, 'day').format(DEFAULT_DATE_FORMAT),
- );
+ const startDate = inclusiveStartDateOf(duration, inclusiveEndDate);
// dayjs doesn't allow adding an ISO 8601 period to dates.
const [amount, type]: [number, OpUnitType] = dayjsDuration.days()
? [dayjsDuration.days(), 'day']
diff --git a/plugins/cost-insights/src/utils/duration.ts b/plugins/cost-insights/src/utils/duration.ts
index 79ea150fc5..27447537cc 100644
--- a/plugins/cost-insights/src/utils/duration.ts
+++ b/plugins/cost-insights/src/utils/duration.ts
@@ -24,23 +24,21 @@ export const DEFAULT_DURATION = Duration.P30D;
* Derive the start date of a given period, assuming two repeating intervals.
*
* @param duration see comment on Duration enum
- * @param exclusiveEndDate from CostInsightsApi.getLastCompleteBillingDate + 1 day
+ * @param inclusiveEndDate from CostInsightsApi.getLastCompleteBillingDate
*/
export function inclusiveStartDateOf(
duration: Duration,
- exclusiveEndDate: string,
+ inclusiveEndDate: string,
): string {
switch (duration) {
case Duration.P7D:
case Duration.P30D:
case Duration.P90D:
- return moment(exclusiveEndDate)
- .utc()
+ return moment(inclusiveEndDate)
.subtract(moment.duration(duration).add(moment.duration(duration)))
.format(DEFAULT_DATE_FORMAT);
case Duration.P3M:
- return moment(exclusiveEndDate)
- .utc()
+ return moment(inclusiveEndDate)
.startOf('quarter')
.subtract(moment.duration(duration).add(moment.duration(duration)))
.format(DEFAULT_DATE_FORMAT);
@@ -57,13 +55,9 @@ export function exclusiveEndDateOf(
case Duration.P7D:
case Duration.P30D:
case Duration.P90D:
- return moment(inclusiveEndDate)
- .utc()
- .add(1, 'day')
- .format(DEFAULT_DATE_FORMAT);
+ return moment(inclusiveEndDate).add(1, 'day').format(DEFAULT_DATE_FORMAT);
case Duration.P3M:
return moment(quarterEndDate(inclusiveEndDate))
- .utc()
.add(1, 'day')
.format(DEFAULT_DATE_FORMAT);
default:
@@ -76,7 +70,6 @@ export function inclusiveEndDateOf(
inclusiveEndDate: string,
): string {
return moment(exclusiveEndDateOf(duration, inclusiveEndDate))
- .utc()
.subtract(1, 'day')
.format(DEFAULT_DATE_FORMAT);
}
@@ -94,7 +87,7 @@ export function intervalsOf(
}
export function quarterEndDate(inclusiveEndDate: string): string {
- const endDate = moment(inclusiveEndDate).utc();
+ const endDate = moment(inclusiveEndDate);
const endOfQuarter = endDate.endOf('quarter').format(DEFAULT_DATE_FORMAT);
if (endOfQuarter === inclusiveEndDate) {
return endDate.format(DEFAULT_DATE_FORMAT);
diff --git a/plugins/cost-insights/src/utils/formatters.ts b/plugins/cost-insights/src/utils/formatters.ts
index 182c567644..8f2b94f997 100644
--- a/plugins/cost-insights/src/utils/formatters.ts
+++ b/plugins/cost-insights/src/utils/formatters.ts
@@ -16,7 +16,7 @@
import moment from 'moment';
import pluralize from 'pluralize';
-import { Duration, DEFAULT_DATE_FORMAT } from '../types';
+import { Duration } from '../types';
import { inclusiveEndDateOf, inclusiveStartDateOf } from '../utils/duration';
export type Period = {
@@ -92,11 +92,8 @@ export function formatPercent(n: number): string {
}
export function formatLastTwoLookaheadQuarters(inclusiveEndDate: string) {
- const exclusiveEndDate = moment(inclusiveEndDate)
- .add(1, 'day')
- .format(DEFAULT_DATE_FORMAT);
const start = moment(
- inclusiveStartDateOf(Duration.P3M, exclusiveEndDate),
+ inclusiveStartDateOf(Duration.P3M, inclusiveEndDate),
).format('[Q]Q YYYY');
const end = moment(inclusiveEndDateOf(Duration.P3M, inclusiveEndDate)).format(
'[Q]Q YYYY',
diff --git a/plugins/cost-insights/src/utils/mockData.ts b/plugins/cost-insights/src/utils/mockData.ts
index 14ff9aecd1..d4ac4cd2df 100644
--- a/plugins/cost-insights/src/utils/mockData.ts
+++ b/plugins/cost-insights/src/utils/mockData.ts
@@ -36,7 +36,7 @@ import {
getDefaultState as getDefaultLoadingState,
} from '../utils/loading';
import { findAlways } from '../utils/assert';
-import { inclusiveStartDateOf } from './duration';
+import { inclusiveEndDateOf, inclusiveStartDateOf } from './duration';
type mockAlertRenderer = (alert: T) => T;
type mockEntityRenderer = (entity: T) => T;
@@ -228,8 +228,9 @@ export function aggregationFor(
baseline: number,
): DateAggregation[] {
const { duration, endDate } = parseIntervals(intervals);
+ const inclusiveEndDate = inclusiveEndDateOf(duration, endDate);
const days = dayjs(endDate).diff(
- inclusiveStartDateOf(duration, endDate),
+ inclusiveStartDateOf(duration, inclusiveEndDate),
'day',
);
@@ -244,7 +245,7 @@ export function aggregationFor(
return [...Array(days).keys()].reduce(
(values: DateAggregation[], i: number): DateAggregation[] => {
const last = values.length ? values[values.length - 1].amount : baseline;
- const date = dayjs(inclusiveStartDateOf(duration, endDate))
+ const date = dayjs(inclusiveStartDateOf(duration, inclusiveEndDate))
.add(i, 'day')
.format(DEFAULT_DATE_FORMAT);
const amount = Math.max(0, last + nextDelta());
diff --git a/plugins/rollbar/README.md b/plugins/rollbar/README.md
index cc862051f7..6337d45ffe 100644
--- a/plugins/rollbar/README.md
+++ b/plugins/rollbar/README.md
@@ -19,17 +19,7 @@ yarn add @backstage/plugin-rollbar
export { plugin as Rollbar } from '@backstage/plugin-rollbar';
```
-4. Add plugin API to your Backstage instance:
-
-```ts
-// packages/app/src/api.ts
-import { RollbarClient, rollbarApiRef } from '@backstage/plugin-rollbar';
-
-// ...
-builder.add(rollbarApiRef, new RollbarClient({ discoveryApi }));
-```
-
-5. Add to the app `EntityPage` component:
+4. Add to the app `EntityPage` component:
```ts
// packages/app/src/components/catalog/EntityPage.tsx
@@ -48,7 +38,7 @@ const ServiceEntityPage = ({ entity }: { entity: Entity }) => (
);
```
-6. Setup the `app.config.yaml` and account token environment variable
+5. Setup the `app.config.yaml` and account token environment variable
```yaml
# app.config.yaml
@@ -59,7 +49,7 @@ rollbar:
$env: ROLLBAR_ACCOUNT_TOKEN
```
-7. Annotate entities with the rollbar project slug
+6. Annotate entities with the rollbar project slug
```yaml
# pump-station-catalog-component.yaml
@@ -71,7 +61,7 @@ metadata:
rollbar.com/project-slug: project-name
```
-8. Run app with `yarn start` and navigate to `/rollbar` or a catalog entity
+7. Run app with `yarn start` and navigate to `/rollbar` or a catalog entity
## Features
diff --git a/plugins/rollbar/dev/index.tsx b/plugins/rollbar/dev/index.tsx
index 812a5585d4..6cac0d9a0c 100644
--- a/plugins/rollbar/dev/index.tsx
+++ b/plugins/rollbar/dev/index.tsx
@@ -15,6 +15,6 @@
*/
import { createDevApp } from '@backstage/dev-utils';
-import { plugin } from '../src/plugin';
+import { rollbarPlugin } from '../src/plugin';
-createDevApp().registerPlugin(plugin).render();
+createDevApp().registerPlugin(rollbarPlugin).render();
diff --git a/plugins/rollbar/src/components/EntityPageRollbar/EntityPageRollbar.tsx b/plugins/rollbar/src/components/EntityPageRollbar/EntityPageRollbar.tsx
index 888b9aabe0..07a39bd147 100644
--- a/plugins/rollbar/src/components/EntityPageRollbar/EntityPageRollbar.tsx
+++ b/plugins/rollbar/src/components/EntityPageRollbar/EntityPageRollbar.tsx
@@ -14,14 +14,18 @@
* limitations under the License.
*/
-import React from 'react';
import { Entity } from '@backstage/catalog-model';
+import { useEntity } from '@backstage/plugin-catalog-react';
+import React from 'react';
import { RollbarProject } from '../RollbarProject/RollbarProject';
type Props = {
- entity: Entity;
+ /** @deprecated The entity is now grabbed from context instead */
+ entity?: Entity;
};
-export const EntityPageRollbar = ({ entity }: Props) => {
+export const EntityPageRollbar = (_props: Props) => {
+ const { entity } = useEntity();
+
return ;
};
diff --git a/plugins/rollbar/src/components/RollbarHome/RollbarHome.test.tsx b/plugins/rollbar/src/components/RollbarHome/RollbarHome.test.tsx
deleted file mode 100644
index 5bd885c488..0000000000
--- a/plugins/rollbar/src/components/RollbarHome/RollbarHome.test.tsx
+++ /dev/null
@@ -1,70 +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 * as React from 'react';
-import {
- ApiProvider,
- ApiRegistry,
- ConfigApi,
- configApiRef,
-} from '@backstage/core';
-import { catalogApiRef, CatalogApi } from '@backstage/plugin-catalog-react';
-import { wrapInTestApp } from '@backstage/test-utils';
-import { render } from '@testing-library/react';
-import { RollbarApi, rollbarApiRef } from '../../api/RollbarApi';
-import { RollbarProject } from '../../api/types';
-import { RollbarHome } from './RollbarHome';
-
-describe('RollbarHome component', () => {
- const projects: RollbarProject[] = [
- { id: 123, name: 'abc', accountId: 1, status: 'enabled' },
- { id: 456, name: 'xyz', accountId: 1, status: 'enabled' },
- ];
- const rollbarApi: Partial = {
- getAllProjects: () => Promise.resolve(projects),
- };
- const config: Partial = {
- getString: () => 'foo',
- getOptionalString: () => 'foo',
- };
-
- const renderWrapped = (children: React.ReactNode) =>
- render(
- wrapInTestApp(
- ) as CatalogApi,
- ],
- ])}
- >
- {children}
- ,
- ),
- );
-
- it('should render rollbar landing page', async () => {
- const rendered = renderWrapped();
- expect(rendered.getByText(/Rollbar/)).toBeInTheDocument();
- });
-});
diff --git a/plugins/rollbar/src/components/RollbarHome/RollbarHome.tsx b/plugins/rollbar/src/components/RollbarHome/RollbarHome.tsx
deleted file mode 100644
index fe99e70575..0000000000
--- a/plugins/rollbar/src/components/RollbarHome/RollbarHome.tsx
+++ /dev/null
@@ -1,40 +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 React from 'react';
-import { Content, Header, Page } from '@backstage/core';
-import { RollbarProjectTable } from '../RollbarProjectTable/RollbarProjectTable';
-import { useRollbarEntities } from '../../hooks/useRollbarEntities';
-
-export const RollbarHome = () => {
- const { entities, loading, error } = useRollbarEntities();
-
- return (
-
-
-
-
-
-
- );
-};
diff --git a/plugins/rollbar/src/components/RollbarProject/RollbarProject.tsx b/plugins/rollbar/src/components/RollbarProject/RollbarProject.tsx
index 34881ba560..b69c69a56b 100644
--- a/plugins/rollbar/src/components/RollbarProject/RollbarProject.tsx
+++ b/plugins/rollbar/src/components/RollbarProject/RollbarProject.tsx
@@ -14,8 +14,8 @@
* limitations under the License.
*/
-import React from 'react';
import { Entity } from '@backstage/catalog-model';
+import React from 'react';
import { useTopActiveItems } from '../../hooks/useTopActiveItems';
import { RollbarTopItemsTable } from '../RollbarTopItemsTable/RollbarTopItemsTable';
diff --git a/plugins/rollbar/src/components/RollbarProjectPage/RollbarProjectPage.test.tsx b/plugins/rollbar/src/components/RollbarProjectPage/RollbarProjectPage.test.tsx
deleted file mode 100644
index 6aeee782c4..0000000000
--- a/plugins/rollbar/src/components/RollbarProjectPage/RollbarProjectPage.test.tsx
+++ /dev/null
@@ -1,86 +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 {
- ApiProvider,
- ApiRegistry,
- ConfigApi,
- configApiRef,
-} from '@backstage/core';
-import { CatalogApi, catalogApiRef } from '@backstage/plugin-catalog-react';
-import { wrapInTestApp } from '@backstage/test-utils';
-import { render } from '@testing-library/react';
-import * as React from 'react';
-import { RollbarApi, rollbarApiRef } from '../../api/RollbarApi';
-import { RollbarTopActiveItem } from '../../api/types';
-import { RollbarProjectPage } from './RollbarProjectPage';
-
-describe('RollbarProjectPage component', () => {
- const items: RollbarTopActiveItem[] = [
- {
- item: {
- id: 9898989,
- counter: 1234,
- environment: 'production',
- framework: 2,
- lastOccurrenceTimestamp: new Date().getTime() / 1000,
- level: 50,
- occurrences: 100,
- projectId: 12345,
- title: 'error occurred',
- uniqueOccurrences: 10,
- },
- counts: [10, 10, 10, 10, 10, 50],
- },
- ];
- const rollbarApi: Partial = {
- getTopActiveItems: () => Promise.resolve(items),
- };
- const config: Partial = {
- getString: () => 'foo',
- getOptionalString: () => 'foo',
- };
-
- const renderWrapped = (children: React.ReactNode) =>
- render(
- wrapInTestApp(
- ) as CatalogApi,
- ],
- ])}
- >
- {children}
- ,
- ),
- );
-
- it('should render rollbar project page', async () => {
- const rendered = renderWrapped();
- expect(rendered.getByText(/Rollbar/)).toBeInTheDocument();
- });
-});
diff --git a/plugins/rollbar/src/components/RollbarProjectPage/RollbarProjectPage.tsx b/plugins/rollbar/src/components/RollbarProjectPage/RollbarProjectPage.tsx
deleted file mode 100644
index 5563a6d7a0..0000000000
--- a/plugins/rollbar/src/components/RollbarProjectPage/RollbarProjectPage.tsx
+++ /dev/null
@@ -1,36 +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 React from 'react';
-import { Content, Header, HeaderLabel, Page } from '@backstage/core';
-import { useCatalogEntity } from '../../hooks/useCatalogEntity';
-import { RollbarProject } from '../RollbarProject/RollbarProject';
-
-export const RollbarProjectPage = () => {
- const { entity } = useCatalogEntity();
-
- return (
-
-
-
- {entity ? : 'Loading'}
-
-
- );
-};
diff --git a/plugins/rollbar/src/components/RollbarProjectTable/RollbarProjectTable.tsx b/plugins/rollbar/src/components/RollbarProjectTable/RollbarProjectTable.tsx
deleted file mode 100644
index 5b3631ade9..0000000000
--- a/plugins/rollbar/src/components/RollbarProjectTable/RollbarProjectTable.tsx
+++ /dev/null
@@ -1,85 +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 React from 'react';
-import { Link as RouterLink, generatePath } from 'react-router-dom';
-import { Table, TableColumn } from '@backstage/core';
-import { Entity } from '@backstage/catalog-model';
-import { Link } from '@material-ui/core';
-import { Alert } from '@material-ui/lab';
-import { entityRouteRef } from '../../routes';
-
-const columns: TableColumn[] = [
- {
- title: 'Name',
- field: 'metadata.name',
- type: 'string',
- highlight: true,
- render: (entity: any) => (
-
- {entity.metadata.name}
-
- ),
- },
- {
- title: 'Description',
- field: 'metadata.description',
- },
-];
-
-type Props = {
- entities: Entity[];
- loading: boolean;
- error?: any;
-};
-
-export const RollbarProjectTable = ({ entities, loading, error }: Props) => {
- if (error) {
- return (
-
-
- Error encountered while fetching rollbar projects. {error.toString()}
-
-