squidex/backend/src/Squidex.Domain.Apps.Core.Operations/Scripting/JintScriptEngine.cs

// ==========================================================================
//  Squidex Headless CMS
// ==========================================================================
//  Copyright (c) Squidex UG (haftungsbeschraenkt)
//  All rights reserved. Licensed under the MIT license.
// ==========================================================================

using Esprima;
using Jint;
using Jint.Native;
using Jint.Runtime;
using Microsoft.Extensions.Caching.Memory;
using Microsoft.Extensions.Options;
using Squidex.Domain.Apps.Core.Contents;
using Squidex.Domain.Apps.Core.Properties;
using Squidex.Domain.Apps.Core.Scripting.ContentWrapper;
using Squidex.Domain.Apps.Core.Scripting.Internal;
using Squidex.Infrastructure;
using Squidex.Infrastructure.Json.Objects;
using Squidex.Infrastructure.Translations;
using Squidex.Infrastructure.Validation;

namespace Squidex.Domain.Apps.Core.Scripting
{
    public sealed class JintScriptEngine : IScriptEngine, IScriptDescriptor
    {
        private readonly IJintExtension[] extensions;
        private readonly Parser parser;
        private readonly TimeSpan timeoutScript;
        private readonly TimeSpan timeoutExecution;

        public JintScriptEngine(IMemoryCache cache, IOptions<JintScriptOptions> options, IEnumerable<IJintExtension>? extensions = null)
        {
            parser = new Parser(cache);

            timeoutScript = options.Value.TimeoutScript;
            timeoutExecution = options.Value.TimeoutExecution;

            this.extensions = extensions?.ToArray() ?? Array.Empty<IJintExtension>();
        }

        public async Task<IJsonValue> ExecuteAsync(ScriptVars vars, string script, ScriptOptions options = default,
            CancellationToken ct = default)
        {
            Guard.NotNull(vars);
            Guard.NotNullOrEmpty(script);

            using (var cts = new CancellationTokenSource(timeoutExecution))
            {
                using (var combined = CancellationTokenSource.CreateLinkedTokenSource(cts.Token, ct))
                {
                    var tcs = new TaskCompletionSource<IJsonValue>();

                    await using (combined.Token.Register(() => tcs.TrySetCanceled(combined.Token)))
                    {
                        var context =
                            CreateEngine(options)
                                .Extend(vars, options)
                                .Extend(extensions)
                                .ExtendAsync(extensions, tcs.TrySetException, combined.Token);

                        context.Engine.SetValue("complete", new Action<JsValue?>(value =>
                        {
                            tcs.TrySetResult(JsonMapper.Map(value));
                        }));

                        var result = Execute(context.Engine, script);

                        if (!context.IsAsync)
                        {
                            tcs.TrySetResult(JsonMapper.Map(result));
                        }

                        return await tcs.Task;
                    }
                }
            }
        }

        public async Task<ContentData> TransformAsync(ScriptVars vars, string script, ScriptOptions options = default,
            CancellationToken ct = default)
        {
            Guard.NotNull(vars);
            Guard.NotNullOrEmpty(script);

            using (var cts = new CancellationTokenSource(timeoutExecution))
            {
                using (var combined = CancellationTokenSource.CreateLinkedTokenSource(cts.Token, ct))
                {
                    var tcs = new TaskCompletionSource<ContentData>();

                    await using (combined.Token.Register(() => tcs.TrySetCanceled(combined.Token)))
                    {
                        var context =
                            CreateEngine(options)
                                .Extend(vars, options)
                                .Extend(extensions)
                                .ExtendAsync(extensions, tcs.TrySetException, combined.Token);

                        context.Engine.SetValue("complete", new Action<JsValue?>(_ =>
                        {
                            tcs.TrySetResult(vars.Data!);
                        }));

                        context.Engine.SetValue("replace", new Action(() =>
                        {
                            var dataInstance = context.Engine.GetValue("ctx").AsObject().Get("data");

                            if (dataInstance != null && dataInstance.IsObject() && dataInstance.AsObject() is ContentDataObject data)
                            {
                                if (!tcs.Task.IsCompleted)
                                {
                                    if (data.TryUpdate(out var modified))
                                    {
                                        tcs.TrySetResult(modified);
                                    }
                                    else
                                    {
                                        tcs.TrySetResult(vars.Data!);
                                    }
                                }
                            }
                        }));

                        Execute(context.Engine, script);

                        if (!context.IsAsync)
                        {
                            tcs.TrySetResult(vars.Data!);
                        }

                        return await tcs.Task;
                    }
                }
            }
        }

        public IJsonValue Execute(ScriptVars vars, string script, ScriptOptions options = default)
        {
            Guard.NotNull(vars);
            Guard.NotNullOrEmpty(script);

            var context =
                CreateEngine(options)
                    .Extend(vars, options)
                    .Extend(extensions);

            var result = Execute(context.Engine, script);

            return JsonMapper.Map(result);
        }

        private ScriptExecutionContext CreateEngine(ScriptOptions options)
        {
            var engine = new Engine(engineOptions =>
            {
                engineOptions.AddObjectConverter(DefaultConverter.Instance);
                engineOptions.SetReferencesResolver(NullPropagation.Instance);
                engineOptions.Strict();
                engineOptions.TimeoutInterval(timeoutScript);
            });

            if (options.CanDisallow)
            {
                engine.AddDisallow();
            }

            if (options.CanReject)
            {
                engine.AddReject();
            }

            foreach (var extension in extensions)
            {
                extension.Extend(engine);
            }

            var context = new ScriptExecutionContext(engine);

            return context;
        }

        private JsValue Execute(Engine engine, string script)
        {
            try
            {
                var program = parser.Parse(script);

                return engine.Evaluate(program);
            }
            catch (ArgumentException ex)
            {
                throw new ValidationException(T.Get("common.jsParseError", new { error = ex.Message }));
            }
            catch (JavaScriptException ex)
            {
                throw new ValidationException(T.Get("common.jsError", new { message = ex.Message }));
            }
            catch (ParserException ex)
            {
                throw new ValidationException(T.Get("common.jsError", new { message = ex.Message }));
            }
            catch (DomainException)
            {
                throw;
            }
            catch (Exception ex)
            {
                throw new ValidationException(T.Get("common.jsError", new { message = ex.GetType().Name }), ex);
            }
        }

        public void Describe(AddDescription describe, ScriptScope scope)
        {
            if (scope == ScriptScope.Transform)
            {
                describe(JsonType.Function, "replace()",
                    Resources.ScriptingReplace);
            }

            describe(JsonType.Function, "disallow()",
                Resources.ScriptingDisallow);

            describe(JsonType.Function, "complete()",
                Resources.ScriptingComplete);

            describe(JsonType.Function, "reject(reason)",
                Resources.ScriptingReject);
        }
    }
}