@backstage-community/plugin-cicd-statistics-module-gitlab 0.1.34 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,24 @@
1
1
  # @backstage-community/plugin-cicd-statistics-module-gitlab
2
2
 
3
+ ## 0.2.0
4
+
5
+ ### Minor Changes
6
+
7
+ - b0190ad: Backstage version bump to v1.34.1
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [b0190ad]
12
+ - @backstage-community/plugin-cicd-statistics@0.2.0
13
+
14
+ ## 0.1.35
15
+
16
+ ### Patch Changes
17
+
18
+ - a624400: Backstage version bump to v1.32.0
19
+ - Updated dependencies [a624400]
20
+ - @backstage-community/plugin-cicd-statistics@0.1.41
21
+
3
22
  ## 0.1.34
4
23
 
5
24
  ### Patch Changes
package/dist/alpha.d.ts CHANGED
@@ -1,17 +1,23 @@
1
1
  import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
2
- import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
2
+ import * as _backstage_core_plugin_api_index from '@backstage/core-plugin-api/index';
3
3
 
4
4
  /**
5
5
  * @alpha
6
6
  */
7
- declare const cicdStatisticsGitlabExtension: _backstage_frontend_plugin_api.ExtensionDefinition<{}, {}, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_core_plugin_api.AnyApiFactory, "core.api.factory", {}>, {}, {
7
+ declare const cicdStatisticsGitlabExtension: _backstage_frontend_plugin_api.ExtensionDefinition<{
8
8
  kind: "api";
9
- namespace: undefined;
10
9
  name: "cicd-statistics-gitlab-api";
10
+ config: {};
11
+ configInput: {};
12
+ output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_core_plugin_api_index.AnyApiFactory, "core.api.factory", {}>;
13
+ inputs: {};
14
+ params: {
15
+ factory: _backstage_core_plugin_api_index.AnyApiFactory;
16
+ };
11
17
  }>;
12
18
  /**
13
19
  * @alpha
14
20
  */
15
- declare const cicdStatisticsExtensionOverrides: _backstage_frontend_plugin_api.ExtensionOverrides;
21
+ declare const cicdStatisticsExtensionOverrides: _backstage_frontend_plugin_api.FrontendModule;
16
22
 
17
23
  export { cicdStatisticsGitlabExtension, cicdStatisticsExtensionOverrides as default };
package/dist/alpha.esm.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import { cicdStatisticsApiRef } from '@backstage-community/plugin-cicd-statistics';
2
- import { ApiBlueprint, createApiFactory, gitlabAuthApiRef, createExtensionOverrides } from '@backstage/frontend-plugin-api';
2
+ import { ApiBlueprint, createApiFactory, gitlabAuthApiRef, createFrontendModule } from '@backstage/frontend-plugin-api';
3
3
  import { CicdStatisticsApiGitlab } from './api/gitlab.esm.js';
4
4
 
5
5
  const cicdStatisticsGitlabExtension = ApiBlueprint.make({
@@ -16,7 +16,8 @@ const cicdStatisticsGitlabExtension = ApiBlueprint.make({
16
16
  })
17
17
  }
18
18
  });
19
- const cicdStatisticsExtensionOverrides = createExtensionOverrides({
19
+ const cicdStatisticsExtensionOverrides = createFrontendModule({
20
+ pluginId: "cicd-statistics",
20
21
  extensions: [cicdStatisticsGitlabExtension]
21
22
  });
22
23
 
@@ -1 +1 @@
1
- {"version":3,"file":"alpha.esm.js","sources":["../src/alpha.ts"],"sourcesContent":["import { cicdStatisticsApiRef } from '@backstage-community/plugin-cicd-statistics';\nimport {\n ApiBlueprint,\n createApiFactory,\n createExtensionOverrides,\n gitlabAuthApiRef,\n} from '@backstage/frontend-plugin-api';\nimport { CicdStatisticsApiGitlab } from './api';\n\n/**\n * @alpha\n */\nexport const cicdStatisticsGitlabExtension = ApiBlueprint.make({\n name: 'cicd-statistics-gitlab-api',\n params: {\n factory: createApiFactory({\n api: cicdStatisticsApiRef,\n deps: {\n gitlabAuthApi: gitlabAuthApiRef,\n },\n factory: ({ gitlabAuthApi }) => {\n return new CicdStatisticsApiGitlab(gitlabAuthApi);\n },\n }),\n },\n});\n\n/**\n * @alpha\n */\nconst cicdStatisticsExtensionOverrides = createExtensionOverrides({\n extensions: [cicdStatisticsGitlabExtension],\n});\n\nexport default cicdStatisticsExtensionOverrides;\n"],"names":[],"mappings":";;;;AAYa,MAAA,6BAAA,GAAgC,aAAa,IAAK,CAAA;AAAA,EAC7D,IAAM,EAAA,4BAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,SAAS,gBAAiB,CAAA;AAAA,MACxB,GAAK,EAAA,oBAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,aAAe,EAAA,gBAAA;AAAA,OACjB;AAAA,MACA,OAAS,EAAA,CAAC,EAAE,aAAA,EAAoB,KAAA;AAC9B,QAAO,OAAA,IAAI,wBAAwB,aAAa,CAAA,CAAA;AAAA,OAClD;AAAA,KACD,CAAA;AAAA,GACH;AACF,CAAC,EAAA;AAKD,MAAM,mCAAmC,wBAAyB,CAAA;AAAA,EAChE,UAAA,EAAY,CAAC,6BAA6B,CAAA;AAC5C,CAAC;;;;"}
1
+ {"version":3,"file":"alpha.esm.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { cicdStatisticsApiRef } from '@backstage-community/plugin-cicd-statistics';\nimport {\n ApiBlueprint,\n createApiFactory,\n createFrontendModule,\n gitlabAuthApiRef,\n} from '@backstage/frontend-plugin-api';\nimport { CicdStatisticsApiGitlab } from './api';\n\n/**\n * @alpha\n */\nexport const cicdStatisticsGitlabExtension = ApiBlueprint.make({\n name: 'cicd-statistics-gitlab-api',\n params: {\n factory: createApiFactory({\n api: cicdStatisticsApiRef,\n deps: {\n gitlabAuthApi: gitlabAuthApiRef,\n },\n factory: ({ gitlabAuthApi }) => {\n return new CicdStatisticsApiGitlab(gitlabAuthApi);\n },\n }),\n },\n});\n\n/**\n * @alpha\n */\nconst cicdStatisticsExtensionOverrides = createFrontendModule({\n pluginId: 'cicd-statistics',\n extensions: [cicdStatisticsGitlabExtension],\n});\n\nexport default cicdStatisticsExtensionOverrides;\n"],"names":[],"mappings":";;;;AA2Ba,MAAA,6BAAA,GAAgC,aAAa,IAAK,CAAA;AAAA,EAC7D,IAAM,EAAA,4BAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,SAAS,gBAAiB,CAAA;AAAA,MACxB,GAAK,EAAA,oBAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,aAAe,EAAA;AAAA,OACjB;AAAA,MACA,OAAS,EAAA,CAAC,EAAE,aAAA,EAAoB,KAAA;AAC9B,QAAO,OAAA,IAAI,wBAAwB,aAAa,CAAA;AAAA;AAClD,KACD;AAAA;AAEL,CAAC;AAKD,MAAM,mCAAmC,oBAAqB,CAAA;AAAA,EAC5D,QAAU,EAAA,iBAAA;AAAA,EACV,UAAA,EAAY,CAAC,6BAA6B;AAC5C,CAAC;;;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"gitlab.esm.js","sources":["../../src/api/gitlab.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n CicdStatisticsApi,\n CicdState,\n CicdConfiguration,\n CicdDefaults,\n Build,\n FetchBuildsOptions,\n Stage,\n} from '@backstage-community/plugin-cicd-statistics';\nimport { Gitlab } from '@gitbeaker/browser';\nimport { OAuthApi } from '@backstage/core-plugin-api';\nimport limiterFactory from 'p-limit';\nimport { Entity, getEntitySourceLocation } from '@backstage/catalog-model';\nimport { pipelinesToBuilds, jobsToStages } from './utils';\n\n/**\n * This type represents a initialized gitlab client with gitbeaker\n *\n * @public\n */\nexport type GitlabClient = {\n /* the actual API of gitbeaker */\n api: InstanceType<typeof Gitlab>;\n /* the owner the repository, retrieved from the entity source location */\n owner: string;\n};\n\n/**\n * Extracts the CI/CD statistics from a Gitlab repository\n *\n * @public\n */\nexport class CicdStatisticsApiGitlab implements CicdStatisticsApi {\n readonly #gitLabAuthApi: OAuthApi;\n readonly #cicdDefaults: Partial<CicdDefaults>;\n\n constructor(\n gitLabAuthApi: OAuthApi,\n cicdDefaults: Partial<CicdDefaults> = {},\n ) {\n this.#gitLabAuthApi = gitLabAuthApi;\n this.#cicdDefaults = cicdDefaults;\n }\n\n public async createGitlabApi(\n entity: Entity,\n scopes: string[],\n ): Promise<GitlabClient> {\n const entityInfo = getEntitySourceLocation(entity);\n const url = new URL(entityInfo.target);\n const owner = url.pathname.split('/-/blob/')[0];\n const oauthToken = await this.#gitLabAuthApi.getAccessToken(scopes);\n return {\n api: new Gitlab({\n host: `https://${url.host}`,\n oauthToken,\n }),\n owner: owner.substring(1),\n };\n }\n\n private static async updateBuildWithStages(\n gitbeaker: InstanceType<typeof Gitlab>,\n owner: string,\n build: Build,\n ): Promise<Stage[]> {\n const jobs = await gitbeaker.Jobs.showPipelineJobs(\n owner,\n parseInt(build.id, 10),\n );\n const stages = jobsToStages(jobs);\n return stages;\n }\n\n private static async getDurationOfBuild(\n gitbeaker: InstanceType<typeof Gitlab>,\n owner: string,\n build: Build,\n ): Promise<number> {\n const pipeline = await gitbeaker.Pipelines.show(\n owner,\n parseInt(build.id, 10),\n );\n return parseInt(pipeline.duration as string, 10) * 1000;\n }\n\n private static async getDefaultBranch(\n gitbeaker: InstanceType<typeof Gitlab>,\n owner: string,\n ): Promise<string | undefined> {\n const branches = await gitbeaker.Branches.all(owner);\n return branches.find(branch => branch.default)?.name;\n }\n\n public async fetchBuilds(options: FetchBuildsOptions): Promise<CicdState> {\n const {\n entity,\n updateProgress,\n timeFrom,\n timeTo,\n filterStatus = ['all'],\n filterType = 'all',\n } = options;\n const { api, owner } = await this.createGitlabApi(entity, ['read_api']);\n updateProgress(0, 0, 0);\n\n const branch =\n filterType === 'master'\n ? await CicdStatisticsApiGitlab.getDefaultBranch(api, owner)\n : undefined;\n const pipelines = await api.Pipelines.all(owner, {\n perPage: 25,\n updated_after: timeFrom.toISOString(),\n updated_before: timeTo.toISOString(),\n ref: branch,\n });\n\n const limiter = limiterFactory(10);\n const builds = pipelinesToBuilds(pipelines).map(async build => ({\n ...build,\n duration: await limiter(() =>\n CicdStatisticsApiGitlab.getDurationOfBuild(api, owner, build),\n ),\n stages: await limiter(() =>\n CicdStatisticsApiGitlab.updateBuildWithStages(api, owner, build),\n ),\n }));\n const promisedBuilds = (await Promise.all(builds)).filter(b =>\n filterStatus.includes(b.status),\n );\n\n return { builds: promisedBuilds };\n }\n\n public async getConfiguration(): Promise<Partial<CicdConfiguration>> {\n return {\n availableStatuses: [\n 'succeeded',\n 'failed',\n 'enqueued',\n 'running',\n 'aborted',\n 'stalled',\n 'expired',\n 'unknown',\n ] as const,\n defaults: this.#cicdDefaults,\n };\n }\n}\n"],"names":[],"mappings":";;;;;AAgDO,MAAM,uBAAqD,CAAA;AAAA,EACvD,cAAA,CAAA;AAAA,EACA,aAAA,CAAA;AAAA,EAET,WACE,CAAA,aAAA,EACA,YAAsC,GAAA,EACtC,EAAA;AACA,IAAA,IAAA,CAAK,cAAiB,GAAA,aAAA,CAAA;AACtB,IAAA,IAAA,CAAK,aAAgB,GAAA,YAAA,CAAA;AAAA,GACvB;AAAA,EAEA,MAAa,eACX,CAAA,MAAA,EACA,MACuB,EAAA;AACvB,IAAM,MAAA,UAAA,GAAa,wBAAwB,MAAM,CAAA,CAAA;AACjD,IAAA,MAAM,GAAM,GAAA,IAAI,GAAI,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACrC,IAAA,MAAM,QAAQ,GAAI,CAAA,QAAA,CAAS,KAAM,CAAA,UAAU,EAAE,CAAC,CAAA,CAAA;AAC9C,IAAA,MAAM,UAAa,GAAA,MAAM,IAAK,CAAA,cAAA,CAAe,eAAe,MAAM,CAAA,CAAA;AAClE,IAAO,OAAA;AAAA,MACL,GAAA,EAAK,IAAI,MAAO,CAAA;AAAA,QACd,IAAA,EAAM,CAAW,QAAA,EAAA,GAAA,CAAI,IAAI,CAAA,CAAA;AAAA,QACzB,UAAA;AAAA,OACD,CAAA;AAAA,MACD,KAAA,EAAO,KAAM,CAAA,SAAA,CAAU,CAAC,CAAA;AAAA,KAC1B,CAAA;AAAA,GACF;AAAA,EAEA,aAAqB,qBAAA,CACnB,SACA,EAAA,KAAA,EACA,KACkB,EAAA;AAClB,IAAM,MAAA,IAAA,GAAO,MAAM,SAAA,CAAU,IAAK,CAAA,gBAAA;AAAA,MAChC,KAAA;AAAA,MACA,QAAA,CAAS,KAAM,CAAA,EAAA,EAAI,EAAE,CAAA;AAAA,KACvB,CAAA;AACA,IAAM,MAAA,MAAA,GAAS,aAAa,IAAI,CAAA,CAAA;AAChC,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEA,aAAqB,kBAAA,CACnB,SACA,EAAA,KAAA,EACA,KACiB,EAAA;AACjB,IAAM,MAAA,QAAA,GAAW,MAAM,SAAA,CAAU,SAAU,CAAA,IAAA;AAAA,MACzC,KAAA;AAAA,MACA,QAAA,CAAS,KAAM,CAAA,EAAA,EAAI,EAAE,CAAA;AAAA,KACvB,CAAA;AACA,IAAA,OAAO,QAAS,CAAA,QAAA,CAAS,QAAoB,EAAA,EAAE,CAAI,GAAA,GAAA,CAAA;AAAA,GACrD;AAAA,EAEA,aAAqB,gBACnB,CAAA,SAAA,EACA,KAC6B,EAAA;AAC7B,IAAA,MAAM,QAAW,GAAA,MAAM,SAAU,CAAA,QAAA,CAAS,IAAI,KAAK,CAAA,CAAA;AACnD,IAAA,OAAO,QAAS,CAAA,IAAA,CAAK,CAAU,MAAA,KAAA,MAAA,CAAO,OAAO,CAAG,EAAA,IAAA,CAAA;AAAA,GAClD;AAAA,EAEA,MAAa,YAAY,OAAiD,EAAA;AACxE,IAAM,MAAA;AAAA,MACJ,MAAA;AAAA,MACA,cAAA;AAAA,MACA,QAAA;AAAA,MACA,MAAA;AAAA,MACA,YAAA,GAAe,CAAC,KAAK,CAAA;AAAA,MACrB,UAAa,GAAA,KAAA;AAAA,KACX,GAAA,OAAA,CAAA;AACJ,IAAM,MAAA,EAAE,GAAK,EAAA,KAAA,EAAU,GAAA,MAAM,KAAK,eAAgB,CAAA,MAAA,EAAQ,CAAC,UAAU,CAAC,CAAA,CAAA;AACtE,IAAe,cAAA,CAAA,CAAA,EAAG,GAAG,CAAC,CAAA,CAAA;AAEtB,IAAM,MAAA,MAAA,GACJ,eAAe,QACX,GAAA,MAAM,wBAAwB,gBAAiB,CAAA,GAAA,EAAK,KAAK,CACzD,GAAA,KAAA,CAAA,CAAA;AACN,IAAA,MAAM,SAAY,GAAA,MAAM,GAAI,CAAA,SAAA,CAAU,IAAI,KAAO,EAAA;AAAA,MAC/C,OAAS,EAAA,EAAA;AAAA,MACT,aAAA,EAAe,SAAS,WAAY,EAAA;AAAA,MACpC,cAAA,EAAgB,OAAO,WAAY,EAAA;AAAA,MACnC,GAAK,EAAA,MAAA;AAAA,KACN,CAAA,CAAA;AAED,IAAM,MAAA,OAAA,GAAU,eAAe,EAAE,CAAA,CAAA;AACjC,IAAA,MAAM,SAAS,iBAAkB,CAAA,SAAS,CAAE,CAAA,GAAA,CAAI,OAAM,KAAU,MAAA;AAAA,MAC9D,GAAG,KAAA;AAAA,MACH,UAAU,MAAM,OAAA;AAAA,QAAQ,MACtB,uBAAA,CAAwB,kBAAmB,CAAA,GAAA,EAAK,OAAO,KAAK,CAAA;AAAA,OAC9D;AAAA,MACA,QAAQ,MAAM,OAAA;AAAA,QAAQ,MACpB,uBAAA,CAAwB,qBAAsB,CAAA,GAAA,EAAK,OAAO,KAAK,CAAA;AAAA,OACjE;AAAA,KACA,CAAA,CAAA,CAAA;AACF,IAAA,MAAM,cAAkB,GAAA,CAAA,MAAM,OAAQ,CAAA,GAAA,CAAI,MAAM,CAAG,EAAA,MAAA;AAAA,MAAO,CACxD,CAAA,KAAA,YAAA,CAAa,QAAS,CAAA,CAAA,CAAE,MAAM,CAAA;AAAA,KAChC,CAAA;AAEA,IAAO,OAAA,EAAE,QAAQ,cAAe,EAAA,CAAA;AAAA,GAClC;AAAA,EAEA,MAAa,gBAAwD,GAAA;AACnE,IAAO,OAAA;AAAA,MACL,iBAAmB,EAAA;AAAA,QACjB,WAAA;AAAA,QACA,QAAA;AAAA,QACA,UAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,OACF;AAAA,MACA,UAAU,IAAK,CAAA,aAAA;AAAA,KACjB,CAAA;AAAA,GACF;AACF;;;;"}
1
+ {"version":3,"file":"gitlab.esm.js","sources":["../../src/api/gitlab.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n CicdStatisticsApi,\n CicdState,\n CicdConfiguration,\n CicdDefaults,\n Build,\n FetchBuildsOptions,\n Stage,\n} from '@backstage-community/plugin-cicd-statistics';\nimport { Gitlab } from '@gitbeaker/browser';\nimport { OAuthApi } from '@backstage/core-plugin-api';\nimport limiterFactory from 'p-limit';\nimport { Entity, getEntitySourceLocation } from '@backstage/catalog-model';\nimport { pipelinesToBuilds, jobsToStages } from './utils';\n\n/**\n * This type represents a initialized gitlab client with gitbeaker\n *\n * @public\n */\nexport type GitlabClient = {\n /* the actual API of gitbeaker */\n api: InstanceType<typeof Gitlab>;\n /* the owner the repository, retrieved from the entity source location */\n owner: string;\n};\n\n/**\n * Extracts the CI/CD statistics from a Gitlab repository\n *\n * @public\n */\nexport class CicdStatisticsApiGitlab implements CicdStatisticsApi {\n readonly #gitLabAuthApi: OAuthApi;\n readonly #cicdDefaults: Partial<CicdDefaults>;\n\n constructor(\n gitLabAuthApi: OAuthApi,\n cicdDefaults: Partial<CicdDefaults> = {},\n ) {\n this.#gitLabAuthApi = gitLabAuthApi;\n this.#cicdDefaults = cicdDefaults;\n }\n\n public async createGitlabApi(\n entity: Entity,\n scopes: string[],\n ): Promise<GitlabClient> {\n const entityInfo = getEntitySourceLocation(entity);\n const url = new URL(entityInfo.target);\n const owner = url.pathname.split('/-/blob/')[0];\n const oauthToken = await this.#gitLabAuthApi.getAccessToken(scopes);\n return {\n api: new Gitlab({\n host: `https://${url.host}`,\n oauthToken,\n }),\n owner: owner.substring(1),\n };\n }\n\n private static async updateBuildWithStages(\n gitbeaker: InstanceType<typeof Gitlab>,\n owner: string,\n build: Build,\n ): Promise<Stage[]> {\n const jobs = await gitbeaker.Jobs.showPipelineJobs(\n owner,\n parseInt(build.id, 10),\n );\n const stages = jobsToStages(jobs);\n return stages;\n }\n\n private static async getDurationOfBuild(\n gitbeaker: InstanceType<typeof Gitlab>,\n owner: string,\n build: Build,\n ): Promise<number> {\n const pipeline = await gitbeaker.Pipelines.show(\n owner,\n parseInt(build.id, 10),\n );\n return parseInt(pipeline.duration as string, 10) * 1000;\n }\n\n private static async getDefaultBranch(\n gitbeaker: InstanceType<typeof Gitlab>,\n owner: string,\n ): Promise<string | undefined> {\n const branches = await gitbeaker.Branches.all(owner);\n return branches.find(branch => branch.default)?.name;\n }\n\n public async fetchBuilds(options: FetchBuildsOptions): Promise<CicdState> {\n const {\n entity,\n updateProgress,\n timeFrom,\n timeTo,\n filterStatus = ['all'],\n filterType = 'all',\n } = options;\n const { api, owner } = await this.createGitlabApi(entity, ['read_api']);\n updateProgress(0, 0, 0);\n\n const branch =\n filterType === 'master'\n ? await CicdStatisticsApiGitlab.getDefaultBranch(api, owner)\n : undefined;\n const pipelines = await api.Pipelines.all(owner, {\n perPage: 25,\n updated_after: timeFrom.toISOString(),\n updated_before: timeTo.toISOString(),\n ref: branch,\n });\n\n const limiter = limiterFactory(10);\n const builds = pipelinesToBuilds(pipelines).map(async build => ({\n ...build,\n duration: await limiter(() =>\n CicdStatisticsApiGitlab.getDurationOfBuild(api, owner, build),\n ),\n stages: await limiter(() =>\n CicdStatisticsApiGitlab.updateBuildWithStages(api, owner, build),\n ),\n }));\n const promisedBuilds = (await Promise.all(builds)).filter(b =>\n filterStatus.includes(b.status),\n );\n\n return { builds: promisedBuilds };\n }\n\n public async getConfiguration(): Promise<Partial<CicdConfiguration>> {\n return {\n availableStatuses: [\n 'succeeded',\n 'failed',\n 'enqueued',\n 'running',\n 'aborted',\n 'stalled',\n 'expired',\n 'unknown',\n ] as const,\n defaults: this.#cicdDefaults,\n };\n }\n}\n"],"names":[],"mappings":";;;;;AAgDO,MAAM,uBAAqD,CAAA;AAAA,EACvD,cAAA;AAAA,EACA,aAAA;AAAA,EAET,WACE,CAAA,aAAA,EACA,YAAsC,GAAA,EACtC,EAAA;AACA,IAAA,IAAA,CAAK,cAAiB,GAAA,aAAA;AACtB,IAAA,IAAA,CAAK,aAAgB,GAAA,YAAA;AAAA;AACvB,EAEA,MAAa,eACX,CAAA,MAAA,EACA,MACuB,EAAA;AACvB,IAAM,MAAA,UAAA,GAAa,wBAAwB,MAAM,CAAA;AACjD,IAAA,MAAM,GAAM,GAAA,IAAI,GAAI,CAAA,UAAA,CAAW,MAAM,CAAA;AACrC,IAAA,MAAM,QAAQ,GAAI,CAAA,QAAA,CAAS,KAAM,CAAA,UAAU,EAAE,CAAC,CAAA;AAC9C,IAAA,MAAM,UAAa,GAAA,MAAM,IAAK,CAAA,cAAA,CAAe,eAAe,MAAM,CAAA;AAClE,IAAO,OAAA;AAAA,MACL,GAAA,EAAK,IAAI,MAAO,CAAA;AAAA,QACd,IAAA,EAAM,CAAW,QAAA,EAAA,GAAA,CAAI,IAAI,CAAA,CAAA;AAAA,QACzB;AAAA,OACD,CAAA;AAAA,MACD,KAAA,EAAO,KAAM,CAAA,SAAA,CAAU,CAAC;AAAA,KAC1B;AAAA;AACF,EAEA,aAAqB,qBAAA,CACnB,SACA,EAAA,KAAA,EACA,KACkB,EAAA;AAClB,IAAM,MAAA,IAAA,GAAO,MAAM,SAAA,CAAU,IAAK,CAAA,gBAAA;AAAA,MAChC,KAAA;AAAA,MACA,QAAA,CAAS,KAAM,CAAA,EAAA,EAAI,EAAE;AAAA,KACvB;AACA,IAAM,MAAA,MAAA,GAAS,aAAa,IAAI,CAAA;AAChC,IAAO,OAAA,MAAA;AAAA;AACT,EAEA,aAAqB,kBAAA,CACnB,SACA,EAAA,KAAA,EACA,KACiB,EAAA;AACjB,IAAM,MAAA,QAAA,GAAW,MAAM,SAAA,CAAU,SAAU,CAAA,IAAA;AAAA,MACzC,KAAA;AAAA,MACA,QAAA,CAAS,KAAM,CAAA,EAAA,EAAI,EAAE;AAAA,KACvB;AACA,IAAA,OAAO,QAAS,CAAA,QAAA,CAAS,QAAoB,EAAA,EAAE,CAAI,GAAA,GAAA;AAAA;AACrD,EAEA,aAAqB,gBACnB,CAAA,SAAA,EACA,KAC6B,EAAA;AAC7B,IAAA,MAAM,QAAW,GAAA,MAAM,SAAU,CAAA,QAAA,CAAS,IAAI,KAAK,CAAA;AACnD,IAAA,OAAO,QAAS,CAAA,IAAA,CAAK,CAAU,MAAA,KAAA,MAAA,CAAO,OAAO,CAAG,EAAA,IAAA;AAAA;AAClD,EAEA,MAAa,YAAY,OAAiD,EAAA;AACxE,IAAM,MAAA;AAAA,MACJ,MAAA;AAAA,MACA,cAAA;AAAA,MACA,QAAA;AAAA,MACA,MAAA;AAAA,MACA,YAAA,GAAe,CAAC,KAAK,CAAA;AAAA,MACrB,UAAa,GAAA;AAAA,KACX,GAAA,OAAA;AACJ,IAAM,MAAA,EAAE,GAAK,EAAA,KAAA,EAAU,GAAA,MAAM,KAAK,eAAgB,CAAA,MAAA,EAAQ,CAAC,UAAU,CAAC,CAAA;AACtE,IAAe,cAAA,CAAA,CAAA,EAAG,GAAG,CAAC,CAAA;AAEtB,IAAM,MAAA,MAAA,GACJ,eAAe,QACX,GAAA,MAAM,wBAAwB,gBAAiB,CAAA,GAAA,EAAK,KAAK,CACzD,GAAA,KAAA,CAAA;AACN,IAAA,MAAM,SAAY,GAAA,MAAM,GAAI,CAAA,SAAA,CAAU,IAAI,KAAO,EAAA;AAAA,MAC/C,OAAS,EAAA,EAAA;AAAA,MACT,aAAA,EAAe,SAAS,WAAY,EAAA;AAAA,MACpC,cAAA,EAAgB,OAAO,WAAY,EAAA;AAAA,MACnC,GAAK,EAAA;AAAA,KACN,CAAA;AAED,IAAM,MAAA,OAAA,GAAU,eAAe,EAAE,CAAA;AACjC,IAAA,MAAM,SAAS,iBAAkB,CAAA,SAAS,CAAE,CAAA,GAAA,CAAI,OAAM,KAAU,MAAA;AAAA,MAC9D,GAAG,KAAA;AAAA,MACH,UAAU,MAAM,OAAA;AAAA,QAAQ,MACtB,uBAAA,CAAwB,kBAAmB,CAAA,GAAA,EAAK,OAAO,KAAK;AAAA,OAC9D;AAAA,MACA,QAAQ,MAAM,OAAA;AAAA,QAAQ,MACpB,uBAAA,CAAwB,qBAAsB,CAAA,GAAA,EAAK,OAAO,KAAK;AAAA;AACjE,KACA,CAAA,CAAA;AACF,IAAA,MAAM,cAAkB,GAAA,CAAA,MAAM,OAAQ,CAAA,GAAA,CAAI,MAAM,CAAG,EAAA,MAAA;AAAA,MAAO,CACxD,CAAA,KAAA,YAAA,CAAa,QAAS,CAAA,CAAA,CAAE,MAAM;AAAA,KAChC;AAEA,IAAO,OAAA,EAAE,QAAQ,cAAe,EAAA;AAAA;AAClC,EAEA,MAAa,gBAAwD,GAAA;AACnE,IAAO,OAAA;AAAA,MACL,iBAAmB,EAAA;AAAA,QACjB,WAAA;AAAA,QACA,QAAA;AAAA,QACA,UAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA;AAAA,OACF;AAAA,MACA,UAAU,IAAK,CAAA;AAAA,KACjB;AAAA;AAEJ;;;;"}
@@ -1 +1 @@
1
- {"version":3,"file":"utils.esm.js","sources":["../../src/api/utils.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n Build,\n FilterStatusType,\n TriggerReason,\n Stage,\n} from '@backstage-community/plugin-cicd-statistics';\nimport { Types } from '@gitbeaker/core';\n\nconst statusMap: Record<string, FilterStatusType> = {\n manual: 'unknown',\n created: 'enqueued',\n waiting_for_resource: 'stalled',\n preparing: 'unknown',\n pending: 'scheduled',\n running: 'running',\n success: 'succeeded',\n failed: 'failed',\n canceled: 'aborted',\n skipped: 'aborted',\n scheduled: 'scheduled',\n};\n\n// all gitlab trigger reasons can be found here: https://docs.gitlab.com/ee/api/pipelines.html#list-project-pipelines\nconst triggerReasonMap: Record<string, TriggerReason> = {\n push: 'scm',\n trigger: 'manual',\n merge_request_event: 'scm',\n schedule: 'internal',\n};\n\n/**\n * Takes the Pipeline object from Gitlab and transforms it to the Build object\n *\n * @param pipelines - Pipeline object that gets returned from Gitlab\n *\n * @public\n */\nexport function pipelinesToBuilds(\n pipelines: Array<Types.PipelineSchema>,\n): Build[] {\n return pipelines.map(pipeline => {\n return {\n id: pipeline.id.toString(),\n status: statusMap[pipeline.status],\n branchType: 'master',\n duration: 0, // will get filled in later in a seperate API call\n requestedAt: new Date(pipeline.created_at),\n triggeredBy: triggerReasonMap[pipeline.source as string] ?? 'other',\n stages: [],\n };\n });\n}\n\n/**\n * Takes the Job object from Gitlab and transforms it to the Stage object\n *\n * @param jobs - Job object that gets returned from Gitlab\n *\n * @public\n *\n * @remarks\n *\n * The Gitlab API can only return the job (sub-stage) of a pipeline and not a whole stage\n * The job does return from which stage it is\n * So, for the stage name we use the parent stage name and in the sub-stages we add the current job\n * In the end the cicd-statistics plugin will calculate the right durations for each stage\n *\n * Furthermore, we don't add the job to the sub-stage if it is has the same name as the parent stage\n * We then assume that the stage has no sub-stages\n */\nexport function jobsToStages(jobs: Array<Types.JobSchema>): Stage[] {\n return jobs.map(job => {\n const status = statusMap[job.status] ? statusMap[job.status] : 'unknown';\n const duration = job.duration ? ((job.duration * 1000) as number) : 0;\n return {\n name: job.stage,\n status,\n duration,\n stages:\n job.name !== job.stage\n ? [\n {\n name: job.name,\n status,\n duration,\n },\n ]\n : [],\n };\n });\n}\n"],"names":[],"mappings":"AAwBA,MAAM,SAA8C,GAAA;AAAA,EAClD,MAAQ,EAAA,SAAA;AAAA,EACR,OAAS,EAAA,UAAA;AAAA,EACT,oBAAsB,EAAA,SAAA;AAAA,EACtB,SAAW,EAAA,SAAA;AAAA,EACX,OAAS,EAAA,WAAA;AAAA,EACT,OAAS,EAAA,SAAA;AAAA,EACT,OAAS,EAAA,WAAA;AAAA,EACT,MAAQ,EAAA,QAAA;AAAA,EACR,QAAU,EAAA,SAAA;AAAA,EACV,OAAS,EAAA,SAAA;AAAA,EACT,SAAW,EAAA,WAAA;AACb,CAAA,CAAA;AAGA,MAAM,gBAAkD,GAAA;AAAA,EACtD,IAAM,EAAA,KAAA;AAAA,EACN,OAAS,EAAA,QAAA;AAAA,EACT,mBAAqB,EAAA,KAAA;AAAA,EACrB,QAAU,EAAA,UAAA;AACZ,CAAA,CAAA;AASO,SAAS,kBACd,SACS,EAAA;AACT,EAAO,OAAA,SAAA,CAAU,IAAI,CAAY,QAAA,KAAA;AAC/B,IAAO,OAAA;AAAA,MACL,EAAA,EAAI,QAAS,CAAA,EAAA,CAAG,QAAS,EAAA;AAAA,MACzB,MAAA,EAAQ,SAAU,CAAA,QAAA,CAAS,MAAM,CAAA;AAAA,MACjC,UAAY,EAAA,QAAA;AAAA,MACZ,QAAU,EAAA,CAAA;AAAA;AAAA,MACV,WAAa,EAAA,IAAI,IAAK,CAAA,QAAA,CAAS,UAAU,CAAA;AAAA,MACzC,WAAa,EAAA,gBAAA,CAAiB,QAAS,CAAA,MAAgB,CAAK,IAAA,OAAA;AAAA,MAC5D,QAAQ,EAAC;AAAA,KACX,CAAA;AAAA,GACD,CAAA,CAAA;AACH,CAAA;AAmBO,SAAS,aAAa,IAAuC,EAAA;AAClE,EAAO,OAAA,IAAA,CAAK,IAAI,CAAO,GAAA,KAAA;AACrB,IAAM,MAAA,MAAA,GAAS,UAAU,GAAI,CAAA,MAAM,IAAI,SAAU,CAAA,GAAA,CAAI,MAAM,CAAI,GAAA,SAAA,CAAA;AAC/D,IAAA,MAAM,QAAW,GAAA,GAAA,CAAI,QAAa,GAAA,GAAA,CAAI,WAAW,GAAmB,GAAA,CAAA,CAAA;AACpE,IAAO,OAAA;AAAA,MACL,MAAM,GAAI,CAAA,KAAA;AAAA,MACV,MAAA;AAAA,MACA,QAAA;AAAA,MACA,MACE,EAAA,GAAA,CAAI,IAAS,KAAA,GAAA,CAAI,KACb,GAAA;AAAA,QACE;AAAA,UACE,MAAM,GAAI,CAAA,IAAA;AAAA,UACV,MAAA;AAAA,UACA,QAAA;AAAA,SACF;AAAA,UAEF,EAAC;AAAA,KACT,CAAA;AAAA,GACD,CAAA,CAAA;AACH;;;;"}
1
+ {"version":3,"file":"utils.esm.js","sources":["../../src/api/utils.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n Build,\n FilterStatusType,\n TriggerReason,\n Stage,\n} from '@backstage-community/plugin-cicd-statistics';\nimport { Types } from '@gitbeaker/core';\n\nconst statusMap: Record<string, FilterStatusType> = {\n manual: 'unknown',\n created: 'enqueued',\n waiting_for_resource: 'stalled',\n preparing: 'unknown',\n pending: 'scheduled',\n running: 'running',\n success: 'succeeded',\n failed: 'failed',\n canceled: 'aborted',\n skipped: 'aborted',\n scheduled: 'scheduled',\n};\n\n// all gitlab trigger reasons can be found here: https://docs.gitlab.com/ee/api/pipelines.html#list-project-pipelines\nconst triggerReasonMap: Record<string, TriggerReason> = {\n push: 'scm',\n trigger: 'manual',\n merge_request_event: 'scm',\n schedule: 'internal',\n};\n\n/**\n * Takes the Pipeline object from Gitlab and transforms it to the Build object\n *\n * @param pipelines - Pipeline object that gets returned from Gitlab\n *\n * @public\n */\nexport function pipelinesToBuilds(\n pipelines: Array<Types.PipelineSchema>,\n): Build[] {\n return pipelines.map(pipeline => {\n return {\n id: pipeline.id.toString(),\n status: statusMap[pipeline.status],\n branchType: 'master',\n duration: 0, // will get filled in later in a seperate API call\n requestedAt: new Date(pipeline.created_at),\n triggeredBy: triggerReasonMap[pipeline.source as string] ?? 'other',\n stages: [],\n };\n });\n}\n\n/**\n * Takes the Job object from Gitlab and transforms it to the Stage object\n *\n * @param jobs - Job object that gets returned from Gitlab\n *\n * @public\n *\n * @remarks\n *\n * The Gitlab API can only return the job (sub-stage) of a pipeline and not a whole stage\n * The job does return from which stage it is\n * So, for the stage name we use the parent stage name and in the sub-stages we add the current job\n * In the end the cicd-statistics plugin will calculate the right durations for each stage\n *\n * Furthermore, we don't add the job to the sub-stage if it is has the same name as the parent stage\n * We then assume that the stage has no sub-stages\n */\nexport function jobsToStages(jobs: Array<Types.JobSchema>): Stage[] {\n return jobs.map(job => {\n const status = statusMap[job.status] ? statusMap[job.status] : 'unknown';\n const duration = job.duration ? ((job.duration * 1000) as number) : 0;\n return {\n name: job.stage,\n status,\n duration,\n stages:\n job.name !== job.stage\n ? [\n {\n name: job.name,\n status,\n duration,\n },\n ]\n : [],\n };\n });\n}\n"],"names":[],"mappings":"AAwBA,MAAM,SAA8C,GAAA;AAAA,EAClD,MAAQ,EAAA,SAAA;AAAA,EACR,OAAS,EAAA,UAAA;AAAA,EACT,oBAAsB,EAAA,SAAA;AAAA,EACtB,SAAW,EAAA,SAAA;AAAA,EACX,OAAS,EAAA,WAAA;AAAA,EACT,OAAS,EAAA,SAAA;AAAA,EACT,OAAS,EAAA,WAAA;AAAA,EACT,MAAQ,EAAA,QAAA;AAAA,EACR,QAAU,EAAA,SAAA;AAAA,EACV,OAAS,EAAA,SAAA;AAAA,EACT,SAAW,EAAA;AACb,CAAA;AAGA,MAAM,gBAAkD,GAAA;AAAA,EACtD,IAAM,EAAA,KAAA;AAAA,EACN,OAAS,EAAA,QAAA;AAAA,EACT,mBAAqB,EAAA,KAAA;AAAA,EACrB,QAAU,EAAA;AACZ,CAAA;AASO,SAAS,kBACd,SACS,EAAA;AACT,EAAO,OAAA,SAAA,CAAU,IAAI,CAAY,QAAA,KAAA;AAC/B,IAAO,OAAA;AAAA,MACL,EAAA,EAAI,QAAS,CAAA,EAAA,CAAG,QAAS,EAAA;AAAA,MACzB,MAAA,EAAQ,SAAU,CAAA,QAAA,CAAS,MAAM,CAAA;AAAA,MACjC,UAAY,EAAA,QAAA;AAAA,MACZ,QAAU,EAAA,CAAA;AAAA;AAAA,MACV,WAAa,EAAA,IAAI,IAAK,CAAA,QAAA,CAAS,UAAU,CAAA;AAAA,MACzC,WAAa,EAAA,gBAAA,CAAiB,QAAS,CAAA,MAAgB,CAAK,IAAA,OAAA;AAAA,MAC5D,QAAQ;AAAC,KACX;AAAA,GACD,CAAA;AACH;AAmBO,SAAS,aAAa,IAAuC,EAAA;AAClE,EAAO,OAAA,IAAA,CAAK,IAAI,CAAO,GAAA,KAAA;AACrB,IAAM,MAAA,MAAA,GAAS,UAAU,GAAI,CAAA,MAAM,IAAI,SAAU,CAAA,GAAA,CAAI,MAAM,CAAI,GAAA,SAAA;AAC/D,IAAA,MAAM,QAAW,GAAA,GAAA,CAAI,QAAa,GAAA,GAAA,CAAI,WAAW,GAAmB,GAAA,CAAA;AACpE,IAAO,OAAA;AAAA,MACL,MAAM,GAAI,CAAA,KAAA;AAAA,MACV,MAAA;AAAA,MACA,QAAA;AAAA,MACA,MACE,EAAA,GAAA,CAAI,IAAS,KAAA,GAAA,CAAI,KACb,GAAA;AAAA,QACE;AAAA,UACE,MAAM,GAAI,CAAA,IAAA;AAAA,UACV,MAAA;AAAA,UACA;AAAA;AACF,UAEF;AAAC,KACT;AAAA,GACD,CAAA;AACH;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage-community/plugin-cicd-statistics-module-gitlab",
3
- "version": "0.1.34",
3
+ "version": "0.2.0",
4
4
  "description": "CI/CD Statistics plugin module; Gitlab CICD",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin-module",
@@ -28,19 +28,29 @@
28
28
  "default": "./dist/index.esm.js"
29
29
  },
30
30
  "./alpha": {
31
+ "backstage": "@backstage/FrontendModule",
31
32
  "import": "./dist/alpha.esm.js",
32
33
  "types": "./dist/alpha.d.ts",
33
34
  "default": "./dist/alpha.esm.js"
34
35
  },
35
36
  "./package.json": "./package.json"
36
37
  },
38
+ "typesVersions": {
39
+ "*": {
40
+ "index": [
41
+ "dist/index.d.ts"
42
+ ],
43
+ "alpha": [
44
+ "dist/alpha.d.ts"
45
+ ]
46
+ }
47
+ },
37
48
  "license": "Apache-2.0",
38
49
  "sideEffects": false,
39
50
  "main": "./dist/index.esm.js",
40
51
  "types": "./dist/index.d.ts",
41
52
  "files": [
42
- "dist",
43
- "alpha"
53
+ "dist"
44
54
  ],
45
55
  "scripts": {
46
56
  "build": "backstage-cli package build",
@@ -51,17 +61,17 @@
51
61
  "test": "backstage-cli package test"
52
62
  },
53
63
  "dependencies": {
54
- "@backstage-community/plugin-cicd-statistics": "^0.1.40",
55
- "@backstage/catalog-model": "^1.6.0",
56
- "@backstage/core-plugin-api": "^1.9.3",
57
- "@backstage/frontend-plugin-api": "^0.7.0",
64
+ "@backstage-community/plugin-cicd-statistics": "^0.2.0",
65
+ "@backstage/catalog-model": "^1.7.2",
66
+ "@backstage/core-plugin-api": "^1.10.2",
67
+ "@backstage/frontend-plugin-api": "^0.9.3",
58
68
  "@gitbeaker/browser": "^35.6.0",
59
69
  "@gitbeaker/core": "^35.6.0",
60
70
  "luxon": "^3.0.0",
61
71
  "p-limit": "^3.1.0"
62
72
  },
63
73
  "devDependencies": {
64
- "@backstage/cli": "^0.27.0",
74
+ "@backstage/cli": "^0.29.4",
65
75
  "@types/react": "^16.13.1 || ^17.0.0",
66
76
  "@types/react-dom": "^18.2.19",
67
77
  "react": "^16.13.1 || ^17.0.0 || ^18.0.0",
@@ -1,7 +0,0 @@
1
- {
2
- "name": "@backstage-community/plugin-cicd-statistics-module-gitlab__alpha",
3
- "version": "0.1.34",
4
- "main": "../dist/alpha.esm.js",
5
- "module": "../dist/alpha.esm.js",
6
- "types": "../dist/alpha.d.ts"
7
- }