fix(docs-infra): handle CircleCI API v2 responses in preview server#45934
Closed
gkalpak wants to merge 1 commit intoangular:mainfrom
Closed
fix(docs-infra): handle CircleCI API v2 responses in preview server#45934gkalpak wants to merge 1 commit intoangular:mainfrom
gkalpak wants to merge 1 commit intoangular:mainfrom
Conversation
In PR angular#45349 we switched to using version 2 of the CircleCI API. It turns out that this version of the API (in addition to different URLs) also returns different info from some endpoints, which we have failed to account for. More specifically, the v2 API response for a job does not contain info that we need in [BuildRetriever][1]. As an example, see the API responses for an `aio_preview` run: - [API v1.1][2] - [API v2][3] This commit updates the code to handle API v2 responses. In addition, since the info we need is not present in the job info (as it was with the previous version of the API), we now also retrieve the pipeline info. NOTE: This issue did not manifest earlier, because the preview server code on the VM was not updated to the latest version (that tried to use API v2) due to a different error. This error was fixed with PR angular#45895, which allowed the preview server to be updated on the VM and uncovered the API v2 incompatibility. [1]: https://github.com/angular/angular/blob/baa3e18812127e7266580f4cd202a4cb3204cbcb/aio/aio-builds-setup/dockerbuild/scripts-js/lib/preview-server/build-retriever.ts#L39-L45 [2]: https://circleci.com/api/v1.1/project/github/angular/angular/1163816 [3]: https://circleci.com/api/v2/project/gh/angular/angular/job/1163816 Fixes angular#45931
|
I see that you just added the If you want your PR to be merged, it has to pass all the CI checks. If you can't get the PR to a green state due to flakes or broken |
Contributor
|
This PR was merged into the repository by commit c434097. |
AndrewKushnir
pushed a commit
that referenced
this pull request
May 9, 2022
…45934) In PR #45349 we switched to using version 2 of the CircleCI API. It turns out that this version of the API (in addition to different URLs) also returns different info from some endpoints, which we have failed to account for. More specifically, the v2 API response for a job does not contain info that we need in [BuildRetriever][1]. As an example, see the API responses for an `aio_preview` run: - [API v1.1][2] - [API v2][3] This commit updates the code to handle API v2 responses. In addition, since the info we need is not present in the job info (as it was with the previous version of the API), we now also retrieve the pipeline info. NOTE: This issue did not manifest earlier, because the preview server code on the VM was not updated to the latest version (that tried to use API v2) due to a different error. This error was fixed with PR #45895, which allowed the preview server to be updated on the VM and uncovered the API v2 incompatibility. [1]: https://github.com/angular/angular/blob/baa3e18812127e7266580f4cd202a4cb3204cbcb/aio/aio-builds-setup/dockerbuild/scripts-js/lib/preview-server/build-retriever.ts#L39-L45 [2]: https://circleci.com/api/v1.1/project/github/angular/angular/1163816 [3]: https://circleci.com/api/v2/project/gh/angular/angular/job/1163816 Fixes #45931 PR Close #45934
AndrewKushnir
pushed a commit
that referenced
this pull request
May 9, 2022
…45934) In PR #45349 we switched to using version 2 of the CircleCI API. It turns out that this version of the API (in addition to different URLs) also returns different info from some endpoints, which we have failed to account for. More specifically, the v2 API response for a job does not contain info that we need in [BuildRetriever][1]. As an example, see the API responses for an `aio_preview` run: - [API v1.1][2] - [API v2][3] This commit updates the code to handle API v2 responses. In addition, since the info we need is not present in the job info (as it was with the previous version of the API), we now also retrieve the pipeline info. NOTE: This issue did not manifest earlier, because the preview server code on the VM was not updated to the latest version (that tried to use API v2) due to a different error. This error was fixed with PR #45895, which allowed the preview server to be updated on the VM and uncovered the API v2 incompatibility. [1]: https://github.com/angular/angular/blob/baa3e18812127e7266580f4cd202a4cb3204cbcb/aio/aio-builds-setup/dockerbuild/scripts-js/lib/preview-server/build-retriever.ts#L39-L45 [2]: https://circleci.com/api/v1.1/project/github/angular/angular/1163816 [3]: https://circleci.com/api/v2/project/gh/angular/angular/job/1163816 Fixes #45931 PR Close #45934
gkalpak
added a commit
to gkalpak/angular
that referenced
this pull request
May 10, 2022
Previously, the preview server would incorrectly identify a running `aio_preview` CI job as failed and therefore skip creating a preview. This happened because it only checked whether the job's status is `success`, failing to account for the fact that the job would have a `running` status. (This bug was accidentally introduced in angular#45934.) This commit avoids the problem by getting rid of the job status check altogether. This check does not offer any benefit, since the CI job will always be in a `running` state (i.e. neither successfully completed nor failed).
jessicajaniuk
pushed a commit
that referenced
this pull request
May 12, 2022
Previously, the preview server would incorrectly identify a running `aio_preview` CI job as failed and therefore skip creating a preview. This happened because it only checked whether the job's status is `success`, failing to account for the fact that the job would have a `running` status. (This bug was accidentally introduced in #45934.) This commit avoids the problem by getting rid of the job status check altogether. This check does not offer any benefit, since the CI job will always be in a `running` state (i.e. neither successfully completed nor failed). PR Close #45948
jessicajaniuk
pushed a commit
that referenced
this pull request
May 12, 2022
Previously, the preview server would incorrectly identify a running `aio_preview` CI job as failed and therefore skip creating a preview. This happened because it only checked whether the job's status is `success`, failing to account for the fact that the job would have a `running` status. (This bug was accidentally introduced in #45934.) This commit avoids the problem by getting rid of the job status check altogether. This check does not offer any benefit, since the CI job will always be in a `running` state (i.e. neither successfully completed nor failed). PR Close #45948
jessicajaniuk
pushed a commit
that referenced
this pull request
May 12, 2022
Previously, the preview server would incorrectly identify a running `aio_preview` CI job as failed and therefore skip creating a preview. This happened because it only checked whether the job's status is `success`, failing to account for the fact that the job would have a `running` status. (This bug was accidentally introduced in #45934.) This commit avoids the problem by getting rid of the job status check altogether. This check does not offer any benefit, since the CI job will always be in a `running` state (i.e. neither successfully completed nor failed). PR Close #45948
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
In PR #45349 we switched to using version 2 of the CircleCI API. It turns out that this version of the API (in addition to different URLs) also returns different info from some endpoints, which we have failed to account for.
More specifically, the v2 API response for a job does not contain info that we need in BuildRetriever.
As an example, see the API responses for an
aio_previewrun:This commit updates the code to handle API v2 responses. In addition, since the info we need is not present in the job info (as it was with the previous version of the API), we now also retrieve the pipeline
info.
NOTE:
This issue did not manifest earlier, because the preview server code on the VM was not updated to the latest version (that tried to use API v2) due to a different error. This error was fixed with PR #45895, which allowed the preview server to be updated on the VM and uncovered the API v2 incompatibility.
Fixes #45931.