Maintenance mode for storage operators

distributor-node/CHANGELOG.md

@@ -1,6 +1,7 @@
-### 2.1.2
+### 2.2.0
 
-- Bump @joystream/types to Petra version
+- Updates `operator:set-metadata` CLI command to set distributor-node's operational status along with other metadata.
+- Adds `leader:set-node-operational-status` CLI command to set operational status of any distributor-node by Lead.
 
 ### 2.1.1
 

distributor-node/docs/commands/leader.md

@@ -12,6 +12,7 @@ Commands for performing Distribution Working Group leader on-chain duties (like
 * [`joystream-distributor leader:remove-bucket-operator`](#joystream-distributor-leaderremove-bucket-operator)
 * [`joystream-distributor leader:set-bucket-family-metadata`](#joystream-distributor-leaderset-bucket-family-metadata)
 * [`joystream-distributor leader:set-buckets-per-bag-limit`](#joystream-distributor-leaderset-buckets-per-bag-limit)
+* [`joystream-distributor leader:set-node-operational-status`](#joystream-distributor-leaderset-node-operational-status)
 * [`joystream-distributor leader:update-bag`](#joystream-distributor-leaderupdate-bag)
 * [`joystream-distributor leader:update-bucket-mode`](#joystream-distributor-leaderupdate-bucket-mode)
 * [`joystream-distributor leader:update-bucket-status`](#joystream-distributor-leaderupdate-bucket-status)
@@ -210,6 +211,33 @@ OPTIONS
 
 _See code: [src/commands/leader/set-buckets-per-bag-limit.ts](https://github.com/Joystream/joystream/blob/master/src/commands/leader/set-buckets-per-bag-limit.ts)_
 
+## `joystream-distributor leader:set-node-operational-status`
+
+Set/update distribution node operational status. Requires distribution working group leader permissions.
+
+```
+USAGE
+  $ joystream-distributor leader:set-node-operational-status
+
+OPTIONS
+  -B, --bucketId=bucketId                                                   (required) Distribution bucket ID in
+                                                                            {familyId}:{bucketIndex} format.
+
+  -c, --configPath=configPath                                               [default: ./config.yml] Path to config
+                                                                            JSON/YAML file (relative to current working
+                                                                            directory)
+
+  -o, --operationalStatus=(Normal|NoService|NoServiceFrom|NoServiceDuring)  Operational status of the operator
+
+  -w, --workerId=workerId                                                   (required) ID of the operator (distribution
+                                                                            group worker)
+
+  -y, --yes                                                                 Answer "yes" to any prompt, skipping any
+                                                                            manual confirmations
+```
+
+_See code: [src/commands/leader/set-node-operational-status.ts](https://github.com/Joystream/joystream/blob/master/src/commands/leader/set-node-operational-status.ts)_
+
 ## `joystream-distributor leader:update-bag`
 
 Add/remove distribution buckets from a bag.

distributor-node/docs/commands/operator.md

@@ -39,18 +39,24 @@ USAGE
   $ joystream-distributor operator:set-metadata
 
 OPTIONS
-  -B, --bucketId=bucketId      (required) Distribution bucket ID in {familyId}:{bucketIndex} format.
+  -B, --bucketId=bucketId                                                   (required) Distribution bucket ID in
+                                                                            {familyId}:{bucketIndex} format.
 
-  -c, --configPath=configPath  [default: ./config.yml] Path to config JSON/YAML file (relative to current working
-                               directory)
+  -c, --configPath=configPath                                               [default: ./config.yml] Path to config
+                                                                            JSON/YAML file (relative to current working
+                                                                            directory)
 
-  -e, --endpoint=endpoint      Root distribution node endpoint
+  -e, --endpoint=endpoint                                                   Root distribution node endpoint
 
-  -i, --input=input            Path to JSON metadata file
+  -i, --input=input                                                         Path to JSON metadata file
 
-  -w, --workerId=workerId      (required) ID of the operator (distribution group worker)
+  -o, --operationalStatus=(Normal|NoService|NoServiceFrom|NoServiceDuring)  Operational status of the operator
 
-  -y, --yes                    Answer "yes" to any prompt, skipping any manual confirmations
+  -w, --workerId=workerId                                                   (required) ID of the operator (distribution
+                                                                            group worker)
+
+  -y, --yes                                                                 Answer "yes" to any prompt, skipping any
+                                                                            manual confirmations
 
 DESCRIPTION
   Requires active distribution bucket operator worker role key.

distributor-node/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@joystream/distributor-cli",
   "description": "Joystream distributor node CLI",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "author": "Joystream contributors",
   "bin": {
     "joystream-distributor": "./bin/run"
@@ -34,6 +34,7 @@
     "graphql": "^15.3.0",
     "graphql-tag": "^2.12.6",
     "inquirer": "^8.1.2",
+    "inquirer-datepicker": "2.0.2",
     "js-image-generator": "^1.0.3",
     "jsonwebtoken": "^8.5.1",
     "lodash": "^4.17.21",

distributor-node/src/@types/inquirer-datepicker/index.d.ts

@@ -0,0 +1 @@
+declare module 'inquirer-datepicker'

distributor-node/src/command-base/default.ts

@@ -1,12 +1,13 @@
 import Command, { flags as oclifFlags } from '@oclif/command'
-import inquirer from 'inquirer'
-import ExitCodes from './ExitCodes'
-import { ReadonlyConfig } from '../types/config'
-import { ConfigParserService } from '../services/parsers/ConfigParserService'
-import { LoggingService } from '../services/logging'
+import inquirer, { DistinctQuestion } from 'inquirer'
+import inquirerDatepicker from 'inquirer-datepicker'
 import { Logger } from 'winston'
+import { LoggingService } from '../services/logging'
 import { BagIdParserService } from '../services/parsers/BagIdParserService'
 import { BucketIdParserService } from '../services/parsers/BucketIdParserService'
+import { ConfigParserService } from '../services/parsers/ConfigParserService'
+import { ReadonlyConfig } from '../types/config'
+import ExitCodes from './ExitCodes'
 
 export const flags = {
   ...oclifFlags,
@@ -75,6 +76,7 @@ export default abstract class DefaultCommandBase extends Command {
     this.logging = LoggingService.withCLIConfig()
     this.logger = this.logging.createLogger('CLI')
     this.autoConfirm = !!(process.env.AUTO_CONFIRM === 'true' || parseInt(process.env.AUTO_CONFIRM || '') || yes)
+    inquirer.registerPrompt('datepicker', inquirerDatepicker)
   }
 
   public log(message: string, ...meta: unknown[]): void {
@@ -98,6 +100,21 @@ export default abstract class DefaultCommandBase extends Command {
     }
   }
 
+  async datePrompt(question: DistinctQuestion): Promise<Date> {
+    const { result } = await inquirer.prompt([
+      {
+        ...question,
+        type: 'datepicker',
+        name: 'result',
+        clearable: true,
+        default: new Date().toISOString(),
+      },
+    ])
+
+    const date = new Date(result)
+    return date
+  }
+
   async finally(err: unknown): Promise<void> {
     if (!err) this.exit(ExitCodes.OK)
     if (process.env.DEBUG === 'true') {

distributor-node/src/commands/leader/set-node-operational-status.ts

@@ -0,0 +1,93 @@
+import {
+  INodeOperationalStatus,
+  ISetNodeOperationalStatus,
+  NodeOperationalStatus,
+  SetNodeOperationalStatus,
+} from '@joystream/metadata-protobuf'
+import AccountsCommandBase from '../../command-base/accounts'
+import DefaultCommandBase, { flags } from '../../command-base/default'
+
+export default class LeadSetNodeOperationalStatus extends AccountsCommandBase {
+  static description = `Set/update distribution node operational status. Requires distribution working group leader permissions.`
+
+  static flags = {
+    bucketId: flags.bucketId({
+      required: true,
+    }),
+    workerId: flags.integer({
+      char: 'w',
+      description: 'ID of the operator (distribution group worker)',
+      required: true,
+    }),
+    operationalStatus: flags.enum<Exclude<NodeOperationalStatus['nodeOperationalStatus'], undefined>>({
+      char: 'o',
+      options: ['normal', 'noService', 'noServiceFrom', 'noServiceUntil'],
+      required: true,
+      description: 'Operational status of the operator',
+    }),
+    rationale: flags.string({
+      char: 'r',
+      description: 'Rationale for setting the operational status',
+    }),
+    ...DefaultCommandBase.flags,
+  }
+
+  async run(): Promise<void> {
+    const {
+      bucketId,
+      workerId,
+      rationale,
+      operationalStatus: statusType,
+    } = this.parse(LeadSetNodeOperationalStatus).flags
+    const leadKey = await this.getDistributorLeadKey()
+
+    let operationalStatus: INodeOperationalStatus
+    switch (statusType) {
+      case 'normal': {
+        operationalStatus = { normal: { rationale } }
+        break
+      }
+      case 'noService': {
+        operationalStatus = { noService: { rationale } }
+        break
+      }
+      case 'noServiceFrom': {
+        operationalStatus = {
+          noServiceFrom: {
+            rationale,
+            from: (await this.datePrompt({ message: 'Enter No Service period start date' })).toISOString(),
+          },
+        }
+        break
+      }
+      case 'noServiceUntil': {
+        operationalStatus = {
+          noServiceUntil: {
+            rationale,
+            from: (await this.datePrompt({ message: 'Enter No Service period start date' })).toISOString(),
+            until: (await this.datePrompt({ message: 'Enter No Service period end date' })).toISOString(),
+          },
+        }
+      }
+    }
+
+    this.log(`Setting node operational status...`, {
+      bucketId: bucketId.toHuman(),
+      workerId,
+      operationalStatus,
+    })
+
+    const metadata: ISetNodeOperationalStatus = {
+      workerId: workerId.toString(),
+      bucketId: `${bucketId.distributionBucketFamilyId}:${bucketId.distributionBucketIndex}`,
+      operationalStatus,
+    }
+    await this.sendAndFollowTx(
+      await this.getDecodedPair(leadKey),
+      this.api.tx.distributionWorkingGroup.leadRemark(
+        '0x' + Buffer.from(SetNodeOperationalStatus.encode(metadata).finish()).toString('hex')
+      )
+    )
+    this.log('Bucket operator metadata successfully set/updated!')
+  }
+}

distributor-node/src/commands/operator/set-metadata.ts

@@ -1,8 +1,13 @@
+import {
+  DistributionBucketOperatorMetadata,
+  IDistributionBucketOperatorMetadata,
+  INodeOperationalStatus,
+  NodeOperationalStatus,
+} from '@joystream/metadata-protobuf'
 import fs from 'fs'
 import AccountsCommandBase from '../../command-base/accounts'
 import DefaultCommandBase, { flags } from '../../command-base/default'
 import { ValidationService } from '../../services/validation/ValidationService'
-import { DistributionBucketOperatorMetadata, IDistributionBucketOperatorMetadata } from '@joystream/metadata-protobuf'
 
 export default class OperatorSetMetadata extends AccountsCommandBase {
   static description = `Set/update distribution bucket operator metadata.
@@ -22,6 +27,12 @@ export default class OperatorSetMetadata extends AccountsCommandBase {
       description: 'Root distribution node endpoint',
       exclusive: ['input'],
     }),
+    operationalStatus: flags.enum<Exclude<NodeOperationalStatus['nodeOperationalStatus'], undefined>>({
+      char: 'o',
+      options: ['normal', 'noService', 'noServiceFrom', 'noServiceUntil'],
+      required: false,
+      description: 'Operational status of the operator',
+    }),
     input: flags.string({
       char: 'i',
       description: 'Path to JSON metadata file',
@@ -31,19 +42,55 @@ export default class OperatorSetMetadata extends AccountsCommandBase {
   }
 
   async run(): Promise<void> {
-    const { bucketId, workerId, input, endpoint } = this.parse(OperatorSetMetadata).flags
+    const { bucketId, workerId, input, endpoint, operationalStatus: statusType } = this.parse(OperatorSetMetadata).flags
     const workerKey = await this.getDistributorWorkerRoleKey(workerId)
 
+    let operationalStatus: INodeOperationalStatus
+    switch (statusType) {
+      case 'normal': {
+        operationalStatus = { normal: {} }
+        break
+      }
+      case 'noService': {
+        operationalStatus = { noService: {} }
+        break
+      }
+      case 'noServiceFrom': {
+        operationalStatus = {
+          noServiceFrom: {
+            from: (await this.datePrompt({ message: 'Enter No Service period start date' })).toISOString(),
+          },
+        }
+        break
+      }
+      case 'noServiceUntil': {
+        operationalStatus = {
+          noServiceUntil: {
+            from: (await this.datePrompt({ message: 'Enter No Service period start date' })).toISOString(),
+            until: (await this.datePrompt({ message: 'Enter No Service period end date' })).toISOString(),
+          },
+        }
+      }
+    }
+
     const validation = new ValidationService()
-    const metadata: IDistributionBucketOperatorMetadata = input
-      ? validation.validate('OperatorMetadata', JSON.parse(fs.readFileSync(input).toString()))
-      : { endpoint }
+    let metadata: IDistributionBucketOperatorMetadata
+    if (input) {
+      const params = validation.validate('OperatorMetadata', JSON.parse(fs.readFileSync(input).toString()))
+      metadata = {
+        ...params,
+        ...(params.operationalStatus && { operationalStatus: params.operationalStatus }),
+      }
+    } else {
+      metadata = { endpoint, operationalStatus }
+    }
 
     this.log(`Setting bucket operator metadata...`, {
       bucketId: bucketId.toHuman(),
       workerId,
       metadata,
     })
+
     await this.sendAndFollowTx(
       await this.getDecodedPair(workerKey),
       this.api.tx.storage.setDistributionOperatorMetadata(
@@ -52,6 +99,6 @@ export default class OperatorSetMetadata extends AccountsCommandBase {
         '0x' + Buffer.from(DistributionBucketOperatorMetadata.encode(metadata).finish()).toString('hex')
       )
     )
-    this.log('Bucket operator metadata succesfully set/updated!')
+    this.log('Bucket operator metadata successfully set/updated!')
   }
 }