restructure: move bin/ and tests/ to src/

Also add symlinks from the old `bin/` and `tests/` locations to avoid
breaking scripts and other tools.

Motivations:

  * Scripts and tests no longer have to do dubious things like:

        require('ep_etherpad-lite/node_modules/foo')

    to access packages installed as dependencies in
    `src/package.json`.

  * Plugins can access the backend test helper library in a non-hacky
    way:

        require('ep_etherpad-lite/tests/backend/common')

  * We can delete the top-level `package.json` without breaking our
    ability to lint the files in `bin/` and `tests/`.

    Deleting the top-level `package.json` has downsides: It will cause
    `npm` to print warnings whenever plugins are installed, npm will
    no longer be able to enforce a plugin's peer dependency on
    ep_etherpad-lite, and npm will keep deleting the
    `node_modules/ep_etherpad-lite` symlink that points to `../src`.

    But there are significant upsides to deleting the top-level
    `package.json`: It will drastically speed up plugin installation
    because `npm` doesn't have to recursively walk the dependencies in
    `src/package.json`. Also, deleting the top-level `package.json`
    avoids npm's horrible dependency hoisting behavior (where it moves
    stuff from `src/node_modules/` to the top-level `node_modules/`
    directory). Dependency hoisting causes numerous mysterious
    problems such as silent failures in `npm outdated` and `npm
    update`. Dependency hoisting also breaks plugins that do:

        require('ep_etherpad-lite/node_modules/foo')
This commit is contained in:
John McLear 2021-02-03 12:08:43 +00:00 committed by Richard Hansen
parent efde0b787a
commit 2ea8ea1275
146 changed files with 191 additions and 1161 deletions

View file

@ -0,0 +1,37 @@
/*
* ACHTUNG: this file is a hack used to load "settings.json.docker" instead of
* "settings.json", since in its present form the Settings module does
* not allow it.
* This is a remnant of an analogous file that was placed in
* <basedir>/tests/backend/loadSettings.js
*
* TODO: modify the Settings module:
* 1) no side effects on module load
* 2) write a factory method that loads a configuration file (taking the
* file name from the command line, a function argument, or falling
* back to a default)
*/
const fs = require('fs');
const jsonminify = require('jsonminify');
function loadSettings() {
let settingsStr = fs.readFileSync(`${__dirname}/../../../settings.json.docker`).toString();
// try to parse the settings
try {
if (settingsStr) {
settingsStr = jsonminify(settingsStr).replace(',]', ']').replace(',}', '}');
const settings = JSON.parse(settingsStr);
// custom settings for running in a container
settings.ip = 'localhost';
settings.port = '9001';
return settings;
}
} catch (e) {
console.error('whoops something is bad with settings');
}
}
exports.loadSettings = loadSettings;

View file

@ -0,0 +1,38 @@
/*
* ACHTUNG: this file was copied & modified from the analogous
* <basedir>/tests/backend/specs/api/pad.js
*
* TODO: unify those two files, and merge in a single one.
*/
const settings = require('../../loadSettings').loadSettings();
const supertest = require('supertest');
const api = supertest(`http://${settings.ip}:${settings.port}`);
const apiVersion = 1;
describe('Connectivity', function () {
it('can connect', function (done) {
api.get('/api/')
.expect('Content-Type', /json/)
.expect(200, done);
});
});
describe('API Versioning', function () {
it('finds the version tag', function (done) {
api.get('/api/')
.expect((res) => {
if (!res.body.currentVersion) throw new Error('No version set in API');
return;
})
.expect(200, done);
});
});
describe('Permission', function () {
it('errors with invalid APIKey', function (done) {
api.get(`/api/${apiVersion}/createPad?apikey=wrong_password&padID=test`)
.expect(401, done);
});
});