host_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
 */

/* eslint-disable @typescript-eslint/no-non-null-assertion */
import * as fs from 'fs';
import { tmpdir } from 'os';
import { join } from 'path';
import { normalize, virtualFs } from '../src';
import { NodeJsAsyncHost, NodeJsSyncHost } from './host';

// TODO: replace this with an "it()" macro that's reusable globally.
let linuxOnlyIt: typeof it = it;
if (process.platform.startsWith('win') || process.platform.startsWith('darwin')) {
  linuxOnlyIt = xit;
}

describe('NodeJsAsyncHost', () => {
  let root: string;
  let host: virtualFs.Host<fs.Stats>;

  beforeEach(() => {
    root = fs.mkdtempSync(join(fs.realpathSync(tmpdir()), 'core-node-spec-'));
    host = new virtualFs.ScopedHost(new NodeJsAsyncHost(), normalize(root));
  });

  afterEach(async () => host.delete(normalize('/')).toPromise());

  it('should get correct result for exists', async () => {
    const filePath = normalize('not-found');
    expect(await host.exists(filePath).toPromise()).toBeFalse();
    await host.write(filePath, virtualFs.stringToFileBuffer('content')).toPromise();
    expect(await host.exists(filePath).toPromise()).toBeTrue();
  });

  linuxOnlyIt(
    'can watch',
    async () => {
      const content = virtualFs.stringToFileBuffer('hello world');
      const content2 = virtualFs.stringToFileBuffer('hello world 2');
      const allEvents: virtualFs.HostWatchEvent[] = [];

      fs.mkdirSync(root + '/sub1');
      fs.writeFileSync(root + '/sub1/file1', 'hello world');

      const obs = host.watch(normalize('/sub1'), { recursive: true });
      expect(obs).toBeDefined();
      const subscription = obs!.subscribe((event) => {
        allEvents.push(event);
      });
      await new Promise((resolve) => setTimeout(resolve, 100));

      // Discard the events registered so far.
      allEvents.splice(0);
      await host.write(normalize('/sub1/sub2/file3'), content).toPromise();
      await host.write(normalize('/sub1/file2'), content2).toPromise();
      await host.delete(normalize('/sub1/file1')).toPromise();

      await new Promise((resolve) => setTimeout(resolve, 2000));
      expect(allEvents.length).toBe(3);
      subscription.unsubscribe();
    },
    30000,
  );
});

describe('NodeJsSyncHost', () => {
  let root: string;
  let host: virtualFs.SyncDelegateHost<fs.Stats>;

  beforeEach(() => {
    root = fs.mkdtempSync(join(fs.realpathSync(tmpdir()), 'core-node-spec-'));
    host = new virtualFs.SyncDelegateHost(
      new virtualFs.ScopedHost(new NodeJsSyncHost(), normalize(root)),
    );
  });
  afterEach(() => {
    host.delete(normalize('/'));
  });

  linuxOnlyIt(
    'can watch',
    async () => {
      const content = virtualFs.stringToFileBuffer('hello world');
      const content2 = virtualFs.stringToFileBuffer('hello world 2');
      const allEvents: virtualFs.HostWatchEvent[] = [];

      fs.mkdirSync(root + '/sub1');
      fs.writeFileSync(root + '/sub1/file1', 'hello world');

      const obs = host.watch(normalize('/sub1'), { recursive: true });
      expect(obs).toBeDefined();
      const subscription = obs!.subscribe((event) => {
        allEvents.push(event);
      });
      await new Promise((resolve) => setTimeout(resolve, 100));

      // Discard the events registered so far.
      allEvents.splice(0);

      host.write(normalize('/sub1/sub2/file3'), content);
      host.write(normalize('/sub1/file2'), content2);
      host.delete(normalize('/sub1/file1'));
      await new Promise((resolve) => setTimeout(resolve, 2000));

      expect(allEvents.length).toBe(3);
      subscription.unsubscribe();
    },
    30000,
  );

  linuxOnlyIt(
    'rename to a non-existing dir',
    () => {
      fs.mkdirSync(root + '/rename');
      fs.writeFileSync(root + '/rename/a.txt', 'hello world');

      host.rename(normalize('/rename/a.txt'), normalize('/rename/b/c/d/a.txt'));
      if (fs.existsSync(root + '/rename/b/c/d/a.txt')) {
        const resContent = host.read(normalize('/rename/b/c/d/a.txt'));
        const content = virtualFs.fileBufferToString(resContent);
        expect(content).toEqual('hello world');
      }
    },
    30000,
  );
});