integration-tests: global debugger

tests/network-tests/src/Api.ts

@@ -13,7 +13,7 @@ import {
   Opening as WorkingGroupOpening,
 } from '@joystream/types/working-group'
 import { ElectionStake, Seat } from '@joystream/types/council'
-import { AccountInfo, Balance, BalanceOf, BlockNumber, Event, EventRecord } from '@polkadot/types/interfaces'
+import { AccountInfo, Balance, BalanceOf, BlockNumber, EventRecord } from '@polkadot/types/interfaces'
 import BN from 'bn.js'
 import { SubmittableExtrinsic } from '@polkadot/api/types'
 import { Sender, LogLevel } from './sender'
@@ -35,7 +35,7 @@ import { VideoEntity } from '@joystream/cd-schemas/types/entities/VideoEntity'
 import { initializeContentDir, InputParser } from '@joystream/cd-schemas'
 import { OperationType } from '@joystream/types/content-directory'
 import { ContentId, DataObject } from '@joystream/types/media'
-import Debugger from 'debug'
+import { extendDebug } from './Debugger'
 import { InvertedPromise } from './InvertedPromise'
 
 export enum WorkingGroups {
@@ -54,7 +54,7 @@ export class ApiFactory {
     treasuryAccountUri: string,
     sudoAccountUri: string
   ): Promise<ApiFactory> {
-    const debug = Debugger('integration-tests:api-factory')
+    const debug = extendDebug('api-factory')
     let connectAttempts = 0
     while (true) {
       connectAttempts++

tests/network-tests/src/Debugger.ts

@@ -0,0 +1,9 @@
+import Debugger from 'debug'
+
+// Global debugger
+const debug = Debugger('integration-tests')
+
+// Extend function bound to the global debugger
+const extendDebug = debug.extend.bind(debug)
+
+export { Debugger, debug, extendDebug }

tests/network-tests/src/Job.ts

@@ -1,4 +1,4 @@
-import Debugger from 'debug'
+import { Debugger, extendDebug } from './Debugger'
 import { EventEmitter } from 'events'
 import { ApiFactory } from './Api'
 import { QueryNodeApi } from './QueryNodeApi'
@@ -30,7 +30,7 @@ export class Job {
     this._flows = flows
     this._outcome = new InvertedPromise<JobOutcome>()
     this._manager.on('run', this.run.bind(this))
-    this.debug = Debugger(`integration-tests:job:${this._label}`)
+    this.debug = extendDebug(`${this._label}`)
   }
 
   // Depend on another job to complete successfully

tests/network-tests/src/Resources.ts

@@ -1,8 +1,8 @@
 import { assert } from 'chai'
 import { Utils } from './utils'
-import Debugger from 'debug'
+import { extendDebug } from './Debugger'
 
-const debug = Debugger('integration-tests:resources')
+const debug = extendDebug('resources')
 
 type NamedLocks = Record<Resource, Lock>
 export type ResourceLocker = (resource: Resource, timeout?: number) => Promise<() => void>

tests/network-tests/src/Scenario.ts

@@ -3,7 +3,7 @@ import { ApiFactory } from './Api'
 import { QueryNodeApi } from './QueryNodeApi'
 import { config } from 'dotenv'
 import { ApolloClient, InMemoryCache, HttpLink } from '@apollo/client'
-import Debugger from 'debug'
+import { Debugger, extendDebug } from './Debugger'
 import { Flow } from './Flow'
 import { Job } from './Job'
 import { JobManager } from './JobManager'
@@ -41,7 +41,7 @@ export async function scenario(scene: (props: ScenarioProps) => Promise<void>):
 
   const query = new QueryNodeApi(queryNodeProvider)
 
-  const debug = Debugger('integration-tests:scenario')
+  const debug = extendDebug('scenario')
 
   const jobs = new JobManager({ apiFactory, query, env })
 

tests/network-tests/src/fixtures/membershipModule.ts

@@ -3,7 +3,7 @@ import BN from 'bn.js'
 import { assert } from 'chai'
 import { BaseFixture } from '../Fixture'
 import { PaidTermId, MemberId } from '@joystream/types/members'
-import Debugger from 'debug'
+import { Debugger, extendDebug } from '../Debugger'
 
 export class BuyMembershipHappyCaseFixture extends BaseFixture {
   private accounts: string[]
@@ -15,7 +15,7 @@ export class BuyMembershipHappyCaseFixture extends BaseFixture {
     super(api)
     this.accounts = accounts
     this.paidTerms = paidTerms
-    this.debug = Debugger('integration-tests:fixture:BuyMembershipHappyCaseFixture')
+    this.debug = extendDebug('fixture:BuyMembershipHappyCaseFixture')
   }
 
   public getCreatedMembers(): MemberId[] {

tests/network-tests/src/flows/contentDirectory/contentDirectoryInitialization.ts

@@ -1,6 +1,6 @@
 import { FlowProps } from '../../Flow'
-import Debugger from 'debug'
-const debug = Debugger('integration-tests:initializeContentDirectory')
+import { extendDebug } from '../../Debugger'
+const debug = extendDebug('initializeContentDirectory')
 
 export default async function initializeContentDirectory({ api }: FlowProps): Promise<void> {
   debug('Started')

tests/network-tests/src/flows/contentDirectory/creatingChannel.ts

@@ -5,7 +5,7 @@ import { CreateChannelFixture } from '../../fixtures/contentDirectoryModule'
 import { ChannelEntity } from '@joystream/cd-schemas/types/entities/ChannelEntity'
 import { assert } from 'chai'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 
 export function createSimpleChannelFixture(api: Api): CreateChannelFixture {
   const channelEntity: ChannelEntity = {
@@ -31,7 +31,7 @@ function assertChannelMatchQueriedResult(queriedChannel: any, channel: ChannelEn
 }
 
 export default async function channelCreation({ api, query }: FlowProps): Promise<void> {
-  const debug = Debugger('integration-tests:flow:creatingChannel')
+  const debug = extendDebug('flow:creatingChannel')
   debug('Started')
 
   const createChannelHappyCaseFixture = createSimpleChannelFixture(api)

tests/network-tests/src/flows/contentDirectory/creatingVideo.ts

@@ -5,7 +5,7 @@ import { VideoEntity } from '@joystream/cd-schemas/types/entities/VideoEntity'
 import { assert } from 'chai'
 import { Utils } from '../../utils'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 
 export function createVideoReferencingChannelFixture(api: Api, handle: string): CreateVideoFixture {
   const videoEntity: VideoEntity = {
@@ -56,7 +56,7 @@ function assertVideoMatchQueriedResult(queriedVideo: any, video: VideoEntity) {
 }
 
 export default async function createVideo({ api, query }: FlowProps): Promise<void> {
-  const debug = Debugger('integration-tests:flow:creatingVideo')
+  const debug = extendDebug('flow:creatingVideo')
   debug('Started')
 
   const channelTitle = 'New channel example'

tests/network-tests/src/flows/contentDirectory/updatingChannel.ts

@@ -5,7 +5,7 @@ import { ChannelEntity } from '@joystream/cd-schemas/types/entities/ChannelEntit
 import { assert } from 'chai'
 import { Utils } from '../../utils'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 
 export function createUpdateChannelHandleFixture(api: Api, handle: string, description: string): UpdateChannelFixture {
   // Create partial channel entity, only containing the fields we wish to update
@@ -19,7 +19,7 @@ export function createUpdateChannelHandleFixture(api: Api, handle: string, descr
 }
 
 export default async function updateChannel({ api, query }: FlowProps): Promise<void> {
-  const debug = Debugger('integration-tests:flow:updateChannel')
+  const debug = extendDebug('flow:updateChannel')
   debug('Started')
 
   const handle = 'New channel example'

tests/network-tests/src/flows/council/setup.ts

@@ -3,13 +3,13 @@ import { PaidTermId } from '@joystream/types/members'
 import { FlowProps } from '../../Flow'
 import { ElectCouncilFixture } from '../../fixtures/councilElectionModule'
 import { BuyMembershipHappyCaseFixture } from '../../fixtures/membershipModule'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { FixtureRunner } from '../../Fixture'
 import { Resource } from '../../Resources'
 
 export default async function councilSetup({ api, env, lock }: FlowProps): Promise<void> {
   const label = 'councilSetup'
-  const debug = Debugger(`integration-tests:flow:${label}`)
+  const debug = extendDebug(`flow:${label}`)
 
   debug('Started')
 

tests/network-tests/src/flows/membership/creatingMemberships.ts

@@ -5,12 +5,12 @@ import {
 } from '../../fixtures/membershipModule'
 import { PaidTermId } from '@joystream/types/members'
 import BN from 'bn.js'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { FixtureRunner } from '../../Fixture'
 import { assert } from 'chai'
 
 export default async function membershipCreation({ api, env }: FlowProps): Promise<void> {
-  const debug = Debugger('integration-tests:flow:memberships')
+  const debug = extendDebug('flow:memberships')
   debug('Started')
   api.enableDebugTxLogs()
 

tests/network-tests/src/flows/proposals/electionParametersProposal.ts

@@ -2,12 +2,12 @@ import { FlowProps } from '../../Flow'
 import { ElectionParametersProposalFixture } from '../../fixtures/proposalsModule'
 import { assert } from 'chai'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { Resource } from '../../Resources'
 
 // Election parameters proposal scenario
 export default async function electionParametersProposal({ api, lock }: FlowProps): Promise<void> {
-  const debug = Debugger('integration-tests:flow:electionParametersProposal')
+  const debug = extendDebug('flow:electionParametersProposal')
   debug('Started')
   await lock(Resource.Proposals)
 

tests/network-tests/src/flows/proposals/manageLeaderRole.ts

@@ -19,7 +19,7 @@ import { ProposalId } from '@joystream/types/proposals'
 import { WorkerId } from '@joystream/types/working-group'
 import { assert } from 'chai'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { Resource, ResourceLocker } from '../../Resources'
 
 export default {
@@ -32,7 +32,7 @@ export default {
 }
 
 async function manageLeaderRole(api: Api, env: NodeJS.ProcessEnv, group: WorkingGroups, lock: ResourceLocker) {
-  const debug = Debugger(`integration-tests:flow:managerLeaderRole:${group}`)
+  const debug = extendDebug(`flow:managerLeaderRole:${group}`)
   debug('Started')
   await lock(Resource.Proposals)
 

tests/network-tests/src/flows/proposals/spendingProposal.ts

@@ -3,11 +3,11 @@ import { FlowProps } from '../../Flow'
 import { SpendingProposalFixture } from '../../fixtures/proposalsModule'
 import { assert } from 'chai'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { Resource } from '../../Resources'
 
 export default async function spendingProposal({ api, env, lock }: FlowProps): Promise<void> {
-  const debug = Debugger('integration-tests:flow:spendingProposals')
+  const debug = extendDebug('flow:spendingProposals')
   debug('Started')
   await lock(Resource.Proposals)
 

tests/network-tests/src/flows/proposals/textProposal.ts

@@ -2,11 +2,11 @@ import { FlowProps } from '../../Flow'
 import { TextProposalFixture } from '../../fixtures/proposalsModule'
 import { assert } from 'chai'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { Resource } from '../../Resources'
 
 export default async function textProposal({ api, lock }: FlowProps): Promise<void> {
-  const debug = Debugger('integration-tests:flow:textProposal')
+  const debug = extendDebug('flow:textProposal')
   debug('Started')
   await lock(Resource.Proposals)
 

tests/network-tests/src/flows/proposals/updateRuntime.ts

@@ -5,11 +5,11 @@ import { UpdateRuntimeFixture } from '../../fixtures/proposalsModule'
 import { PaidTermId } from '@joystream/types/members'
 import { assert } from 'chai'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { Resource } from '../../Resources'
 
 export default async function updateRuntime({ api, env, lock }: FlowProps): Promise<void> {
-  const debug = Debugger('integration-tests:flow:updateRuntime')
+  const debug = extendDebug('flow:updateRuntime')
   debug('Started')
   await lock(Resource.Proposals)
 

tests/network-tests/src/flows/proposals/validatorCountProposal.ts

@@ -3,11 +3,11 @@ import { FlowProps } from '../../Flow'
 import { ValidatorCountProposalFixture } from '../../fixtures/proposalsModule'
 import { assert } from 'chai'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { Resource } from '../../Resources'
 
 export default async function validatorCount({ api, lock }: FlowProps): Promise<void> {
-  const debug = Debugger('integration-tests:flow:validatorCountProposal')
+  const debug = extendDebug('flow:validatorCountProposal')
   debug('Started')
   await lock(Resource.Proposals)
 

tests/network-tests/src/flows/proposals/workingGroupMintCapacityProposal.ts

@@ -5,7 +5,7 @@ import { VoteForProposalFixture, WorkingGroupMintCapacityProposalFixture } from
 import { ProposalId } from '@joystream/types/proposals'
 import { assert } from 'chai'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { Resource, ResourceLocker } from '../../Resources'
 
 export default {
@@ -19,7 +19,7 @@ export default {
 }
 
 async function workingGroupMintCapactiy(api: Api, env: NodeJS.ProcessEnv, group: WorkingGroups, lock: ResourceLocker) {
-  const debug = Debugger(`flow:workingGroupMintCapacityProposal:${group}`)
+  const debug = extendDebug(`flow:workingGroupMintCapacityProposal:${group}`)
   debug('Started')
   await lock(Resource.Proposals)
 

tests/network-tests/src/flows/storageNode/getContentFromStorageNode.ts

@@ -5,10 +5,10 @@ import { registry } from '@joystream/types'
 
 import { FlowProps } from '../../Flow'
 import { Utils } from '../../utils'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 
 export default async function getContentFromStorageNode({ api, query }: FlowProps): Promise<void> {
-  const debug = Debugger('integration-tests:flow:getContentFromStorageNode')
+  const debug = extendDebug('flow:getContentFromStorageNode')
   debug('Started')
 
   const videoTitle = 'Storage node test'

tests/network-tests/src/flows/workingGroup/atLeastValueBug.ts

@@ -3,12 +3,12 @@ import { FlowProps } from '../../Flow'
 import { AddWorkerOpeningFixture } from '../../fixtures/workingGroupModule'
 import BN from 'bn.js'
 import { assert } from 'chai'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { FixtureRunner } from '../../Fixture'
 
 // Zero at least value bug scenario
 export default async function zeroAtLeastValueBug({ api, env }: FlowProps): Promise<void> {
-  const debug = Debugger('integration-tests:flow:atLeastValueBug')
+  const debug = extendDebug('flow:atLeastValueBug')
   debug('Started')
   api.enableDebugTxLogs()
 

tests/network-tests/src/flows/workingGroup/leaderSetup.ts

@@ -6,7 +6,7 @@ import { SudoHireLeadFixture } from '../../fixtures/sudoHireLead'
 import { assert } from 'chai'
 // import { KeyringPair } from '@polkadot/keyring/types'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 
 export default {
   storage: async function ({ api, env }: FlowProps): Promise<void> {
@@ -19,7 +19,7 @@ export default {
 
 // Worker application happy case scenario
 async function leaderSetup(api: Api, env: NodeJS.ProcessEnv, group: WorkingGroups): Promise<void> {
-  const debug = Debugger(`integration-tests:flow:leaderSetup:${group}`)
+  const debug = extendDebug(`flow:leaderSetup:${group}`)
   debug('Started')
 
   const existingLead = await api.getGroupLead(group)

tests/network-tests/src/flows/workingGroup/manageWorkerAsLead.ts

@@ -13,7 +13,7 @@ import { BuyMembershipHappyCaseFixture } from '../../fixtures/membershipModule'
 import BN from 'bn.js'
 import { OpeningId } from '@joystream/types/hiring'
 import { assert } from 'chai'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { FixtureRunner } from '../../Fixture'
 
 export default {
@@ -26,7 +26,7 @@ export default {
 }
 
 async function manageWorkerAsLead(api: Api, env: NodeJS.ProcessEnv, group: WorkingGroups): Promise<void> {
-  const debug = Debugger(`integration-tests:flow:manageWorkerAsLead:${group}`)
+  const debug = extendDebug(`flow:manageWorkerAsLead:${group}`)
   debug('Started')
 
   const applicationStake: BN = new BN(env.WORKING_GROUP_APPLICATION_STAKE!)

tests/network-tests/src/flows/workingGroup/manageWorkerAsWorker.ts

@@ -13,7 +13,7 @@ import { OpeningId } from '@joystream/types/hiring'
 import { BuyMembershipHappyCaseFixture } from '../../fixtures/membershipModule'
 import { assert } from 'chai'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 
 export default {
   storage: async function ({ api, env }: FlowProps): Promise<void> {
@@ -26,7 +26,7 @@ export default {
 
 // Manage worker as worker
 async function manageWorkerAsWorker(api: Api, env: NodeJS.ProcessEnv, group: WorkingGroups) {
-  const debug = Debugger(`integration-tests:flow:manageWorkerAsWorker:${group}`)
+  const debug = extendDebug(`flow:manageWorkerAsWorker:${group}`)
   debug('Started')
 
   const applicationStake: BN = new BN(env.WORKING_GROUP_APPLICATION_STAKE!)

tests/network-tests/src/flows/workingGroup/workerPayout.ts

@@ -15,7 +15,7 @@ import { ProposalId } from '@joystream/types/proposals'
 import { BuyMembershipHappyCaseFixture } from '../../fixtures/membershipModule'
 import { assert } from 'chai'
 import { FixtureRunner } from '../../Fixture'
-import Debugger from 'debug'
+import { extendDebug } from '../../Debugger'
 import { Resource, ResourceLocker } from '../../Resources'
 
 export default {
@@ -28,7 +28,7 @@ export default {
 }
 
 async function workerPayouts(api: Api, env: NodeJS.ProcessEnv, group: WorkingGroups, lock: ResourceLocker) {
-  const debug = Debugger(`integration-tests:flow:workerPayout:${group}`)
+  const debug = extendDebug(`flow:workerPayout:${group}`)
   debug('Started')
   await lock(Resource.Proposals)
 

tests/network-tests/src/sender.ts

@@ -5,7 +5,7 @@ import { AccountId, EventRecord } from '@polkadot/types/interfaces'
 import { DispatchError, DispatchResult } from '@polkadot/types/interfaces/system'
 import { TypeRegistry } from '@polkadot/types'
 import { KeyringPair } from '@polkadot/keyring/types'
-import Debugger from 'debug'
+import { Debugger, extendDebug } from './Debugger'
 import AsyncLock from 'async-lock'
 import { assert } from 'chai'
 
@@ -26,7 +26,7 @@ export class Sender {
   constructor(api: ApiPromise, keyring: Keyring, label: string) {
     this.api = api
     this.keyring = keyring
-    this.debug = Debugger(`integration-tests:sender:${Sender.instance++}:${label}`)
+    this.debug = extendDebug(`sender:${Sender.instance++}:${label}`)
   }
 
   // Synchronize all sending of transactions into mempool, so we can always safely read