GraphQL unable to resolve Global Id Ruleset #60620

kmason-extron · 2023-07-11T17:26:48Z

kmason-extron
Jul 11, 2023

Select Topic Area

Bug

Body

I want to be able to add bypass actors via their Global Ids in updateRepositoryRuleset or createRepositoryRuleset but get the following message

"Could not resolve to a node with the global id of 'T_xxxxxxxxxxxxxxxxx'." I obfuscated our Id.

I have no problems with the other recent changes for using org admins, repository roles etc only when specifying actorIds

If I update them in the UI and query the ruleset then the returned info is correct and shows them but using graphql to set them does not.

Mutation

mutation UpdateRepoRule(
    $ruleId: ID!, 
    $name: String!, 
    $enforcement: RuleEnforcement!, 
    $target: RepositoryRulesetTarget!, 
    $include: [String!]!, 
    $type: RepositoryRuleType!, 
    $parameters: RuleParametersInput!,
    $bypass: [RepositoryRulesetBypassActorInput!]
  ) {
  updateRepositoryRuleset(
    input: {
        repositoryRulesetId: $ruleId, 
        name: $name, 
        enforcement: $enforcement, 
        target: $target,
        bypassActors: $bypass,
        conditions: {
            refName: {
                exclude: [],
                include: $include
            }
        },
        rules: [
            {
                type: $type,
                parameters: $parameters
            }
        ]
    }
  ) {
    ruleset {
      id,
      databaseId 
    }
  }
}

Variables

{
  "ruleId": "RRS_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "target": "BRANCH",
  "include": [
    "~DEFAULT_BRANCH",
    "refs/heads/hotfix.*",
    "refs/heads/dvt.*"
  ],
  "enforcement": "ACTIVE",
  "bypass": [
    {
      "bypassMode": "ALWAYS",
      "repositoryRoleDatabaseId": 5
    },
    {
      "bypassMode": "ALWAYS",
      "organizationAdmin": true
    },
    {
      "bypassMode": "ALWAYS",
      "actorId": "T_xxxxxxxxxxxxxxxxxxx"
    }
  ],
  "type": "REQUIRED_STATUS_CHECKS",
  "name": "PR Status Checks",
  "parameters": {
    "requiredStatusChecks": {
      "strictRequiredStatusChecksPolicy": true,
      "requiredStatusChecks": []
    }
  }
}

Full Response

{
  "data": {
    "updateRepositoryRuleset": null
  },
  "errors": [
    {
      "type": "NOT_FOUND",
      "path": [
        "updateRepositoryRuleset"
      ],
      "locations": [
        {
          "line": 11,
          "column": 3
        }
      ],
      "message": "Could not resolve to a node with the global id of 'T_xxxxxxxxxxxxxxxxx'."
    }
  ]
}

Query after manual update in UI

{
  "data": {
    "repository": {
      "rulesets": {
        "nodes": [
          {
            "name": "PR Status Checks",
            "bypassActors": {
              "nodes": [
                {
                  "repositoryRoleName": "admin",
                  "repositoryRoleDatabaseId": 5,
                  "organizationAdmin": false,
                  "actor": null,
                  "bypassMode": "ALWAYS"
                },
                {
                  "repositoryRoleName": null,
                  "repositoryRoleDatabaseId": null,
                  "organizationAdmin": false,
                  "actor": {
                    "id": "T_xxxxxxxxxxxxxxxxxx",
                    "name": "Control Software Engineering Platform"
                  },
                  "bypassMode": "ALWAYS"
                },
                {
                  "repositoryRoleName": null,
                  "repositoryRoleDatabaseId": null,
                  "organizationAdmin": false,
                  "actor": {
                    "id": "T_xxxxxxxxxxxxxxxxxx",
                    "name": "Control Software Engineering Leads"
                  },
                  "bypassMode": "ALWAYS"
                },
                {
                  "repositoryRoleName": null,
                  "repositoryRoleDatabaseId": null,
                  "organizationAdmin": true,
                  "actor": null,
                  "bypassMode": "ALWAYS"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

kmason-extron · 2023-07-12T16:24:46Z

kmason-extron
Jul 12, 2023
Author

It does appear that the REST endpoint works (substitution of databaseId for the string in graph)

0 replies

patrick-knight · 2023-07-17T15:16:13Z

patrick-knight
Jul 17, 2023
Collaborator

Thanks for the info @kmason-extron just to confirm we're looking into this.

3 replies

kmason-extron Jul 17, 2023
Author

Thanks. Let me know if you need more testing from me. So far only the rulesets I've found has this issue. Everywhere else is using the int or string versions just fine.

kmason-extron Aug 1, 2023
Author

@patrick-knight with the GA notice has this been resolved?

patrick-knight Aug 7, 2023
Collaborator

Hey @kmason-extron sorry for the delayed response I was out of the office for a bit.

Looking back at notes with the team we're having trouble replicating the same behavior. Would you mind opening a support case so you can share more details about the org, repo, actor, etc. so we can investigate more in depth?

Thanks!

rfossicav · 2023-12-05T02:03:04Z

rfossicav
Dec 5, 2023

Greetings Team, any updates on this? I'm having a similar issue with createRepositoryRuleset, but the issue seems to be against the required sourceId field. I've tried with the legacy id and with the X-Github-Next-Global-ID id the curl spit out. Or maybe Maybe I'm not understanding the syntax / usage here?

the call:

mutation {
  createRepositoryRuleset(input: 
    {
      sourceId: "U_*********"
      name: "branch rule test 001"
      enforcement: ACTIVE
      target: BRANCH
      conditions: {
        repositoryName: {
          include: ["real-repo-name-here"]
          exclude: []
        }
      }
      rules: {
      type:CREATION
      parameters: {
        branchNamePattern: {
          pattern: "*001test*"
          operator: "equals"
        }
      }
    }
      bypassActors: [
        {
        bypassMode: ALWAYS
        organizationAdmin: true
      	}
      ]
    }) 
    {
    clientMutationId
    } 
  }

The response to my mutation:

{
  "data": {
    "createRepositoryRuleset": null
  },
  "errors": [
    {
      "type": "NOT_FOUND",
      "path": [
        "createRepositoryRuleset"
      ],
      "locations": [
        {
          "line": 2,
          "column": 3
        }
      ],
      "message": "Could not resolve to RuleSource node with the global id of 'U_***********'."
    }
  ]
}

2 replies

jschnapper Dec 6, 2023

Hey @rfossicav, I think there may be some confusion on what id to provide as an input. The sourceId accepts the global node id for the source (a repository or organization) of a ruleset. More info on global node ids here: https://docs.github.com/en/graphql/guides/using-global-node-ids

It looks like you're making an organization level ruleset, so you'll want to get the global node id of the organization and provide it as the input.

Also, a few other notes:

The rules field takes an array of rule inputs, which you can see from the CreateRepositoryRulesetInput documentation: https://docs.github.com/en/graphql/reference/input-objects#createrepositoryrulesetinput
The CREATION rule does not have a parameters field, which can be seen from its omission from the RuleParametersInput: https://docs.github.com/en/graphql/reference/input-objects#ruleparametersinput. However, I think the it's most clear to see what rules have parameters by looking at the REST API docs: https://docs.github.com/en/rest/repos/rules?apiVersion=2022-11-28#create-a-repository-ruleset
Instead of adding branchNamePattern to the CREATION rule, you likely want to add a refName field to your conditions: https://docs.github.com/en/graphql/reference/input-objects#repositoryruleconditionsinput.

For example

      conditions: {
        repositoryName: {
          include: ["real-repo-name-here"]
          exclude: []
        }
        refName: {
          include: ["*001test*"]
        }
      }
      rules: [
        {
            type: CREATION
        }
      ]
    }

rfossicav Dec 8, 2023

@jschnapper Thanks so much! This helped me a lot... It helped me wrap my brain around the parameters and where they actually belonged.

My final call for posterity:

mutation {
  createRepositoryRuleset(input: 
    {
      sourceId: "<<repo_node_id_here>>" # must use repo node_id
      name: "Restrict Honey Branch Usage" # your ruleset name
      enforcement: ACTIVE
      target: BRANCH
      conditions: {
        refName: {
          include: ["refs/heads/*honey*"] # keep refs/heads/ portion
          exclude: []
        }
      }
      rules: [
        {
          type:CREATION 
        },
        {
          type:NON_FAST_FORWARD
        },
        {
          type:DELETION
        },
        {
          type:PULL_REQUEST 
            parameters: {
                pullRequest: {
                    requiredApprovingReviewCount: 2
                    requireCodeOwnerReview: true
                    dismissStaleReviewsOnPush: false
                    requireLastPushApproval: false
                    requiredReviewThreadResolution: false
                }
            }
        }
      ]
  	}) 
  {
    clientMutationId
  } 
}

Next, I will work on improving my calls and using variables. Thank you again!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

GraphQL unable to resolve Global Id Ruleset #60620

{{title}}

Replies: 3 comments 6 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

Select a reply

GitHub Community

GraphQL unable to resolve Global Id Ruleset #60620

kmason-extron Jul 11, 2023

Select Topic Area

Body

Mutation

Variables

Full Response

Query after manual update in UI

Replies: 3 comments · 6 replies

kmason-extron Jul 12, 2023 Author

patrick-knight Jul 17, 2023 Collaborator

kmason-extron Jul 17, 2023 Author

kmason-extron Aug 1, 2023 Author

patrick-knight Aug 7, 2023 Collaborator

rfossicav Dec 5, 2023

jschnapper Dec 6, 2023

rfossicav Dec 8, 2023

kmason-extron
Jul 11, 2023

Replies: 3 comments 6 replies

kmason-extron
Jul 12, 2023
Author

patrick-knight
Jul 17, 2023
Collaborator

kmason-extron Jul 17, 2023
Author

kmason-extron Aug 1, 2023
Author

patrick-knight Aug 7, 2023
Collaborator

rfossicav
Dec 5, 2023