excaliburhan / node-gitlab-webhook Goto Github PK

View Code? Open in Web Editor NEW

54.0 1.0 8.0 11 KB

Gitlab Webhooks handler based on Node.js. Support multiple handlers.

License: MIT License

JavaScript 100.00%

gitlab-webhook gitlab nodejs

node-gitlab-webhook's People

Contributors

Stargazers

Watchers

Forkers

gopenguin joerobich aidandai ccckblaze rsrajendra ltbyce falxcerebri iq-scm

node-gitlab-webhook's Issues

Missing issue hook in the Typescript definition file

In your Typescript definition file your are exposing the available hooks right here:

node-gitlab-webhook/index.d.ts

Lines 381 to 390 in 84f5777

    
           export interface GitLabHooks { 
        
               on(type: 'push', callback: (event: EventData<PushEvent>) => void): void; 
        
               on(type: 'tag_push', callback: (event: EventData<TagPushEvent>) => void): void; 
        
               on(type: 'note', callback: (event: EventData<NoteEvent>) => void): void; 
        
               on(type: 'merge_request', callback: (event: EventData<MergeRequestEvent>) => void): void; 
        
               on(type: 'wiki_page', callback: (event: EventData<WikiPageEvent>) => void): void; 
        
               on(type: 'pipeline', callback: (event: EventData<PipelineEvent>) => void): void; 
        
               on(type: 'build', callback: (event: EventData<BuildEvent>) => void): void; 
        
               on(type: 'error', callback: (err: Error) => void): void; 
        
           }

Unfortunately though you are missing out on one:

on(type: 'issue', callback: (event: EventData<IssueEvent>) => void): void;

Currently I am not able to create a pull request, so I'd appreciate it if you can do this yourself.

Security issue

I'm a member of the Node.js Foundation Security Working Group and we received a report of a vulnerability in this module.

We tried inviting the author by e-mail but received no response so I'm opening this issue and inviting anyone with commit and npm publish rights to collaborate with us on a fix.

Project id in payload and project object typing issue

In my handler for incoming issues I noticed that event.payload.project.id is typed as id?: number | undefined (line 354):

node-gitlab-webhook/index.d.ts

Lines 339 to 355 in 5e2db48

    
           export interface Project { 
        
               name: string; 
        
               description: string; 
        
               web_url: string; 
        
               avatar_url: string; 
        
               git_ssh_url: string; 
        
               git_http_url: string; 
        
               namespace: string; 
        
               visibility_level: number; 
        
               path_with_namespace: string; 
        
               default_branch: string; 
        
               homepage: string; 
        
               url: string; 
        
               ssh_url: string; 
        
               http_url: string; 
        
               id?: number; 
        
           }

However event.payload.object_attributes.project_id (line 63) is not optional:

node-gitlab-webhook/index.d.ts

Lines 57 to 74 in 5e2db48

    
           export interface IssueAttributes { 
        
               id: number; 
        
               title: string; 
        
               assignee_ids: number[]; 
        
               assignee_id: number; 
        
               author_id: number; 
        
               project_id: number; 
        
               created_at: string; 
        
               updated_at: string; 
        
               position: number; 
        
               branch_name: string; 
        
               description: string; 
        
               milestone_id: number; 
        
               state: string; 
        
               iid: number; 
        
               url: string; 
        
               action: string; 
        
           }

Is that a mistake in your typings or is it actually possible that Gitlab will return undefined for the first id while project_id is not?

excaliburhan / node-gitlab-webhook Goto Github PK

node-gitlab-webhook's People

Contributors

Stargazers

Watchers

Forkers

node-gitlab-webhook's Issues

Missing issue hook in the Typescript definition file

Security issue

Project id in payload and project object typing issue

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	export interface GitLabHooks {
	on(type: 'push', callback: (event: EventData<PushEvent>) => void): void;
	on(type: 'tag_push', callback: (event: EventData<TagPushEvent>) => void): void;
	on(type: 'note', callback: (event: EventData<NoteEvent>) => void): void;
	on(type: 'merge_request', callback: (event: EventData<MergeRequestEvent>) => void): void;
	on(type: 'wiki_page', callback: (event: EventData<WikiPageEvent>) => void): void;
	on(type: 'pipeline', callback: (event: EventData<PipelineEvent>) => void): void;
	on(type: 'build', callback: (event: EventData<BuildEvent>) => void): void;
	on(type: 'error', callback: (err: Error) => void): void;
	}

	export interface Project {
	name: string;
	description: string;
	web_url: string;
	avatar_url: string;
	git_ssh_url: string;
	git_http_url: string;
	namespace: string;
	visibility_level: number;
	path_with_namespace: string;
	default_branch: string;
	homepage: string;
	url: string;
	ssh_url: string;
	http_url: string;
	id?: number;
	}

	export interface IssueAttributes {
	id: number;
	title: string;
	assignee_ids: number[];
	assignee_id: number;
	author_id: number;
	project_id: number;
	created_at: string;
	updated_at: string;
	position: number;
	branch_name: string;
	description: string;
	milestone_id: number;
	state: string;
	iid: number;
	url: string;
	action: string;
	}