Archival & Deprecation Roadmap

[denopink]

This ticket will outline a general roadmap for archiving & deprecating webpa-common. Xmidt libraries depending on webpa-common will tagged in this ticket.

Affected Xmidt Repos

• themis
  • Upgrade Dependencies Containing Deprecated webpa-common themis#108
  • Denopink/refactoring/archive webpa common/logging themis#124
• argus
  • Remove Deprecated webpa-common argus#280
• bascule
  • Remove go-kit/kit/log & go-kit/log bascule#163
    • Enable & Fix Linter bascule#149
    • Remove go-kit/kit/log & go-kit/log bascule#148
    • Move to zap logger bascule#103
• sallust
  • Migrate Useful webpa-common/logging Utilities sallust#39
    • Remove go-kit/kit/log & go-kit/log sallust#38
    • Migrate Useful webpa-common/logging Utilities sallust#37
    • Enable & Fix Linter sallust#36
• scytale
  • Remove Deprecated webpa-common scytale#195
    • Remove webpa-common/logging & webpa-common/bascule* & go-kit/log & go-kit/kit/log scytale#203
      • Remove go-kit/kit/log & go-kit/log scytale#199
      • Logging: Update To Use Uber Zap & Sallust scytale#186
      • Replace webpa-common/bascule* with bascule scytale#210
• caduceator
  • Remove Deprecated webpa-common caduceator#56
• caduceus
  • Remove Deprecated webpa-common caduceus#347
• talaria
  • Remove Deprecated webpa-common talaria#261
    • Add Bascule Helper Package talaria#314
    • Logging: Update To Use Uber Zap & Sallust talaria#253
• wrp-go
  • Remove Deprecated webpa-common wrp-go#104
• tr1d1um
  • Remove Deprecated webpa-common tr1d1um#304
    • Remove webpa-common/logging & webpa-common/bascule* & go-kit/log & go-kit/kit/log tr1d1um#324
      • Replace webpa-common/bascule* with bascule tr1d1um#326
• heimdall
  • Remove Deprecated webpa-common heimdall#58
• go-parodus
  • Remove Deprecated webpa-common go-parodus#26
• hecate
  • Remove Deprecated webpa-common hecate#56
• svalinn
  • Remove Deprecated webpa-common svalinn#172
• gungnir
  • Remove Deprecated webpa-common gungnir#146
• codex-db
  • Remove Deprecated webpa-common codex-db#52
• wrp-listener
  • Remove Deprecated webpa-common wrp-listener#65
• kratos
  • Remove Deprecated webpa-common kratos#45
• ancla
  • Remove Deprecated webpa-common ancla#119
• mimisbrunnr
  • Remove Deprecated webpa-common mimisbrunnr#93
• glaukos
  • Remove Deprecated webpa-common glaukos#107
• petasos
  • Remove Deprecated webpa-common petasos#110
• voynicrpyto
  • Remove Deprecated webpa-common voynicrypto#38
• codex-deploy
  • Remove Deprecated webpa-common codex-deploy#127

Archival Order

• logging* related work, replace with webpa-common/logging & go-kit/log & go-kit/kit/log withhttps://github.com/uber-go/zap
  • bascule
    • Remove go-kit/kit/log & go-kit/log bascule#150
      • Enable & Fix Linter bascule#149
      • Remove go-kit/kit/log & go-kit/log bascule#148
      • Move to zap logger bascule#103
  • scytale
    • Remove webpa-common/logging & webpa-common/bascule* & go-kit/log & go-kit/kit/log scytale#203
      • Remove go-kit/kit/log & go-kit/log scytale#199
      • Logging: Update To Use Uber Zap & Sallust scytale#186

Packages ready to be replaced

• https://github.com/uber-go/fx will replace
  • secure*
  • service*
• https://github.com/uber-go/zap will replace
  • logging*

Where packages are used

• device*
  • scytale
  • tr1d1um
  • petasos
  • talaria
  • caduceus
  • kratos
• bascule* REMOVED
• bookkeeping REMOVED
• capacitor REMOVED
• clock REMOVED
• concurrent
  • scytale
  • tr1d1um
  • petasos
  • talaria
  • caduceus
  • caduceator
  • heimdall
  • svalinn
  • gungnir
• convey*
  • talaria
• event
  • talaria
• hash REMOVED
• health
  • used internally by device*
• logging* REMOVED & Migrated to sallust
  • scytale
  • tr1d1um
  • petasos
  • talaria
  • caduceus
  • caduceator
  • heimdall
  • hecate
  • go-parodus
  • svalinn
  • gungnir
  • codex-db
  • wrp-listener
  • kratos
  • ancla
  • mimisbrunnr
  • voynicrpto
• middleware REMOVED
• secured REMOVED
• resource REMOVED
• semaphore
  • caduceus
  • heimdall
  • svalinn
  • codex-db
  • kratos
  • mimisbrunnr
  • glaukos
• server
  • scytale
  • petasos
  • caduceus
  • caduceator
  • heimdall
  • svalinn
  • gungnir
• service* package can be deleted when things move to uber/fx
  • scytale
  • tr1d1um
  • petasos
  • talaria
  • caduceus
• tracing*
  • wrp-go
  • used internally by http/fanout
• webhook*
  • scytale
  • hecate
• xhttp*
  • scytale
  • tr1d1um
  • petasos
  • talaria
  • caduceus
  • heimdall
  • mimisbrunnr
• xlistener*
  • used internally by server
• xmetrics replaced with touchstone
  • scytale
  • tr1d1um
  • talaria
  • caduceus
  • caduceator
  • heimdall
  • hecate
  • svalinn
  • gungnir
  • codex-db
  • wrp-listener
  • ancla
• xresolver*
  • talaria
• xviper*
  • used internally by service/servicecfg
• transport REMOVED
• monitor
  • scytale
  • petasos
  • talaria
  • used internally by http* & xresolver & device*

Packages that need to be moved

• bascule* to https://github.com/xmidt-org/bascule

[denopink]

Addressing the deprecation of github.com/xmidt-org/webpa-common/v2/logging/* in affected servers/libs first, updating ticket body with info

[denopink]

as mentioned above, we're going forward with replacing both webpa-common/logging and go-kit/logging with zap

[denopink]

reverting service/consul & service/servicecfg packages back to using gokit log because of gokitzk.NewRegistrar