Add generated iOS plugin, documentation, and serialization methods #11

Mrhea · 2021-07-14T23:33:33Z

This PR adds the code generated by Flutter for an iOS plugin and the changes to it necessary to connect to Tozny's Flutter client, first versions of serialization methods relevant to implementing Tozny SDK methods, and documentation for how to setup and run the plugin on Xcode.

There are also changes to the Flutter Dart client to handle the errors introduced by the null safety system in the newer version of the sdk.

Note that this PR does not contain an implementation of write record, this is noted in the [WASH-929] Add docs and serialization methods commit. The plugin is confirmed to be working because getPlatformVersion method works and shows the expected output in a simulator.

This is a WIP.

- Adds new writeRecord method to Tozny iOS plugin - Adds WIP tests that need to be completed before writeRecord fully implemented Client in Dart test is needs to use credentials from an existing TozStore client. Completed tests will be added shortly.

- Remove unnecessary code and comments throughout plugin code - Fixes parameters in the writeRecord method in the plugin class Note that this commit will fail to run the app because of a serialization. This will be resolved in the near future.

- Updates SwiftFlutterPlugin writeRecord method to use correct JSON serialization methods - Adds FlutterConfig class as a level of indirection to bridge the tozny_model.dart ClientCredentials class to the E3db Swift SDK's Config class - Updates the tozny_model.dart ClientCredentials class to include the clientName field as it is required by the E3db Swift SDK's Config class - Updates tozny_model.dart and plugin_identity.dart to fix non-nullable errors caused by updated dev-dependency 'sdk' Note that the changes to Dart code need to be error handled properly as making many of the fields nullable possibly introduces downstream errors and thrown exceptions when fields expected to be non-null are null.

- Adds a WIP extension for the JSONDecoder object in Swift: convertFromFlutterConfigToE3dbConfig - The extension has not had its first version written, but the general idea is to use this such that the decoder will customize the values of keys in FlutterConfig to match those of an E3DB Config object

- Removes unnecessarily complicated solution to converting a FlutterConfig to E3db Config - Clients are initialized properly now, but there exists a suspected authentication issue when writing records

- Changes the types of url and uuid fields in FlutterConfig to be Strings

efabens · 2021-07-14T23:43:52Z

DEVELOPMENT.md

+
+The `flutter create` command will complain if the repository name does not adhere to this convention, so make sure to rename the repository's name if necessary. 
+
+At the time of this writing the Tozny plugin's repository is named such that it will encounter this problem. 


I am going to rename this repository so that it is compliant. This will require existing clones of the repo to update their upstream URL. To do that in the directory rungit remote set-url origin git@github.com:tozny/flutter_plugin

efabens

https://stackoverflow.com/questions/49478/git-ignore-file-for-xcode-projects

We briefly talked in this, but then I dug a little more. I think some of the code files should get added to the gitignore. But I wouldn't consider it an emergency

efabens · 2021-07-14T23:49:17Z

DEVELOPMENT.md

+
+The Tozny iOS plugin requires [XCode](https://developer.apple.com/xcode/) and [Cocoapods](https://cocoapods.org/) installed in order to be built. 
+
+Before opening the project, make sure that all necessary project dependencies and pods are installed by running the `flutter pub get` and `pod install` commands. This installs the dependencies and pods found in the project's Podfile and each module's `.podspec` file. 


is pod install run from the root directory?

No, from /example/ios. Will update, thanks for catching that

efabens

This is a great start. Good looking documentation.

efabens · 2021-07-15T00:04:41Z

example/pubspec.lock

@@ -14,7 +14,7 @@ packages:
      name: analyzer
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.7.2"
+    version: "1.7.1"


What is the reason for downgrading the versions in this file?

I believe this was done automatically after a flutter pub get I did at some point. I will trace down why this happened and get them upgraded again, but off the top of my head I only know this was not done intentionally

efabens · 2021-07-15T00:07:10Z

pubspec.lock

@@ -14,7 +14,7 @@ packages:
      name: analyzer
      url: "https://pub.dartlang.org"
    source: hosted
-    version: "1.7.2"
+    version: "1.7.1"


same question re dependencies?

Same reply above

efabens · 2021-07-15T00:16:37Z

ios/Classes/E3dbSerializer.swift

+        data.updateValue(E3dbSerializer.userAgentTokenToJson(tok: id.agentInfo()), forKey: "user_agent_token")
+
+        let jsonData = try! JSONSerialization.data(withJSONObject: data, options: .prettyPrinted)
+        guard let jsonString = String(data: jsonData, encoding: .utf8) else { return "Something bad happened." } // TODO: Error


Let's update these "Something bad happened" to "Failed to <what failed in 3-7 words>" so for this something like Failed to stringify an idClient JsonObject.

Also as I am not a swift expert would it be better to have this throw an error of some kind if this method fails? With this string a downstream consumer will need to equality check for failures, is there a more canonical way to show failures to method callers? Potentially that is what the error handling notes you have are about, if so we should do that sooner rather than later.

Yup, that is the intention of the error handling notes. An option is to, instead of guard (which returns early), provide a default value. e.g. let jsonString = String(...) ?? "". There are better patterns where I can throw errors, though. The try! is a forced unwrapping, which is generally discouraged. Updating the error handling will include removing forced unwraps

I agree the guard pattern is not what should be used here, these will be fixed.

EDIT: Well, guard let may be appropriate... it is supposed to provide an early exit. If I mark the function with throws (e.g. static func idClientToJson(...) throws {...} ), then I can throw an error in the guard's else clause. If I represent serialization errors in an enum, then throw in case of failure then it'll propagate to the surrounding scope

Example of error representation:

enum E3dbSerializationError: Error { case invalidEncoding(message: String), ... }

We should return some type of error whether it is checked and handled or a runtime exception that crashes the program with a serialization error (That appears to be the approach we use on the java side). But propagating a string that downstream functions will not be able to correctly handle seems like the worst of the three options

efabens · 2021-07-15T00:17:26Z

ios/Classes/E3dbSerializer.swift

+        data.updateValue(meta.fileMeta, forKey: "file_meta")
+
+        let jsonData = try! JSONSerialization.data(withJSONObject: data, options: .prettyPrinted)
+        guard let jsonString = String(data: jsonData, encoding: .utf8) else { return "Something bad happened." } // TODO: ERROR HANDLING


see above for this and all the below lines that are the same structure.

sjonz · 2021-07-15T00:40:25Z

It might be worthwhile to group some of these commits together in an interactive rebase? Not required, but it would be nice to clean up the WIP commits at least.

accidental click

- Adds development documentation for setting up and running the Flutter iOS plugin - Adds FlutterConfigSerializer to bridge Flutter Dart client's ClientCredentials object to E3db's Config - Adds RealmConfigSerializer - Adds encoding and decoding methods for E3db objects Note that this PR removed an incomplete version of the writeRecord method.

Matthew Rhea added 7 commits July 9, 2021 09:27

Add scratch work for ios plugin

fab039a

This is a WIP.

[WASH-929] Update writeRecord, fix FlutterConfig

c692749

- Removes unnecessarily complicated solution to converting a FlutterConfig to E3db Config - Clients are initialized properly now, but there exists a suspected authentication issue when writing records

[WASH-929] Update typing in config encoding

d013da2

- Changes the types of url and uuid fields in FlutterConfig to be Strings

Mrhea requested review from efabens, galxy25, carrala, rosasck and sjonz July 14, 2021 23:33

efabens reviewed Jul 14, 2021

View reviewed changes

efabens reviewed Jul 15, 2021

View reviewed changes

sjonz previously approved these changes Jul 15, 2021

View reviewed changes

Mrhea force-pushed the wash-929-e3db-serialization-and-documentation branch 4 times, most recently from 4a3c35e to 013c2c1 Compare July 16, 2021 16:57

galxy25 approved these changes Jul 20, 2021

View reviewed changes

Mrhea force-pushed the wash-929-e3db-serialization-and-documentation branch from 013c2c1 to ecfcb1b Compare July 20, 2021 18:40

Mrhea merged commit 957ffc1 into trunk Jul 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add generated iOS plugin, documentation, and serialization methods #11

Add generated iOS plugin, documentation, and serialization methods #11

Mrhea commented Jul 14, 2021 •

edited by jira bot

Loading

efabens Jul 14, 2021

efabens left a comment

efabens Jul 14, 2021

Mrhea Jul 15, 2021

efabens left a comment

efabens Jul 15, 2021

Mrhea Jul 15, 2021

efabens Jul 15, 2021

Mrhea Jul 15, 2021

efabens Jul 15, 2021

Mrhea Jul 15, 2021 •

edited

Loading

efabens Jul 15, 2021

efabens Jul 15, 2021

sjonz commented Jul 15, 2021


		The `flutter create` command will complain if the repository name does not adhere to this convention, so make sure to rename the repository's name if necessary.

		At the time of this writing the Tozny plugin's repository is named such that it will encounter this problem.


		The Tozny iOS plugin requires [XCode](https://developer.apple.com/xcode/) and [Cocoapods](https://cocoapods.org/) installed in order to be built.

		Before opening the project, make sure that all necessary project dependencies and pods are installed by running the `flutter pub get` and `pod install` commands. This installs the dependencies and pods found in the project's Podfile and each module's `.podspec` file.

Add generated iOS plugin, documentation, and serialization methods #11

Add generated iOS plugin, documentation, and serialization methods #11

Conversation

Mrhea commented Jul 14, 2021 • edited by jira bot Loading

Choose a reason for hiding this comment

efabens left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

efabens left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mrhea Jul 15, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sjonz commented Jul 15, 2021

Mrhea commented Jul 14, 2021 •

edited by jira bot

Loading

Mrhea Jul 15, 2021 •

edited

Loading