This repository was archived by the owner on Feb 25, 2025. It is now read-only.
iOS FlutterTextureRegistry should be a proxy, not the engine itself #37666
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| // Copyright 2013 The Flutter Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| #import "flutter/shell/platform/darwin/common/framework/Headers/FlutterMacros.h" | ||
| #import "flutter/shell/platform/darwin/common/framework/Headers/FlutterTexture.h" | ||
|
|
||
| #if FLUTTER_RUNTIME_MODE == FLUTTER_RUNTIME_MODE_DEBUG | ||
| FLUTTER_DARWIN_EXPORT | ||
| #endif | ||
|
|
||
| /** | ||
| * Wrapper around a weakly held collection of registered textures. | ||
| * | ||
| * Avoids a retain cycle between plugins and the engine. | ||
| */ | ||
| @interface FlutterTextureRegistryRelay : NSObject <FlutterTextureRegistry> | ||
|
There was a problem hiding this comment. can you add a comment explaining that this relay is used to solve the issue with plugin retaining the engine? There was a problem hiding this comment. Use From this comment I don't really understand when this would be used. Returned from what? There was a problem hiding this comment. @jmagman, are these comments ok? There was a problem hiding this comment. How about: There was a problem hiding this comment. Thanks, this would be better. |
||
|
|
||
| /** | ||
| * A weak reference to a FlutterEngine that will be passed texture registration. | ||
| */ | ||
| @property(nonatomic, assign) NSObject<FlutterTextureRegistry>* parent; | ||
| - (instancetype)initWithParent:(NSObject<FlutterTextureRegistry>*)parent; | ||
| @end | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| // Copyright 2013 The Flutter Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterTextureRegistryRelay.h" | ||
|
|
||
| #include "flutter/fml/logging.h" | ||
|
|
||
| @implementation FlutterTextureRegistryRelay : NSObject | ||
|
|
||
| #pragma mark - FlutterTextureRegistry | ||
|
|
||
| - (instancetype)initWithParent:(NSObject<FlutterTextureRegistry>*)parent { | ||
| if (self = [super init]) { | ||
| _parent = parent; | ||
| } | ||
| return self; | ||
| } | ||
|
|
||
| - (int64_t)registerTexture:(NSObject<FlutterTexture>*)texture { | ||
| if (!self.parent) { | ||
| FML_LOG(WARNING) << "Using on an empty registry."; | ||
| return 0; | ||
| } | ||
| return [self.parent registerTexture:texture]; | ||
| } | ||
|
|
||
| - (void)textureFrameAvailable:(int64_t)textureId { | ||
| if (!self.parent) { | ||
| FML_LOG(WARNING) << "Using on an empty registry."; | ||
| } | ||
| return [self.parent textureFrameAvailable:textureId]; | ||
| } | ||
|
|
||
| - (void)unregisterTexture:(int64_t)textureId { | ||
| if (!self.parent) { | ||
| FML_LOG(WARNING) << "Using on an empty registry."; | ||
| } | ||
| return [self.parent unregisterTexture:textureId]; | ||
| } | ||
|
|
||
endless7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| @end | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| // Copyright 2013 The Flutter Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| #import "flutter/shell/platform/darwin/ios/framework/Headers/FlutterEngine.h" | ||
| #import "flutter/shell/platform/darwin/ios/framework/Source/FlutterTextureRegistryRelay.h" | ||
|
|
||
| #import <OCMock/OCMock.h> | ||
| #import <XCTest/XCTest.h> | ||
|
|
||
| #import "flutter/shell/platform/darwin/common/framework/Headers/FlutterMacros.h" | ||
| #import "flutter/shell/platform/darwin/common/framework/Headers/FlutterTexture.h" | ||
|
|
||
| FLUTTER_ASSERT_ARC | ||
|
|
||
| @interface FlutterTextureRegistryRelayTest : XCTestCase | ||
| @end | ||
|
|
||
| @implementation FlutterTextureRegistryRelayTest | ||
endless7 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - (void)testCreate { | ||
| id textureRegistry = OCMProtocolMock(@protocol(FlutterTextureRegistry)); | ||
| FlutterTextureRegistryRelay* relay = | ||
| [[FlutterTextureRegistryRelay alloc] initWithParent:textureRegistry]; | ||
| XCTAssertNotNil(relay); | ||
| XCTAssertEqual(textureRegistry, relay.parent); | ||
| } | ||
|
|
||
| - (void)testRegisterTexture { | ||
| id textureRegistry = OCMProtocolMock(@protocol(FlutterTextureRegistry)); | ||
| FlutterTextureRegistryRelay* relay = | ||
| [[FlutterTextureRegistryRelay alloc] initWithParent:textureRegistry]; | ||
| id texture = OCMProtocolMock(@protocol(FlutterTexture)); | ||
| [relay registerTexture:texture]; | ||
| OCMVerify([textureRegistry registerTexture:texture]); | ||
| } | ||
|
|
||
| - (void)testTextureFrameAvailable { | ||
| id textureRegistry = OCMProtocolMock(@protocol(FlutterTextureRegistry)); | ||
| FlutterTextureRegistryRelay* relay = | ||
| [[FlutterTextureRegistryRelay alloc] initWithParent:textureRegistry]; | ||
| [relay textureFrameAvailable:0]; | ||
| OCMVerify([textureRegistry textureFrameAvailable:0]); | ||
| } | ||
|
|
||
| - (void)testUnregisterTexture { | ||
| id textureRegistry = OCMProtocolMock(@protocol(FlutterTextureRegistry)); | ||
| FlutterTextureRegistryRelay* relay = | ||
| [[FlutterTextureRegistryRelay alloc] initWithParent:textureRegistry]; | ||
| [relay unregisterTexture:0]; | ||
| OCMVerify([textureRegistry unregisterTexture:0]); | ||
| } | ||
|
|
||
| - (void)testRetainCycle { | ||
| __weak FlutterEngine* weakEngine; | ||
| NSObject<FlutterTextureRegistry>* strongRelay; | ||
| @autoreleasepool { | ||
| id project = OCMClassMock([FlutterDartProject class]); | ||
| FlutterEngine* engine = [[FlutterEngine alloc] initWithName:@"foobar" project:project]; | ||
| strongRelay = [engine textureRegistry]; | ||
| weakEngine = engine; | ||
| } | ||
| XCTAssertNil(weakEngine); | ||
| } | ||
|
|
||
| @end | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.