angular/packages/forms/signals/test/node/field_context.spec.ts

/**
 * @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.dev/license
 */

import {Injector, signal, WritableSignal} from '@angular/core';
import {TestBed} from '@angular/core/testing';
import {
  applyEach,
  createMetadataKey,
  FieldContext,
  form,
  metadata,
  PathKind,
  SchemaPath,
  SchemaPathTree,
  validate,
} from '../../public_api';

function testContext<T>(
  s: WritableSignal<T>,
  callback: (ctx: FieldContext<T>, p: SchemaPathTree<T>) => void,
) {
  const isCalled = jasmine.createSpy();

  TestBed.runInInjectionContext(() => {
    const f = form<T>(s, (p) => {
      validate(p as SchemaPath<T>, (ctx) => {
        callback(ctx, p);
        isCalled();
        return undefined;
      });
    });

    f().errors();
  });

  expect(isCalled).toHaveBeenCalled();
}

describe('Field Context', () => {
  it('value', () => {
    const cat = signal({name: 'pirojok-the-cat', age: 5});
    testContext(cat, (ctx) => {
      expect(ctx.value().name).toEqual('pirojok-the-cat');
    });
  });

  it('state', () => {
    const cat = signal({name: 'pirojok-the-cat', age: 5});
    testContext(cat, (ctx) => {
      expect(ctx.state.value().name).toEqual('pirojok-the-cat');
    });
  });

  it('fieldTree', () => {
    const cat = signal({name: 'pirojok-the-cat', age: 5});
    testContext(cat, (ctx) => {
      expect(ctx.fieldTree.name().value()).toEqual('pirojok-the-cat');
      expect(ctx.fieldTree.age().value()).toEqual(5);
    });
  });

  it('key', () => {
    const keys: string[] = [];
    const recordKey = ({key}: FieldContext<unknown, PathKind.Child>) => {
      try {
        keys.push(key());
      } catch (e) {
        keys.push((e as Error).message);
      }
      return undefined;
    };
    const cat = signal({name: 'pirojok-the-cat', age: 5});
    const f = form(
      cat,
      (p) => {
        // @ts-expect-error
        validate(p, recordKey);
        validate(p.name, recordKey);
        validate(p.age, recordKey);
      },
      {injector: TestBed.inject(Injector)},
    );
    f().valid();
    expect(keys).toEqual([
      jasmine.stringContaining('NG01905'), // SIGNAL_FORMS_ROOT_FIELD_NO_PARENT
      'name',
      'age',
    ]);
  });

  it('index', () => {
    const indices: (string | number)[] = [];
    const recordIndex = ({index}: FieldContext<unknown, PathKind.Item>) => {
      try {
        indices.push(index());
      } catch (e) {
        indices.push((e as Error).message);
      }
      return undefined;
    };
    const pets = signal({
      cats: [
        {name: 'pirojok-the-cat', age: 5},
        {name: 'mielo', age: 10},
      ],
      owner: 'joe',
    });
    const f = form(
      pets,
      (p) => {
        // @ts-expect-error
        validate(p, recordIndex);
        applyEach(p.cats, (cat) => {
          validate(cat, recordIndex);
        });
        // @ts-expect-error
        validate(p.owner, recordIndex);
      },
      {injector: TestBed.inject(Injector)},
    );
    f().valid();
    expect(indices).toEqual([
      jasmine.stringContaining('NG01905'), // SIGNAL_FORMS_ROOT_FIELD_NO_PARENT
      0,
      1,
      jasmine.stringContaining('NG01906'), // SIGNAL_FORMS_PARENT_NOT_ARRAY
    ]);
  });

  it('pathKeys', () => {
    const KEYS = createMetadataKey({
      reduce: (_: readonly string[], n: readonly string[]) => n,
      getInitial: () => [],
    });
    const f = form(
      signal({x: [1]}),
      (p) => {
        metadata(p, KEYS, ({pathKeys}) => pathKeys());
        metadata(p.x, KEYS, ({pathKeys}) => pathKeys());
        applyEach(p.x, (it) => {
          metadata(it, KEYS, ({pathKeys}) => pathKeys());
        });
      },
      {injector: TestBed.inject(Injector)},
    );
    expect(f().metadata(KEYS)?.()).toEqual([]);
    expect(f.x().metadata(KEYS)?.()).toEqual(['x']);
    expect(f.x[0]().metadata(KEYS)?.()).toEqual(['x', '0']);
  });

  it('valueOf', () => {
    const cat = signal({name: 'pirojok-the-cat', age: 5});
    testContext(cat, (ctx, p) => {
      expect(ctx.valueOf(p.name)).toEqual('pirojok-the-cat');
      expect(ctx.valueOf(p.age)).toEqual(5);
    });
  });

  it('stateOf', () => {
    const cat = signal({name: 'pirojok-the-cat', age: 5});
    testContext(cat, (ctx, p) => {
      expect(ctx.stateOf(p.name).value()).toEqual('pirojok-the-cat');
      expect(ctx.stateOf(p.age).value()).toEqual(5);
    });
  });

  it('fieldTreeOf', () => {
    const cat = signal({name: 'pirojok-the-cat', age: 5});
    testContext(cat, (ctx, p) => {
      expect(ctx.fieldTreeOf(p.name)().value()).toEqual('pirojok-the-cat');
      expect(ctx.fieldTreeOf(p.age)().value()).toEqual(5);
    });
  });
});