[Javascript] Incorrectly generated import paths when using `google/api` or `google/type`
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Bug
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- grpc, javascript, typescript
- Domínio
- tooling
Direção de pesquisa
Comece pelos imports gerados em annotations_pb.js e pelo comando grpc_tools_node_protoc mostrado na issue; em seguida, compare como as raízes de inclusão -I afetam os caminhos de google/api e google/type. Considera-se concluído quando os imports JavaScript gerados forem resolvidos corretamente, incluindo imports transitivos como google/api/http_pb.js, sem copiar manualmente os arquivos gerados.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
/cc @zchee
What version of protobuf and what language are you using?
Version: v3.6.0
Language: Javascript
What operating system (Linux, Windows, ...) and version?
Docker Image: node:9
What runtime / compiler are you using (e.g., python version or gcc version)
What did you do?
Steps to reproduce the behavior:
When using imports for google/api/.. or google/type/... the imports generated for javascript resolve to incorrect paths
Example:
import "google/api/annotations.proto";
import "google/type/date.proto";
What did you expect to see
Correctly resolved import paths
What did you see instead?
Wrongly resolved import paths:
generated output (these directories don't exist):
var google_api_annotations_pb = require('../../../../../../google/api/annotations_pb.js');
var google_type_date_pb = require('../../../../../../google/type/date_pb.js');
We resolved these imports by generating these files ourselves (from https://github.com/googleapis/googleapis repository) and copying them to the correct folder but inside of annotations_pb.js another incorrect import is generated so it seems that this problem is carrying through to any imports down the road:
// inside of annotations_pb.js
var google_api_http_pb = require('../../../../../../google/api/http_pb.js');
We wondered how we could resolve this? Generating the files ourselves and copying them is totally ok but the wrongly generated imports inside these files are an issue we can not resolve on our end unfortunately, so any help is appreciated.
Anything else we should know about your project / environment
We use grpc_tools_node_protoc and grpc_tools_node_protoc_ts plugins to generate typescript and grpc code.
Command we execute:
# Variables:
GRPC_GATEWAY_REPO=github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis
GOOGLE_API_REPO=github.com/googleapis/googleapis
VENDOR_DIR=vendor
PROTOC_OPTION=-I. -I$(VENDOR_DIR) -I$(VENDOR_DIR)/$(GRPC_GATEWAY_REPO) -I$(VENDOR_DIR)/$(GOOGLE_API_REPO)
TYPESCRIPT_OUTPUT=gen/typescript
# Command:
grpc_tools_node_protoc $(PROTOC_OPTION) --js_out=import_style=commonjs,binary:$(TYPESCRIPT_OUTPUT) --grpc_out=$(TYPESCRIPT_OUTPUT) --plugin=protoc-gen-grpc=$(shell which grpc_tools_node_protoc_plugin)
# followed by this command for typescript generation:
protoc $(PROTOC_OPTION) --plugin=protoc-gen-ts=`which protoc-gen-ts` --ts_out=$(TYPESCRIPT_OUTPUT)
- Linguagem predominante
- JavaScript
- Estrelas
- 471
- Forks
- 91
- Merge médio
- 1d 12h
- PRs com merge (30d)
- 6
Preparar o ambiente
Ainda não verificamos os arquivos de configuração deste projeto. Comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de protocolbuffers/protobuf-javascript
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 30/100
protocolbuffers/protobuf-javascript#248 · 1 comentário · 13 reações ·
-
question
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 45/100
protocolbuffers/protobuf-javascript#222 · 9 comentários ·
-
Why map.js sort keys?Abertaenhancement port-fix triaged
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
protocolbuffers/protobuf-javascript#185 · 1 comentário ·
-
enhancement port-fix triaged
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
protocolbuffers/protobuf-javascript#182 · 3 comentários · 1 reação ·
Todas as issues de protocolbuffers/protobuf-javascript
Issues semelhantes
-
Complexity: Small P-Feature: Projects page ready for merge team role: back end/devOps role: front end size: 0.25pt
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 88/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 67/100
bellingcat/toolkit#905 ·
-
self-care self-care:docs-build-time-investigator
Dificuldade 2/5 Meio dia Facilidade para iniciantes 76/100
githubnext/gh-aw-cao#14191 ·
Mantenedores costumam responder em até 1 dia
-
effort:low impact:medium RAG status: auto-triaged
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
mastra-ai/mastra#25229 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
sugarlabs/musicblocks#8984 ·
Mantenedores costumam responder em até 1 dia