Version 5.0.0 #216

jdalrymple · 2018-10-12T17:21:20Z

Summary

Breaking

Added content as a required parameter for RepositoryFiles
Removed projectId from System Hooks API since it wasn't required
Removed dependency on FS. Now the Projects API takes in two arguments projectId and content as well as an option fileName argument
Changing everything to named exports for simplicity
Switching required initialization argument from 'url' to 'host'
Updated Approvals API support to match https://docs.gitlab.com/ee/api/merge_request_approvals.html
MergeRequest Pipelines require the mergeRequestId
NotificationSettings API edit function now takes one parameter, options
Changing the access level enum property from master to maintainer as per https://gitlab.com/gitlab-org/gitlab-ce/issues/42751
Notes now require a body argument instead of checking the options argument for a body parameter

Bug Fixes

Fix array syntax to 'brackets' #227 (Fix array syntax to 'brackets' #227) Fixing array syntax thanks to Lukas Eipert (https://github.com/leipert) (f9bc34d (f9bc34d))
Fixing Todos support. If todoId was not passed, an undefined value would be introduced into the url (cbeef18 (cbeef18))
ResourceAwardEmojis API wasn't properly filtering based on awardId (70f4315 (70f4315))
Removed xhr library in favour of ky, and switched request for got for a smaller package size and retry functionality

Features

Added the ability to add sudo to specific requests (780244f (780244f))
Added the missing edit function to the Groups API
Added LDAP support to the Groups API

Documentation

Removing xml request docs
Updating imports to be named imports

jdalrymple · 2018-11-11T01:45:37Z

Releasing Rc.1 soon!

jetersen · 2018-11-11T04:16:41Z

lots of conflicts, jikes 😱

jdalrymple · 2018-11-11T04:35:13Z

@Casz Yea, going to do my best to rebase the branch

jetersen · 2018-11-11T16:49:37Z

@jdalrymple build is failing on https://github.com/jdalrymple/node-gitlab/blob/e10ce7541f13ced678e364e2802a77139950a549/src/infrastructure/index.ts#L3 https://travis-ci.org/jdalrymple/node-gitlab/jobs/453496159#L477
I guess you forgot to add Utils file to git 😅

jdalrymple · 2018-11-11T16:53:58Z

lol i definitely messed up some things when rebasing, working on fixing them up now!

src/types.d.ts

jdalrymple · 2018-11-13T02:30:24Z

....it passed :o, time to clean up the git history

jdalrymple · 2018-11-13T02:52:59Z

@Casz Do you mind giving it a look over? I'm sure i missed things. If all goes well, ill push to a rc build on npm within the next day.

jdalrymple · 2018-11-16T01:33:32Z

Published under the next tag

geektheripper · 2018-11-16T05:53:36Z

Awesome，but it seems that you forgot publish dist/index.d.ts

@jdalrymple

jdalrymple · 2018-11-16T06:41:48Z

Oops! Ill fix that now!

jdalrymple · 2018-11-16T07:16:55Z

Should be published now. Not sure if i should have the index.d.ts file in the root or in the dist folder since im not generating it...

geektheripper · 2018-11-16T11:35:18Z

I read some some source code, I think it's not a good idea to use build a bundle for nodejs by rollup, and you should publish declaration files to help typescript users.

The types in package.json is used to target the generated declaration file, not the types you used as global type defination in your project. Readmore

In my view, it's better to remove node build in rollup config, and use tsc to build the node version.

then project will looks like following tree:

├── dist
│   ├── index.browser.js
│   ├── index.d.ts
│   ├── index.es.js
│   ├── index.js
│   ├── infrastructure
│   │   ├── *.js
│   │   └── *.d.ts
│   └── ...
├── package.json
├── rollup.config.js
├── src
│   ├── index.ts
│   ├── infrastructure
│   ├── ...
│   └── types
│       └── index.d.ts
└── ...

BTW, there's some issue in you types file:

https://github.com/jdalrymple/node-gitlab/blob/78108913b7c71ba88f6c81c3249bdcdfcd3be185/index.d.ts#L79

https://github.com/jdalrymple/node-gitlab/blob/78108913b7c71ba88f6c81c3249bdcdfcd3be185/index.d.ts#L112-L118

jdalrymple · 2018-11-16T20:52:28Z

I can easily turn on the declaration file, but only three things get generated. It isnt that helpful lol.

jdalrymple · 2018-11-16T22:10:26Z

Im a little confused, and my research hasnt been very fruitful. Should the generated declaration file (index.d.ts) include all the types ive predefined in the project? And if so, how does one setup up the configuration to do so?

jdalrymple · 2018-11-21T00:53:05Z

@Mr-Wallet Do you see any problems that could arise in terms of the xhr compatibilities ?

Mr-Wallet · 2018-11-21T17:00:31Z

According to ky's docs, it uses the Request API instead of XHR, so that's a no-go.

Skimming the changes (and I emphasize skimming) I don't immediately see any way we could inject XHR ourselves. So we (and potentially other electron apps) are going to be locked out of this version.

I appreciate the esoteric nature of our XHR requirement so I don't mind if all mention of it is scrubbed from the project, but we at least need a way to write a wrapper for XHR that we can plug into this project to make requests, or else we're hosed.

jdalrymple · 2018-11-21T17:29:00Z

Thank you for looking! If thats the case, well have to find another way around it :P Alot of the changes were made to ensure cross compatibility. I asked the question in the ky repo to ensure that conclusion was correct before investigating further.

sindresorhus/ky#62

Mr-Wallet · 2018-11-21T18:28:57Z

They closed the issue stating it's not supported, and based on the project's apparent goals, I think it would be strange to expect them to do so. I feel that the onus is on node-gitlab to be pluggable. I'd like to stress that I'm fine if node-gitlab doesn't support XHR directly, as long as it supports dependency injection where we can provide our own requester which wraps XHR. This basically just means putting one abstraction layer between the requests and got/ky (which I think you already pretty much have, in the form of Request Helper) and then allowing users to provide that implementation as a parameter.

jdalrymple · 2018-11-22T04:09:22Z

😂 I was really hoping on removing that complexity, but i see that really isnt possible. Ill add back that functionality asap!

sebald · 2018-11-26T11:07:46Z

@jdalrymple @geektheripper The problem is the src/infrastructure/Utils.ts/bundler nullifies all type inference. It produces typings like:

export declare const Gitlab: {
    new (options?: any): {
        [serviceName: string]: import("./infrastructure/BaseService").default;
    };
};

In order to get proper typings something like this should be used:

export interface Constructor {
  new (...args: any): any;
}
export type Mapper<T extends { [name: string]: Constructor }, P extends keyof T> = {
  [name in P]: InstanceType<T[P]>
};

export const bundler = <T extends { [name: string]: Constructor }, P extends keyof T>(
  services: T,
) => (options?: any) =>
  Object.entries(services || {}).reduce((bundle, [name, ser]) => {
    bundle[name] = new ser(options);
    return bundle;
  }, {}) as Mapper<T, P>;

I had to not use a class since computed properties are not really supported when using classes :-/

While the above makes the typings work, it changes the API (no classes, new).

Here are the produced typings (npm run build):

import * as APIServices from './services';
export * from './services';
export declare const GroupsBundle: (options?: any) => import("./infrastructure/Utils").Mapper<{
    Groups: typeof APIServices.Groups;
    GroupAccessRequests: typeof APIServices.GroupAccessRequests;
    GroupBadges: typeof APIServices.GroupBadges;
    GroupCustomAttributes: typeof APIServices.GroupCustomAttributes;
    GroupIssueBoards: typeof APIServices.GroupIssueBoards;
    GroupMembers: typeof APIServices.GroupMembers;
    GroupMilestones: typeof APIServices.GroupMilestones;
    GroupProjects: typeof APIServices.GroupProjects;
    GroupVariables: typeof APIServices.GroupVariables;
    Epics: typeof APIServices.Epics;
    EpicIssues: typeof APIServices.EpicIssues;
    EpicNotes: typeof APIServices.EpicNotes;
    EpicDiscussions: typeof APIServices.EpicDiscussions;
}, "Groups" | "GroupAccessRequests" | "GroupBadges" | "GroupCustomAttributes" | "GroupIssueBoards" | "GroupMembers" | "GroupMilestones" | "GroupProjects" | "GroupVariables" | "Epics" | "EpicIssues" | "EpicNotes" | "EpicDiscussions">;
export declare const UsersBundle: (options?: any) => import("./infrastructure/Utils").Mapper<{
    Users: typeof APIServices.Users;
    UserCustomAttributes: typeof APIServices.UserCustomAttributes;
    UserEmails: typeof APIServices.UserEmails;
    UserImpersonationTokens: typeof APIServices.UserImpersonationTokens;
    UserKeys: typeof APIServices.UserKeys;
    UserGPGKeys: typeof APIServices.UserGPGKeys;
}, "Users" | "UserCustomAttributes" | "UserEmails" | "UserImpersonationTokens" | "UserKeys" | "UserGPGKeys">;
export declare const ProjectsBundle: (options?: any) => import("./infrastructure/Utils").Mapper<{
    Branches: typeof APIServices.Branches;
    Commits: typeof APIServices.Commits;
    CommitDiscussions: typeof APIServices.CommitDiscussions;
    DeployKeys: typeof APIServices.DeployKeys;
    Deployments: typeof APIServices.Deployments;
    Environments: typeof APIServices.Environments;
    Issues: typeof APIServices.Issues;
    IssueAwardEmojis: typeof APIServices.IssueAwardEmojis;
    IssueNotes: typeof APIServices.IssueNotes;
    IssueDiscussions: typeof APIServices.IssueDiscussions;
    Jobs: typeof APIServices.Jobs;
    Labels: typeof APIServices.Labels;
    MergeRequests: typeof APIServices.MergeRequests;
    MergeRequestAwardEmojis: typeof APIServices.MergeRequestAwardEmojis;
    MergeRequestDiscussions: typeof APIServices.MergeRequestDiscussions;
    MergeRequestNotes: typeof APIServices.MergeRequestNotes;
    Pipelines: typeof APIServices.Pipelines;
    PipelineSchedules: typeof APIServices.PipelineSchedules;
    PipelineScheduleVariables: typeof APIServices.PipelineScheduleVariables;
    Projects: typeof APIServices.Projects;
    ProjectAccessRequests: typeof APIServices.ProjectAccessRequests;
    ProjectBadges: typeof APIServices.ProjectBadges;
    ProjectCustomAttributes: typeof APIServices.ProjectCustomAttributes;
    ProjectImportExport: typeof APIServices.ProjectImportExport;
    ProjectIssueBoards: typeof APIServices.ProjectIssueBoards;
    ProjectHooks: typeof APIServices.ProjectHooks;
    ProjectMembers: typeof APIServices.ProjectMembers;
    ProjectMilestones: typeof APIServices.ProjectMilestones;
    ProjectSnippets: typeof APIServices.ProjectSnippets;
    ProjectSnippetNotes: typeof APIServices.ProjectSnippetNotes;
    ProjectSnippetDiscussions: typeof APIServices.ProjectSnippetDiscussions;
    ProjectSnippetAwardEmojis: typeof APIServices.ProjectSnippetAwardEmojis;
    ProtectedBranches: typeof APIServices.ProtectedBranches;
    ProjectVariables: typeof APIServices.ProjectVariables;
    Repositories: typeof APIServices.Repositories;
    RepositoryFiles: typeof APIServices.RepositoryFiles;
    Runners: typeof APIServices.Runners;
    Services: typeof APIServices.Services;
    Tags: typeof APIServices.Tags;
    Triggers: typeof APIServices.Triggers;
}, "Branches" | "Commits" | "CommitDiscussions" | "DeployKeys" | "Deployments" | "Environments" | "Issues" | "IssueAwardEmojis" | "IssueNotes" | "IssueDiscussions" | "Jobs" | "Labels" | "MergeRequests" | "MergeRequestAwardEmojis" | "MergeRequestDiscussions" | "MergeRequestNotes" | "Pipelines" | "PipelineSchedules" | "PipelineScheduleVariables" | "Projects" | "ProjectAccessRequests" | "ProjectBadges" | "ProjectCustomAttributes" | "ProjectImportExport" | "ProjectIssueBoards" | "ProjectHooks" | "ProjectMembers" | "ProjectMilestones" | "ProjectSnippets" | "ProjectSnippetNotes" | "ProjectSnippetDiscussions" | "ProjectSnippetAwardEmojis" | "ProtectedBranches" | "ProjectVariables" | "Repositories" | "RepositoryFiles" | "Runners" | "Services" | "Tags" | "Triggers">;
export declare const Gitlab: (options?: any) => import("./infrastructure/Utils").Mapper<typeof APIServices, "Groups" | "GroupAccessRequests" | "GroupBadges" | "GroupCustomAttributes" | "GroupIssueBoards" | "GroupMembers" | "GroupMilestones" | "GroupProjects" | "GroupVariables" | "Epics" | "EpicIssues" | "EpicNotes" | "EpicDiscussions" | "Users" | "UserCustomAttributes" | "UserEmails" | "UserImpersonationTokens" | "UserKeys" | "UserGPGKeys" | "Branches" | "Commits" | "CommitDiscussions" | "DeployKeys" | "Deployments" | "Environments" | "Issues" | "IssueAwardEmojis" | "IssueNotes" | "IssueDiscussions" | "Jobs" | "Labels" | "MergeRequests" | "MergeRequestAwardEmojis" | "MergeRequestDiscussions" | "MergeRequestNotes" | "Pipelines" | "PipelineSchedules" | "PipelineScheduleVariables" | "Projects" | "ProjectAccessRequests" | "ProjectBadges" | "ProjectCustomAttributes" | "ProjectImportExport" | "ProjectIssueBoards" | "ProjectHooks" | "ProjectMembers" | "ProjectMilestones" | "ProjectSnippets" | "ProjectSnippetNotes" | "ProjectSnippetDiscussions" | "ProjectSnippetAwardEmojis" | "ProtectedBranches" | "ProjectVariables" | "Repositories" | "RepositoryFiles" | "Runners" | "Services" | "Tags" | "Triggers" | "Todos" | "PushRule" | "ApplicationSettings" | "BroadcastMessages" | "Events" | "FeatureFlags" | "GeoNodes" | "GitignoreTemplates" | "GitLabCIYMLTemplates" | "Keys" | "Licence" | "LicenceTemplates" | "Lint" | "Namespaces" | "NotificationSettings" | "Markdown" | "PagesDomains" | "Search" | "SidekiqMetrics" | "Snippets" | "SystemHooks" | "Version" | "Wikis">;

TypeScript can not produce flat typings (yet) so the dist folder will have subfolders with the .d.ts in it.

PS: Of course it would be nice to replace (options: any) with (options: BaseServiceOptions & {[name:string]: any}) to have at least some basic intellisense ;)

sebald · 2018-11-26T11:28:06Z

Also the @typings can not be resolved in projects that use node-gitlab :-/

jdalrymple · 2018-11-26T15:53:28Z

@sebald Thanks! Ill look into fixing these up some more this week. I definitely still learning how to use these typing correctly 😆

Mr-Wallet · 2019-05-21T20:45:55Z

Why would a user ever want to make sure that this package hid the pagination info? Wouldn't it help discoverability of the pagination system to always include it?

jdalrymple · 2019-05-21T20:47:37Z

It's an extra level of complexity. For example without that option, you get back an array of the data or the object itself. With this option is deeper in the object tree, which is annoying

Also if we were always returning all results ( like now) the pagination info was less important

Mr-Wallet · 2019-05-21T20:53:46Z

Good point. I guess this is a more subjective design decision of how much you want to abstract it. I would say, it would be better to abstract it completely and fetch all pages, than to only fetch one page and hide from the programmer that there may be more pages unless they read the docs on this package very carefully.

I would prefer to always nest the response and put the pagination info front and center, because any abstraction over pagination is destined to be a leaky one, and my personal opinion is that a very leaky abstraction is more dangerous than no abstraction; but if it's a given that you're going to hide pagination info by default, then it's better to go ahead and fetch all of the pages before resolving.

…possibility of multiple results feat: Adding the option to camelize response body

test: Adding tests to cover the maxPages option properly

…te url error

…es were not being set properly in the previously allotted time

Fixing #313 - AutoCamelizing of response keys

jetersen · 2019-05-25T18:00:00Z

@jdalrymple hint you can turn off the LGTM comments 😆

src/infrastructure/KyRequester.ts

jdalrymple · 2019-05-25T18:09:26Z

Anything else stand out as an impediment to officially releasing?

jetersen · 2019-05-25T18:15:23Z

Oh, it looks like you managed to do two LGTM integrations 😆

jdalrymple · 2019-05-25T18:27:36Z

The github app is supposed to replace the web application :P

jdalrymple · 2019-05-25T18:29:14Z

The tests keep failing intermittently because the gitlab instance isnt fully started in the allocated time -_-

jdalrymple · 2019-05-25T18:48:25Z

@Casz Do you think were good for an official release?

jetersen · 2019-05-25T18:53:06Z

I think so, I haven't had a chance to test in our bot 😅
Too many dependencies updated and haven't had the time to maintain the bot 😰

jdalrymple · 2019-05-25T19:21:30Z

🎉 This PR is included in version 5.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

jdalrymple added this to the 5.0.0 milestone Oct 12, 2018

jdalrymple changed the title ~~Next major release~~ Version 5.0.0 Nov 11, 2018

jdalrymple force-pushed the next branch from 8b53d0a to 12b269d Compare November 11, 2018 05:19

jdalrymple force-pushed the next branch 2 times, most recently from 48fdbc5 to 981f472 Compare November 12, 2018 16:39

jetersen reviewed Nov 12, 2018

View reviewed changes

src/types.d.ts Outdated Show resolved Hide resolved

jdalrymple force-pushed the next branch from 9e632bc to d140abc Compare November 13, 2018 02:39

jdalrymple force-pushed the next branch from d1f8dae to 9f1c50a Compare November 19, 2018 15:26

jdalrymple force-pushed the next branch from c47174f to 396c71c Compare May 21, 2019 20:00

jdalrymple added 3 commits May 21, 2019 19:20

Merge branch '312-fixing-global-recursiveness' into next

745cc19

fix: Removing the camelizeKeys function on the response body

7a4b477

fix: Fixing up pagination logic to only be present when their is the …

96f448b

…possibility of multiple results feat: Adding the option to camelize response body

jdalrymple force-pushed the next branch from 59d666a to 745cc19 Compare May 23, 2019 16:24

jdalrymple and others added 9 commits May 23, 2019 13:43

test: Adding tests to cover the new camelize option

26bf4e9

test: Adding tests to cover the maxPages option properly

Adding try catch around request function to narrow down recent absolu…

a42d559

…te url error

Extending the wait time to 45 seconds because the environment variabl…

2c5b73e

…es were not being set properly in the previously allotted time

Adding to sleep inside the travis script

9f951ef

Merge pull request #317 from jdalrymple/313-fixing-camelizekeys

f49ad9c

Fixing #313 - AutoCamelizing of response keys

chore: bump version

ef36379

fix: Fixing request for recursive repository trees #266

6cc5bd9

chore: releasing 5.0.0-rc.17

e10eab2

Linting

7841702

jetersen reviewed May 25, 2019

View reviewed changes

src/infrastructure/KyRequester.ts Outdated Show resolved Hide resolved

Removing useless conditional

6c73dd0

Repository owner deleted a comment from lgtm-com bot May 25, 2019

jdalrymple merged commit aa31353 into master May 25, 2019

jdalrymple added the released label May 25, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Version 5.0.0 #216

Version 5.0.0 #216

jdalrymple commented Oct 12, 2018 •

edited

Loading

jdalrymple commented Nov 11, 2018

jetersen commented Nov 11, 2018

jdalrymple commented Nov 11, 2018

jetersen commented Nov 11, 2018 •

edited

Loading

jdalrymple commented Nov 11, 2018

jdalrymple commented Nov 13, 2018

jdalrymple commented Nov 13, 2018

jdalrymple commented Nov 16, 2018

geektheripper commented Nov 16, 2018 •

edited

Loading

jdalrymple commented Nov 16, 2018

jdalrymple commented Nov 16, 2018

geektheripper commented Nov 16, 2018

jdalrymple commented Nov 16, 2018

jdalrymple commented Nov 16, 2018

jdalrymple commented Nov 21, 2018

Mr-Wallet commented Nov 21, 2018

jdalrymple commented Nov 21, 2018

Mr-Wallet commented Nov 21, 2018 •

edited

Loading

jdalrymple commented Nov 22, 2018

sebald commented Nov 26, 2018 •

edited

Loading

sebald commented Nov 26, 2018

jdalrymple commented Nov 26, 2018 •

edited

Loading

Mr-Wallet commented May 21, 2019

jdalrymple commented May 21, 2019 •

edited

Loading

Mr-Wallet commented May 21, 2019

jetersen commented May 25, 2019

jdalrymple commented May 25, 2019

jetersen commented May 25, 2019

jdalrymple commented May 25, 2019

jdalrymple commented May 25, 2019

jdalrymple commented May 25, 2019

jetersen commented May 25, 2019

jdalrymple commented May 25, 2019 •

edited

Loading

Version 5.0.0 #216

Version 5.0.0 #216

Conversation

jdalrymple commented Oct 12, 2018 • edited Loading

Summary

Breaking

Bug Fixes

Features

Documentation

jdalrymple commented Nov 11, 2018

jetersen commented Nov 11, 2018

jdalrymple commented Nov 11, 2018

jetersen commented Nov 11, 2018 • edited Loading

jdalrymple commented Nov 11, 2018

jdalrymple commented Nov 13, 2018

jdalrymple commented Nov 13, 2018

jdalrymple commented Nov 16, 2018

geektheripper commented Nov 16, 2018 • edited Loading

jdalrymple commented Nov 16, 2018

jdalrymple commented Nov 16, 2018

geektheripper commented Nov 16, 2018

jdalrymple commented Nov 16, 2018

jdalrymple commented Nov 16, 2018

jdalrymple commented Nov 21, 2018

Mr-Wallet commented Nov 21, 2018

jdalrymple commented Nov 21, 2018

Mr-Wallet commented Nov 21, 2018 • edited Loading

jdalrymple commented Nov 22, 2018

sebald commented Nov 26, 2018 • edited Loading

sebald commented Nov 26, 2018

jdalrymple commented Nov 26, 2018 • edited Loading

Mr-Wallet commented May 21, 2019

jdalrymple commented May 21, 2019 • edited Loading

Mr-Wallet commented May 21, 2019

jetersen commented May 25, 2019

jdalrymple commented May 25, 2019

jetersen commented May 25, 2019

jdalrymple commented May 25, 2019

jdalrymple commented May 25, 2019

jdalrymple commented May 25, 2019

jetersen commented May 25, 2019

jdalrymple commented May 25, 2019 • edited Loading

jdalrymple commented Oct 12, 2018 •

edited

Loading

jetersen commented Nov 11, 2018 •

edited

Loading

geektheripper commented Nov 16, 2018 •

edited

Loading

Mr-Wallet commented Nov 21, 2018 •

edited

Loading

sebald commented Nov 26, 2018 •

edited

Loading

jdalrymple commented Nov 26, 2018 •

edited

Loading

jdalrymple commented May 21, 2019 •

edited

Loading

jdalrymple commented May 25, 2019 •

edited

Loading