Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Wrong TypeScript type used for fields when name collision exists between imported and nested messages

Abierto
  • ¿Algo no está bien?
#3,025 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
node.js, typescript
Área
tooling

Línea de trabajo

Comienza ejecutando el comando proto-loader-gen-types reportado con common.proto y service.proto; después, inspecciona el example/Service.ts generado. Sigue cómo el generador resuelve Resource cuando el mensaje anidado tiene el mismo nombre y verifica que el campo generado use el tipo importado e incluya su importación.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

package: @grpc/proto-loader
Problem description

proto-loader-gen-types fails to disambiguate between imported top-level types and nested messages with the same name. When this collision occurs, it incorrectly uses the nested type, omits the required import, and generates types that don't match the protobuf structure. This causes type errors and breaks IDE autocomplete for affected fields.

Reproduction steps

Command:

npx proto-loader-gen-types --longs=String --enums=String --defaults --oneofs -I . --outDir=. common.proto service.proto

common.proto:

syntax = "proto3";
package example;

message Resource {
    int64 id = 1;
    string name = 2;
}

service.proto:

syntax = "proto3";
package example;
import "common.proto";

message Service {
    Resource resource = 1;  // Should reference Resource from common.proto
    
    message Status {
        message Metric {
            message Resource {  // Name collision
                string name = 1;
                int32 value = 2;
            }
        }
    }
}

Expected:

// example/Service.ts
import type { Resource as _example_Resource } from './Resource';

export interface Service {
  resource?: _example_Resource | null;  // Uses imported type
}

Actual:

// example/Service.ts
// Missing import for Resource

export interface Service {
  resource?: _example_Service_Status_Metric_Resource | null;  // Uses wrong nested type
}

Workaround - Manually add the import and fix the type:

import type { Resource as _example_Resource } from './Resource';

export interface Service {
  resource?: _example_Resource | null;  // Fixed
}
Environment

Reproduced with @grpc/[email protected] and @grpc/[email protected] on Ubuntu 22.04 on WSL2 (x86_64) with multiple 16+ Node versions. Node is installed using nvm

Additional context

Python and Go generators seem to handle this correctly:

# Python (protoc)
from example import common_pb2 as _common_pb2
class Service(_message.Message):
    resource: _common_pb2.Resource  # Correct

// Go (protoc-gen-go)
type Service struct {
    Resource *Resource  // Correct
}

// TypeScript (proto-loader-gen-types)
resource?: _example_Service_Status_Metric_Resource | null;  // Wrong
Lenguaje dominante
TypeScript
Estrellas
4.8k
Forks
716
Merge medio
2 d 3 h
PR fusionados (30 d)
10

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de grpc/grpc-node

Todos los issues de grpc/grpc-node

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.