fix(workitems): Use `int64` for global work item IDs. (f04e3d08) · Commits · GitLab.org / API / client-go

workitems.go

+10 −19

Original line number	Diff line number	Diff line
		@@ -11,7 +11,7 @@ import (

		type (
		WorkItemsServiceInterface interface {
		GetWorkItemByID(gid any, options ...RequestOptionFunc) (WorkItem, Response, error)
		GetWorkItemByID(gid int64, options ...RequestOptionFunc) (WorkItem, Response, error)
		GetWorkItem(fullPath string, iid int64, options ...RequestOptionFunc) (WorkItem, Response, error)
		ListWorkItems(fullPath string, opt ListWorkItemsOptions, options ...RequestOptionFunc) ([]WorkItem, *Response, error)
		}
		@@ -102,7 +102,7 @@ features {
		// gid is either a string in the form of "gid://gitlab/WorkItem/<ID>", or an integer.
		//
		// GitLab API docs: https://docs.gitlab.com/api/graphql/reference/#queryworkitem
		func (s WorkItemsService) GetWorkItemByID(gid any, options ...RequestOptionFunc) (WorkItem, *Response, error) {
		func (s WorkItemsService) GetWorkItemByID(gid int64, options ...RequestOptionFunc) (WorkItem, *Response, error) {
		q := GraphQLQuery{
		Query: fmt.Sprintf(`
		query ($id: WorkItemID!) {
		@@ -111,18 +111,9 @@ query ($id: WorkItemID!) {
		}
		}
		`, workItemQuery),
		Variables: map[string]any{},
		}

		switch v := gid.(type) {
		case string:
		q.Variables["id"] = v

		case int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64:
		q.Variables["id"] = fmt.Sprintf("gid://gitlab/WorkItem/%d", v)

		default:
		return nil, nil, fmt.Errorf("invalid GID type: %T", gid)
		Variables: map[string]any{
		"id": fmt.Sprintf("gid://gitlab/WorkItem/%d", gid),
		},
		}

		var result struct {

workitems_test.go

+4 −43

Original line number	Diff line number	Diff line
		@@ -143,52 +143,13 @@ func TestGetWorkItemByID(t *testing.T) {

		tests := []struct {
		name string
		gid any
		gid int64
		response io.WriterTo
		want *WorkItem
		wantErr error // Must be a concrete error type!
		}{
		{
		name: "successful response with work item using string GID",
		gid: "gid://gitlab/WorkItem/179785913",
		response: bytes.NewReader(getWorkItemByIDResponse),
		want: &WorkItem{
		ID: 179785913,
		IID: 756,
		Type: "Task",
		State: "OPEN",
		Status: "New",
		Title: "Update Helm charts to use Argo Rollouts for progressive deployments",
		Description: "## Overview\n\nUpdate Runway Helm charts to generate Argo Rollout resources ...",
		CreatedAt: Ptr(time.Date(2026, time.January, 6, 15, 9, 24, 0, time.UTC)),
		UpdatedAt: Ptr(time.Date(2026, time.January, 9, 13, 6, 8, 0, time.UTC)),
		WebURL: "https://gitlab.com/gitlab-com/gl-infra/platform/runway/team/-/work_items/756",
		Author: &BasicUser{
		ID: 5532616,
		Username: "swainaina",
		Name: "Silvester Wainaina",
		State: "active",
		Locked: false,
		CreatedAt: Ptr(time.Date(2020, time.March, 2, 6, 29, 14, 0, time.UTC)),
		AvatarURL: "/uploads/-/system/user/avatar/5532616/avatar.png",
		WebURL: "https://gitlab.com/swainaina",
		},
		Assignees: []*BasicUser{
		{
		ID: 5532616,
		Username: "swainaina",
		Name: "Silvester Wainaina",
		State: "active",
		Locked: false,
		CreatedAt: Ptr(time.Date(2020, time.March, 2, 6, 29, 14, 0, time.UTC)),
		AvatarURL: "/uploads/-/system/user/avatar/5532616/avatar.png",
		WebURL: "https://gitlab.com/swainaina",
		},
		},
		},
		},
		{
		name: "successful response with work item using int64 GID",
		name: "successful response",
		gid: int64(179785913),
		response: bytes.NewReader(getWorkItemByIDResponse),
		want: &WorkItem{
		@@ -227,8 +188,8 @@ func TestGetWorkItemByID(t *testing.T) {
		},
		},
		{
		name: "successful response with zero work item returns not found error",
		gid: "gid://gitlab/WorkItem/999",
		name: "using a work item ID that doesn't exist returns an error",
		gid: 9999,
		response: strings.NewReader(`
		{
		"errors": [