Deprecate the profilerOutputDir profiler and name Java members in V8/DevTools profiles

Abierto
#2,100 0 comentarios 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
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
android, cpp

Línea de trabajo

Start by reading Profiler.cpp, MetadataNode::Wrap, and the core and CLI declarations for profilerOutputDir; the issue also points to @nativescript/core/profiling and the follow-up to #2099. Compare DevTools profiles for the listed Java constructors, methods, fields, and functions created by extend or interface implementations, then review V8's naming APIs. Done means the legacy profiler's deprecation or removal path is resolved and Java members have useful profile names; the issue leaves API compatibility decisions open.

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

Descripción

improvement

Is your feature request related to a problem? Please describe.

The runtime ships a legacy profiler, added in 2016 (d81045c76), next to the Chrome DevTools profiler:

  • Profiler.cpp always installs three globals:
    • __startCPUProfiler(name) and __stopCPUProfiler(name) wrap V8's CpuProfiler, and stopping writes <profilerOutputDir>/<app>-<name>-<time>.cpuprofile.
    • __heapSnapshot() writes a .heapsnapshot file to the same directory.
  • Setting android.profilerOutputDir also turns on MetadataNode::Wrap. That compiles a named JS wrapper around every Java class constructor and every Java method (function getAlpha() { return getAlpha.__func.apply(this, arguments); }) so that profiles show Java member names. The wrappers add a JS frame to every call and replace the functions apps see. In that mode a wrapper's prototype.constructor is the inner function, not the class the app sees.

As far as I can tell nobody uses it:

  • nothing in core, the CLI, the plugins or angular sets profilerOutputDir;
  • with the default empty value, Write builds a path at / and fails, so the globals produce nothing unless the option is set.

The only consumers I found are @nativescript/core/profiling's startCPUProfile/stopCPUProfile, which call these globals on Android, and the profilerOutputDir entries in core's config.interface.ts and the CLI's project.d.ts.

The DevTools CPU and heap profilers cover the same ground through the inspector, with a better workflow. The one thing the legacy profiler does that they don't is to start and stop from app code with no inspector attached.

Describe the solution you'd like

  1. Deprecate the legacy profiler.

    • Log a deprecation warning when profilerOutputDir is set.
    • Remove MetadataNode::Wrap and s_profilerEnabled in the next major release.
    • Decide what happens to __startCPUProfiler/__stopCPUProfiler/__heapSnapshot, and to core's startCPUProfile/stopCPUProfile:
      • remove them along with the profiler;
      • or keep them as thin helpers that write to the app's files directory by default, for profiling a release build without an inspector.
    • Deprecate profilerOutputDir in core's config types and the CLI's typings at the same time.
  2. Make V8/DevTools profiles more informative instead. Java members should show up under useful names in a DevTools CPU profile without wrapper functions. Start by checking what a profile shows today for:

    • Java class constructors (FunctionTemplate::SetClassName is already set to the dotted Java name);
    • instance and static methods (prototype template functions);
    • field accessors and static members;
    • functions created by extend and interface implementations.

    Then fill the gaps with V8's naming APIs: FunctionTemplate::SetClassName, Function::SetName, or naming the template functions after their property keys. Where a name alone is ambiguous across overloads or same-named methods of different classes, include the declaring class, e.g. android.view.View.getAlpha.

    • Optionally, label the time spent in the JS↔Java bridge: callback dispatch from Java, argument conversion and ObjectManager wrapper creation. A DevTools profile could then tell bridge overhead apart from app JS. V8's CPU profiler supports embedder states and trace events that could carry this.

Describe alternatives you've considered

  • Keep the profiler as is. It costs little at runtime when off: Wrap returns the function unchanged unless profilerOutputDir is set. But it is unmaintained, undocumented, and has semantic quirks when on.
  • Keep only the wrapper naming. It changes the functions apps see and adds a frame per call, so it distorts the very profiles it is meant to label.

Additional context

This came up while optimizing JS wrapper creation for Java objects, in the follow-up to #2099. Dropping a wrapper's own constructor property only made a difference in this profiler mode, where wrapper.constructor now resolves to the inner, unwrapped constructor, as new-created instances already did.

Lenguaje dominante
C++
Estrellas
565
Forks
147
Merge medio
1 d 2 h
PR fusionados (30 d)
27

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 NativeScript/android

Todos los issues de NativeScript/android

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.