/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.io/license
 */

import ts from 'typescript';
import {InputNode} from '../input_detection/input_node';
import {ProgramInfo, projectFile} from '../../../../utils/tsurge';
import {MigrationHost} from '../migration_host';
import {
  ClassFieldDescriptor,
  ClassFieldUniqueKey,
} from '../passes/reference_resolution/known_fields';

/**
 * Interface that describes an input recognized in the
 * migration and project.
 */
export interface InputDescriptor extends ClassFieldDescriptor {
  node: InputNode;
}

/**
 * Gets the descriptor for the given input node.
 *
 * An input descriptor describes a recognized input in the
 * whole project (regardless of batching) and allows easy
 * access to the associated TypeScript declaration node, while
 * also providing a unique key for the input that can be used
 * for serializable communication between compilation units
 * (e.g. when running via batching; in e.g. go/tsunami).
 */
export function getInputDescriptor(host: MigrationHost, node: InputNode): InputDescriptor;
export function getInputDescriptor(info: ProgramInfo, node: InputNode): InputDescriptor;
export function getInputDescriptor(
  hostOrInfo: ProgramInfo | MigrationHost,
  node: InputNode,
): InputDescriptor {
  let className: string;
  if (ts.isAccessor(node)) {
    className = node.parent.name?.text || '<anonymous>';
  } else {
    className = node.parent.name?.text ?? '<anonymous>';
  }

  const info = hostOrInfo instanceof MigrationHost ? hostOrInfo.programInfo : hostOrInfo;
  const file = projectFile(node.getSourceFile(), info);
  // Inputs may be detected in `.d.ts` files. Ensure that if the file IDs
  // match regardless of extension. E.g. `/google3/blaze-out/bin/my_file.ts` should
  // have the same ID as `/google3/my_file.ts`.
  const id = file.id.replace(/\.d\.ts$/, '.ts');

  return {
    key: `${id}@@${className}@@${node.name.text}` as unknown as ClassFieldUniqueKey,
    node,
  };
}

/** Whether the given value is an input descriptor. */
export function isInputDescriptor(v: unknown): v is InputDescriptor {
  return (
    (v as Partial<InputDescriptor>).key !== undefined &&
    (v as Partial<InputDescriptor>).node !== undefined
  );
}
