joystream/utils/migration-scripts/src/sumer-giza/ChannelsMigration.ts

import { AssetsMigration, AssetsMigrationConfig, AssetsMigrationParams } from './AssetsMigration'
import { ChannelMetadata } from '@joystream/metadata-protobuf'
import { ChannelFieldsFragment } from './sumer-query-node/generated/queries'
import { createType } from '@joystream/types'
import Long from 'long'
import { ChannelCreationParameters } from '@joystream/types/content'
import { CHANNEL_AVATAR_TARGET_SIZE, CHANNEL_COVER_TARGET_SIZE } from './ImageResizer'
import { ChannelId } from '@joystream/types/common'
import _ from 'lodash'
import { MigrationResult } from './BaseMigration'
import { Logger } from 'winston'
import { createLogger } from '../logging'

export type ChannelsMigrationConfig = AssetsMigrationConfig & {
  channelIds: number[]
  channelBatchSize: number
  forceChannelOwnerMemberId: number | undefined
}

export type ChannelsMigrationParams = AssetsMigrationParams & {
  config: ChannelsMigrationConfig
  forcedChannelOwner: { id: string; controllerAccount: string } | undefined
}

export type ChannelsMigrationResult = MigrationResult & {
  videoIds: number[]
}

export class ChannelMigration extends AssetsMigration {
  name = 'Channels migration'
  protected config: ChannelsMigrationConfig
  protected videoIds: number[] = []
  protected forcedChannelOwner: { id: string; controllerAccount: string } | undefined
  protected logger: Logger

  public constructor(params: ChannelsMigrationParams) {
    super(params)
    this.config = params.config
    this.forcedChannelOwner = params.forcedChannelOwner
    this.logger = createLogger(this.name)
  }

  private getChannelOwnerMember({ id, ownerMember }: ChannelFieldsFragment) {
    if (!ownerMember) {
      throw new Error(`Chanel ownerMember missing: ${id}. Only member-owned channels are supported!`)
    }

    if (this.forcedChannelOwner) {
      return this.forcedChannelOwner
    }

    return ownerMember
  }

  protected async migrateBatch(channels: ChannelFieldsFragment[]): Promise<void> {
    const { api } = this
    const txs = _.flatten(await Promise.all(channels.map((c) => this.prepareChannel(c))))
    const result = await api.sendExtrinsic(this.sudo, api.tx.utility.batch(txs))
    const channelCreatedEvents = api.findEvents(result, 'content', 'ChannelCreated')
    const newChannelIds: ChannelId[] = channelCreatedEvents.map((e) => e.data[1])
    if (channelCreatedEvents.length !== channels.length) {
      this.extractFailedMigrations(result, channels)
    }
    const newChannelMapEntries: [number, number][] = []
    let newChannelIdIndex = 0
    channels.forEach(({ id }) => {
      if (this.failedMigrations.has(parseInt(id))) {
        return
      }
      const newChannelId = newChannelIds[newChannelIdIndex++].toNumber()
      this.idsMap.set(parseInt(id), newChannelId)
      newChannelMapEntries.push([parseInt(id), newChannelId])
    })
    if (newChannelMapEntries.length) {
      this.logger.info('Channel map entries added!', { newChannelMapEntries })
      const dataObjectsUploadedEvents = this.api.findEvents(result, 'storage', 'DataObjectsUploaded')
      this.assetsManager.queueUploadsFromEvents(dataObjectsUploadedEvents)
    }
  }

  public async run(): Promise<ChannelsMigrationResult> {
    await this.init()
    const {
      config: { channelIds, channelBatchSize },
    } = this
    const ids = channelIds.sort((a, b) => a - b)
    while (ids.length) {
      const idsBatch = ids.splice(0, channelBatchSize)
      this.logger.info(`Fetching a batch of ${idsBatch.length} channels...`)
      const channelsBatch = (await this.queryNodeApi.getChannelsByIds(idsBatch)).sort(
        (a, b) => parseInt(a.id) - parseInt(b.id)
      )
      if (channelsBatch.length < idsBatch.length) {
        this.logger.warn(
          `Some channels were not be found: ${_.difference(
            idsBatch,
            channelsBatch.map((c) => parseInt(c.id))
          )}`
        )
      }
      const channelsToMigrate = channelsBatch.filter((c) => !this.idsMap.has(parseInt(c.id)))
      if (channelsToMigrate.length < channelsBatch.length) {
        this.logger.info(
          `${channelsToMigrate.length ? 'Some' : 'All'} channels in this batch were already migrated ` +
            `(${channelsBatch.length - channelsToMigrate.length}/${channelsBatch.length})`
        )
      }
      if (channelsToMigrate.length) {
        await this.executeBatchMigration(channelsToMigrate)
        await this.assetsManager.processQueuedUploads()
      }
      const videoIdsToMigrate: number[] = channelsBatch.reduce<number[]>(
        (res, { id, videos }) => (this.idsMap.has(parseInt(id)) ? res.concat(videos.map((v) => parseInt(v.id))) : res),
        []
      )
      this.videoIds = this.videoIds.concat(videoIdsToMigrate)
      if (videoIdsToMigrate.length) {
        this.logger.info(`Added ${videoIdsToMigrate.length} video ids to the list of videos to migrate`)
      }
    }
    return {
      ...this.getResult(),
      videoIds: [...this.videoIds],
    }
  }

  private async prepareChannel(channel: ChannelFieldsFragment) {
    const { api } = this
    const { avatarPhotoDataObject, coverPhotoDataObject, title, description, categoryId, isPublic, language } = channel

    const ownerMember = this.getChannelOwnerMember(channel)

    const assetsToPrepare = {
      avatar: { data: avatarPhotoDataObject || undefined, targetSize: CHANNEL_AVATAR_TARGET_SIZE },
      coverPhoto: { data: coverPhotoDataObject || undefined, targetSize: CHANNEL_COVER_TARGET_SIZE },
    }
    const preparedAssets = await this.assetsManager.prepareAssets(assetsToPrepare)
    const meta = new ChannelMetadata({
      title,
      description,
      category: categoryId ? Long.fromString(categoryId) : undefined,
      avatarPhoto: preparedAssets.avatar?.index,
      coverPhoto: preparedAssets.coverPhoto?.index,
      isPublic,
      language: language?.iso,
    })
    const assetsParams = Object.values(preparedAssets)
      .sort((a, b) => a.index - b.index)
      .map((a) => a.params)
    const channelCreationParams = createType<ChannelCreationParameters, 'ChannelCreationParameters'>(
      'ChannelCreationParameters',
      {
        assets: assetsParams.length
          ? {
              object_creation_list: assetsParams,
              expected_data_size_fee: this.assetsManager.dataObjectFeePerMB,
            }
          : null,
        meta: `0x${Buffer.from(ChannelMetadata.encode(meta).finish()).toString('hex')}`,
      }
    )
    const feesToCover = this.assetsManager.calcDataObjectsFee(assetsParams)
    return [
      api.tx.balances.transferKeepAlive(ownerMember.controllerAccount, feesToCover),
      api.tx.sudo.sudoAs(
        ownerMember.controllerAccount,
        api.tx.content.createChannel({ Member: ownerMember.id }, channelCreationParams)
      ),
    ]
  }
}