Intelli sense not working in visual studio code and webstorm for function "requestReviewers"

[florian30491]

Hey :)

I'm new to typescript programming and writing actions on GitHub with octokit.

I wanted to adjust a GitHub Action from GitHub to work with GitHub Enterprise server. Therefore, I created a fork and adjusted the instantiation of the octokit client. Due to this change I had to adjust the function for adding reviewers to a pull request. Unfortunately the intelli sense of this function is not working, but the function is working inside the GitHub Action, see image below.

The code snippet of the function can be found here:

https://github.com/florian30491/create-pull-request/blob/077ac2ff73029f6a18ba0a56d08cb0461a8cba8b/src/index.ts#L16-L21

I hope you can answer me this question.

Best Regards,
Florian

[gr2m]

I've no insights on what @actions/github is using, it might be out of date.

Due to this change I had to adjust the function for adding reviewers to a pull request. Unfortunately the intelli sense of this function is not working, but the function is working inside the GitHub Action, see image below.

what exactly is not working that worked before?

[florian30491]

Hi @gr2m ,

in @actions/github the following package dependencies are accessed:

The version 6.14.2 for @octokit/types is not that old, from the 1st of May.

what exactly is not working that worked before?

I had to change the function from octokit.pulls.createReviewRequest to octokit.rest.pulls.requestReviewers. This must be done according to a change in the API of octokit.

[gr2m]

octokit.pulls.createReviewRequest() has been renamed to octokit.pulls.requestReviewers() in June 2020, as part of @octokit/type v5.0.0, see octokit/plugin-rest-endpoint-methods.js#135

Can you please create a reproducible test case with @octokit modules, not @actions/github? Otherwise I'm not able to help you

[florian30491]

Based on your proposal, I have created an example code for this issue.

https://github.com/florian30491/OctokitTypeScriptTest/blob/main/index.ts

When starting the intelli sense for the function requestReviewers in line 22 the code completion is not working. For other functions the code completion is working, see image below.

https://github.com/florian30491/OctokitTypeScriptTest/blob/f104d8e41ee7fba2143f38c3866e5ab97ae87010/index.ts#L22

Hope this can clarify my problem.

Thank you.

[gr2m]

Thanks a lot for the repository, I am able to reproduce the problem that way

It seems that the types work correctly when you use the octokit.request method directly

octokit.request(
  "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
  {
    owner: "octocat",
    repo: "hello-world",
    pull_number: 42,
    reviewers: ["reviewers"],
  }
);

octokit.rest.pulls.requestReviewers() is just an alias for the method above, so the types for the parameters should be exactly the same. You can import parameters types for an endpoint like this

import { Endpoints } from "@octokit/types";
type Parmeters = Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["parameters"];

That also works correctly.

The problem must be with the mapping of the parameter types for the route and the .pulls.requestReviewers() method in https://github.com/octokit/plugin-rest-endpoint-methods.js/.

I'm looking into it

[gr2m]

The problem seems to be the Partial<{ [key: string]: any; }>s in https://github.com/octokit/openapi-types.ts/blob/2a159ffd67600917b18b5ea6d357bc6d7ff13756/src/generated/types.ts

    "pulls/request-reviewers": {
        parameters: {
            path: {
                owner: components["parameters"]["owner"];
                repo: components["parameters"]["repo"];
                pull_number: components["parameters"]["pull-number"];
            };
        };
        responses: {
            /** Response */
            201: {
                content: {
                    "application/json": components["schemas"]["pull-request-simple"];
                };
            };
            403: components["responses"]["forbidden"];
            /** Unprocessable Entity if user is not a collaborator */
            422: unknown;
        };
        requestBody: {
            content: {
                "application/json": (Partial<{
                    [key: string]: any;
                }> & Partial<{
                    [key: string]: any;
                }>) & {
                    /** An array of user `login`s that will be requested. */
                    reviewers?: string[];
                    /** An array of team `slug`s that will be requested. */
                    team_reviewers?: string[];
                };
            };
        };
    }

I see a few of these weird Partial<{ [key: string]: any; }> in https://github.com/octokit/openapi-types.ts. Might be a problem with https://github.com/drwpow/openapi-typescript (which we use to transpile GitHub's OpenAPI spec to TypeScript), or with GitHub's OpenAPI spec itself.

Update

The JSON schema is rather complicate for this endpoints requestBody schema

              "schema": {
                "type": "object",
                "properties": {
                  "reviewers": {
                    "type": "array",
                    "description": "An array of user `login`s that will be requested.",
                    "items": { "type": "string" }
                  },
                  "team_reviewers": {
                    "type": "array",
                    "description": "An array of team `slug`s that will be requested.",
                    "items": { "type": "string" }
                  }
                },
                "anyOf": [
                  { "required": ["reviewers"] },
                  { "required": ["team_reviewers"] }
                ]
              },

I'm pretty sure that https://github.com/drwpow/openapi-typescript doesn't handle the schema.anyOf key very well.

Update

openapi-ts/openapi-typescript#642

Quite the rabbit hole, I'll keep you posted