sketches-service-impl.slow-test.ts

import {
  Disposable,
  DisposableCollection,
} from '@theia/core/lib/common/disposable';
import { isWindows } from '@theia/core/lib/common/os';
import { URI } from '@theia/core/lib/common/uri';
import { FileUri } from '@theia/core/lib/node/file-uri';
import { Container } from '@theia/core/shared/inversify';
import { expect } from 'chai';
import { rejects } from 'node:assert/strict';
import { promises as fs } from 'node:fs';
import path, { basename, join } from 'node:path';
import { sync as rimrafSync } from 'rimraf';
import temp from 'temp';
import { Sketch, SketchesError, SketchesService } from '../../common/protocol';
import {
  SketchesServiceImpl,
  isAccessibleSketchPath,
} from '../../node/sketches-service-impl';
import { ErrnoException } from '../../node/utils/errors';
import { createBaseContainer, startDaemon } from './node-test-bindings';

const testTimeout = 10_000;

describe('isAccessibleSketchPath', () => {
  let tracked: typeof temp;
  let testDirPath: string;

  before(() => (tracked = temp.track()));
  beforeEach(() => (testDirPath = tracked.mkdirSync()));
  after(() => tracked.cleanupSync());

  it('should be accessible by the main sketch file', async () => {
    const sketchFolderPath = join(testDirPath, 'my_sketch');
    const mainSketchFilePath = join(sketchFolderPath, 'my_sketch.ino');
    await fs.mkdir(sketchFolderPath, { recursive: true });
    await fs.writeFile(mainSketchFilePath, '', { encoding: 'utf8' });
    const actual = await isAccessibleSketchPath(mainSketchFilePath);
    expect(actual).to.be.equal(mainSketchFilePath);
  });

  it('should be accessible by the sketch folder', async () => {
    const sketchFolderPath = join(testDirPath, 'my_sketch');
    const mainSketchFilePath = join(sketchFolderPath, 'my_sketch.ino');
    await fs.mkdir(sketchFolderPath, { recursive: true });
    await fs.writeFile(mainSketchFilePath, '', { encoding: 'utf8' });
    const actual = await isAccessibleSketchPath(sketchFolderPath);
    expect(actual).to.be.equal(mainSketchFilePath);
  });

  it('should be accessible when the sketch folder and main sketch file basenames are different', async () => {
    const sketchFolderPath = join(testDirPath, 'my_sketch');
    const mainSketchFilePath = join(sketchFolderPath, 'other_name_sketch.ino');
    await fs.mkdir(sketchFolderPath, { recursive: true });
    await fs.writeFile(mainSketchFilePath, '', { encoding: 'utf8' });
    const actual = await isAccessibleSketchPath(sketchFolderPath);
    expect(actual).to.be.equal(mainSketchFilePath);
  });

  it('should be deterministic (and sort by basename) when multiple sketch files exist', async () => {
    const sketchFolderPath = join(testDirPath, 'my_sketch');
    const aSketchFilePath = join(sketchFolderPath, 'a.ino');
    const bSketchFilePath = join(sketchFolderPath, 'b.ino');
    await fs.mkdir(sketchFolderPath, { recursive: true });
    await fs.writeFile(aSketchFilePath, '', { encoding: 'utf8' });
    await fs.writeFile(bSketchFilePath, '', { encoding: 'utf8' });
    const actual = await isAccessibleSketchPath(sketchFolderPath);
    expect(actual).to.be.equal(aSketchFilePath);
  });

  it('should ignore EACCESS', async function () {
    const sketchFolderPath = join(testDirPath, 'my_sketch');
    const mainSketchFilePath = join(sketchFolderPath, 'my_sketch.ino');
    await fs.mkdir(sketchFolderPath, { recursive: true });
    await fs.writeFile(mainSketchFilePath, '', { encoding: 'utf8' });
    await fs.chmod(mainSketchFilePath, 0o000); // remove all permissions
    try {
      await fs.readFile(mainSketchFilePath);
      // If reading the file without sufficient permissions does not result in EACCESS error, do not run the test.
      // For example, a `stat` syscall does not result in an EACCESS on Windows after stripping the file permissions.
      // an `open` syscall would, but IDE2 on purpose does not check the files.
      // the sketch files are provided by the CLI after loading the sketch.
      console.info(
        'Skip. Reading the file content without permissions was successful.'
      );
      return this.skip();
    } catch (err) {
      expect(
        ErrnoException.isEACCES(err),
        `Expected an error with EACCES code. Got: ${
          typeof err === 'object' ? JSON.stringify(err) : err
        }`
      ).to.be.true;
    }
    const actual = await isAccessibleSketchPath(sketchFolderPath);
    expect(actual).to.be.equal(mainSketchFilePath);
  });

  it("should not be accessible when there are no '.ino' files in the folder", async () => {
    const sketchFolderPath = join(testDirPath, 'my_sketch');
    await fs.mkdir(sketchFolderPath, { recursive: true });
    const actual = await isAccessibleSketchPath(sketchFolderPath);
    expect(actual).to.be.undefined;
  });

  it("should not be accessible when the main sketch file extension is not '.ino'", async () => {
    const sketchFolderPath = join(testDirPath, 'my_sketch');
    const mainSketchFilePath = join(sketchFolderPath, 'my_sketch.cpp');
    await fs.mkdir(sketchFolderPath, { recursive: true });
    await fs.writeFile(mainSketchFilePath, '', { encoding: 'utf8' });
    const actual = await isAccessibleSketchPath(sketchFolderPath);
    expect(actual).to.be.undefined;
  });

  it('should handle ENOENT', async () => {
    const sketchFolderPath = join(testDirPath, 'my_sketch');
    const actual = await isAccessibleSketchPath(sketchFolderPath);
    expect(actual).to.be.undefined;
  });

  it('should handle UNKNOWN (Windows)', async function () {
    if (!isWindows) {
      return this.skip();
    }
    this.timeout(60_000);
    const actual = await isAccessibleSketchPath('\\\\10.0.0.200\\path');
    expect(actual).to.be.undefined;
  });
});

describe('sketches-service-impl', () => {
  let container: Container;
  let toDispose: DisposableCollection;

  before(async () => {
    toDispose = new DisposableCollection();
    container = await createContainer();
    await start(container, toDispose);
  });

  after(() => toDispose.dispose());

  describe('copy', function () {
    this.timeout(testTimeout);
    this.slow(250);

    it('should error when the destination sketch folder name is invalid', async () => {
      const sketchesService =
        container.get<SketchesServiceImpl>(SketchesService);
      const tempDirPath = await sketchesService['createTempFolder']();
      const destinationPath = join(tempDirPath, 'invalid with spaces');
      const sketch = await sketchesService.createNewSketch();
      toDispose.push(disposeSketch(sketch));
      await rejects(
        sketchesService.copy(sketch, {
          destinationUri: FileUri.create(destinationPath).toString(),
        }),
        SketchesError.InvalidFolderName.is
      );
    });

    it('should error when the destination sketch folder name collides with an existing sketch file name', async () => {
      const sketchesService =
        container.get<SketchesServiceImpl>(SketchesService);
      const tempDirPath = await sketchesService['createTempFolder']();
      const destinationPath = join(tempDirPath, 'ExistingSketchFile');
      let sketch = await sketchesService.createNewSketch();
      toDispose.push(disposeSketch(sketch));
      const sourcePath = FileUri.fsPath(sketch.uri);
      const otherInoBasename = 'ExistingSketchFile.ino';
      const otherInoPath = join(sourcePath, otherInoBasename);
      await fs.writeFile(otherInoPath, '// a comment', { encoding: 'utf8' });

      sketch = await sketchesService.loadSketch(sketch.uri);
      expect(Sketch.isInSketch(FileUri.create(otherInoPath), sketch)).to.be
        .true;

      await rejects(
        sketchesService.copy(sketch, {
          destinationUri: FileUri.create(destinationPath).toString(),
        }),
        (reason) => {
          return (
            typeof reason === 'object' &&
            reason !== null &&
            SketchesError.SketchAlreadyContainsThisFile.is(reason) &&
            reason.data.existingSketchFilename === otherInoBasename
          );
        }
      );
    });

    it('should copy a sketch when the destination does not exist', async () => {
      const sketchesService =
        container.get<SketchesServiceImpl>(SketchesService);
      const tempDirPath = await sketchesService['createTempFolder']();
      const destinationPath = join(tempDirPath, 'Does_Not_Exist_but_valid');
      await rejects(fs.readdir(destinationPath), ErrnoException.isENOENT);
      let sketch = await sketchesService.createNewSketch();
      toDispose.push(disposeSketch(sketch));
      const sourcePath = FileUri.fsPath(sketch.uri);
      const libBasename = 'lib.cpp';
      const libContent = 'lib content';
      const libPath = join(sourcePath, libBasename);
      await fs.writeFile(libPath, libContent, { encoding: 'utf8' });
      const headerBasename = 'header.h';
      const headerContent = 'header content';
      const headerPath = join(sourcePath, headerBasename);
      await fs.writeFile(headerPath, headerContent, { encoding: 'utf8' });

      sketch = await sketchesService.loadSketch(sketch.uri);
      expect(Sketch.isInSketch(FileUri.create(libPath), sketch)).to.be.true;
      expect(Sketch.isInSketch(FileUri.create(headerPath), sketch)).to.be.true;

      const copied = await sketchesService.copy(sketch, {
        destinationUri: FileUri.create(destinationPath).toString(),
      });
      toDispose.push(disposeSketch(copied));
      expect(copied.name).to.be.equal(basename(destinationPath));
      expect(
        Sketch.isInSketch(
          FileUri.create(
            join(destinationPath, `${basename(destinationPath)}.ino`)
          ),
          copied
        )
      ).to.be.true;
      expect(
        Sketch.isInSketch(
          FileUri.create(join(destinationPath, libBasename)),
          copied
        )
      ).to.be.true;
      expect(
        Sketch.isInSketch(
          FileUri.create(join(destinationPath, headerBasename)),
          copied
        )
      ).to.be.true;
    });

    it("should copy only sketch files if 'onlySketchFiles' is true", async () => {
      const sketchesService =
        container.get<SketchesServiceImpl>(SketchesService);
      const tempDirPath = await sketchesService['createTempFolder']();
      const destinationPath = join(tempDirPath, 'OnlySketchFiles');
      let sketch = await sketchesService.createNewSketch();
      toDispose.push(disposeSketch(sketch));
      const sourcePath = FileUri.fsPath(sketch.uri);
      const libBasename = 'lib.cpp';
      const libContent = 'lib content';
      const libPath = join(sourcePath, libBasename);
      await fs.writeFile(libPath, libContent, { encoding: 'utf8' });
      const headerBasename = 'header.h';
      const headerContent = 'header content';
      const headerPath = join(sourcePath, headerBasename);
      await fs.writeFile(headerPath, headerContent, { encoding: 'utf8' });
      const logBasename = 'inols-clangd-err.log';
      const logContent = 'log file content';
      const logPath = join(sourcePath, logBasename);
      await fs.writeFile(logPath, logContent, { encoding: 'utf8' });
      const srcPath = join(sourcePath, 'src');
      await fs.mkdir(srcPath, { recursive: true });
      const libInSrcBasename = 'lib_in_src.cpp';
      const libInSrcContent = 'lib in src content';
      const libInSrcPath = join(srcPath, libInSrcBasename);
      await fs.writeFile(libInSrcPath, libInSrcContent, { encoding: 'utf8' });
      const logInSrcBasename = 'inols-clangd-err_in_src.log';
      const logInSrcContent = 'log file content in src';
      const logInSrcPath = join(srcPath, logInSrcBasename);
      await fs.writeFile(logInSrcPath, logInSrcContent, { encoding: 'utf8' });

      sketch = await sketchesService.loadSketch(sketch.uri);
      expect(Sketch.isInSketch(FileUri.create(libPath), sketch)).to.be.true;
      expect(Sketch.isInSketch(FileUri.create(headerPath), sketch)).to.be.true;
      expect(Sketch.isInSketch(FileUri.create(logPath), sketch)).to.be.false;
      expect(Sketch.isInSketch(FileUri.create(libInSrcPath), sketch)).to.be
        .true;
      expect(Sketch.isInSketch(FileUri.create(logInSrcPath), sketch)).to.be
        .false;
      const reloadedLogContent = await fs.readFile(logPath, {
        encoding: 'utf8',
      });
      expect(reloadedLogContent).to.be.equal(logContent);

      const copied = await sketchesService.copy(sketch, {
        destinationUri: FileUri.create(destinationPath).toString(),
        onlySketchFiles: true,
      });
      toDispose.push(disposeSketch(copied));
      expect(copied.name).to.be.equal(basename(destinationPath));
      expect(
        Sketch.isInSketch(
          FileUri.create(
            join(destinationPath, `${basename(destinationPath)}.ino`)
          ),
          copied
        )
      ).to.be.true;
      expect(
        Sketch.isInSketch(
          FileUri.create(join(destinationPath, libBasename)),
          copied
        )
      ).to.be.true;
      expect(
        Sketch.isInSketch(
          FileUri.create(join(destinationPath, headerBasename)),
          copied
        )
      ).to.be.true;
      expect(
        Sketch.isInSketch(
          FileUri.create(join(destinationPath, logBasename)),
          copied
        )
      ).to.be.false;
      expect(
        Sketch.isInSketch(
          FileUri.create(join(destinationPath, 'src', libInSrcBasename)),
          copied
        )
      ).to.be.true;
      expect(
        Sketch.isInSketch(
          FileUri.create(join(destinationPath, 'src', logInSrcBasename)),
          copied
        )
      ).to.be.false;
      await rejects(
        fs.readFile(join(destinationPath, logBasename)),
        ErrnoException.isENOENT
      );
    });

    it('should copy sketch if the main sketch file has pde extension (#2377)', async () => {
      const sketchesService =
        container.get<SketchesServiceImpl>(SketchesService);
      let sketch = await sketchesService.createNewSketch();
      toDispose.push(disposeSketch(sketch));
      expect(sketch.mainFileUri.endsWith('.ino')).to.be.true;

      // Create a sketch and rename the main sketch file to .pde
      const mainSketchFilePathIno = FileUri.fsPath(new URI(sketch.mainFileUri));
      const sketchFolderPath = path.dirname(mainSketchFilePathIno);
      const mainSketchFilePathPde = path.join(
        sketchFolderPath,
        `${basename(sketchFolderPath)}.pde`
      );
      await fs.rename(mainSketchFilePathIno, mainSketchFilePathPde);

      sketch = await sketchesService.loadSketch(sketch.uri);
      expect(sketch.mainFileUri.endsWith('.pde')).to.be.true;

      const tempDirPath = await sketchesService['createTempFolder']();
      const destinationPath = join(tempDirPath, 'GH-2377');
      const destinationUri = FileUri.create(destinationPath).toString();

      await sketchesService.copy(sketch, {
        destinationUri,
      });

      const copiedSketch = await sketchesService.loadSketch(destinationUri);
      expect(copiedSketch.mainFileUri.endsWith('.ino')).to.be.true;
    });

    it('should copy sketch inside the sketch folder', async () => {
      const sketchesService =
        container.get<SketchesServiceImpl>(SketchesService);
      let sketch = await sketchesService.createNewSketch();
      const destinationPath = join(FileUri.fsPath(sketch.uri), 'nested_copy');
      toDispose.push(disposeSketch(sketch));
      const sourcePath = FileUri.fsPath(sketch.uri);
      const libBasename = 'lib.cpp';
      const libContent = 'lib content';
      const libPath = join(sourcePath, libBasename);
      await fs.writeFile(libPath, libContent, { encoding: 'utf8' });
      const headerBasename = 'header.h';
      const headerContent = 'header content';
      const headerPath = join(sourcePath, headerBasename);
      await fs.writeFile(headerPath, headerContent, { encoding: 'utf8' });

      sketch = await sketchesService.loadSketch(sketch.uri);
      expect(Sketch.isInSketch(FileUri.create(libPath), sketch)).to.be.true;
      expect(Sketch.isInSketch(FileUri.create(headerPath), sketch)).to.be.true;

      const copied = await sketchesService.copy(sketch, {
        destinationUri: FileUri.create(destinationPath).toString(),
      });
      toDispose.push(disposeSketch(copied));
      expect(copied.name).to.be.equal(basename(destinationPath));
      expect(
        Sketch.isInSketch(
          FileUri.create(
            join(destinationPath, `${basename(destinationPath)}.ino`)
          ),
          copied
        )
      ).to.be.true;
      expect(
        Sketch.isInSketch(
          FileUri.create(join(destinationPath, libBasename)),
          copied
        )
      ).to.be.true;
      expect(
        Sketch.isInSketch(
          FileUri.create(join(destinationPath, headerBasename)),
          copied
        )
      ).to.be.true;
    });

    it('should not modify the subfolder structure', async () => {
      const sketchesService =
        container.get<SketchesServiceImpl>(SketchesService);
      const tempDirPath = await sketchesService['createTempFolder']();
      const destinationPath = join(tempDirPath, 'HasSubfolders_copy');
      await fs.mkdir(destinationPath, { recursive: true });
      let sketch = await sketchesService.createNewSketch('HasSubfolders');
      toDispose.push(disposeSketch(sketch));

      const sourcePath = FileUri.fsPath(sketch.uri);
      const srcPath = join(sourcePath, 'src');
      await fs.mkdir(srcPath, { recursive: true });
      const headerPath = join(srcPath, 'FomSubfolder.h');
      await fs.writeFile(headerPath, '// empty', { encoding: 'utf8' });

      sketch = await sketchesService.loadSketch(sketch.uri);

      expect(sketch.mainFileUri).to.be.equal(
        FileUri.create(join(sourcePath, 'HasSubfolders.ino')).toString()
      );
      expect(sketch.additionalFileUris).to.be.deep.equal([
        FileUri.create(join(srcPath, 'FomSubfolder.h')).toString(),
      ]);
      expect(sketch.otherSketchFileUris).to.be.empty;
      expect(sketch.rootFolderFileUris).to.be.empty;

      const destinationUri = FileUri.create(destinationPath).toString();
      const copySketch = await sketchesService.copy(sketch, { destinationUri });
      toDispose.push(disposeSketch(copySketch));
      expect(copySketch.mainFileUri).to.be.equal(
        FileUri.create(
          join(destinationPath, 'HasSubfolders_copy.ino')
        ).toString()
      );
      expect(copySketch.additionalFileUris).to.be.deep.equal([
        FileUri.create(
          join(destinationPath, 'src', 'FomSubfolder.h')
        ).toString(),
      ]);
      expect(copySketch.otherSketchFileUris).to.be.empty;
      expect(copySketch.rootFolderFileUris).to.be.empty;

      const actualHeaderContent = await fs.readFile(
        join(destinationPath, 'src', 'FomSubfolder.h'),
        { encoding: 'utf8' }
      );
      expect(actualHeaderContent).to.be.equal('// empty');
    });

    it('should copy sketch with overwrite when source and destination sketch folder names are the same', async function () {
      this.timeout(testTimeout);
      const sketchesService =
        container.get<SketchesServiceImpl>(SketchesService);
      const sketchFolderName = 'alma';
      const contentOne = 'korte';
      const contentTwo = 'szilva';
      const [sketchOne, sketchTwo] = await Promise.all([
        sketchesService.createNewSketch(sketchFolderName, contentOne),
        sketchesService.createNewSketch(sketchFolderName, contentTwo),
      ]);
      toDispose.push(disposeSketch(sketchOne, sketchTwo));
      const [mainFileContentOne, mainFileContentTwo] = await Promise.all([
        mainFileContentOf(sketchOne),
        mainFileContentOf(sketchTwo),
      ]);
      expect(mainFileContentOne).to.be.equal(contentOne);
      expect(mainFileContentTwo).to.be.equal(contentTwo);

      await sketchesService.copy(sketchOne, { destinationUri: sketchTwo.uri });
      const [mainFileContentOneAfterCopy, mainFileContentTwoAfterCopy] =
        await Promise.all([
          mainFileContentOf(sketchOne),
          mainFileContentOf(sketchTwo),
        ]);
      expect(mainFileContentOneAfterCopy).to.be.equal(contentOne);
      expect(mainFileContentTwoAfterCopy).to.be.equal(contentOne);
    });

    (
      [
        ['(', ')', 'parentheses'],
        ['[', ']', 'brackets'],
        ['{', '}', 'braces'],
        [
          '<',
          '>',
          'lt+gt',
          {
            predicate: () => isWindows,
            why: '< (less than) and > (greater than) are reserved characters on Windows (https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions)',
          },
        ],
      ] as [
        open: string,
        close: string,
        name: string,
        skip?: { predicate: () => boolean; why: string }
      ][]
    ).map(([open, close, name, skip]) =>
      it(`should copy a sketch when the path contains ${name} in the sketch folder path: '${open},${close}'`, async function () {
        if (skip) {
          const { predicate, why } = skip;
          if (predicate()) {
            console.info(why);
            return this.skip();
          }
        }
        this.timeout(testTimeout);
        const sketchesService =
          container.get<SketchesServiceImpl>(SketchesService);
        const content = `// special content when ${name} are in the path`;
        const tempRoot = await sketchesService['createTempFolder']();
        toDispose.push(disposeFolder(tempRoot));
        const sketch = await sketchesService.createNewSketch(
          'punctuation_marks',
          content
        );
        toDispose.push(disposeSketch(sketch));

        // the destination path contains punctuation marks
        const tempRootUri = FileUri.create(tempRoot);
        const testSegment = `path segment with ${open}${name}${close}`;
        const firstDestinationUri = tempRootUri
          .resolve(testSegment)
          .resolve('first')
          .resolve(sketch.name);

        const firstSketchCopy = await sketchesService.copy(sketch, {
          destinationUri: firstDestinationUri.toString(),
        });
        expect(firstSketchCopy).to.be.not.undefined;
        expect(firstSketchCopy.mainFileUri).to.be.equal(
          firstDestinationUri.resolve(`${sketch.name}.ino`).toString()
        );
        const firstCopyContent = await mainFileContentOf(firstSketchCopy);
        expect(firstCopyContent).to.be.equal(content);

        // the source path contains punctuation marks. yes, the target too, but it does not matter
        const secondDestinationUri = tempRootUri
          .resolve(testSegment)
          .resolve('second')
          .resolve(sketch.name);
        const secondSketchCopy = await sketchesService.copy(firstSketchCopy, {
          destinationUri: secondDestinationUri.toString(),
        });
        expect(secondSketchCopy).to.be.not.undefined;
        expect(secondSketchCopy.mainFileUri).to.be.equal(
          secondDestinationUri.resolve(`${sketch.name}.ino`).toString()
        );
        const secondCopyContent = await mainFileContentOf(secondSketchCopy);
        expect(secondCopyContent).to.be.equal(content);
      })
    );
  });
});

function disposeSketch(...sketch: Sketch[]): Disposable {
  return disposeFolder(...sketch.map(({ uri }) => FileUri.fsPath(uri)));
}

function disposeFolder(...paths: string[]): Disposable {
  return new DisposableCollection(
    ...paths.map((path) =>
      Disposable.create(() => rimrafSync(path, { maxBusyTries: 5 }))
    )
  );
}

async function mainFileContentOf(sketch: Sketch): Promise<string> {
  return fs.readFile(FileUri.fsPath(sketch.mainFileUri), {
    encoding: 'utf8',
  });
}

async function start(
  container: Container,
  toDispose: DisposableCollection
): Promise<void> {
  await startDaemon(container, toDispose);
}

async function createContainer(): Promise<Container> {
  return createBaseContainer();
}