search

gitpod-io / gitpod

The developer platform for on-demand cloud development environments to create software faster and more securely.
https://www.gitpod.io
GNU Affero General Public License v3.0
13.01k stars 1.24k forks source link

Wrong branch checked out (main) when opening a Pull Request #13991

Closed jankeromnes closed 1 year ago

jankeromnes commented 2 years ago

Bug description

When opening a Pull Request, we expect Gitpod to check out the Pull Request's branch.

However, since recently, it seems that it (sometimes?) checks out the default branch instead. 🐛

Steps to reproduce

  1. https://gitpod.io/#https://github.com/gitpod-io/gitpod/pull/13963
  2. Checked out branch should be jx/fix-attribution-again, but you actually get main instead:
Screenshot 2022-10-19 at 12 02 56

Workspace affected

gitpodio-gitpod-m35tlw96nof, gitpodio-gitpod-4nxderxz5x0

Expected behavior

  1. Gitpod should always check out the Pull Request branch

Example repository

https://github.com/gitpod-io/gitpod

Anything else?

No response

laushinka commented 2 years ago

This also happens when opening a non-PR branch[1].

jankeromnes commented 2 years ago

In the database, the affected workspaces appear to have the correct context:

[{
  "id": "gitpodio-gitpod-m35tlw96nof",
  "creationTime": "2022-10-19T09:44:12.466Z",
  "ownerId": "643ac637-74ae-4f82-9a86-c8527eb1e496",
  "contextURL": "https://github.com/gitpod-io/gitpod/pull/13963",
  "description": "[server] Don\u0027t attribute usage to a team without active billing",
  "context": "{\"title\":\"[server] Don\u0027t attribute usage to a team without active billing\",\"repository\":{\"cloneUrl\":\"https://github.com/gitpod-io/gitpod.git\",\"host\":\"github.com\",\"name\":\"gitpod\",\"owner\":\"gitpod-io\",\"private\":false},\"ref\":\"jx/fix-attribution-again\",\"refType\":\"branch\",\"revision\":\"fdc1d3b969fbe186310435832b149dcc45b6798a\",\"nr\":13963,\"base\":{\"repository\":{\"cloneUrl\":\"https://github.com/gitpod-io/gitpod.git\",\"host\":\"github.com\",\"name\":\"gitpod\",\"owner\":\"gitpod-io\",\"private\":false},\"ref\":\"main\",\"refType\":\"branch\"},\"normalizedContextURL\":\"https://github.com/gitpod-io/gitpod/pull/13963\",\"checkoutLocation\":\"gitpod\",\"snapshotBucketId\":\"0915f180-d85c-4832-9533-a2f13e4af2eb\",\"prebuildWorkspaceId\":\"f06a627a-0d4a-4b5c-9f81-7f7b992900b6\",\"wasPrebuilt\":true}",
  "config": "{\"image\":\"eu.gcr.io/gitpod-core-dev/dev/dev-environment:af-dev-update-image.8\",\"workspaceLocation\":\"gitpod/gitpod-ws.code-workspace\",\"checkoutLocation\":\"gitpod\",\"ports\":[{\"port\":1337,\"onOpen\":\"open-preview\"},{\"port\":3000,\"onOpen\":\"ignore\"},{\"port\":3001,\"onOpen\":\"ignore\"},{\"port\":3306,\"onOpen\":\"ignore\"},{\"port\":4000,\"onOpen\":\"ignore\"},{\"port\":5900,\"onOpen\":\"ignore\"},{\"port\":6080,\"onOpen\":\"ignore\"},{\"port\":7777,\"onOpen\":\"ignore\"},{\"port\":9229,\"onOpen\":\"ignore\"},{\"port\":9999,\"onOpen\":\"ignore\"},{\"port\":13001,\"onOpen\":\"ignore\"},{\"port\":13444},{\"port\":8022,\"onOpen\":\"ignore\"}],\"tasks\":[{\"name\":\"Install Preview Environment kube-context\",\"command\":\"previewctl install-context --watch\\nexit\\n\"},{\"name\":\"Add Harvester kubeconfig\",\"command\":\"./dev/preview/util/download-and-merge-harvester-kubeconfig.sh\\nexit 0\\n\"},{\"name\":\"Installer dependencies\",\"init\":\"(cd install/installer \u0026\u0026 make deps)\\nexit 0\\n\"},{\"name\":\"Java\",\"command\":\"if [ -z \\\"$RUN_GRADLE_TASK\\\" ]; then\\n  read -r -p \\\"Press enter to continue Java gradle task\\\"\\nfi\\nleeway exec --package components/supervisor-api/java:lib --package components/gitpod-protocol/java:lib -- ./gradlew build\\nleeway exec --package components/ide/jetbrains/backend-plugin:plugin-latest --package components/ide/jetbrains/gateway-plugin:publish-latest --parallel -- ./gradlew buildPlugin\\n\"},{\"name\":\"TypeScript\",\"before\":\"scripts/branch-namespace.sh\",\"init\":\"yarn --network-timeout 100000 \u0026\u0026 yarn build\"},{\"name\":\"Go\",\"before\":\"pre-commit install --install-hooks\",\"init\":\"./components/gitpod-protocol/go/scripts/generate-config.sh\\nleeway exec --filter-type go -v -- go mod verify\\n\",\"openMode\":\"split-right\"}],\"vscode\":{\"extensions\":[\"EditorConfig.EditorConfig\",\"golang.go\",\"hashicorp.terraform\",\"ms-azuretools.vscode-docker\",\"ms-kubernetes-tools.vscode-kubernetes-tools\",\"stkb.rewrap\",\"zxh404.vscode-proto3\",\"matthewpi.caddyfile-support\",\"heptio.jsonnet\",\"timonwong.shellcheck\",\"fwcd.kotlin\",\"dbaeumer.vscode-eslint\",\"esbenp.prettier-vscode\"]},\"jetbrains\":{\"goland\":{\"prebuilds\":{\"version\":\"stable\"}}},\"_origin\":\"repo\",\"_featureFlags\":[]}",
  "archived": "0",
  "shareable": "0",
  "imageSource": "{\"baseImageResolved\":\"eu.gcr.io/gitpod-core-dev/dev/dev-environment:af-dev-update-image.8\"}",
  "imageNameResolved": "eu.gcr.io/gitpod-dev/workspace-images:7097d5fde6cd08f1131fdc232f920696501d86d6f6a83d5d8774590aeb787baf",
  "_lastModified": "2022-10-19 09:44:12.474817 UTC",
  "deleted": "0",
  "type": "regular",
  "baseImageNameResolved": "eu.gcr.io/gitpod-core-dev/dev/dev-environment@sha256:3dc66ca8903c3270befbbf6e38b2fcee4fd7bd6e0ff71aaa83e79f526f6a64dd",
  "softDeleted": null,
  "pinned": "0",
  "softDeletedTime": "",
  "contentDeletedTime": "",
  "basedOnPrebuildId": "f06a627a-0d4a-4b5c-9f81-7f7b992900b6",
  "basedOnSnapshotId": "",
  "projectId": "ef9d3f23-e5ab-4086-82f4-91813524bc3e",
  "cloneURL": "https://github.com/gitpod-io/gitpod.git"
}]

EDIT: Here is the same parsed "context" as above but in more readable format:

{
  "title": "[server] Don't attribute usage to a team without active billing",
  "repository": {
    "cloneUrl": "https://github.com/gitpod-io/gitpod.git",
    "host": "github.com",
    "name": "gitpod",
    "owner": "gitpod-io",
    "private": false
  },
  "ref": "jx/fix-attribution-again",
  "refType": "branch",
  "revision": "fdc1d3b969fbe186310435832b149dcc45b6798a",
  "nr": 13963,
  "base": {
    "repository": {
      "cloneUrl": "https://github.com/gitpod-io/gitpod.git",
      "host": "github.com",
      "name": "gitpod",
      "owner": "gitpod-io",
      "private": false
    },
    "ref": "main",
    "refType": "branch"
  },
  "normalizedContextURL": "https://github.com/gitpod-io/gitpod/pull/13963",
  "checkoutLocation": "gitpod",
  "snapshotBucketId": "0915f180-d85c-4832-9533-a2f13e4af2eb",
  "prebuildWorkspaceId": "f06a627a-0d4a-4b5c-9f81-7f7b992900b6",
  "wasPrebuilt": true
}
jankeromnes commented 2 years ago

We no longer believe the revert fixed this.

jankeromnes commented 2 years ago

Here is a different way to reproduce the bug:

  1. https://gitpod.io/#https://github.com/gitpod-io/gitpod/blob/4c59bdae5db15a9e439c1264771dac55f67a0db4/README.md
  2. I would expect commit 4c59bdae5db15a9e439c1264771dac55f67a0db4 to be checked out (see context URL), but instead, it is the older commit 1a8f1b6e5ac55697a505a75aefe385021030ca84 that is checked out
jankeromnes commented 2 years ago

Useful debug info for https://github.com/gitpod-io/gitpod/issues/13991#issuecomment-1283992856:

It looks like the very old commit that initially served to build the base prebuild never got reset to a more recent commit (not when building the more recent incremental prebuild, nor when opening the workspace for a more recent commit).

geropl commented 2 years ago

Two more comments:

Given this, we suspect it's either a) a change in content-initializer, or b) caused by the PVC enabled prebuilds.

/vv @kylos101

nVitius commented 2 years ago

Might be related to this code that was added recently: https://github.com/gitpod-io/gitpod/blob/4c6b2246a1892129a938d38d6da21f6a8a24d9c2/components/server/ee/src/workspace/workspace-factory.ts#L375-L385

We're replacing the originalContext, which I think contains the git revision to checkout, with the one from the prebuild. At least that's how I understand it. This makes sense in the context of the original change (#13768), which was to create a workspace with a specific prebuild (you would probably want to check out the codebase as it was during the prebuild too).

There's probably some more checks to add in before deciding to change the context there for workspaces with incremental prebuilds.

kylos101 commented 2 years ago

@geropl we have 100% of the traces enabled for US and EU clusters, can you share the instanceID for a workspace where you sent a branch, but the workspace still opened on main?

Also, I just tried opening this workspace, and got the branch associated with the PR, not main: https://kylos101-faascli-qptn5bvl7k9.ws-us72.gitpod.io/

geropl commented 2 years ago

we have 100% of the traces enabled for US and EU clusters

Ah, nice! From the example @jankeromnes mentioned above:

Can you share the links to said traces? It's not clear where the (potentially) wrong context has been sent; either on this workspace or the prebuild base, or the incremental prebuild.

geropl commented 2 years ago

@nVitius This is should be unrelated to the issue you filed (#14017), as that code is guarded by OpenPrebuildContext.is, and should only be triggered if you manually open a workspace from the UI using one of those buttons (which is not the case here).

kylos101 commented 2 years ago

@geropl you can see the trace here, which includes the entire startWorkspace request that was sent. :rocket:

edit: the trace has a parent and a child, the parent's details contain what you're looking for, underneath the logs section there's a request object.

geropl commented 2 years ago

Awesome. And it confirms that the initializer looks properly configured (as the DB already suggested):

        "initializer": {
            "prebuild": {
                "git": [
                    {
                        "checkoutLocation": "gitpod",
                        "cloneTaget": "4c59bdae5db15a9e439c1264771dac55f67a0db4",
                        "config": {
                            "authPassword": "[redacted]",
                            "authUser": "oauth2",
                            "authentication": "BASIC_AUTH"
                        },
                        "remoteUri": "https://github.com/gitpod-io/gitpod.git",
                        "targetMode": "REMOTE_COMMIT"
                    }
                ],
                "prebuild": {
                    "fromVolumeSnapshot": true,
                    "snapshot": "44160888-6c54-405e-b1e4-0215494935ae"
                }
            }
        },
stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.