| // Copyright 2017 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #include "modules/animationworklet/AnimationWorkletGlobalScope.h" |
| |
| #include "bindings/core/v8/ExceptionState.h" |
| #include "bindings/core/v8/ScriptModule.h" |
| #include "bindings/core/v8/ScriptSourceCode.h" |
| #include "bindings/core/v8/V8BindingForCore.h" |
| #include "bindings/core/v8/V8CacheOptions.h" |
| #include "bindings/core/v8/WorkerOrWorkletScriptController.h" |
| #include "core/dom/Document.h" |
| #include "core/origin_trials/OriginTrialContext.h" |
| #include "core/testing/PageTestBase.h" |
| #include "core/workers/GlobalScopeCreationParams.h" |
| #include "core/workers/WorkerReportingProxy.h" |
| #include "core/workers/WorkletModuleResponsesMap.h" |
| #include "modules/animationworklet/AnimationWorklet.h" |
| #include "modules/animationworklet/AnimationWorkletThread.h" |
| #include "modules/animationworklet/Animator.h" |
| #include "modules/animationworklet/AnimatorDefinition.h" |
| #include "platform/CrossThreadFunctional.h" |
| #include "platform/WaitableEvent.h" |
| #include "platform/loader/fetch/AccessControlStatus.h" |
| #include "platform/loader/fetch/ResourceLoaderOptions.h" |
| #include "platform/wtf/text/TextPosition.h" |
| #include "public/platform/TaskType.h" |
| #include "public/platform/WebURLRequest.h" |
| #include "testing/gtest/include/gtest/gtest.h" |
| |
| #include <memory> |
| |
| namespace blink { |
| |
| class AnimationWorkletGlobalScopeTest : public PageTestBase { |
| public: |
| AnimationWorkletGlobalScopeTest() = default; |
| |
| void SetUp() override { |
| AnimationWorkletThread::CreateSharedBackingThreadForTest(); |
| PageTestBase::SetUp(IntSize()); |
| Document* document = &GetDocument(); |
| document->SetURL(KURL("https://example.com/")); |
| document->UpdateSecurityOrigin(SecurityOrigin::Create(document->Url())); |
| reporting_proxy_ = std::make_unique<WorkerReportingProxy>(); |
| } |
| |
| void TearDown() override { |
| AnimationWorkletThread::ClearSharedBackingThread(); |
| } |
| |
| std::unique_ptr<AnimationWorkletThread> CreateAnimationWorkletThread() { |
| std::unique_ptr<AnimationWorkletThread> thread = |
| AnimationWorkletThread::Create(nullptr, *reporting_proxy_); |
| |
| WorkerClients* clients = WorkerClients::Create(); |
| |
| Document* document = &GetDocument(); |
| thread->Start( |
| std::make_unique<GlobalScopeCreationParams>( |
| document->Url(), document->UserAgent(), |
| nullptr /* content_security_policy_parsed_headers */, |
| document->GetReferrerPolicy(), document->GetSecurityOrigin(), |
| document->IsSecureContext(), clients, document->AddressSpace(), |
| OriginTrialContext::GetTokens(document).get(), |
| base::UnguessableToken::Create(), nullptr /* worker_settings */, |
| kV8CacheOptionsDefault, |
| new WorkletModuleResponsesMap(document->Fetcher())), |
| WTF::nullopt, WorkerInspectorProxy::PauseOnWorkerStart::kDontPause, |
| ParentFrameTaskRunners::Create()); |
| return thread; |
| } |
| |
| using TestCalback = void (AnimationWorkletGlobalScopeTest::*)(WorkerThread*, |
| WaitableEvent*); |
| // Create a new animation worklet and run the callback task on it. Terminate |
| // the worklet once the task completion is signaled. |
| void RunTestOnWorkletThread(TestCalback callback) { |
| std::unique_ptr<WorkerThread> worklet = CreateAnimationWorkletThread(); |
| WaitableEvent waitable_event; |
| PostCrossThreadTask( |
| *worklet->GetTaskRunner(TaskType::kInternalTest), FROM_HERE, |
| CrossThreadBind(callback, CrossThreadUnretained(this), |
| CrossThreadUnretained(worklet.get()), |
| CrossThreadUnretained(&waitable_event))); |
| waitable_event.Wait(); |
| |
| worklet->Terminate(); |
| worklet->WaitForShutdownForTesting(); |
| } |
| |
| void RunBasicParsingTestOnWorklet(WorkerThread* thread, |
| WaitableEvent* waitable_event) { |
| ASSERT_TRUE(thread->IsCurrentThread()); |
| auto* global_scope = ToAnimationWorkletGlobalScope(thread->GlobalScope()); |
| ScriptState* script_state = |
| global_scope->ScriptController()->GetScriptState(); |
| ASSERT_TRUE(script_state); |
| v8::Isolate* isolate = script_state->GetIsolate(); |
| ASSERT_TRUE(isolate); |
| |
| ScriptState::Scope scope(script_state); |
| |
| { |
| // registerAnimator() with a valid class definition should define an |
| // animator. |
| String source_code = |
| R"JS( |
| registerAnimator('test', class { |
| constructor () {} |
| animate () {} |
| }); |
| )JS"; |
| ASSERT_TRUE(EvaluateScriptModule(global_scope, source_code)); |
| |
| AnimatorDefinition* definition = |
| global_scope->FindDefinitionForTest("test"); |
| ASSERT_TRUE(definition); |
| |
| EXPECT_TRUE(definition->ConstructorLocal(isolate)->IsFunction()); |
| EXPECT_TRUE(definition->AnimateLocal(isolate)->IsFunction()); |
| } |
| |
| { |
| // registerAnimator() with a null class definition should fail to define |
| // an animator. |
| String source_code = "registerAnimator('null', null);"; |
| ASSERT_FALSE(EvaluateScriptModule(global_scope, source_code)); |
| EXPECT_FALSE(global_scope->FindDefinitionForTest("null")); |
| } |
| |
| EXPECT_FALSE(global_scope->FindDefinitionForTest("non-existent")); |
| |
| waitable_event->Signal(); |
| } |
| |
| void RunConstructAndAnimateTestOnWorklet(WorkerThread* thread, |
| WaitableEvent* waitable_event) { |
| ASSERT_TRUE(thread->IsCurrentThread()); |
| auto* global_scope = ToAnimationWorkletGlobalScope(thread->GlobalScope()); |
| ScriptState* script_state = |
| global_scope->ScriptController()->GetScriptState(); |
| ASSERT_TRUE(script_state); |
| v8::Isolate* isolate = script_state->GetIsolate(); |
| ASSERT_TRUE(isolate); |
| |
| ScriptState::Scope scope(script_state); |
| |
| String source_code = |
| R"JS( |
| // Worklet doesn't have a reference to the global object. Instead, |
| // retrieve it in a tricky way. |
| var global_object = Function('return this')(); |
| global_object.constructed = false; |
| global_object.animated = false; |
| |
| registerAnimator('test', class { |
| constructor () { |
| constructed = true; |
| } |
| animate () { |
| animated = true; |
| } |
| }); |
| )JS"; |
| ASSERT_TRUE(EvaluateScriptModule(global_scope, source_code)); |
| |
| ScriptValue constructed_before = |
| global_scope->ScriptController()->EvaluateAndReturnValueForTest( |
| ScriptSourceCode("Function('return this')().constructed")); |
| EXPECT_FALSE( |
| ToBoolean(isolate, constructed_before.V8Value(), ASSERT_NO_EXCEPTION)) |
| << "constructor is not invoked"; |
| |
| ScriptValue animated_before = |
| global_scope->ScriptController()->EvaluateAndReturnValueForTest( |
| ScriptSourceCode("Function('return this')().animated")); |
| EXPECT_FALSE( |
| ToBoolean(isolate, animated_before.V8Value(), ASSERT_NO_EXCEPTION)) |
| << "animate function is invoked early"; |
| |
| // Passing a new input state with a new animation id should cause the |
| // worklet to create and animate an animator. |
| CompositorMutatorInputState state; |
| CompositorMutatorInputState::AnimationState test_animation_state; |
| test_animation_state.animation_id = 1; |
| test_animation_state.name = "test"; |
| test_animation_state.current_time = 5000; |
| state.animations = {test_animation_state}; |
| |
| std::unique_ptr<CompositorMutatorOutputState> output = |
| global_scope->Mutate(state); |
| EXPECT_TRUE(output); |
| |
| ScriptValue constructed_after = |
| global_scope->ScriptController()->EvaluateAndReturnValueForTest( |
| ScriptSourceCode("Function('return this')().constructed")); |
| EXPECT_TRUE( |
| ToBoolean(isolate, constructed_after.V8Value(), ASSERT_NO_EXCEPTION)) |
| << "constructor is not invoked"; |
| |
| ScriptValue animated_after = |
| global_scope->ScriptController()->EvaluateAndReturnValueForTest( |
| ScriptSourceCode("Function('return this')().animated")); |
| EXPECT_TRUE( |
| ToBoolean(isolate, animated_after.V8Value(), ASSERT_NO_EXCEPTION)) |
| << "animate function is not invoked"; |
| |
| waitable_event->Signal(); |
| } |
| |
| void RunAnimateOutputTestOnWorklet(WorkerThread* thread, |
| WaitableEvent* waitable_event) { |
| AnimationWorkletGlobalScope* global_scope = |
| static_cast<AnimationWorkletGlobalScope*>(thread->GlobalScope()); |
| ASSERT_TRUE(global_scope); |
| ASSERT_TRUE(global_scope->IsAnimationWorkletGlobalScope()); |
| ScriptState* script_state = |
| global_scope->ScriptController()->GetScriptState(); |
| ASSERT_TRUE(script_state); |
| v8::Isolate* isolate = script_state->GetIsolate(); |
| ASSERT_TRUE(isolate); |
| |
| ScriptState::Scope scope(script_state); |
| global_scope->ScriptController()->Evaluate(ScriptSourceCode( |
| R"JS( |
| registerAnimator('test', class { |
| animate (currentTime, effect) { |
| effect.localTime = 123; |
| } |
| }); |
| )JS")); |
| |
| // Passing a new input state with a new animation id should cause the |
| // worklet to create and animate an animator. |
| CompositorMutatorInputState state; |
| CompositorMutatorInputState::AnimationState test_animation_state; |
| test_animation_state.animation_id = 1; |
| test_animation_state.name = "test"; |
| test_animation_state.current_time = 5000; |
| state.animations = {test_animation_state}; |
| |
| std::unique_ptr<CompositorMutatorOutputState> output = |
| global_scope->Mutate(state); |
| EXPECT_TRUE(output); |
| |
| EXPECT_EQ(output->animations.size(), 1ul); |
| EXPECT_EQ(output->animations[0].local_time, |
| WTF::TimeDelta::FromMillisecondsD(123)); |
| |
| // Passing a new empty input state should cause the worklet to remove the |
| // previously constructed animator. |
| CompositorMutatorInputState empty_state; |
| output = global_scope->Mutate(empty_state); |
| EXPECT_TRUE(output); |
| EXPECT_EQ(output->animations.size(), 0ul); |
| EXPECT_EQ(global_scope->GetAnimatorsSizeForTest(), 0u); |
| |
| waitable_event->Signal(); |
| } |
| |
| private: |
| // Returns false when a script evaluation error happens. |
| bool EvaluateScriptModule(AnimationWorkletGlobalScope* global_scope, |
| const String& source_code) { |
| ScriptState* script_state = |
| global_scope->ScriptController()->GetScriptState(); |
| EXPECT_TRUE(script_state); |
| const KURL js_url("https://example.com/worklet.js"); |
| ScriptModule module = ScriptModule::Compile( |
| script_state->GetIsolate(), source_code, js_url, js_url, |
| ScriptFetchOptions(), kSharableCrossOrigin, |
| TextPosition::MinimumPosition(), ASSERT_NO_EXCEPTION); |
| EXPECT_FALSE(module.IsNull()); |
| ScriptValue exception = module.Instantiate(script_state); |
| EXPECT_TRUE(exception.IsEmpty()); |
| ScriptValue value = module.Evaluate(script_state); |
| return value.IsEmpty(); |
| } |
| |
| std::unique_ptr<WorkerReportingProxy> reporting_proxy_; |
| }; |
| |
| TEST_F(AnimationWorkletGlobalScopeTest, BasicParsing) { |
| RunTestOnWorkletThread( |
| &AnimationWorkletGlobalScopeTest::RunBasicParsingTestOnWorklet); |
| } |
| |
| TEST_F(AnimationWorkletGlobalScopeTest, ConstructAndAnimate) { |
| RunTestOnWorkletThread( |
| &AnimationWorkletGlobalScopeTest::RunConstructAndAnimateTestOnWorklet); |
| } |
| |
| TEST_F(AnimationWorkletGlobalScopeTest, AnimationOutput) { |
| RunTestOnWorkletThread( |
| &AnimationWorkletGlobalScopeTest::RunAnimateOutputTestOnWorklet); |
| } |
| |
| } // namespace blink |