chore: Reduce dependencies and binary size, add circle ci detector #26522
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| import type { DetectorSync, ResourceAttributes, IResource } from '@opentelemetry/resources' | ||
| import { Resource } from '@opentelemetry/resources' | ||
|
|
||
| /** | ||
| * CircleCiDetectorSync can be used to detect the presence of and create a Resource | ||
| * from circle ci env variables. | ||
| */ | ||
| class CircleCiDetectorSync implements DetectorSync { | ||
| /** | ||
| * Returns a {@link Resource} populated with attributes from the | ||
| * circle ci environment variable. | ||
| * | ||
| * @param config The resource detection config -- ignored | ||
| */ | ||
| detect (): IResource { | ||
| const attributes: ResourceAttributes = {} | ||
|
|
||
| const { CIRCLECI, CIRCLE_BRANCH, CIRCLE_JOB, CIRCLE_NODE_INDEX, CIRCLE_BUILD_URL, CIRCLE_BUILD_NUM, CIRCLE_SHA1, CIRCLE_PR_NUMBER } = process.env | ||
|
|
||
| if (CIRCLECI) { | ||
| attributes['ci.circle'] = CIRCLECI | ||
| attributes['ci.branch'] = CIRCLE_BRANCH | ||
| attributes['ci.job'] = CIRCLE_JOB | ||
| attributes['ci.node'] = CIRCLE_NODE_INDEX | ||
| attributes['ci.build-url'] = CIRCLE_BUILD_URL | ||
| attributes['ci.build-number'] = CIRCLE_BUILD_NUM | ||
| attributes['SHA1'] = CIRCLE_SHA1 | ||
| attributes['ci.pr-number'] = CIRCLE_PR_NUMBER | ||
| } | ||
|
|
||
| return new Resource(attributes) | ||
| } | ||
| } | ||
|
|
||
| export const circleCiDetectorSync = new CircleCiDetectorSync() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| import { expect } from 'chai' | ||
|
|
||
|
|
||
| import { circleCiDetectorSync } from '../../src/detectors/circleCiDetectorSync' | ||
|
|
||
| describe('circleCiDetectorSync', () => { | ||
| describe('undefined values', () => { | ||
| const processValues: any = {} | ||
|
|
||
| beforeEach(() => { | ||
| // cache values | ||
| processValues.CIRCLECI = process.env.CIRCLECI | ||
| processValues.CIRCLE_BRANCH = process.env.CIRCLE_BRANCH | ||
| processValues.CIRCLE_JOB = process.env.CIRCLE_JOB | ||
| processValues.CIRCLE_NODE_INDEX = process.env.CIRCLE_NODE_INDEX | ||
| processValues.CIRCLE_BUILD_URL = process.env.CIRCLE_BUILD_URL | ||
| processValues.CIRCLE_BUILD_NUM = process.env.CIRCLE_BUILD_NUM | ||
| processValues.CIRCLE_SHA1 = process.env.CIRCLE_SHA1 | ||
| processValues.CIRCLE_PR_NUMBER = process.env.CIRCLE_PR_NUMBER | ||
|
|
||
| //reset values | ||
| delete process.env.CIRCLECI | ||
| delete process.env.CIRCLE_BRANCH | ||
| delete process.env.CIRCLE_JOB | ||
| delete process.env.CIRCLE_NODE_INDEX | ||
| delete process.env.CIRCLE_BUILD_URL | ||
| delete process.env.CIRCLE_BUILD_NUM | ||
| delete process.env.CIRCLE_SHA1 | ||
| delete process.env.CIRCLE_PR_NUMBER | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| // Replace values | ||
| process.env.CIRCLECI = processValues.CIRCLECI | ||
|
There was a problem hiding this comment. Does this condition need to be reversed so we delete the circle process variables so they don't leak out to other tests in the process? There was a problem hiding this comment. this is the reversing, we cache the values, delete them, then reset them to the cache There was a problem hiding this comment. Ah that makes a lot of sense now 😅 |
||
| process.env.CIRCLE_BRANCH = processValues.CIRCLE_BRANCH | ||
| process.env.CIRCLE_JOB = processValues.CIRCLE_JOB | ||
| process.env.CIRCLE_NODE_INDEX = processValues.CIRCLE_NODE_INDEX | ||
| process.env.CIRCLE_BUILD_URL = processValues.CIRCLE_BUILD_URL | ||
| process.env.CIRCLE_BUILD_NUM = processValues.CIRCLE_BUILD_NUM | ||
| process.env.CIRCLE_SHA1 = processValues.CIRCLE_SHA1 | ||
| process.env.CIRCLE_PR_NUMBER = processValues.CIRCLE_PR_NUMBER | ||
| }) | ||
|
|
||
| describe('detect', () => { | ||
| it('returns an empty resource', () => { | ||
| const resource = circleCiDetectorSync.detect() | ||
|
|
||
| expect(resource.attributes).to.be.empty | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| describe('defined values', () => { | ||
| const processValues: any = {} | ||
|
|
||
| beforeEach(() => { | ||
| // cache values | ||
| processValues.CIRCLECI = process.env.CIRCLECI | ||
| processValues.CIRCLE_BRANCH = process.env.CIRCLE_BRANCH | ||
| processValues.CIRCLE_JOB = process.env.CIRCLE_JOB | ||
| processValues.CIRCLE_NODE_INDEX = process.env.CIRCLE_NODE_INDEX | ||
| processValues.CIRCLE_BUILD_URL = process.env.CIRCLE_BUILD_URL | ||
| processValues.CIRCLE_BUILD_NUM = process.env.CIRCLE_BUILD_NUM | ||
| processValues.CIRCLE_SHA1 = process.env.CIRCLE_SHA1 | ||
| processValues.CIRCLE_PR_NUMBER = process.env.CIRCLE_PR_NUMBER | ||
|
|
||
| //reset values | ||
| process.env.CIRCLECI = 'circleCi' | ||
| process.env.CIRCLE_BRANCH = 'circleBranch' | ||
| process.env.CIRCLE_JOB = 'circleJob' | ||
| process.env.CIRCLE_NODE_INDEX = 'circleNodeIndex' | ||
| process.env.CIRCLE_BUILD_URL = 'circleBuildUrl' | ||
| process.env.CIRCLE_BUILD_NUM = 'circleBuildNum' | ||
| process.env.CIRCLE_SHA1 = 'circleSha1' | ||
| process.env.CIRCLE_PR_NUMBER = 'circlePrNumber' | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| // Replace values | ||
| process.env.CIRCLECI = processValues.CIRCLECI | ||
| process.env.CIRCLE_BRANCH = processValues.CIRCLE_BRANCH | ||
| process.env.CIRCLE_JOB = processValues.CIRCLE_JOB | ||
| process.env.CIRCLE_NODE_INDEX = processValues.CIRCLE_NODE_INDEX | ||
| process.env.CIRCLE_BUILD_URL = processValues.CIRCLE_BUILD_URL | ||
| process.env.CIRCLE_BUILD_NUM = processValues.CIRCLE_BUILD_NUM | ||
| process.env.CIRCLE_SHA1 = processValues.CIRCLE_SHA1 | ||
| process.env.CIRCLE_PR_NUMBER = processValues.CIRCLE_PR_NUMBER | ||
| }) | ||
|
|
||
| describe('detect', () => { | ||
| it('returns a resource with attributes', () => { | ||
| const resource = circleCiDetectorSync.detect() | ||
|
|
||
| console.log(resource.attributes) | ||
|
|
||
| expect(resource.attributes['ci.circle']).to.equal('circleCi') | ||
| expect(resource.attributes['ci.branch']).to.equal('circleBranch') | ||
| expect(resource.attributes['ci.job']).to.equal('circleJob') | ||
| expect(resource.attributes['ci.node']).to.equal('circleNodeIndex') | ||
| expect(resource.attributes['ci.build-url']).to.equal('circleBuildUrl') | ||
| expect(resource.attributes['ci.build-number']).to.equal('circleBuildNum') | ||
| expect(resource.attributes['SHA1']).to.equal('circleSha1') | ||
| expect(resource.attributes['ci.pr-number']).to.equal('circlePrNumber') | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the circle ci detector replaces the need for this line