alfresco-ng2-components/lib/js-api/test/content-services/webScriptApi.spec.ts

/*!
 * @license
 * Copyright © 2005-2026 Hyland Software, Inc. and its affiliates. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import assert from 'assert';
import { resetGlobalMockAgent } from '../mockObjects/base.mock';
import { AlfrescoApi, WebscriptApi } from '../../src';
import { EcmAuthMock, WebScriptMock } from '../mockObjects';
import { describe, it, beforeEach, afterEach } from 'node:test';

describe('WebScript', () => {
    const hostEcm = 'https://127.0.0.1:8080';
    const contextRoot = 'script';
    const servicePath = 'alfresco';
    const scriptPath = 'testWebScript';

    let authResponseMock: EcmAuthMock;
    let webScriptMock: WebScriptMock;
    let webscriptApi: WebscriptApi;

    beforeEach(async () => {
        authResponseMock = new EcmAuthMock(hostEcm);
        webScriptMock = new WebScriptMock(hostEcm, contextRoot, servicePath, scriptPath);
        authResponseMock.get201Response();

        const alfrescoJsApi = new AlfrescoApi({
            hostEcm
        });

        await alfrescoJsApi.login('admin', 'admin');

        webscriptApi = new WebscriptApi(alfrescoJsApi);
    });

    afterEach(() => {
        resetGlobalMockAgent();
    });

    it('execute webScript return 400 error if is not present on the server should be handled by reject promise', async () => {
        webScriptMock.get404Response();

        await assert.rejects(
            () => webscriptApi.executeWebScript('GET', scriptPath, null, contextRoot, servicePath),
            (error: any) => error.status === 404
        );
    });

    it('execute webScript GET return 200 if all is ok  should be handled by resolve promise', async () => {
        webScriptMock.get200Response();

        const result = await webscriptApi.executeWebScript('GET', scriptPath, null, contextRoot, servicePath);
        assert.ok(result, 'executeWebScript should return a result');
    });

    it('execute webScript that return HTML should not return it as Object', async () => {
        webScriptMock.get200ResponseHTMLFormat();

        const data = await webscriptApi.executeWebScript('GET', 'sample/folder/Company%20Home');
        assert.ok(data, 'executeWebScript should return data');
        let isValidJson = false;
        try {
            JSON.parse(data);
            isValidJson = true;
        } catch {
            // Expected - HTML cannot be parsed as JSON
        }
        assert.equal(isValidJson, false, 'HTML response should not be valid JSON');
    });

    describe('Events', () => {
        it('WebScript should fire success event at the end', async () => {
            webScriptMock.get200Response();

            let successEventFired = false;
            const webscriptPromise: any = webscriptApi.executeWebScript('GET', scriptPath, null, contextRoot, servicePath);

            webscriptPromise.catch(() => {});
            webscriptPromise.on('success', () => {
                successEventFired = true;
            });

            await webscriptPromise;
            assert.equal(successEventFired, true, 'Success event should have fired');
        });

        it('WebScript should fire error event if something go wrong', async () => {
            webScriptMock.get404Response();

            let errorEventFired = false;
            const webscriptPromise: any = webscriptApi.executeWebScript('GET', scriptPath, null, contextRoot, servicePath);

            webscriptPromise.catch(() => {});
            webscriptPromise.on('error', () => {
                errorEventFired = true;
            });

            await webscriptPromise.catch(() => {});
            assert.equal(errorEventFired, true, 'Error event should have fired');
        });

        it('WebScript should fire unauthorized event if get 401', async () => {
            webScriptMock.get401Response();

            let unauthorizedEventFired = false;
            const webscriptPromise: any = webscriptApi.executeWebScript('GET', scriptPath, null, contextRoot, servicePath);

            webscriptPromise.catch(() => {});
            webscriptPromise.on('unauthorized', () => {
                unauthorizedEventFired = true;
            });

            await webscriptPromise.catch(() => {});
            assert.equal(unauthorizedEventFired, true, 'Unauthorized event should have fired');
        });
    });
});