Refactoring and Code Documentation

[ljay79]

• Entire code requires some review and enhancement of code documentation.

• move all jira field functionalities (mapping, parsing, converting,..) into its own .gs file and maybe even into a nice class

• refactor field parsing and mapping functionalities; review performance; redundant code; ... -- extended field data with flag indicating compatibility to update data back to Jira

• rename functions and classes to be GAS private: trailing "_" underscore (https://developers.google.com/apps-script/guides/html/communication#private_functions)

• create unified api response handler; error messages are handled everywhere almost the same way or different in each call - should be centralized and unified Sample:

  var error = function (respData, httpResp, status) {
  var jiraErrorMessage = "";
  if (respData != null && respData.errorMessages != null) {
    jiraErrorMessage = respData.errorMessages.join(",") || respData.errorMessages;
  }
  var msg = "Failed to retrieve Jira Fields info with status [" + status + "]!\\n" + jiraErrorMessage;
  ...

• to many individual single functions, most of them would make sense to combine into classes; more OO approach needed -- BTW: i started with transactional style too and then shifted over to OO style

• change log level of (regular) JQL syntax errors; do show to user as error but do not log as error to StackDriver (flooding logs):

  Error: [400] - "Error in JQL Query: Expecting either a value, list or function but got 'AND'. You must surround 'AND' in quotation marks to use it as a value. (line 1, character 147)" - JQL: IssueType in ('Feature Story') AND Status CHANGED FROM 'In Verification' TO 'Release Pending' DURING ('2018-09-03 00:00', '2018-09-09 23:59') BY AND Status in ('Release Pending', 'Released') at JST_getTotalForSearchResult(customFunctions:75)

[paul-lemon]

All valid stuff - too big to tackle in one issue though! :)

[paul-lemon]

Ok if I close this now we have agreed standards? @ljay79

[ljay79]

Pls keep open, as it also serves as a note for myself. Not everything of my above notes has been acomplished yet.