You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by "abeizn (via GitHub)" <gi...@apache.org> on 2024/01/11 09:13:02 UTC
[PR] feat: add filter jql checker [incubator-devlake]
abeizn opened a new pull request, #6789:
URL: https://github.com/apache/incubator-devlake/pull/6789
### Summary
feat: add filter jql checker
### Does this close any open issues?
Closes #6765
### Screenshots
1. first run:
2. collect data(not first):
3. full sync（jql !=nil）
4. full sync（jql ==nil）
5. re-trans:
6. update JQL after last run:
7. update JQL and full sync:
8. update JQL when running:
### Other Information
Any other information that is important to this PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] feat: add filter jql checker [incubator-devlake]
Posted by "d4x1 (via GitHub)" <gi...@apache.org>.
d4x1 commented on code in PR #6789:
URL: https://github.com/apache/incubator-devlake/pull/6789#discussion_r1449806247
##########
backend/plugins/jira/tasks/board_filter_begin_collector.go:
##########
@@ -0,0 +1,222 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package tasks
+
+import (
+ "fmt"
+
+ "github.com/apache/incubator-devlake/core/dal"
+ "github.com/apache/incubator-devlake/core/errors"
+ "github.com/apache/incubator-devlake/core/plugin"
+ helper "github.com/apache/incubator-devlake/helpers/pluginhelper/api"
+ "github.com/apache/incubator-devlake/plugins/jira/models"
+)
+
+var CollectBoardFilterBeginMeta = plugin.SubTaskMeta{
+ Name: "collectBoardFilterBegin",
+ EntryPoint: CollectBoardFilterBegin,
+ EnabledByDefault: true,
+ Description: "Jira board filter jql checker before runnig",
Review Comment:
I think it's a typo. `runnig`
##########
backend/plugins/jira/tasks/board_filter_end_collector.go:
##########
@@ -0,0 +1,72 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package tasks
+
+import (
+ "fmt"
+
+ "github.com/apache/incubator-devlake/core/dal"
+ "github.com/apache/incubator-devlake/core/errors"
+ "github.com/apache/incubator-devlake/core/plugin"
+ "github.com/apache/incubator-devlake/plugins/jira/models"
+)
+
+var CollectBoardFilterEndMeta = plugin.SubTaskMeta{
+ Name: "collectBoardFilterEnd",
+ EntryPoint: CollectBoardFilterEnd,
+ EnabledByDefault: true,
+ Description: "Jira board filter jql checker after runnig",
Review Comment:
Same as above.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] feat: add filter jql checker [incubator-devlake]
Posted by "klesh (via GitHub)" <gi...@apache.org>.
klesh commented on code in PR #6789:
URL: https://github.com/apache/incubator-devlake/pull/6789#discussion_r1449697370
##########
backend/plugins/jira/tasks/board_filter_begin_collector.go:
##########
@@ -0,0 +1,211 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package tasks
+
+import (
+ "fmt"
+
+ "github.com/apache/incubator-devlake/core/dal"
+ "github.com/apache/incubator-devlake/core/errors"
+ "github.com/apache/incubator-devlake/core/plugin"
+ helper "github.com/apache/incubator-devlake/helpers/pluginhelper/api"
+ "github.com/apache/incubator-devlake/plugins/jira/models"
+)
+
+var CollectBoardFilterBeginMeta = plugin.SubTaskMeta{
+ Name: "collectBoardFilterBegin",
+ EntryPoint: CollectBoardFilterBegin,
+ EnabledByDefault: true,
+ Description: "Jira board filter jql checker before runnig",
+ DomainTypes: plugin.DOMAIN_TYPES,
+}
+
+func CollectBoardFilterBegin(taskCtx plugin.SubTaskContext) errors.Error {
+ data := taskCtx.GetData().(*JiraTaskData)
+ logger := taskCtx.GetLogger()
+ db := taskCtx.GetDal()
+ logger.Info("collect board in collectBoardFilterBegin: %d", data.Options.BoardId)
+
+ // get board filter id
+ url := fmt.Sprintf("agile/1.0/board/%d/configuration", data.Options.BoardId)
+ boardConfiguration, err := data.ApiClient.Get(url, nil, nil)
+ if err != nil {
+ return err
+ }
+ bc := &BoardConfiguration{}
+ err = helper.UnmarshalResponse(boardConfiguration, bc)
+ if err != nil {
+ return err
+ }
+ filterId := bc.Filter.ID
+ logger.Info("collect board filter:%s", filterId)
+
+ // get board filter jql
+ url = fmt.Sprintf("api/2/filter/%s", filterId)
+ filterInfo, err := data.ApiClient.Get(url, nil, nil)
+ if err != nil {
+ return err
+ }
+ fi := &FilterInfo{}
+ err = helper.UnmarshalResponse(filterInfo, fi)
+ if err != nil {
+ return err
+ }
+ jql := fi.Jql
+ logger.Info("collect board filter jql:%s", jql)
+
+ var record models.JiraBoard
+ err = db.First(&record, dal.Where("connection_id = ? AND board_id = ? ", data.Options.ConnectionId, data.Options.BoardId))
+ if err != nil {
+ return errors.Default.Wrap(err, fmt.Sprintf("error finding record in _tool_jira_boards table for connection_id:%d board_id:%d", data.Options.ConnectionId, data.Options.BoardId))
+ }
+
+ // full sync
+ syncPolicy := taskCtx.TaskContext().SyncPolicy()
+ if syncPolicy != nil && syncPolicy.FullSync {
+ if record.Jql != jql {
+ record.Jql = jql
+ err = db.Update(&record, dal.Where("connection_id = ? AND board_id = ? ", data.Options.ConnectionId, data.Options.BoardId))
+ if err != nil {
+ return errors.Default.Wrap(err, fmt.Sprintf("error updating record in _tool_jira_boards table for connection_id:%d board_id:%d", data.Options.ConnectionId, data.Options.BoardId))
+ }
+ }
+ return nil
+ }
+ // first run
+ if record.Jql == "" {
+ record.Jql = jql
+ err = db.Update(&record, dal.Where("connection_id = ? AND board_id = ? ", data.Options.ConnectionId, data.Options.BoardId))
+ if err != nil {
+ return errors.Default.Wrap(err, fmt.Sprintf("error updating record in _tool_jira_boards table for connection_id:%d board_id:%d", data.Options.ConnectionId, data.Options.BoardId))
+ }
+ return nil
+ }
+ // no change
+ if record.Jql == jql {
Review Comment:
Not needed
##########
backend/plugins/jira/tasks/board_filter_end_collector.go:
##########
@@ -0,0 +1,84 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package tasks
+
+import (
+ "fmt"
+
+ "github.com/apache/incubator-devlake/core/dal"
+ "github.com/apache/incubator-devlake/core/errors"
+ "github.com/apache/incubator-devlake/core/plugin"
+ helper "github.com/apache/incubator-devlake/helpers/pluginhelper/api"
+ "github.com/apache/incubator-devlake/plugins/jira/models"
+)
+
+var CollectBoardFilterEndMeta = plugin.SubTaskMeta{
+ Name: "collectBoardFilterEnd",
+ EntryPoint: CollectBoardFilterEnd,
+ EnabledByDefault: true,
+ Description: "Jira board filter jql checker after runnig",
+ DomainTypes: plugin.DOMAIN_TYPES,
+}
+
+func CollectBoardFilterEnd(taskCtx plugin.SubTaskContext) errors.Error {
+ data := taskCtx.GetData().(*JiraTaskData)
+ logger := taskCtx.GetLogger()
+ db := taskCtx.GetDal()
+ logger.Info("collect board in collectBoardFilterEnd: %d", data.Options.BoardId)
+
+ // get board filter id
+ url := fmt.Sprintf("agile/1.0/board/%d/configuration", data.Options.BoardId)
+ boardConfiguration, err := data.ApiClient.Get(url, nil, nil)
+ if err != nil {
+ return err
+ }
+ bc := &BoardConfiguration{}
+ err = helper.UnmarshalResponse(boardConfiguration, bc)
+ if err != nil {
+ return err
+ }
+ filterId := bc.Filter.ID
+ logger.Info("collect board filter:%s", filterId)
+
+ // get board filter jql
+ url = fmt.Sprintf("api/2/filter/%s", filterId)
+ filterInfo, err := data.ApiClient.Get(url, nil, nil)
+ if err != nil {
+ return err
+ }
+ fi := &FilterInfo{}
+ err = helper.UnmarshalResponse(filterInfo, fi)
+ if err != nil {
+ return err
+ }
Review Comment:
It would be better to extract them into a new function called `getJqlForBoard(boardId)` and share it with the `CollectBoardFilterBegin`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] feat: add filter jql checker [incubator-devlake]
Posted by "klesh (via GitHub)" <gi...@apache.org>.
klesh merged PR #6789:
URL: https://github.com/apache/incubator-devlake/pull/6789
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org