Merge pull request #486 from Kommunicate-io/dev

Release 7.2.8

Author: KommunicateDeveloper

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,10 +1,7 @@
 ## Summary
 <!-- Simple summary of what was changed. -->
 
-## Motivation
-<!-- Why are you making this change? -->
-
 ## Testing Branches
-<!-- How was the code tested? Be as specific as possible. -->
+<!-- Which branch the code should be tested? Add the code in `<BRANCH_NAME>`. -->
 KM_ChatUI_Branch : `dev`
 KM_Core_Branch: `dev`

.github/workflows/ios-automation-test.yaml

@@ -1,16 +1,72 @@
 name: iOS Automation Test Workflow
 
 on:
-  pull_request: # Trigger this workflow on pull request events
+  pull_request:
     types:
       - opened
+      - synchronize  # Triggers when a new commit is pushed to the PR
+
+concurrency:
+  group: pr-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
 
 jobs:
+  # Build and Lint Job
+  build-and-lint:
+    name: Build and Lint
+    # Only run this job when the base branch is master
+    if: github.event.pull_request.base.ref == 'master'
+    runs-on: macos-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Set up Xcode
+        uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: '16.1.0'
+
+      - name: Run Linter Check
+        run: |
+          pod lib lint --allow-warnings
+
+      - name: Debug Environment Variables (Optional)
+        run: echo "Environment variables set successfully."
+
+      - name: Post Lint Test Results to PR
+        if: github.event_name == 'pull_request' && success()
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const comment = `✅ **iOS Lint Test Result**\nCongratulations! Linter Check Passed Successfully 🎉`;
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: comment,
+            });
+
+      - name: Post Lint Failure Result to PR
+        if: github.event_name == 'pull_request' && failure()
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const comment = `❌ **iOS Lint Test Result**\nOops! Linter Check Failed. Please fix the issues.`;
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: comment,
+            });
+
+  # Build and Test Job
   build-and-test:
     name: Build and Test
     runs-on: macos-latest
-    timeout-minutes: 45 # Prevents the workflow from hanging indefinitely
-
+    timeout-minutes: 45
+    
     steps:
       # Step 1: Checkout the code
       - name: Checkout Repository

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 The changelog for [Kommunicate-iOS-SDK](https://github.com/Kommunicate-io/Kommunicate-iOS-SDK). Also see the [releases](https://github.com/Kommunicate-io/Kommunicate-iOS-SDK/releases) on Github.
 
+## [7.2.8] 2025-03-18
+- Internal Code Refactor.
+- Typing indicator For bot message delay.
+- Updated TableView Update function.
+- Updated depricated Code and resolved Warnings.
+
 ## [7.2.7] 2025-02-14
 - Updated Kingfisher from 7.6.2 to 7.10.0 to align with Privacy Manifest requirements.
 

Example/.swiftlint.yml

@@ -0,0 +1,56 @@
+
+reporter: "xcode" # reporter type (xcode, json, csv, checkstyle, junit, html, emoji)
+
+included:
+    - ../sources
+    - ../../KommunicateChatUI-iOS-SDK/sources
+    - ../../KommunicateCore-iOS-SDK/sources
+
+excluded: # paths to ignore during linting. Takes precedence over `included`.
+    - .
+    - Carthage
+    - Pods
+    - SwiftLint/Common/3rdPartyLib
+
+# Disable specific rules that may be unnecessary or too strict
+disabled_rules:
+  - trailing_whitespace  # Allows trailing whitespace (not recommended but sometimes needed)
+  - empty_count          # Disables warning for using `.count == 0` instead of `.isEmpty`
+
+# Enable additional rules for stricter linting
+opt_in_rules:
+  - empty_parameters              # Ensures function parameters are not left empty
+  - explicit_init                 # Requires explicit initializers to avoid ambiguity
+  - vertical_parameter_alignment  # Aligns function parameters for better readability
+
+# Enforce maximum line length to keep code readable
+line_length: 120  # Maximum allowed characters per line
+
+cyclomatic_complexity:
+  warning: 50 # Increase the limit from 10 to 50
+  error: 60
+
+# Function and type length restrictions to encourage modular code
+function_body_length: 40  # Limits function body length to 40 lines
+type_body_length: 200     # Limits classes/structs to 200 lines
+file_length: 400          # Restricts each file to a maximum of 400 lines
+
+# Naming conventions for better readability
+identifier_name:
+  min_length: 3  # Ensures variables have meaningful names (e.g., `id` is too short)
+  max_length: 40 # Prevents excessively long variable names
+  allowed_symbols: ["_"]  # Allows underscores in variable names
+  validates_start_with_lowercase: false  # Allows uppercase identifiers
+
+# Prevent forced unwrapping and casting to improve safety
+force_unwrapping: warning  # Warns against using `!`, which can cause crashes
+force_cast: warning        # Discourages forced type casting using `as!`
+
+# Optimize code by avoiding redundant initializations
+redundant_optional_initialization: warning  # Detects unnecessary `= nil` assignments
+redundant_setter_value: warning             # Avoids redundant property setter assignments
+redundant_string_enum_value: warning        # Removes unnecessary explicit raw
+
+# Allow Todo Comments (if enabled above)
+todo:
+  severity: warning

Example/Kommunicate.xcodeproj/project.pbxproj

@@ -21,6 +21,8 @@
 		8213687C2CDA2CEE00B09F37 /* KommunicateConfigurationTesting.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8213687B2CDA2CEE00B09F37 /* KommunicateConfigurationTesting.swift */; };
 		8213687E2CDA332100B09F37 /* KommunicateLoginAndWelcomeMessage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8213687D2CDA332100B09F37 /* KommunicateLoginAndWelcomeMessage.swift */; };
 		8237AC4C2D4A5DF8008BC1AC /* KommunicateResolveAndAssignmentUITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8237AC4B2D4A5DF8008BC1AC /* KommunicateResolveAndAssignmentUITests.swift */; };
+		82881F2A2D65B82300D3A1C1 /* KommunicateCSATUITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 82881F292D65B82300D3A1C1 /* KommunicateCSATUITests.swift */; };
+		82881F2F2D684CA900D3A1C1 /* KommunicatePreChatUITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 82881F2E2D684CA900D3A1C1 /* KommunicatePreChatUITests.swift */; };
 		8B33037F2226A494003BF306 /* LoginViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B33037E2226A494003BF306 /* LoginViewController.swift */; };
 		8B5BC12A22002FDC00F39956 /* Localizable.strings in Resources */ = {isa = PBXBuildFile; fileRef = 8B5BC12822002FDC00F39956 /* Localizable.strings */; };
 		8B8FFA9421D5171F00C8ED57 /* PaymentTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B8FFA9321D5171F00C8ED57 /* PaymentTests.swift */; };
@@ -66,9 +68,12 @@
 		6C12430200CB714F7C6EC6DE /* Pods_Kommunicate_ExampleUITests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Kommunicate_ExampleUITests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		707E7F0040A81A7354816747 /* Pods-Kommunicate_Example.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Kommunicate_Example.debug.xcconfig"; path = "Target Support Files/Pods-Kommunicate_Example/Pods-Kommunicate_Example.debug.xcconfig"; sourceTree = "<group>"; };
 		78226602544E9745BB6CB084 /* Pods_Kommunicate_Tests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Kommunicate_Tests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
+		8206968B2D7ACB8400D006DA /* .swiftlint.yml */ = {isa = PBXFileReference; lastKnownFileType = text.yaml; path = .swiftlint.yml; sourceTree = "<group>"; };
 		8213687B2CDA2CEE00B09F37 /* KommunicateConfigurationTesting.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = KommunicateConfigurationTesting.swift; sourceTree = "<group>"; };
 		8213687D2CDA332100B09F37 /* KommunicateLoginAndWelcomeMessage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = KommunicateLoginAndWelcomeMessage.swift; sourceTree = "<group>"; };
 		8237AC4B2D4A5DF8008BC1AC /* KommunicateResolveAndAssignmentUITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = KommunicateResolveAndAssignmentUITests.swift; sourceTree = "<group>"; };
+		82881F292D65B82300D3A1C1 /* KommunicateCSATUITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = KommunicateCSATUITests.swift; sourceTree = "<group>"; };
+		82881F2E2D684CA900D3A1C1 /* KommunicatePreChatUITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = KommunicatePreChatUITests.swift; sourceTree = "<group>"; };
 		8AFCF2C4706B87B553819E20 /* Pods-Kommunicate_Tests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Kommunicate_Tests.debug.xcconfig"; path = "Target Support Files/Pods-Kommunicate_Tests/Pods-Kommunicate_Tests.debug.xcconfig"; sourceTree = "<group>"; };
 		8B33037E2226A494003BF306 /* LoginViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoginViewController.swift; sourceTree = "<group>"; };
 		8B5BC12422002C4000F39956 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = "<group>"; };
@@ -142,6 +147,7 @@
 		607FACC71AFB9204008FA782 = {
 			isa = PBXGroup;
 			children = (
+				8206968B2D7ACB8400D006DA /* .swiftlint.yml */,
 				8B68A6F72051551F00BF6C22 /* Kommunicate_Example.entitlements */,
 				607FACF51AFB993E008FA782 /* Podspec Metadata */,
 				607FACD21AFB9204008FA782 /* Example for Kommunicate */,
@@ -245,7 +251,9 @@
 			children = (
 				8213687B2CDA2CEE00B09F37 /* KommunicateConfigurationTesting.swift */,
 				8237AC4B2D4A5DF8008BC1AC /* KommunicateResolveAndAssignmentUITests.swift */,
+				82881F292D65B82300D3A1C1 /* KommunicateCSATUITests.swift */,
 				C698B48F24AB76A5008BB4D9 /* KommunicateCreateConversationAndSendMessagesTests.swift */,
+				82881F2E2D684CA900D3A1C1 /* KommunicatePreChatUITests.swift */,
 				C698B48E24AB76A5008BB4D9 /* TestCaseInfo.swift */,
 				C698B49D24AB77D5008BB4D9 /* Info.plist */,
 				C67D56E724AE439A001BA419 /* KommunicateLoginAsVisitorUITests.swift */,
@@ -268,6 +276,7 @@
 				607FACCD1AFB9204008FA782 /* Frameworks */,
 				607FACCE1AFB9204008FA782 /* Resources */,
 				1D7D9C8FADF87FDBB71B7A4E /* [CP] Embed Pods Frameworks */,
+				820696862D7ABB0D00D006DA /* ShellScript */,
 			);
 			buildRules = (
 			);
@@ -538,6 +547,23 @@
 			shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-Kommunicate_ExampleUITests/Pods-Kommunicate_ExampleUITests-frameworks.sh\"\n";
 			showEnvVarsInLog = 0;
 		};
+		820696862D7ABB0D00D006DA /* ShellScript */ = {
+			isa = PBXShellScriptBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputFileListPaths = (
+			);
+			inputPaths = (
+			);
+			outputFileListPaths = (
+			);
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "#!/bin/bash\n\n# Set Homebrew path for Apple Silicon Macs\nif [[ \"$(uname -m)\" == arm64 ]]; then\n    export PATH=\"/opt/homebrew/bin:$PATH\"\nfi\n\n# Define valid paths for SwiftLint\nVALID_PATHS=(\n    \"../sources\"\n    \"../../KommunicateChatUI-iOS-SDK/sources\"\n    \"../../KommunicateCore-iOS-SDK/sources\"\n)\n\n# Check if at least one path exists before running SwiftLint\nFOUND_VALID_PATH=false\n\nfor path in \"${VALID_PATHS[@]}\"; do\n    if [ -d \"$path\" ]; then\n        FOUND_VALID_PATH=true\n        break\n    fi\ndone\n\nif [ \"$FOUND_VALID_PATH\" = false ]; then\n    echo \"No valid SwiftLint paths found. Skipping linting.\"\n    exit 0\nfi\n\n# Run SwiftLint if installed\nif command -v swiftlint >/dev/null 2>&1; then\n    swiftlint --fix\n    swiftlint\nelse\n    echo \"warning: 'swiftlint' command not found - See https://github.com/realm/SwiftLint#installation for installation instructions.\"\nfi\n";
+		};
 		F47AF37523481C3B162F3C1B /* [CP] Check Pods Manifest.lock */ = {
 			isa = PBXShellScriptBuildPhase;
 			buildActionMask = 2147483647;
@@ -592,7 +618,9 @@
 			files = (
 				C698B4A424AB7803008BB4D9 /* KommunicateCreateConversationAndSendMessagesTests.swift in Sources */,
 				8237AC4C2D4A5DF8008BC1AC /* KommunicateResolveAndAssignmentUITests.swift in Sources */,
+				82881F2F2D684CA900D3A1C1 /* KommunicatePreChatUITests.swift in Sources */,
 				C67D56E824AE439A001BA419 /* KommunicateLoginAsVisitorUITests.swift in Sources */,
+				82881F2A2D65B82300D3A1C1 /* KommunicateCSATUITests.swift in Sources */,
 				C698B4A324AB7803008BB4D9 /* TestCaseInfo.swift in Sources */,
 				8213687E2CDA332100B09F37 /* KommunicateLoginAndWelcomeMessage.swift in Sources */,
 				8213687C2CDA2CEE00B09F37 /* KommunicateConfigurationTesting.swift in Sources */,

Example/Kommunicate/AppDelegate.swift

@@ -23,6 +23,10 @@
                 Kommunicate.defaultConfiguration.restrictedMessageRegexPattern = regexPattern
             }
 
+            if ProcessInfo.processInfo.environment["isCSATRatingButtonEnabled"] != nil {
+                Kommunicate.defaultConfiguration.rateConversationMenuOption = true
+            }
+            
             if let KMAppID = Bundle.main.object(forInfoDictionaryKey: "KOMMUNICATE_APP_ID") as? String {
                 appId = KMAppID
             }

Example/Kommunicate/LoginViewController.swift

@@ -10,7 +10,7 @@
     import Kommunicate
     import UIKit
 
-    class LoginViewController: UIViewController {
+class LoginViewController: UIViewController, KMPreChatFormViewControllerDelegate {
         @IBOutlet var scrollView: UIScrollView!
         @IBOutlet var userName: UITextField!
         @IBOutlet var password: UITextField!
@@ -89,8 +89,25 @@
             registerUser(kmUser)
         }
 
-        @IBAction func loginAsVisitor(_: Any) {
-            resignFields()
+    @IBAction func loginAsVisitor(_: Any) {
+        resignFields()
+        
+        if ProcessInfo.processInfo.environment["isFaqUIFromDashboardTestEnabled"] != nil {
+            let applicationId = (UIApplication.shared.delegate as! AppDelegate).appId
+            setupApplicationKey(applicationId)
+            let conversation = KMConversation(userId: Kommunicate.randomId())
+            Kommunicate.createConversationWithPreChat(appID: applicationId, conversation: conversation, viewController: self) { error in
+                if error != nil {
+                    return
+                }
+            }
+        } else if ProcessInfo.processInfo.environment["isFaqUITestEnabled"] != nil {
+            let preChatVC = KMPreChatFormViewController(configuration: Kommunicate.defaultConfiguration)
+            preChatVC.delegate = self // Set the delegate to self to receive callbacks
+            preChatVC.preChatConfiguration.optionsToShow = [.email, .name, .phoneNumber] // Configure options to be visible in pre-chat
+            preChatVC.preChatConfiguration.mandatoryOptions = [.email, .name, .phoneNumber] // Configure mandatory options
+            self.present(preChatVC, animated: false, completion: nil) // Present the pre-chat view
+        } else {
             let applicationId = (UIApplication.shared.delegate as! AppDelegate).appId
             setupApplicationKey(applicationId)
             let kmUser = userWithUserId(Kommunicate.randomId(), andApplicationId: applicationId)
@@ -111,7 +128,25 @@
                 }
             })
         }
-
+    }
+    
+        func userSubmittedResponse(name: String, email: String, phoneNumber: String, password: String) {
+            dismiss(animated: true)
+            let applicationId = (UIApplication.shared.delegate as! AppDelegate).appId
+            setupApplicationKey(applicationId)
+            let kmUser = userWithUserId(Kommunicate.randomId(), andApplicationId: applicationId)
+            kmUser.displayName = name
+            kmUser.email = email
+            kmUser.contactNumber = phoneNumber
+            kmUser.password = password
+            activityIndicator.startAnimating()
+            registerUser(kmUser)
+        }
+    
+        func closeButtonTapped() {
+            dismiss(animated: true)
+        }
+    
         @objc func keyboardWillHide(notification: NSNotification) {
             guard isKeyboardVisible,
                   let duration = notification.userInfo?[UIResponder.keyboardAnimationDurationUserInfoKey] as? TimeInterval

Example/Kommunicate/ViewController.swift

@@ -11,7 +11,7 @@
     import UIKit
 
     class ViewController: UIViewController {
-        let activityIndicator = UIActivityIndicatorView(style: .gray)
+        let activityIndicator = UIActivityIndicatorView(style: UIActivityIndicatorView.Style.medium)
 
         override func viewDidLoad() {
             super.viewDidLoad()