unleash-server/dist/lib/routes/admin-api/strategy.test.js

Unleash is an enterprise ready feature flag service. It provides different strategies for handling feature flags.

import supertest from 'supertest';
import { createTestConfig } from '../../../test/config/test-config.js';
import createStores from '../../../test/fixtures/store.js';
import permissions from '../../../test/fixtures/permissions.js';
import getApp from '../../app.js';
import { createServices } from '../../services/index.js';
import { afterEach, vi } from 'vitest';
async function getSetup() {
    const randomBase = `/random${Math.round(Math.random() * 1000)}`;
    const perms = permissions();
    const stores = createStores();
    const config = createTestConfig({
        server: { baseUriPath: randomBase },
        preRouterHook: perms.hook,
    });
    const services = createServices(stores, config);
    const app = await getApp(config, stores, services);
    return {
        base: randomBase,
        strategyStore: stores.strategyStore,
        request: supertest(app),
        perms,
    };
}
afterEach(() => {
    delete process.env.UNLEASH_DISABLE_CUSTOM_STRATEGY_CREATION;
    delete process.env.UNLEASH_DISABLE_CUSTOM_STRATEGY_EDITING;
});
test('add version numbers for /strategies', async () => {
    const { request, base } = await getSetup();
    return request
        .get(`${base}/api/admin/strategies`)
        .expect('Content-Type', /json/)
        .expect(200)
        .expect((res) => {
        expect(res.body.version).toBe(1);
    });
});
test('require a name when creating a new strategy', async () => {
    const { request, base } = await getSetup();
    return request
        .post(`${base}/api/admin/strategies`)
        .send({})
        .expect(400)
        .expect((res) => {
        expect(['name', 'property', 'required'].every((word) => res.body.details[0].message.includes(word))).toBeTruthy();
    });
});
test('require parameters array when creating a new strategy', async () => {
    const { request, base } = await getSetup();
    const { body } = await request
        .post(`${base}/api/admin/strategies`)
        .send({ name: 'TestStrat' })
        .expect(400);
    const detailsDescription = body.details[0].message;
    expect(detailsDescription).toEqual(expect.stringMatching('parameters'));
    expect(detailsDescription).toEqual(expect.stringMatching('required'));
});
test('create a new strategy with empty parameters', async () => {
    const { request, base } = await getSetup();
    return request
        .post(`${base}/api/admin/strategies`)
        .send({ name: 'TestStrat', parameters: [] })
        .expect(201);
});
test('creating strategies is forbidden when disabled by configuration', async () => {
    process.env.UNLEASH_DISABLE_CUSTOM_STRATEGY_CREATION = 'true';
    const { request, base } = await getSetup();
    const response = await request
        .post(`${base}/api/admin/strategies`)
        .send({ name: 'LockedStrategy', parameters: [] })
        .expect(403);
    expect(response.body.message).toContain('Custom strategy creation is disabled');
});
test('not be possible to override name', async () => {
    const { request, base, strategyStore } = await getSetup();
    strategyStore.createStrategy({ name: 'Testing', parameters: [] });
    return request
        .post(`${base}/api/admin/strategies`)
        .send({ name: 'Testing', parameters: [] })
        .expect(409);
});
test('update strategy', async () => {
    const { request, base, strategyStore } = await getSetup();
    const name = 'AnotherStrat';
    strategyStore.createStrategy({ name, parameters: [] });
    return request
        .put(`${base}/api/admin/strategies/${name}`)
        .send({ name, parameters: [], description: 'added' })
        .expect(200);
});
test('updating strategies is forbidden when disabled by configuration', async () => {
    process.env.UNLEASH_DISABLE_CUSTOM_STRATEGY_EDITING = 'true';
    const { request, base, strategyStore } = await getSetup();
    const name = 'LockedStrategy';
    await strategyStore.createStrategy({ name, parameters: [] });
    const response = await request
        .put(`${base}/api/admin/strategies/${name}`)
        .send({ name, parameters: [] })
        .expect(403);
    expect(response.body.message).toContain('Custom strategy modification is disabled');
});
test('not update unknown strategy', async () => {
    const { request, base } = await getSetup();
    const name = 'UnknownStrat';
    return request
        .put(`${base}/api/admin/strategies/${name}`)
        .send({ name, parameters: [], description: 'added' })
        .expect(404);
});
test('validate format when updating strategy', async () => {
    const { request, base, strategyStore } = await getSetup();
    const name = 'AnotherStrat';
    strategyStore.createStrategy({ name, parameters: [] });
    return request
        .put(`${base}/api/admin/strategies/${name}`)
        .send({})
        .expect(400);
});
test('editable=false will stop delete request', async () => {
    vi.spyOn(global.console, 'error').mockImplementation(() => vi.fn());
    const { request, base } = await getSetup();
    const name = 'default';
    return request.delete(`${base}/api/admin/strategies/${name}`).expect(500);
});
test('editable=false will stop edit request', async () => {
    vi.spyOn(global.console, 'error').mockImplementation(() => vi.fn());
    const { request, base } = await getSetup();
    const name = 'default';
    return request
        .put(`${base}/api/admin/strategies/${name}`)
        .send({ name, parameters: [] })
        .expect(500);
});
test('editable=true will allow delete request', async () => {
    const { request, base, strategyStore } = await getSetup();
    const name = 'deleteStrat';
    strategyStore.createStrategy({ name, parameters: [] });
    return request
        .delete(`${base}/api/admin/strategies/${name}`)
        .send({})
        .expect(200);
});
test('editable=true will allow edit request', async () => {
    const { request, base, strategyStore } = await getSetup();
    const name = 'editStrat';
    strategyStore.createStrategy({ name, parameters: [] });
    return request
        .put(`${base}/api/admin/strategies/${name}`)
        .send({ name, parameters: [] })
        .expect(200);
});
test('deprecating a strategy works', async () => {
    const { request, base, strategyStore } = await getSetup();
    const name = 'editStrat';
    strategyStore.createStrategy({ name, parameters: [] });
    await request
        .post(`${base}/api/admin/strategies/${name}/deprecate`)
        .set('Content-Type', 'application/json')
        .send()
        .expect(200);
    return request
        .get(`${base}/api/admin/strategies/${name}`)
        .expect(200)
        .expect((res) => expect(res.body.deprecated).toBe(true));
});
test('deprecating a non-existent strategy yields 404', async () => {
    const { request, base } = await getSetup();
    return request
        .post(`${base}/api/admin/strategies/non-existent-strategy/deprecate`)
        .set('Content-Type', 'application/json')
        .expect(404);
});
test('reactivating a strategy works', async () => {
    const { request, base, strategyStore } = await getSetup();
    const name = 'editStrat';
    strategyStore.createStrategy({ name, parameters: [] });
    await request
        .post(`${base}/api/admin/strategies/${name}/reactivate`)
        .set('Content-Type', 'application/json')
        .send()
        .expect(200);
    return request
        .get(`${base}/api/admin/strategies/${name}`)
        .expect(200)
        .expect((res) => expect(res.body.deprecated).toBe(false));
});
test('reactivating a non-existent strategy yields 404', async () => {
    const { request, base } = await getSetup();
    return request
        .post(`${base}/api/admin/strategies/non-existent-strategy/reactivate`)
        .set('Content-Type', 'application/json')
        .expect(404);
});
//# sourceMappingURL=strategy.test.js.map