runtime/observatory/lib/src/elements/instance_ref.dart

// Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'dart:async';

import 'package:web/web.dart';

import 'package:observatory/models.dart' as M;
import 'package:observatory/src/elements/curly_block.dart';
import 'package:observatory/src/elements/field_ref.dart';
import 'package:observatory/src/elements/helpers/any_ref.dart';
import 'package:observatory/src/elements/helpers/custom_element.dart';
import 'package:observatory/src/elements/helpers/element_utils.dart';
import 'package:observatory/src/elements/helpers/rendering_scheduler.dart';
import 'package:observatory/src/elements/helpers/uris.dart';
import 'package:observatory/utils.dart';

class InstanceRefElement extends CustomElement implements Renderable {
  late RenderingScheduler<InstanceRefElement> _r;

  Stream<RenderedEvent<InstanceRefElement>> get onRendered => _r.onRendered;

  late M.IsolateRef _isolate;
  late M.InstanceRef _instance;
  late M.ObjectRepository _objects;
  M.Instance? _loadedInstance;
  late bool _expandable;
  late bool _expanded = false;

  M.IsolateRef get isolate => _isolate;
  M.InstanceRef get instance => _instance;

  factory InstanceRefElement(
      M.IsolateRef isolate, M.InstanceRef instance, M.ObjectRepository objects,
      {RenderingQueue? queue, bool expandable = true}) {
    InstanceRefElement e = new InstanceRefElement.created();
    e._r = new RenderingScheduler<InstanceRefElement>(e, queue: queue);
    e._isolate = isolate;
    e._instance = instance;
    e._objects = objects;
    e._expandable = expandable;
    return e;
  }

  InstanceRefElement.created() : super.created('instance-ref');

  @override
  void attached() {
    super.attached();
    _r.enable();
  }

  @override
  void detached() {
    super.detached();
    removeChildren();
    _r.disable(notify: true);
  }

  void render() {
    final content = _createLink();

    if (_expandable && _hasValue()) {
      content.addAll([
        new HTMLSpanElement()..textContent = ' ',
        (new CurlyBlockElement(expanded: _expanded, queue: _r.queue)
              ..content = <HTMLElement>[
                new HTMLDivElement()
                  ..className = 'indent'
                  ..appendChildren(_createValue())
              ]
              ..onToggle.listen((e) async {
                _expanded = e.control.expanded;
                if (_expanded) {
                  e.control.disabled = true;
                  await _refresh();
                  e.control.disabled = false;
                }
              }))
            .element
      ]);
    }

    children = content;
  }

  Future _refresh() async {
    _loadedInstance = await _objects.get(_isolate, _instance.id!) as M.Instance;
    _r.dirty();
  }

  List<HTMLElement> _createShowMoreButton() {
    if (_loadedInstance!.count == null) {
      return [];
    }
    final count = _loadedInstance!.count;
    final button = new HTMLButtonElement()..textContent = 'show next ${count}';
    button.onClick.listen((_) async {
      button.disabled = true;
      _loadedInstance =
          await _objects.get(_isolate, _instance.id!) as M.Instance;
      _r.dirty();
    });
    return [button];
  }

  List<HTMLElement> _createLink() {
    switch (_instance.kind) {
      case M.InstanceKind.vNull:
      case M.InstanceKind.bool:
      case M.InstanceKind.int:
      case M.InstanceKind.double:
      case M.InstanceKind.float32x4:
      case M.InstanceKind.float64x2:
      case M.InstanceKind.int32x4:
        return [
          new HTMLAnchorElement()
            ..href = Uris.inspect(_isolate, object: _instance)
            ..text = _instance.valueAsString ?? ''
        ];
      case M.InstanceKind.string:
        return [
          new HTMLAnchorElement()
            ..href = Uris.inspect(_isolate, object: _instance)
            ..text = Utils.formatStringAsLiteral(
                _instance.valueAsString!, _instance.valueAsStringIsTruncated!)
        ];
      case M.InstanceKind.type:
      case M.InstanceKind.functionType:
      case M.InstanceKind.typeParameter:
      case M.InstanceKind.recordType:
        return [
          new HTMLAnchorElement()
            ..href = Uris.inspect(_isolate, object: _instance)
            ..text = _instance.name ?? ''
        ];
      case M.InstanceKind.closure:
        return [
          new HTMLAnchorElement()
            ..href = Uris.inspect(_isolate, object: _instance)
            ..appendChildren(<HTMLElement>[
              new HTMLSpanElement()
                ..className = 'emphasize'
                ..textContent = 'Closure',
              new HTMLSpanElement()
                ..textContent = ' (${_instance.closureFunction!.name})'
            ])
        ];
      case M.InstanceKind.regExp:
        return [
          new HTMLAnchorElement()
            ..href = Uris.inspect(_isolate, object: _instance)
            ..appendChildren(<HTMLElement>[
              new HTMLSpanElement()
                ..className = 'emphasize'
                ..textContent = _instance.clazz!.name ?? '',
              new HTMLSpanElement()
                ..textContent = ' (${_instance.pattern!.valueAsString})'
            ])
        ];
      case M.InstanceKind.userTag:
        return [
          new HTMLAnchorElement()
            ..href = Uris.inspect(_isolate, object: _instance)
            ..appendChildren(<HTMLElement>[
              new HTMLSpanElement()
                ..className = 'emphasize'
                ..textContent = _instance.clazz!.name ?? '',
              new HTMLSpanElement()..textContent = ' (${_instance.name})'
            ])
        ];
      case M.InstanceKind.stackTrace:
        return [
          new HTMLAnchorElement()
            ..href = Uris.inspect(_isolate, object: _instance)
            ..appendChildren(<HTMLElement>[
              new HTMLSpanElement()
                ..className = 'emphasize'
                ..textContent = _instance.clazz!.name ?? '',
            ])
        ];
      case M.InstanceKind.plainInstance:
      case M.InstanceKind.receivePort:
        return [
          new HTMLAnchorElement()
            ..href = Uris.inspect(_isolate, object: _instance)
            ..className = 'emphasize'
            ..text = _instance.clazz!.name ?? ''
        ];
      case M.InstanceKind.list:
      case M.InstanceKind.map:
      case M.InstanceKind.set:
      case M.InstanceKind.uint8ClampedList:
      case M.InstanceKind.uint8List:
      case M.InstanceKind.uint16List:
      case M.InstanceKind.uint32List:
      case M.InstanceKind.uint64List:
      case M.InstanceKind.int8List:
      case M.InstanceKind.int16List:
      case M.InstanceKind.int32List:
      case M.InstanceKind.int64List:
      case M.InstanceKind.float32List:
      case M.InstanceKind.float64List:
      case M.InstanceKind.int32x4List:
      case M.InstanceKind.float32x4List:
      case M.InstanceKind.float64x2List:
        return [
          new HTMLAnchorElement()
            ..href = Uris.inspect(_isolate, object: _instance)
            ..appendChildren(<HTMLElement>[
              new HTMLSpanElement()
                ..className = 'emphasize'
                ..textContent = _instance.clazz!.name ?? '',
              new HTMLSpanElement()..textContent = ' (${_instance.length})'
            ])
        ];
      case M.InstanceKind.mirrorReference:
      case M.InstanceKind.weakProperty:
      case M.InstanceKind.finalizer:
      case M.InstanceKind.nativeFinalizer:
      case M.InstanceKind.finalizerEntry:
      case M.InstanceKind.weakReference:
      case M.InstanceKind.record:
        return [
          HTMLAnchorElement()
            ..href = Uris.inspect(_isolate, object: _instance)
            ..className = 'emphasize'
            ..textContent = _instance.clazz!.name ?? ''
        ];
      default:
        throw new Exception('Unknown InstanceKind: ${_instance.kind}');
    }
  }

  bool _hasValue() {
    switch (_instance.kind) {
      case M.InstanceKind.closure:
      case M.InstanceKind.plainInstance:
      case M.InstanceKind.mirrorReference:
      case M.InstanceKind.stackTrace:
      case M.InstanceKind.weakReference:
      case M.InstanceKind.weakProperty:
      case M.InstanceKind.recordType:
      case M.InstanceKind.finalizer:
      case M.InstanceKind.nativeFinalizer:
      case M.InstanceKind.finalizerEntry:
        return true;
      case M.InstanceKind.list:
      case M.InstanceKind.map:
      case M.InstanceKind.set:
      case M.InstanceKind.uint8ClampedList:
      case M.InstanceKind.uint8List:
      case M.InstanceKind.uint16List:
      case M.InstanceKind.uint32List:
      case M.InstanceKind.uint64List:
      case M.InstanceKind.int8List:
      case M.InstanceKind.int16List:
      case M.InstanceKind.int32List:
      case M.InstanceKind.int64List:
      case M.InstanceKind.float32List:
      case M.InstanceKind.float64List:
      case M.InstanceKind.int32x4List:
      case M.InstanceKind.float32x4List:
      case M.InstanceKind.float64x2List:
        return _instance.length! > 0;
      default:
        return false;
    }
  }

  List<HTMLElement> _createValue() {
    if (_loadedInstance == null) {
      return [new HTMLSpanElement()..textContent = 'Loading...'];
    }
    switch (_instance.kind) {
      case M.InstanceKind.closure:
        {
          var members = <HTMLElement>[];
          if (_loadedInstance!.closureFunction != null) {
            members.add(new HTMLDivElement()
              ..appendChildren(<HTMLElement>[
                new HTMLSpanElement()..textContent = 'function = ',
                anyRef(_isolate, _loadedInstance!.closureFunction, _objects,
                    queue: _r.queue)
              ]));
          }
          if (_loadedInstance!.closureContext != null) {
            members.add(new HTMLDivElement()
              ..appendChildren(<HTMLElement>[
                new HTMLSpanElement()..textContent = 'context = ',
                anyRef(_isolate, _loadedInstance!.closureContext, _objects,
                    queue: _r.queue)
              ]));
          }
          if (_loadedInstance!.closureReceiver != null) {
            members.add(new HTMLDivElement()
              ..appendChildren(<HTMLElement>[
                new HTMLSpanElement()..textContent = 'receiver = ',
                anyRef(_isolate, _loadedInstance!.closureReceiver, _objects,
                    queue: _r.queue)
              ]));
          }
          return members;
        }
      case M.InstanceKind.plainInstance:
        return _loadedInstance!.fields!
            .map<HTMLElement>((f) => new HTMLDivElement()
              ..appendChildren(<HTMLElement>[
                new FieldRefElement(_isolate, f.decl!, _objects,
                        queue: _r.queue)
                    .element,
                new HTMLSpanElement()..textContent = ' = ',
                anyRef(_isolate, f.value, _objects, queue: _r.queue)
              ]))
            .toList();
      case M.InstanceKind.list:
        var index = 0;
        return _loadedInstance!.elements!
            .map<HTMLElement>((element) => new HTMLDivElement()
              ..appendChildren(<HTMLElement>[
                new HTMLSpanElement()..textContent = '[ ${index++} ] : ',
                anyRef(_isolate, element, _objects, queue: _r.queue)
              ]))
            .toList()
          ..addAll(_createShowMoreButton());
      case M.InstanceKind.map:
        return _loadedInstance!.associations!
            .map<HTMLElement>((association) => new HTMLDivElement()
              ..appendChildren(<HTMLElement>[
                new HTMLSpanElement()..textContent = '[ ',
                anyRef(_isolate, association.key, _objects, queue: _r.queue),
                new HTMLSpanElement()..textContent = ' ] : ',
                anyRef(_isolate, association.value, _objects, queue: _r.queue)
              ]))
            .toList()
          ..addAll(_createShowMoreButton());
      case M.InstanceKind.set:
        return _loadedInstance!.elements!
            .map<HTMLElement>((element) => new HTMLDivElement()
              ..appendChildren(<HTMLElement>[
                anyRef(_isolate, element, _objects, queue: _r.queue)
              ]))
            .toList()
          ..addAll(_createShowMoreButton());
      case M.InstanceKind.uint8ClampedList:
      case M.InstanceKind.uint8List:
      case M.InstanceKind.uint16List:
      case M.InstanceKind.uint32List:
      case M.InstanceKind.uint64List:
      case M.InstanceKind.int8List:
      case M.InstanceKind.int16List:
      case M.InstanceKind.int32List:
      case M.InstanceKind.int64List:
      case M.InstanceKind.float32List:
      case M.InstanceKind.float64List:
      case M.InstanceKind.int32x4List:
      case M.InstanceKind.float32x4List:
      case M.InstanceKind.float64x2List:
        var index = 0;
        return _loadedInstance!.typedElements!
            .map<HTMLElement>((e) =>
                new HTMLDivElement()..textContent = '[ ${index++} ] : $e')
            .toList()
          ..addAll(_createShowMoreButton());
      case M.InstanceKind.mirrorReference:
        return [
          new HTMLSpanElement()..textContent = '<referent> : ',
          anyRef(_isolate, _loadedInstance!.referent, _objects, queue: _r.queue)
        ];
      case M.InstanceKind.stackTrace:
        return [
          new HTMLDivElement()
            ..className = 'stackTraceBox'
            ..textContent = _instance.valueAsString ?? ''
        ];
      case M.InstanceKind.weakReference:
        return [
          new HTMLSpanElement()..textContent = '<target> : ',
          anyRef(_isolate, _loadedInstance!.target, _objects, queue: _r.queue)
        ];
      case M.InstanceKind.weakProperty:
        return [
          new HTMLSpanElement()..textContent = '<key> : ',
          anyRef(_isolate, _loadedInstance!.key!, _objects, queue: _r.queue),
          new HTMLBRElement(),
          new HTMLSpanElement()..textContent = '<value> : ',
          anyRef(_isolate, _loadedInstance!.value!, _objects, queue: _r.queue),
        ];
      case M.InstanceKind.recordType:
        final fields = _loadedInstance!.fields!.toList();
        return [
          for (int i = 0; i < fields.length; ++i) ...[
            new HTMLSpanElement()..textContent = '${fields[i].name} = ',
            new InstanceRefElement(
                    _isolate, fields[i].value!.asValue!, _objects,
                    queue: _r.queue)
                .element,
            if (i + 1 != fields.length) new HTMLBRElement(),
          ]
        ];
      case M.InstanceKind.finalizer:
        return [
          new HTMLSpanElement()..textContent = 'callback = ',
          anyRef(_isolate, _loadedInstance!.callback!, _objects,
              queue: _r.queue),
          new HTMLBRElement(),
          new HTMLSpanElement()..textContent = 'allEntries = ',
          anyRef(_isolate, _loadedInstance!.allEntries!, _objects,
              queue: _r.queue),
        ];
      case M.InstanceKind.nativeFinalizer:
        return [
          new HTMLSpanElement()..textContent = 'allEntries = ',
          anyRef(_isolate, _loadedInstance!.allEntries!, _objects,
              queue: _r.queue),
        ];
      case M.InstanceKind.finalizerEntry:
        return [
          new HTMLSpanElement()..textContent = 'value = ',
          anyRef(_isolate, _loadedInstance!.value!, _objects, queue: _r.queue),
          new HTMLBRElement(),
          new HTMLSpanElement()..textContent = 'detach = ',
          anyRef(_isolate, _loadedInstance!.detach!, _objects, queue: _r.queue),
          new HTMLBRElement(),
          new HTMLSpanElement()..textContent = 'token = ',
          anyRef(_isolate, _loadedInstance!.token!, _objects, queue: _r.queue),
        ];
      default:
        return [];
    }
  }
}