Skip to content

Update GitLab REST client library #18523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 28, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/server/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
"@authzed/authzed-node": "^0.12.1",
"@bufbuild/connect": "^0.8.1",
"@bufbuild/connect-express": "^0.8.1",
"@gitbeaker/node": "^35.7.0",
"@gitbeaker/rest": "^39.12.0",
"@gitpod/content-service": "0.1.5",
"@gitpod/gitpod-db": "0.1.5",
"@gitpod/gitpod-protocol": "0.1.5",
Expand Down
25 changes: 12 additions & 13 deletions components/server/src/gitlab/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import { injectable, inject } from "inversify";
import { User } from "@gitpod/gitpod-protocol";

import { Gitlab } from "@gitbeaker/node";
import { Gitlab } from "@gitbeaker/rest";
import {
Projects,
Users,
Expand All @@ -19,10 +19,11 @@ import {
MergeRequests,
Issues,
RepositoryFiles,
NamespaceSchema,
UserSchema,
ExpandedUserSchema,
ProjectSchema,
} from "@gitbeaker/core";
import { ProjectExtendedSchema } from "@gitbeaker/core/dist/types/resources/Projects";
import { NamespaceSchema } from "@gitbeaker/core/dist/types/resources/Namespaces";
import { UserExtendedSchema, UserSchema } from "@gitbeaker/core/dist/types/resources/Users";
import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
import { GitLabScope } from "./scopes";
import { AuthProviderParams } from "../auth/auth-provider";
Expand Down Expand Up @@ -90,9 +91,7 @@ export class GitLabApi {
path: string,
): Promise<string | undefined> {
const projectId = `${org}/${name}`;
const result = await this.run<string>(user, (api) =>
api.RepositoryFiles.showRaw(projectId, path, { ref: commitish }),
);
const result = await this.run<string>(user, (api) => api.RepositoryFiles.showRaw(projectId, path, commitish));
if (GitLab.ApiError.is(result)) {
return undefined; // e.g. 404 error, because the file isn't found
}
Expand Down Expand Up @@ -137,7 +136,7 @@ export namespace GitLab {
/**
* https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/projects.md#get-single-project
*/
export interface Project extends ProjectExtendedSchema {
export interface Project extends ProjectSchema {
visibility: "public" | "private" | "internal";
archived: boolean;
path: string; // "diaspora-project-site"
Expand Down Expand Up @@ -227,7 +226,7 @@ export namespace GitLab {
merge_requests_count: number;
}
// https://docs.gitlab.com/ee/api/users.html#list-current-user-for-normal-users
export interface User extends UserExtendedSchema {
export interface User extends ExpandedUserSchema {
email: string;
state: "active" | string;
}
Expand Down Expand Up @@ -256,19 +255,19 @@ export namespace GitLab {
export namespace Permissions {
export function hasWriteAccess(repo: Project): boolean {
if (repo.permissions.project_access) {
return repo.permissions.project_access.access_level >= 30;
return (repo.permissions.project_access as unknown as { access_level: number }).access_level >= 30;
}
if (repo.permissions.group_access) {
return repo.permissions.group_access.access_level >= 30;
return (repo.permissions.group_access as unknown as { access_level: number }).access_level >= 30;
}
return false;
}
export function hasMaintainerAccess(repo: Project): boolean {
if (repo.permissions.project_access) {
return repo.permissions.project_access.access_level >= 40;
return (repo.permissions.project_access as unknown as { access_level: number }).access_level >= 40;
}
if (repo.permissions.group_access) {
return repo.permissions.group_access.access_level >= 40;
return (repo.permissions.group_access as unknown as { access_level: number }).access_level >= 40;
}
return false;
}
Expand Down
2 changes: 1 addition & 1 deletion components/server/src/gitlab/file-provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export class GitlabFileProvider implements FileProvider {
path: string,
): Promise<string> {
const result = await this.gitlabApi.run<GitLab.Commit[]>(user, async (g) => {
return g.Commits.all(`${repository.owner}/${repository.name}`, { path, ref_name: revisionOrBranch });
return g.Commits.all(`${repository.owner}/${repository.name}`, { path, refName: revisionOrBranch });
});

if (GitLab.ApiError.is(result)) {
Expand Down
4 changes: 2 additions & 2 deletions components/server/src/gitlab/gitlab-app-support.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

import { AuthProviderInfo, ProviderRepository, User } from "@gitpod/gitpod-protocol";
import { inject, injectable } from "inversify";
import { Gitlab } from "@gitbeaker/node";
import { Gitlab } from "@gitbeaker/rest";
import { GitLab } from "./api";
import { TokenProvider } from "../user/token-provider";

Expand Down Expand Up @@ -36,7 +36,7 @@ export class GitLabAppSupport {
// also cf. https://docs.gitlab.com/ee/api/members.html#valid-access-levels
//
const projectsWithAccess = await api.Projects.all({
min_access_level: "40",
minAccessLevel: 40,
perPage: 100,
});
for (const project of projectsWithAccess) {
Expand Down
2 changes: 1 addition & 1 deletion components/server/src/gitlab/gitlab-auth-provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export class GitLabAuthProvider extends GenericAuthProvider {
host: this.baseURL,
});
const getCurrentUser = async () => {
const response = await api.Users.current();
const response = await api.Users.showCurrentUser();
return response as unknown as GitLab.User;
};
const unconfirmedUserMessage = "Please confirm your GitLab account and try again.";
Expand Down
4 changes: 2 additions & 2 deletions components/server/src/gitlab/gitlab-context-parser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ export class GitlabContextParser extends AbstractContextParser implements IConte
}

const result = await this.gitlabApi.run<GitLab.TreeObject[]>(user, async (g) => {
return g.Repositories.tree(`${owner}/${repoName}`, {
return g.Repositories.allRepositoryTrees(`${owner}/${repoName}`, {
ref: branchOrTag.name,
path: path.dirname(branchOrTag.fullPath),
});
Expand Down Expand Up @@ -421,7 +421,7 @@ export class GitlabContextParser extends AbstractContextParser implements IConte
): Promise<IssueContext> {
const ctxPromise = this.handleDefaultContext(user, host, owner, repoName);
const result = await this.gitlabApi.run<GitLab.Issue>(user, async (g) => {
return g.Issues.show(`${owner}/${repoName}`, nr);
return g.Issues.show(nr, { projectId: `${owner}/${repoName}` });
});
if (GitLab.ApiError.is(result)) {
throw await NotFoundError.create(await this.tokenHelper.getCurrentToken(user), user, host, owner, repoName);
Expand Down
5 changes: 2 additions & 3 deletions components/server/src/gitlab/gitlab-file-provider.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,8 @@ class TestFileProvider {
const project = await api.run<GitLab.Project>(this.user, (g) =>
g.Projects.create({
name: `test_project_${i}`,
path: `test_project_${i}`,
namespace_id: 57982169,
initialize_with_readme: true,
namespaceId: 57982169,
initializeWithReadme: true,
description: "generated project to test pagination",
}),
);
Expand Down
4 changes: 2 additions & 2 deletions components/server/src/gitlab/gitlab-repository-provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@ export class GitlabRepositoryProvider implements RepositoryProvider {
const projectId = `${owner}/${repo}`;
const result = await this.gitlab.run<GitLab.Commit[]>(user, async (g) => {
return g.Commits.all(projectId, {
ref_name: ref,
per_page: maxDepth,
refName: ref,
perPage: maxDepth,
page: 1,
});
});
Expand Down
4 changes: 1 addition & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,9 @@
"workspaces": {
"packages": [
"components/*",
"components/ee/*",
"components/*/typescript",
"components/*/typescript-*",
"components/supervisor/frontend",
"charts/"
"components/supervisor/frontend"
]
}
}
125 changes: 33 additions & 92 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2190,37 +2190,30 @@
resolved "https://registry.yarnpkg.com/@eslint/js/-/js-8.47.0.tgz#5478fdf443ff8158f9de171c704ae45308696c7d"
integrity sha512-P6omY1zv5MItm93kLM8s2vr1HICJH8v0dvddDhysbIuZ+vcjOHg5Zbkf1mTkcmi2JA9oBG2anOkRnW8WJTS8Og==

"@gitbeaker/core@^35.7.0":
version "35.7.0"
resolved "https://registry.yarnpkg.com/@gitbeaker/core/-/core-35.7.0.tgz#426e426dff597c1d094bf1fe66fb1109980e816d"
integrity sha512-1N9QcHElYa1NuLhX9mJJ6tnL7wbCsK8Naj2kLXwNC4qyEcDhMiJDnI3YoqNIXSzPTufoNUAbgIsc/h/JmO17/A==
"@gitbeaker/core@^39.12.0":
version "39.12.0"
resolved "https://registry.yarnpkg.com/@gitbeaker/core/-/core-39.12.0.tgz#89a83bb44ae5abf38ab0cd831351ac7ca8f367bf"
integrity sha512-c/LQl+UI+rXjXx+P+kLrdTOZnyD/RdhRWnkuBE8b8/dwfvnJ3ANEv1WBZhVJpTwn6miHlurERiOeLmKeQJ+J6w==
dependencies:
"@gitbeaker/requester-utils" "^35.7.0"
form-data "^4.0.0"
li "^1.3.0"
mime "^3.0.0"
query-string "^7.0.0"
"@gitbeaker/requester-utils" "^39.12.0"
qs "^6.11.2"
xcase "^2.0.1"

"@gitbeaker/node@^35.7.0":
version "35.7.0"
resolved "https://registry.yarnpkg.com/@gitbeaker/node/-/node-35.7.0.tgz#ba4ece7aff388132bdcab8d6fb08c8d063a70e7d"
integrity sha512-zh215EUloAxj2gwTHevBVypEiiwQR0WsFLGPWJwY+yUFJVQRcya+3mcsDbxgCLAk00wwhrTVYyNppvmoYbEZNg==
"@gitbeaker/requester-utils@^39.12.0":
version "39.12.0"
resolved "https://registry.yarnpkg.com/@gitbeaker/requester-utils/-/requester-utils-39.12.0.tgz#e71919dc236df411d59a974e37e4684436ffab13"
integrity sha512-0016Xnt6xIO3kSUuJ/mcXyN8LWUMpqAmLFbXZWMzJ9YZpQHX9vPKsrFHz4/P9Dh9eWKoAnkjEXEf/F6w1gX6Dg==
dependencies:
"@gitbeaker/core" "^35.7.0"
"@gitbeaker/requester-utils" "^35.7.0"
delay "^5.0.0"
got "^11.8.3"
qs "^6.11.2"
xcase "^2.0.1"

"@gitbeaker/requester-utils@^35.7.0":
version "35.7.0"
resolved "https://registry.yarnpkg.com/@gitbeaker/requester-utils/-/requester-utils-35.7.0.tgz#7c1ded70a10ac890322f22488ffea8a3a41ccc79"
integrity sha512-SDYKhL+XUrslpVwUumkCf4I4Ubf+lvzdghCYPwBt/og5kZIorFVbHCxRmtr5bO+iC9nrVNfg24sdoe51vDGn1w==
"@gitbeaker/rest@^39.12.0":
version "39.12.0"
resolved "https://registry.yarnpkg.com/@gitbeaker/rest/-/rest-39.12.0.tgz#3579267804deb78be3dee911b8f11ad481b9a804"
integrity sha512-PILr042hCuB/A/QE7IGQ0ADTMN1e8lvehEfZEQEp78aWlqyNFmi6IUZqL6q8v3Stu6WRKSRcMCOidY83hiCSsA==
dependencies:
form-data "^4.0.0"
qs "^6.10.1"
xcase "^2.0.1"
"@gitbeaker/core" "^39.12.0"
"@gitbeaker/requester-utils" "^39.12.0"

"@grpc/[email protected]", "@grpc/grpc-js@^1.8.3":
version "1.8.8"
Expand Down Expand Up @@ -3123,11 +3116,6 @@
resolved "https://registry.npmjs.org/@sindresorhus/is/-/is-0.14.0.tgz"
integrity sha512-9NET910DNaIPngYnLLPeg+Ogzqsi9uM4mSboU5y6p8S5DzMTVEsJZrawi+BoDNUVBa2DhJqQYUFvMDfgU062LQ==

"@sindresorhus/is@^4.0.0":
version "4.2.0"
resolved "https://registry.npmjs.org/@sindresorhus/is/-/is-4.2.0.tgz"
integrity sha512-VkE3KLBmJwcCaVARtQpfuKcKv8gcBmUubrfHGF84dXuuW6jgsRYxPtzcIhPyK9WAPpRt2/xY6zkD9MnRaJzSyw==

"@sinonjs/commons@^1.7.0":
version "1.8.3"
resolved "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz"
Expand Down Expand Up @@ -3525,16 +3513,6 @@
resolved "https://registry.npmjs.org/@types/btoa-lite/-/btoa-lite-1.0.0.tgz"
integrity sha512-wJsiX1tosQ+J5+bY5LrSahHxr2wT+uME5UDwdN1kg4frt40euqA+wzECkmq4t5QbveHiJepfdThgQrPw6KiSlg==

"@types/cacheable-request@^6.0.1":
version "6.0.2"
resolved "https://registry.npmjs.org/@types/cacheable-request/-/cacheable-request-6.0.2.tgz"
integrity sha512-B3xVo+dlKM6nnKTcmm5ZtY/OL8bOAOd2Olee9M1zft65ox50OzjEHW91sDiU9j6cvW8Ejg1/Qkf4xd2kugApUA==
dependencies:
"@types/http-cache-semantics" "*"
"@types/keyv" "*"
"@types/node" "*"
"@types/responselike" "*"

"@types/chai-subset@^1.3.3":
version "1.3.3"
resolved "https://registry.npmjs.org/@types/chai-subset/-/chai-subset-1.3.3.tgz"
Expand Down Expand Up @@ -3864,13 +3842,6 @@
dependencies:
"@types/node" "*"

"@types/keyv@*":
version "3.1.3"
resolved "https://registry.npmjs.org/@types/keyv/-/keyv-3.1.3.tgz"
integrity sha512-FXCJgyyN3ivVgRoml4h94G/p3kY+u/B86La+QptcqJaWtBWtmc6TtkNfS40n9bIvyLteHh7zXOtgbobORKPbDg==
dependencies:
"@types/node" "*"

"@types/lodash.debounce@^4.0.6":
version "4.0.6"
resolved "https://registry.npmjs.org/@types/lodash.debounce/-/lodash.debounce-4.0.6.tgz"
Expand Down Expand Up @@ -5616,19 +5587,6 @@ cacheable-request@^6.0.0:
normalize-url "^4.1.0"
responselike "^1.0.2"

cacheable-request@^7.0.2:
version "7.0.2"
resolved "https://registry.npmjs.org/cacheable-request/-/cacheable-request-7.0.2.tgz"
integrity sha512-pouW8/FmiPQbuGpkXQ9BAPv/Mo5xDGANgSNXzTzJ8DrKGuXOssM4wIQRjfanNRh3Yu5cfYPvcorqbhg2KIJtew==
dependencies:
clone-response "^1.0.2"
get-stream "^5.1.0"
http-cache-semantics "^4.0.0"
keyv "^4.0.0"
lowercase-keys "^2.0.0"
normalize-url "^6.0.1"
responselike "^2.0.0"

call-bind@^1.0.0, call-bind@^1.0.2:
version "1.0.2"
resolved "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz"
Expand Down Expand Up @@ -6683,13 +6641,6 @@ decompress-response@^3.3.0:
dependencies:
mimic-response "^1.0.0"

decompress-response@^6.0.0:
version "6.0.0"
resolved "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz"
integrity sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==
dependencies:
mimic-response "^3.1.0"

dedent@^0.7.0:
version "0.7.0"
resolved "https://registry.npmjs.org/dedent/-/dedent-0.7.0.tgz"
Expand Down Expand Up @@ -6783,11 +6734,6 @@ define-properties@^1.1.4, define-properties@^1.2.0:
has-property-descriptors "^1.0.0"
object-keys "^1.1.1"

delay@^5.0.0:
version "5.0.0"
resolved "https://registry.yarnpkg.com/delay/-/delay-5.0.0.tgz#137045ef1b96e5071060dd5be60bf9334436bd1d"
integrity sha512-ReEBKkIfe4ya47wlPYf/gu5ib6yUG0/Aez0JQZQz94kiWtRQvZIQbTiehsnwHvLSWJnQdhVeqYue7Id1dKr0qw==

delayed-stream@~1.0.0:
version "1.0.0"
resolved "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz"
Expand Down Expand Up @@ -8186,6 +8132,13 @@ form-data@^4.0.0:
combined-stream "^1.0.8"
mime-types "^2.1.12"

formdata-polyfill@^4.0.10:
version "4.0.10"
resolved "https://registry.yarnpkg.com/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz#24807c31c9d402e002ab3d8c720144ceb8848423"
integrity sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==
dependencies:
fetch-blob "^3.1.2"

formidable@^1.2.0:
version "1.2.6"
resolved "https://registry.npmjs.org/formidable/-/formidable-1.2.6.tgz"
Expand Down Expand Up @@ -10497,11 +10450,6 @@ levn@~0.3.0:
prelude-ls "~1.1.2"
type-check "~0.3.2"

li@^1.3.0:
version "1.3.0"
resolved "https://registry.npmjs.org/li/-/li-1.3.0.tgz"
integrity sha1-IsWbyu+qmo7zWc91l4TkvxBq6hs=

libphonenumber-js-utils@^8.10.5:
version "8.10.5"
resolved "https://registry.yarnpkg.com/libphonenumber-js-utils/-/libphonenumber-js-utils-8.10.5.tgz#778cb7633c94e2524f08c3109a7450095b4e6727"
Expand Down Expand Up @@ -10902,11 +10850,6 @@ mimic-response@^1.0.0, mimic-response@^1.0.1:
resolved "https://registry.npmjs.org/mimic-response/-/mimic-response-1.0.1.tgz"
integrity sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ==

mimic-response@^3.1.0:
version "3.1.0"
resolved "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz"
integrity sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==

min-indent@^1.0.0:
version "1.0.1"
resolved "https://registry.npmjs.org/min-indent/-/min-indent-1.0.1.tgz"
Expand Down Expand Up @@ -12751,17 +12694,10 @@ [email protected]:
resolved "https://registry.npmjs.org/qs/-/qs-6.9.7.tgz"
integrity sha512-IhMFgUmuNpyRfxA90umL7ByLlgRXu6tIfKPpF5TmcfRLlLCckfP/g3IQmju6jjpu+Hh8rA+2p6A27ZSPOOHdKw==

qs@^6.10.1, qs@^6.11.0, qs@^6.9.4:
version "6.11.0"
resolved "https://registry.yarnpkg.com/qs/-/qs-6.11.0.tgz#fd0d963446f7a65e1367e01abd85429453f0c37a"
integrity sha512-MvjoMCJwEarSbUYk5O+nmoSzSutSsTwF85zcHPQ9OrlFoZOYIjaqBAJIqIXjptyD5vThxGq52Xu/MaJzRkIk4Q==
dependencies:
side-channel "^1.0.4"

qs@^6.10.3:
version "6.10.3"
resolved "https://registry.npmjs.org/qs/-/qs-6.10.3.tgz"
integrity sha512-wr7M2E0OFRfIfJZjKGieI8lBKb7fRCH4Fv5KNPEs7gJ8jadvotdsS08PzOKR7opXhZ/Xkjtt3WF9g38drmyRqQ==
qs@^6.10.3, qs@^6.11.0, qs@^6.11.2, qs@^6.9.4:
version "6.11.2"
resolved "https://registry.yarnpkg.com/qs/-/qs-6.11.2.tgz#64bea51f12c1f5da1bc01496f48ffcff7c69d7d9"
integrity sha512-tDNIz22aBzCDxLtVH++VnTfzxlfeK5CbqohpSqpJgj1Wg/cQbStNAz3NuqCs5vV+pjBsK4x4pN9HlVh7rcYRiA==
dependencies:
side-channel "^1.0.4"

Expand Down Expand Up @@ -15534,6 +15470,11 @@ weak-map@^1.0.5:
resolved "https://registry.yarnpkg.com/weak-map/-/weak-map-1.0.8.tgz#394c18a9e8262e790544ed8b55c6a4ddad1cb1a3"
integrity sha512-lNR9aAefbGPpHO7AEnY0hCFjz1eTkWCXYvkTRrTHs9qv8zJp+SkVYpzfLIFXQQiG3tVvbNFQgVg2bQS8YGgxyw==

web-streams-polyfill@^3.0.3, web-streams-polyfill@^3.1.1:
version "3.2.1"
resolved "https://registry.yarnpkg.com/web-streams-polyfill/-/web-streams-polyfill-3.2.1.tgz#71c2718c52b45fd49dbeee88634b3a60ceab42a6"
integrity sha512-e0MO3wdXWKrLbL0DgGnUV7WHVuw9OUvL4hjgnPkIeEvESk74gAITi5G606JtZPp39cd8HA9VQzCIvA49LpPN5Q==

web-vitals@^1.1.1:
version "1.1.2"
resolved "https://registry.npmjs.org/web-vitals/-/web-vitals-1.1.2.tgz"
Expand Down