Class LockingTrait

The Locking Trait is used to lock entity update mutations. Lock allows to handle that this document will not be edited by 2 users Lock can be acquired by mutation Lock can be broken by mutation and after updating entity

This trait adds new properties to query resolver:

lockedBy - user that made this lock
locked - locked flag
lockedTimestamp - lock creation time

To prolong lock after update mutation there is keepTheLock flag in arguments ACL for breaking the lock by another user can be defined via policies: Entity:ForceBreakLock

Usage:

traits:
 - type: locking
   lock_time: 15m

Hierarchy

Trait<LockingTraitConfig>
- LockingTrait

Constructors

constructor

new LockingTrait(graphqlSchemaManager: GraphQLSchemaManager, dataSourceWrapper: DataSourceWrapper, lockManager: LockManager, accessControl: AccessControl): LockingTrait
Parameters
- graphqlSchemaManager: GraphQLSchemaManager
- dataSourceWrapper: DataSourceWrapper
- lockManager: LockManager
- accessControl: AccessControl
Returns LockingTrait
Overrides Trait.constructor
- Defined in src/traits/LockingTrait.ts:140

Properties

`Protected` `Optional` _config

_config?: LockingTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

Whether this is a global (not bound to any specific schema item) trait instance.

`Protected` `Optional` _type

_type?: "locking"

Trait type.

`Protected` `Readonly` accessControl

accessControl: AccessControl

attachToEntities

attachToEntities: LockingConfigAttachSetting[] = []

`Protected` `Readonly` dataSourceWrapper

dataSourceWrapper: DataSourceWrapper

dynamicConfigValidationRequired

dynamicConfigValidationRequired: boolean = false

`Protected` `Readonly` graphqlSchemaManager

graphqlSchemaManager: GraphQLSchemaManager

`Protected` `Readonly` lockManager

lockManager: LockManager

lockTimeSeconds

lockTimeSeconds: number = DEFAULT_LOCK_TIME_SECONDS

pathToAttachedEntity

pathToAttachedEntity: string = ''

`Static` hookedIntoAccessControl

hookedIntoAccessControl: boolean = false

Methods

createConfigs

createConfigs(vertices: LoadedEntities[], data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<void>
Creates locking configs and attaches entities to created configs. If config has already created but entity is not attached - adds required edge
Parameters
- vertices: LoadedEntities[]
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<void>
- Defined in src/traits/LockingTrait.ts:450

createConfigsMutationName

createConfigsMutationName(): string
Returns string
- Defined in src/traits/LockingTrait.ts:587

createLockConfigsResolver

createLockConfigsResolver(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<boolean>
Resolver for mutation create{Entity}LockingConfigs
Parameters
- datasourceWrapper: DataSourceWrapper
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<boolean>
- Defined in src/traits/LockingTrait.ts:495

entityMutationName

entityMutationName(type: "lock" | "unlock"): string
Parameters
- type: "lock" | "unlock"
Returns string
- Defined in src/traits/LockingTrait.ts:192

generateAccessControl

generateAccessControl(statements: TheStatementSchema): TheStatementSchema
Parameters
- statements: TheStatementSchema
Returns TheStatementSchema
- Defined in src/traits/LockingTrait.ts:530

getListConfigsQueryName

getListConfigsQueryName(): string
Returns string
- Defined in src/traits/LockingTrait.ts:583

getLockConfigsResolver

getLockConfigsResolver(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<any[]>
Resolver for query {Entity}LockingConfigs
Parameters
- datasourceWrapper: DataSourceWrapper
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<any[]>
- Defined in src/traits/LockingTrait.ts:378

getLockTimestamp

getLockTimestamp(ttl: number): Date
Generates lock timestamp based on ttl value
Parameters
- ttl: number
  
  time to live
Returns Date
- Defined in src/traits/LockingTrait.ts:346

getLockingConfigLabel

getLockingConfigLabel(): string
Returns string
- Defined in src/traits/LockingTrait.ts:350

hookIntoSchema

hookIntoSchema(schemaItem: SchemaItem<SchemaItemType>): void
Attaches Trait callbacks to schema item hooks.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
Returns void
Overrides Trait.hookIntoSchema
- Defined in src/traits/LockingTrait.ts:612

hookIntoSchemaManager

hookIntoSchemaManager(): void
Attaches Trait callbacks to schema manager hooks.

Returns void
Inherited from Trait.hookIntoSchemaManager
- Defined in src/traits/Trait.ts:225

isLockingEnabled

isLockingEnabled(entityId: string, context: KosmosUserContext<object>): Promise<boolean>
Parameters
- entityId: string
- context: KosmosUserContext<object>
Returns Promise<boolean>
- Defined in src/traits/LockingTrait.ts:354

loadAttachedVertices

loadAttachedVertices(data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<LoadedEntities[]>
Loads entities declared in config using gremlin queries
Parameters
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<LoadedEntities[]>
- Defined in src/traits/LockingTrait.ts:395

loadConfigs

loadConfigs(vertices: LoadedEntities[], data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<void>
Loads all existed configs and finds entities without attached configs Fills following properties of vertices[i]:
1. vertices[i].connectionRequired - entities without attached config
2. vertices[i].config - existed config for this group of entities
Parameters
- vertices: LoadedEntities[]
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<void>
- Defined in src/traits/LockingTrait.ts:413

lockVertex

lockVertex(_parent: unknown, args: Record<string, any>, context: KosmosUserContext<object>): Promise<boolean>
Creates lock for entity
Parameters
- _parent: unknown
- args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<boolean>
- Defined in src/traits/LockingTrait.ts:264

makeGlobal

makeGlobal(): LockingTrait
Makes this Trait instance global.

Returns LockingTrait
Inherited from Trait.makeGlobal
- Defined in src/traits/Trait.ts:237

mutationItemSchema

mutationItemSchema(query: string, label: string, mutationType: "update" | "create"): string
Parameters
- query: string
- label: string
- mutationType: "update" | "create"
Returns string
- Defined in src/traits/LockingTrait.ts:539

mutationSchema

mutationSchema(query: string): string
Parameters
- query: string
Returns string
- Defined in src/traits/LockingTrait.ts:550

name

name(): string
Used to return the name.

Returns string
Inherited from Trait.name
- Defined in src/traits/Trait.ts:198

postUpdate

postUpdate(...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
Parameters
- Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
Returns Promise<void>
- Defined in src/traits/LockingTrait.ts:218

postView

postView(item: StoredKosmosItem, dataSourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>): Promise<void>
Adds lock info properties to reply
Parameters
- item: StoredKosmosItem
- dataSourceWrapper: DataSourceWrapper
- context: KosmosUserContext<object>
Returns Promise<void>
- Defined in src/traits/LockingTrait.ts:237

preUpdate

preUpdate(...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: object, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]): Promise<void>
Parameters
- Rest ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: object, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]
Returns Promise<void>
- Defined in src/traits/LockingTrait.ts:202

process

process<RT, Payload>(callbackName: string, datasourceWrapper: DataSourceWrapper, data: TraitDataObject<RT, Payload, Promise<any>>): Promise<RT>
This method is triggered when a trait callback has been activated
Type Parameters
- RT = any
- Payload = any
Parameters
- callbackName: string
  
  This is the name of the callback function to call.
- datasourceWrapper: DataSourceWrapper
  
  References to the Graph Hanlder
- data: TraitDataObject<RT, Payload, Promise<any>>
  
  Request data passed along as part of the request.
Returns Promise<RT>
Inherited from Trait.process
- Defined in src/traits/Trait.ts:147

querySchema

querySchema(query: string): string
Parameters
- query: string
Returns string
- Defined in src/traits/LockingTrait.ts:573

querySchemaGlobal

querySchemaGlobal(query: string): string
Parameters
- query: string
Returns string
- Defined in src/traits/LockingTrait.ts:595

setConfig

setConfig(config: LockingTraitConfig): void
Configuration setter.
Parameters
- config: LockingTraitConfig
  
  The new configuration.
Returns void
Overrides Trait.setConfig
- Defined in src/traits/LockingTrait.ts:170

traitConfig

traitConfig(): LockingTraitConfig
Returns LockingTraitConfig
Inherited from Trait.traitConfig
- Defined in src/traits/Trait.ts:205

unlockEntity

unlockEntity(_parent: unknown, args: Record<string, any>, context: KosmosUserContext<object>): Promise<boolean>
Breaks lock for entity
Parameters
- _parent: unknown
- args: Record<string, any>
- context: KosmosUserContext<object>
Returns Promise<boolean>
- Defined in src/traits/LockingTrait.ts:315

updateConfigsMutationName

updateConfigsMutationName(): string
Returns string
- Defined in src/traits/LockingTrait.ts:591

updateLockConfigsResolver

updateLockConfigsResolver(datasourceWrapper: DataSourceWrapper, data: TraitDataObject<unknown, Record<string, any>, Promise<any>>): Promise<void>
Resolver for mutation update{Entity}LockingConfigs
Parameters
- datasourceWrapper: DataSourceWrapper
- data: TraitDataObject<unknown, Record<string, any>, Promise<any>>
Returns Promise<void>
- Defined in src/traits/LockingTrait.ts:508

wrapLegacyResolver

wrapLegacyResolver<RT, Payload>(resolver: LegacyKosmosTraitResolverCallback<RT, any>, datasourceWrapper: DataSourceWrapper, callbackName?: string): KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Helper method for wrapping legacy Kosmos traits callbacks.

TODO: Remove this method once all Traits are converted.
Type Parameters
- RT = any
- Payload = any
Parameters
- resolver: LegacyKosmosTraitResolverCallback<RT, any>
- datasourceWrapper: DataSourceWrapper
- Optional callbackName: string
  
  Optional callback name; passing this parameter will additionally wrap the callback into legacy process().
Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Inherited from Trait.wrapLegacyResolver
- Defined in src/traits/Trait.ts:168

`Static` traitTypeName

traitTypeName(): string
This method should return the trait machine name(s).

Returns

Returns string
Overrides Trait.traitTypeName
- Defined in src/traits/LockingTrait.ts:188

Class LockingTrait

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

graphqlSchemaManager: GraphQLSchemaManager

dataSourceWrapper: DataSourceWrapper

lockManager: LockManager

accessControl: AccessControl

Returns LockingTrait

Properties

Protected Optional _config

Protected _global

Protected Optional _type

Protected Readonly accessControl

attachToEntities

Protected Readonly dataSourceWrapper

dynamicConfigValidationRequired

Protected Readonly graphqlSchemaManager

Protected Readonly lockManager

lockTimeSeconds

pathToAttachedEntity

Static hookedIntoAccessControl

Methods

createConfigs

Parameters

vertices: LoadedEntities[]

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

Returns Promise<void>

createConfigsMutationName

Returns string

createLockConfigsResolver

Parameters

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

Returns Promise<boolean>

entityMutationName

Parameters

type: "lock" | "unlock"

Returns string

generateAccessControl

Parameters

statements: TheStatementSchema

Returns TheStatementSchema

getListConfigsQueryName

Returns string

getLockConfigsResolver

Parameters

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

Returns Promise<any[]>

getLockTimestamp

Parameters

ttl: number

Returns Date

getLockingConfigLabel

Returns string

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

isLockingEnabled

Parameters

entityId: string

context: KosmosUserContext<object>

Returns Promise<boolean>

loadAttachedVertices

Parameters

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

Returns Promise<LoadedEntities[]>

loadConfigs

Parameters

vertices: LoadedEntities[]

data: TraitDataObject<unknown, Record<string, any>, Promise<any>>

`Protected` `Optional` _config

`Protected` _global

`Protected` `Optional` _type

`Protected` `Readonly` accessControl

`Protected` `Readonly` dataSourceWrapper

`Protected` `Readonly` graphqlSchemaManager

`Protected` `Readonly` lockManager

`Static` hookedIntoAccessControl

`Rest` ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, item: StoredKosmosItem, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]

`Rest` ...__namedParameters: [traitData: TraitDataObject<unknown, Record<string, any>, Promise<any>>, data: object, datasourceWrapper: DataSourceWrapper, context: KosmosUserContext<object>]