feat: Userid mapping updates (#50)

jscyo · web-flow · commit 7f5d4b1226cf · 2022-08-10T18:54:33.000+05:30
* feat

* fixes

* updates CHANGELOG.md

* adds missing TestOnly

* fixes

* fixes
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [1.19.0] - 2022-08-10
+
+- Adds compatibility with plugin interface 2.17
+
 ## [1.18.0] - 2022-07-25
 
 - Adds support for UserIdMapping recipe
diff --git a/build.gradle b/build.gradle
@@ -2,7 +2,7 @@ plugins {
     id 'java-library'
 }
 
-version = "1.18.0"
+version = "1.19.0"
 
 repositories {
     mavenCentral()
diff --git a/pluginInterfaceSupported.json b/pluginInterfaceSupported.json
@@ -1,6 +1,6 @@
 {
   "_comment": "contains a list of plugin interfaces branch names that this core supports",
   "versions": [
-    "2.16"
+    "2.17"
   ]
 }
diff --git a/src/main/java/io/supertokens/storage/postgresql/Start.java b/src/main/java/io/supertokens/storage/postgresql/Start.java
@@ -31,12 +31,14 @@
 import io.supertokens.pluginInterface.emailpassword.exceptions.DuplicateUserIdException;
 import io.supertokens.pluginInterface.emailpassword.exceptions.UnknownUserIdException;
 import io.supertokens.pluginInterface.emailpassword.sqlStorage.EmailPasswordSQLStorage;
+import io.supertokens.pluginInterface.emailverification.EmailVerificationStorage;
 import io.supertokens.pluginInterface.emailverification.EmailVerificationTokenInfo;
 import io.supertokens.pluginInterface.emailverification.exception.DuplicateEmailVerificationTokenException;
 import io.supertokens.pluginInterface.emailverification.sqlStorage.EmailVerificationSQLStorage;
 import io.supertokens.pluginInterface.exceptions.QuitProgramFromPluginException;
 import io.supertokens.pluginInterface.exceptions.StorageQueryException;
 import io.supertokens.pluginInterface.exceptions.StorageTransactionLogicException;
+import io.supertokens.pluginInterface.jwt.JWTRecipeStorage;
 import io.supertokens.pluginInterface.jwt.JWTSigningKeyInfo;
 import io.supertokens.pluginInterface.jwt.exceptions.DuplicateKeyIdException;
 import io.supertokens.pluginInterface.jwt.sqlstorage.JWTRecipeSQLStorage;
@@ -45,6 +47,7 @@
 import io.supertokens.pluginInterface.passwordless.exception.*;
 import io.supertokens.pluginInterface.passwordless.sqlStorage.PasswordlessSQLStorage;
 import io.supertokens.pluginInterface.session.SessionInfo;
+import io.supertokens.pluginInterface.session.SessionStorage;
 import io.supertokens.pluginInterface.session.sqlStorage.SessionSQLStorage;
 import io.supertokens.pluginInterface.sqlStorage.TransactionConnection;
 import io.supertokens.pluginInterface.thirdparty.exception.DuplicateThirdPartyUserException;
@@ -53,7 +56,9 @@
 import io.supertokens.pluginInterface.useridmapping.UserIdMappingStorage;
 import io.supertokens.pluginInterface.useridmapping.exception.UnknownSuperTokensUserIdException;
 import io.supertokens.pluginInterface.useridmapping.exception.UserIdMappingAlreadyExistsException;
+import io.supertokens.pluginInterface.usermetadata.UserMetadataStorage;
 import io.supertokens.pluginInterface.usermetadata.sqlStorage.UserMetadataSQLStorage;
+import io.supertokens.pluginInterface.userroles.UserRolesStorage;
 import io.supertokens.pluginInterface.userroles.exception.DuplicateUserRoleMappingException;
 import io.supertokens.pluginInterface.userroles.exception.UnknownRoleException;
 import io.supertokens.pluginInterface.userroles.sqlStorage.UserRolesSQLStorage;
@@ -72,6 +77,8 @@
 import java.sql.Connection;
 import java.sql.SQLException;
 import java.sql.SQLTransactionRollbackException;
+import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 
 public class Start
@@ -540,6 +547,84 @@ public boolean canBeUsed(String configFilePath) {
         return Config.canBeUsed(configFilePath);
     }
 
+    @Override
+    public boolean isUserIdBeingUsedInNonAuthRecipe(String className, String userId) throws StorageQueryException {
+        // check if the input userId is being used in nonAuthRecipes.
+        if (className.equals(SessionStorage.class.getName())) {
+            String[] sessionHandlesForUser = getAllNonExpiredSessionHandlesForUser(userId);
+            return sessionHandlesForUser.length > 0;
+        } else if (className.equals(UserRolesStorage.class.getName())) {
+            String[] roles = getRolesForUser(userId);
+            return roles.length > 0;
+        } else if (className.equals(UserMetadataStorage.class.getName())) {
+            JsonObject userMetadata = getUserMetadata(userId);
+            return userMetadata != null;
+        } else if (className.equals(EmailVerificationStorage.class.getName())) {
+            try {
+                return EmailVerificationQueries.isUserIdBeingUsedForEmailVerification(this, userId);
+            } catch (SQLException e) {
+                throw new StorageQueryException(e);
+            }
+        } else if (className.equals(JWTRecipeStorage.class.getName())) {
+            return false;
+        } else {
+            throw new IllegalStateException("ClassName: " + className + " is not part of NonAuthRecipeStorage");
+        }
+    }
+
+    @TestOnly
+    @Override
+    public void addInfoToNonAuthRecipesBasedOnUserId(String className, String userId) throws StorageQueryException {
+        // add entries to nonAuthRecipe tables with input userId
+        if (className.equals(SessionStorage.class.getName())) {
+            try {
+                createNewSession("sessionHandle", userId, "refreshTokenHash", new JsonObject(),
+                        System.currentTimeMillis() + 1000000, new JsonObject(), System.currentTimeMillis());
+            } catch (Exception e) {
+                throw new StorageQueryException(e);
+            }
+        } else if (className.equals(UserRolesStorage.class.getName())) {
+            try {
+                String role = "testRole";
+                this.startTransaction(con -> {
+                    createNewRoleOrDoNothingIfExists_Transaction(con, role);
+                    return null;
+                });
+                try {
+                    addRoleToUser(userId, role);
+                } catch (Exception e) {
+                    throw new StorageTransactionLogicException(e);
+                }
+            } catch (StorageTransactionLogicException e) {
+                throw new StorageQueryException(e.actualException);
+            }
+        } else if (className.equals(EmailVerificationStorage.class.getName())) {
+            try {
+                EmailVerificationTokenInfo info = new EmailVerificationTokenInfo(userId, "someToken", 10000,
+                        "test123@example.com");
+                addEmailVerificationToken(info);
+
+            } catch (DuplicateEmailVerificationTokenException e) {
+                throw new StorageQueryException(e);
+            }
+        } else if (className.equals(UserMetadataStorage.class.getName())) {
+            JsonObject data = new JsonObject();
+            data.addProperty("test", "testData");
+            try {
+                this.startTransaction(con -> {
+                    setUserMetadata_Transaction(con, userId, data);
+                    return null;
+                });
+            } catch (StorageTransactionLogicException e) {
+                throw new StorageQueryException(e);
+            }
+        } else if (className.equals(JWTRecipeStorage.class.getName())) {
+            /* Since JWT recipe tables do not store userId we do not add any data to them */
+        } else {
+            throw new IllegalStateException("ClassName: " + className + " is not part of NonAuthRecipeStorage");
+        }
+    }
+
     @Override
     public void signUp(UserInfo userInfo)
             throws StorageQueryException, DuplicateUserIdException, DuplicateEmailException {
@@ -1717,4 +1802,14 @@ public boolean updateOrDeleteExternalUserIdInfo(String userId, boolean isSuperTo
             throw new StorageQueryException(e);
         }
     }
+
+    @Override
+    public HashMap<String, String> getUserIdMappingForSuperTokensIds(ArrayList<String> userIds)
+            throws StorageQueryException {
+        try {
+            return UserIdMappingQueries.getUserIdMappingWithUserIds(this, userIds);
+        } catch (SQLException e) {
+            throw new StorageQueryException(e);
+        }
+    }
 }
diff --git a/src/main/java/io/supertokens/storage/postgresql/queries/EmailVerificationQueries.java b/src/main/java/io/supertokens/storage/postgresql/queries/EmailVerificationQueries.java
@@ -53,7 +53,7 @@ static String getQueryToCreateEmailVerificationTokensTable(Start start) {
         String emailVerificationTokensTable = Config.getConfig(start).getEmailVerificationTokensTable();
         // @formatter:off
         return "CREATE TABLE IF NOT EXISTS " + emailVerificationTokensTable + " ("
-                + "user_id VARCHAR(128) NOT NULL," 
+                + "user_id VARCHAR(128) NOT NULL,"
                 + "email VARCHAR(256) NOT NULL,"
                 + "token VARCHAR(128) NOT NULL CONSTRAINT " + Utils.getConstraintName(schema, emailVerificationTokensTable, "token", "key") + " UNIQUE,"
                 + "token_expiry BIGINT NOT NULL,"
@@ -232,6 +232,15 @@ public static void revokeAllTokens(Start start, String userId, String email)
         });
     }
 
+    public static boolean isUserIdBeingUsedForEmailVerification(Start start, String userId)
+            throws SQLException, StorageQueryException {
+        String QUERY = "SELECT * FROM " + getConfig(start).getEmailVerificationTokensTable() + " WHERE user_id = ?";
+
+        return execute(start, QUERY, pst -> {
+            pst.setString(1, userId);
+        }, ResultSet::next);
+    }
+
     private static class EmailVerificationTokenInfoRowMapper
             implements RowMapper<EmailVerificationTokenInfo, ResultSet> {
         private static final EmailVerificationTokenInfoRowMapper INSTANCE = new EmailVerificationTokenInfoRowMapper();
diff --git a/src/main/java/io/supertokens/storage/postgresql/queries/UserIdMappingQueries.java b/src/main/java/io/supertokens/storage/postgresql/queries/UserIdMappingQueries.java
@@ -27,6 +27,7 @@
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.util.ArrayList;
+import java.util.HashMap;
 
 import static io.supertokens.storage.postgresql.QueryExecutorTemplate.execute;
 import static io.supertokens.storage.postgresql.QueryExecutorTemplate.update;
@@ -107,6 +108,33 @@ public static UserIdMapping[] getUserIdMappingWithEitherSuperTokensUserIdOrExter
 
     }
 
+    public static HashMap<String, String> getUserIdMappingWithUserIds(Start start, ArrayList<String> userIds)
+            throws SQLException, StorageQueryException {
+        StringBuilder QUERY = new StringBuilder(
+                "SELECT * FROM " + Config.getConfig(start).getUserIdMappingTable() + " WHERE supertokens_user_id IN (");
+        for (int i = 0; i < userIds.size(); i++) {
+            QUERY.append("?");
+            if (i != userIds.size() - 1) {
+                // not the last element
+                QUERY.append(",");
+            }
+        }
+        QUERY.append(")");
+        return execute(start, QUERY.toString(), pst -> {
+            for (int i = 0; i < userIds.size(); i++) {
+                // i+1 cause this starts with 1 and not 0
+                pst.setString(i + 1, userIds.get(i));
+            }
+        }, result -> {
+            HashMap<String, String> userIdMappings = new HashMap<>();
+            while (result.next()) {
+                UserIdMapping temp = UserIdMappingRowMapper.getInstance().mapOrThrow(result);
+                userIdMappings.put(temp.superTokensUserId, temp.externalUserId);
+            }
+            return userIdMappings;
+        });
+    }
+
     public static boolean deleteUserIdMappingWithSuperTokensUserId(Start start, String userId)
             throws SQLException, StorageQueryException {
         String QUERY = "DELETE FROM " + Config.getConfig(start).getUserIdMappingTable()

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ plugins {`
`2`	`2`	`id 'java-library'`
`3`	`3`	`}`
`4`	`4`
`5`		`-version = "1.18.0"`
	`5`	`+version = "1.19.0"`
`6`	`6`
`7`	`7`	`repositories {`
`8`	`8`	`mavenCentral()`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"_comment": "contains a list of plugin interfaces branch names that this core supports",`
`3`	`3`	`"versions": [`
`4`		`- "2.16"`
	`4`	`+ "2.17"`
`5`	`5`	`]`
`6`	`6`	`}`