Merge pull request #779 from appwrite/feat-clientside-id-gen

eldadfux · web-flow · commit 692c2225e6b9 · 2024-03-10T17:53:19.000+01:00
Generate Appwrite ID's on the Client-Side
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -67,4 +67,4 @@ jobs:
         run: composer install
 
       - name: Lint
-        run: composer lint
+        run: composer lint
diff --git a/composer.lock b/composer.lock
diff --git a/templates/android/library/src/main/java/io/package/ID.kt.twig b/templates/android/library/src/main/java/io/package/ID.kt.twig
@@ -1,10 +1,34 @@
 package {{ sdk.namespace | caseDot }}
 
+import java.time.Instant
+import kotlin.math.floor
+import kotlin.random.Random
+
 class ID {
     companion object {
+        // Generate an hex ID based on timestamp
+        // Recreated from https://www.php.net/manual/en/function.uniqid.php
+        private fun hexTimestamp(): String {
+            val now = Instant.now()
+            val sec = now.epochSecond
+            val usec = (System.nanoTime() / 1000) % 1000
+
+            val hexTimestamp = "%08x%05x".format(sec, usec)
+
+            return hexTimestamp
+        }
+
         fun custom(id: String): String
             = id
-        fun unique(): String
-            = "unique()"
+
+        // Generate a unique ID with padding to have a longer ID
+        fun unique(padding: Int = 7): String {
+            val baseId = hexTimestamp()
+            val randomPadding = (1..padding)
+                .map { Random.nextInt(0, 16).toString(16) }
+                .joinToString("")
+
+            return baseId + randomPadding
+        }
     }
-}
+}
diff --git a/templates/dart/lib/id.dart.twig b/templates/dart/lib/id.dart.twig
@@ -4,13 +4,34 @@ part of {{ language.params.packageName }};
 class ID {
   ID._();
 
-  /// Have Appwrite generate a unique ID for you.
-  static String unique() {
-    return 'unique()';
+  // Generate an hex ID based on timestamp
+  // Recreated from https://www.php.net/manual/en/function.uniqid.php
+  static String _hexTimestamp() {
+    final now = DateTime.now();
+    final sec = (now.millisecondsSinceEpoch / 1000).floor();
+    final usec = now.microsecondsSinceEpoch - (sec * 1000000);
+    return sec.toRadixString(16) +
+        usec.toRadixString(16).padLeft(5, '0');
+  }
+
+  // Generate a unique ID with padding to have a longer ID
+  static String unique({int padding = 7}) {
+    String id = _hexTimestamp();
+
+    if (padding > 0) {
+      StringBuffer sb = StringBuffer();
+      for (var i = 0; i < padding; i++) {
+        sb.write(Random().nextInt(16).toRadixString(16));
+      }
+
+      id += sb.toString();
+    }
+
+    return id;
   }
 
   /// Uses [id] as the ID for the resource.
   static String custom(String id) {
     return id;
   }
-}
+}
diff --git a/templates/dart/lib/package.dart.twig b/templates/dart/lib/package.dart.twig
@@ -6,6 +6,7 @@
 library {{ language.params.packageName }};
 
 import 'dart:async';
+import 'dart:math';
 import 'dart:typed_data';
 import 'dart:convert';
 
diff --git a/templates/dart/test/id_test.dart.twig b/templates/dart/test/id_test.dart.twig
@@ -7,8 +7,8 @@ import 'package:flutter_test/flutter_test.dart';
 
 void main() {
   group('unique()', () {
-    test('returns unique()', () {
-      expect(ID.unique(), 'unique()');
+    test('returns unique ID', () {
+      expect((ID.unique()).length, 20);
     });
   });
 
diff --git a/templates/deno/src/id.ts.twig b/templates/deno/src/id.ts.twig
@@ -1,9 +1,30 @@
 export class ID {
+    // Generate an hex ID based on timestamp
+    // Recreated from https://www.php.net/manual/en/function.uniqid.php
+    static #hexTimestamp(): string {
+        const now = new Date();
+        const sec = Math.floor(now.getTime() / 1000);
+        const msec = now.getMilliseconds();
+
+        // Convert to hexadecimal
+        const hexTimestamp = sec.toString(16) + msec.toString(16).padStart(5, '0');
+        return hexTimestamp;
+    }
+
     public static custom(id: string): string {
         return id
     }
-    
-    public static unique(): string {
-        return 'unique()'
+
+    // Generate a unique ID with padding to have a longer ID
+    public static unique(padding: number = 7): string {
+        const baseId = ID.#hexTimestamp();
+        let randomPadding = '';
+
+        for (let i = 0; i < padding; i++) {
+            const randomHexDigit = Math.floor(Math.random() * 16).toString(16);
+            randomPadding += randomHexDigit;
+        }
+
+        return baseId + randomPadding;
     }
-}
+}
diff --git a/templates/dotnet/src/Appwrite/ID.cs.twig b/templates/dotnet/src/Appwrite/ID.cs.twig
@@ -1,15 +1,42 @@
+using System;
+
 namespace {{ spec.title | caseUcfirst }}
 {
     public static class ID
     {
-        public static string Unique()
+        // Generate an hex ID based on timestamp
+        // Recreated from https://www.php.net/manual/en/function.uniqid.php
+        private static string HexTimestamp()
         {
-            return "unique()";
+            var now = DateTime.UtcNow;
+            var epoch = (now - new DateTime(1970, 1, 1));
+            var sec = (long)epoch.TotalSeconds;
+            var usec = (long)((epoch.TotalMilliseconds * 1000) % 1000);
+
+            // Convert to hexadecimal
+            var hexTimestamp = sec.ToString("x") + usec.ToString("x").PadLeft(5, '0');
+            return hexTimestamp;
+        }
+
+        // Generate a unique ID with padding to have a longer ID
+        public static string Unique(int padding = 7)
+        {
+            var random = new Random();
+            var baseId = HexTimestamp();
+            var randomPadding = "";
+
+            for (int i = 0; i < padding; i++)
+            {
+                var randomHexDigit = random.Next(0, 16).ToString("x");
+                randomPadding += randomHexDigit;
+            }
+
+            return baseId + randomPadding;
         }
 
         public static string Custom(string id)
         {
             return id;
         }
     }
-}
+}
diff --git a/templates/flutter/lib/package.dart.twig b/templates/flutter/lib/package.dart.twig
@@ -6,6 +6,7 @@
 library {{ language.params.packageName }};
 
 import 'dart:async';
+import 'dart:math';
 import 'dart:typed_data';
 import 'dart:convert';
 
diff --git a/templates/kotlin/src/main/kotlin/io/appwrite/ID.kt.twig b/templates/kotlin/src/main/kotlin/io/appwrite/ID.kt.twig
@@ -1,10 +1,33 @@
 package {{ sdk.namespace | caseDot }}
 
+import java.time.Instant
+import kotlin.math.floor
+import kotlin.random.Random
+
 class ID {
     companion object {
+        // Generate an hex ID based on timestamp
+        // Recreated from https://www.php.net/manual/en/function.uniqid.php
+        private fun hexTimestamp(): String {
+            val now = Instant.now()
+            val sec = now.epochSecond
+            val usec = (System.nanoTime() / 1000) % 1000
+
+            val hexTimestamp = "%08x%05x".format(sec, usec)
+
+            return hexTimestamp
+        }
+
         fun custom(id: String): String
             = id
-        fun unique(): String
-            = "unique()"
+        // Generate a unique ID with padding to have a longer ID
+        fun unique(padding: Int = 7): String {
+            val baseId = ID.hexTimestamp()
+            val randomPadding = (1..padding)
+                .map { Random.nextInt(0, 16).toString(16) }
+                .joinToString("")
+
+            return baseId + randomPadding
+        }
     }
-}
+}
diff --git a/templates/node/lib/id.js.twig b/templates/node/lib/id.js.twig
@@ -1,7 +1,27 @@
 class ID {
+    // Generate an hex ID based on timestamp
+    // Recreated from https://www.php.net/manual/en/function.uniqid.php
+    static #hexTimestamp = () => {
+        const now = new Date();
+        const sec = Math.floor(now.getTime() / 1000);
+        const msec = now.getMilliseconds();
 
-    static unique = () => {
-         return 'unique()'
+        // Convert to hexadecimal
+        const hexTimestamp = sec.toString(16) + msec.toString(16).padStart(5, '0');
+        return hexTimestamp;
+    }
+
+    // Generate a unique ID with padding to have a longer ID
+    static unique = (padding = 7) => {
+        const baseId = ID.#hexTimestamp();
+        let randomPadding = '';
+
+        for (let i = 0; i < padding; i++) {
+            const randomHexDigit = Math.floor(Math.random() * 16).toString(16);
+            randomPadding += randomHexDigit;
+        }
+
+        return baseId + randomPadding;
     }
 
     static custom = (id) => {
diff --git a/templates/php/src/ID.php.twig b/templates/php/src/ID.php.twig
@@ -3,13 +3,20 @@
 namespace {{ spec.title | caseUcfirst }};
 
 class ID {
-    public static function unique(): string
+    public static function unique(int $padding = 7): string
     {
-        return 'unique()';
+        $uniqid = \uniqid();
+
+        if ($padding > 0) {
+            $bytes = \random_bytes(\max(1, (int)\ceil(($padding / 2)))); // one byte expands to two chars
+            $uniqid .= \substr(\bin2hex($bytes), 0, $padding);
+        }
+
+        return $uniqid;
     }
 
     public static function custom(string $id): string
     {
         return $id;
     }
-}
+}
diff --git a/templates/python/package/id.py.twig b/templates/python/package/id.py.twig
@@ -1,8 +1,26 @@
+from datetime import datetime
+import math
+import os
+
 class ID:
+    # Generate an hex ID based on timestamp
+    # Recreated from https://www.php.net/manual/en/function.uniqid.php
+    @staticmethod
+    def __hex_timestamp():
+        now = datetime.now()
+        sec = int(now.timestamp())
+        usec = (now.microsecond % 1000)
+        hex_timestamp = f'{sec:08x}{usec:05x}'
+        return hex_timestamp
+
     @staticmethod
     def custom(id):
         return id
 
+    # Generate a unique ID with padding to have a longer ID
     @staticmethod
-    def unique():
-        return 'unique()'
+    def unique(padding = 7):
+        base_id = ID.__hex_timestamp()
+        random_bytes = os.urandom(math.ceil(padding / 2))
+        random_padding = random_bytes.hex()[:padding]
+        return base_id + random_padding
diff --git a/templates/ruby/lib/container/id.rb.twig b/templates/ruby/lib/container/id.rb.twig
@@ -1,11 +1,27 @@
+require 'securerandom'
+
 module {{spec.title | caseUcfirst}}
     class ID
         def self.custom(id)
             id
         end
-        
-        def self.unique
-            'unique()'
+
+        # Generate a unique ID with padding to have a longer ID
+        def self.unique(padding=7)
+            base_id = self.hex_timestamp
+            random_padding = SecureRandom.hex(padding)
+            random_padding = random_padding[0...padding]
+            base_id + random_padding
+        end
+
+        #Generate an hex ID based on timestamp
+        #Recreated from https://www.php.net/manual/en/function.uniqid.php
+        private_class_method def self.hex_timestamp
+            now = Time.now
+            sec = now.to_i
+            usec = now.usec
+            hex_timestamp = "%08x%05x" % [sec, usec]
+            hex_timestamp
         end
     end
-end
+end
diff --git a/templates/swift/Sources/ID.swift.twig b/templates/swift/Sources/ID.swift.twig
@@ -1,9 +1,26 @@
+import Foundation
+
 public class ID {
+    // Generate an hex ID based on timestamp
+    // Recreated from https://www.php.net/manual/en/function.uniqid.php
+    private static func hexTimestamp() -> String {
+        let now = Date()
+        let secs = Int(now.timeIntervalSince1970)
+        let usec = Int((now.timeIntervalSince1970 - Double(secs)) * 1_000_000)
+        let hexTimestamp = String(format: "%08x%05x", secs, usec)
+        return hexTimestamp
+    }
+
     public static func custom(_ id: String) -> String {
         return id
     }
 
-    public static func unique() -> String {
-        return "unique()"
+    // Generate a unique ID with padding to have a longer ID
+    public static func unique(padding: Int = 7) -> String {
+        let baseId = Self.hexTimestamp()
+        let randomPadding = (1...padding).map {
+            _ in String(format: "%x", Int.random(in: 0..<16))
+        }.joined()
+        return baseId + randomPadding
     }
-}
+}
diff --git a/templates/web/src/id.ts.twig b/templates/web/src/id.ts.twig
diff --git a/tests/Base.php b/tests/Base.php
