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

/* eslint-disable @typescript-eslint/no-explicit-any */
/* eslint-disable @typescript-eslint/no-non-null-assertion */
/* eslint-disable import/no-extraneous-dependencies */
import { normalize, virtualFs } from '@angular-devkit/core';
import { NodeJsAsyncHost, NodeJsSyncHost } from '@angular-devkit/core/node';
import * as fs from 'fs';
import { Observable, Subscription } from 'rxjs';

const temp = require('temp');

// 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 = temp.mkdirSync('core-node-spec-');
    host = new virtualFs.ScopedHost(new NodeJsAsyncHost(), normalize(root));
  });

  afterEach((done) => host.delete(normalize('/')).toPromise().then(done, done.fail));

  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',
    (done) => {
      let obs: Observable<virtualFs.HostWatchEvent>;
      let subscription: Subscription;
      const content = virtualFs.stringToFileBuffer('hello world');
      const content2 = virtualFs.stringToFileBuffer('hello world 2');
      const allEvents: virtualFs.HostWatchEvent[] = [];

      Promise.resolve()
        .then(() => fs.mkdirSync(root + '/sub1'))
        .then(() => fs.writeFileSync(root + '/sub1/file1', 'hello world'))
        .then(() => {
          obs = host.watch(normalize('/sub1'), { recursive: true })!;
          expect(obs).not.toBeNull();
          subscription = obs.subscribe((event) => {
            allEvents.push(event);
          });
        })
        .then(() => new Promise((resolve) => setTimeout(resolve, 100)))
        // Discard the events registered so far.
        .then(() => allEvents.splice(0))
        .then(() => host.write(normalize('/sub1/sub2/file3'), content).toPromise())
        .then(() => host.write(normalize('/sub1/file2'), content2).toPromise())
        .then(() => host.delete(normalize('/sub1/file1')).toPromise())
        .then(() => new Promise((resolve) => setTimeout(resolve, 2000)))
        .then(() => {
          expect(allEvents.length).toBe(3);
          subscription.unsubscribe();
        })
        .then(done, done.fail);
    },
    30000,
  );
});

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

  beforeEach(() => {
    root = temp.mkdirSync('core-node-spec-');
    host = new virtualFs.SyncDelegateHost(
      new virtualFs.ScopedHost(new NodeJsSyncHost(), normalize(root)),
    );
  });
  afterEach(() => {
    host.delete(normalize('/'));
  });

  linuxOnlyIt(
    'can watch',
    (done) => {
      let obs: Observable<virtualFs.HostWatchEvent>;
      let subscription: Subscription;
      const content = virtualFs.stringToFileBuffer('hello world');
      const content2 = virtualFs.stringToFileBuffer('hello world 2');
      const allEvents: virtualFs.HostWatchEvent[] = [];

      Promise.resolve()
        .then(() => fs.mkdirSync(root + '/sub1'))
        .then(() => fs.writeFileSync(root + '/sub1/file1', 'hello world'))
        .then(() => {
          obs = host.watch(normalize('/sub1'), { recursive: true })!;
          expect(obs).not.toBeNull();
          subscription = obs.subscribe((event) => {
            allEvents.push(event);
          });
        })
        .then(() => new Promise((resolve) => setTimeout(resolve, 100)))
        // Discard the events registered so far.
        .then(() => allEvents.splice(0))
        .then(() => {
          host.write(normalize('/sub1/sub2/file3'), content);
          host.write(normalize('/sub1/file2'), content2);
          host.delete(normalize('/sub1/file1'));
        })
        .then(() => new Promise((resolve) => setTimeout(resolve, 2000)))
        .then(() => {
          expect(allEvents.length).toBe(3);
          subscription.unsubscribe();
        })
        .then(done, done.fail);
    },
    30000,
  );

  linuxOnlyIt(
    'rename to a non-existing dir',
    (done) => {
      Promise.resolve()
        .then(() => fs.mkdirSync(root + '/rename'))
        .then(() => fs.writeFileSync(root + '/rename/a.txt', 'hello world'))
        .then(() => {
          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');
          }
        })
        .then(done, done.fail);
    },
    30000,
  );
});