bpmn-io/bpmn-js

Cannot use `bpmnjs.on` in module constructor when eagerly loaded

Open

#1.624 aberto em 23 de mar. de 2022

Ver no GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (1.249 forks)batch import
backlogbuggood first issuepr welcomespring cleaning

Métricas do repositório

Stars
 (7.739 stars)
Métricas de merge de PR
 (Mesclagem média 17h 6m) (4 fundiu PRs em 30d)

Description

Describe the Bug

Given I have a module of the following structure:

const module = {
  __init__: [ 'custom' ],
  custom: [ 'type', Custom ]
}

function Custom(bpmnjs) {
  bpmnjs.on('diagram.init' /** can be any event */, () => console.log('hello.world'))
}

when I load it to bpmn-js, I get an error similar to the one below:

TypeError: this.get is not a function
    at Modeler.BaseViewer.on (BaseViewer.js?b392:559:1)
    at new ExecutionPlatform (execution-platform.js?5062:41:1)

This is due to injector (and modules) being instantiated before Diagram#get API is defined, cf. https://github.com/bpmn-io/diagram-js/blob/develop/lib/Diagram.js#L139 The BaseViewer tries to get the EventBus but get is not available yet.

Steps to Reproduce

See above.

Expected Behavior

No error. We could move the API declaration to the root of the module and use Diagram.prototype.get, but I haven't tested that.

Environment

  • Browser: [e.g. IE 11, Chrome 69]
  • OS: [e.g. Windows 7]
  • Library version: [e.g. 2.0.0]

Guia do colaborador

Direção de pesquisa
O bug ocorre porque `Diagram#get` ainda não está definido quando os construtores dos módulos são chamados. Para corrigir, examine a ordem de inicialização em `Diagram.js` (linha 139) e `BaseViewer.js` (linhas 558-559). Uma abordagem possível é mover a declaração da API (como `get`) mais cedo no construtor ou usar `Diagram.prototype.get` antes que o injetor esteja totalmente configurado. Verifique os PRs ou comentários vinculados para obter contexto adicional.
Pilha de tecnologia
javascript
Domain
frontend
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Understanding of bpmn js module systemJavaScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
30