Populate Subject cache when obtaining SubjectReferences for instances which already exist

sponge/sponge-service-api6/src/main/java/me/lucko/luckperms/sponge/service/proxy/api6/SubjectCollectionProxy.java

@@ -32,6 +32,7 @@ import me.lucko.luckperms.sponge.service.CompatibilityUtil;
 import me.lucko.luckperms.sponge.service.model.LPPermissionService;
 import me.lucko.luckperms.sponge.service.model.LPSubject;
 import me.lucko.luckperms.sponge.service.model.LPSubjectCollection;
+import me.lucko.luckperms.sponge.service.model.SubjectReferenceFactory;
 
 import org.spongepowered.api.service.context.Context;
 import org.spongepowered.api.service.permission.Subject;
@@ -71,7 +72,7 @@ public final class SubjectCollectionProxy implements SubjectCollection {
         // this behaviour should be replaced when CompletableFutures are added to Sponge
         return (List) handle.getAllIdentifiers()
                 .thenApply(ids -> ids.stream()
-                        .map(s -> new SubjectProxy(service, service.newSubjectReference(getIdentifier(), s)))
+                        .map(s -> new SubjectProxy(service, SubjectReferenceFactory.obtain(service, getIdentifier(), s)))
                         .collect(ImmutableCollectors.toList())
                 ).join();
     }

sponge/sponge-service-api6/src/main/java/me/lucko/luckperms/sponge/service/proxy/api6/SubjectDataProxy.java

@@ -33,6 +33,7 @@ import me.lucko.luckperms.sponge.service.model.LPPermissionService;
 import me.lucko.luckperms.sponge.service.model.LPSubject;
 import me.lucko.luckperms.sponge.service.model.LPSubjectData;
 import me.lucko.luckperms.sponge.service.model.SubjectReference;
+import me.lucko.luckperms.sponge.service.model.SubjectReferenceFactory;
 
 import org.spongepowered.api.service.context.Context;
 import org.spongepowered.api.service.permission.Subject;
@@ -114,10 +115,7 @@ public final class SubjectDataProxy implements SubjectData {
     public boolean addParent(Set<Context> contexts, Subject parent) {
         handle().thenCompose(handle -> handle.addParent(
                 CompatibilityUtil.convertContexts(contexts),
-                service.newSubjectReference(
+                SubjectReferenceFactory.obtain(service, parent)
-                        parent.getContainingCollection().getIdentifier(),
-                        parent.getIdentifier()
-                )
         ));
         return true;
     }
@@ -126,10 +124,7 @@ public final class SubjectDataProxy implements SubjectData {
     public boolean removeParent(Set<Context> contexts, Subject parent) {
         handle().thenCompose(handle -> handle.removeParent(
                 CompatibilityUtil.convertContexts(contexts),
-                service.newSubjectReference(
+                SubjectReferenceFactory.obtain(service, parent)
-                        parent.getContainingCollection().getIdentifier(),
-                        parent.getIdentifier()
-                )
         ));
         return true;
     }

sponge/sponge-service-api6/src/main/java/me/lucko/luckperms/sponge/service/proxy/api6/SubjectProxy.java

@@ -32,7 +32,9 @@ import me.lucko.luckperms.common.utils.ImmutableCollectors;
 import me.lucko.luckperms.sponge.service.CompatibilityUtil;
 import me.lucko.luckperms.sponge.service.model.LPPermissionService;
 import me.lucko.luckperms.sponge.service.model.LPSubject;
+import me.lucko.luckperms.sponge.service.model.ProxiedSubject;
 import me.lucko.luckperms.sponge.service.model.SubjectReference;
+import me.lucko.luckperms.sponge.service.model.SubjectReferenceFactory;
 
 import org.spongepowered.api.command.CommandSource;
 import org.spongepowered.api.service.context.Context;
@@ -48,7 +50,7 @@ import java.util.concurrent.CompletableFuture;
 
 @SuppressWarnings("unchecked")
 @RequiredArgsConstructor
-public final class SubjectProxy implements Subject {
+public final class SubjectProxy implements Subject, ProxiedSubject {
     private final LPPermissionService service;
     private final SubjectReference ref;
 
@@ -56,6 +58,11 @@ public final class SubjectProxy implements Subject {
         return ref.resolveLp();
     }
 
+    @Override
+    public SubjectReference getReference() {
+        return ref;
+    }
+
     @Override
     public Optional<CommandSource> getCommandSource() {
         return handle().thenApply(LPSubject::getCommandSource).join();
@@ -95,10 +102,7 @@ public final class SubjectProxy implements Subject {
     public boolean isChildOf(Subject parent) {
         return handle().thenApply(handle -> handle.isChildOf(
                 ImmutableContextSet.empty(),
-                service.newSubjectReference(
+                SubjectReferenceFactory.obtain(service, parent)
-                        parent.getContainingCollection().getIdentifier(),
-                        parent.getIdentifier()
-                )
         )).join();
     }
 
@@ -106,10 +110,7 @@ public final class SubjectProxy implements Subject {
     public boolean isChildOf(Set<Context> contexts, Subject parent) {
         return handle().thenApply(handle -> handle.isChildOf(
                 CompatibilityUtil.convertContexts(contexts),
-                service.newSubjectReference(
+                SubjectReferenceFactory.obtain(service, parent)
-                        parent.getContainingCollection().getIdentifier(),
-                        parent.getIdentifier()
-                )
         )).join();
     }
 

sponge/sponge-service-api7/src/main/java/me/lucko/luckperms/sponge/service/proxy/api7/PermissionServiceProxy.java

@@ -33,6 +33,7 @@ import me.lucko.luckperms.common.utils.ImmutableCollectors;
 import me.lucko.luckperms.sponge.service.model.LPPermissionDescription;
 import me.lucko.luckperms.sponge.service.model.LPPermissionService;
 import me.lucko.luckperms.sponge.service.model.LPSubjectCollection;
+import me.lucko.luckperms.sponge.service.model.SubjectReferenceFactory;
 
 import org.spongepowered.api.Sponge;
 import org.spongepowered.api.plugin.PluginContainer;
@@ -105,7 +106,7 @@ public final class PermissionServiceProxy implements PermissionService {
 
     @Override
     public SubjectReference newSubjectReference(String s, String s1) {
-        return handle.newSubjectReference(s, s1);
+        return SubjectReferenceFactory.obtain(handle, s, s1);
     }
 
     @Override

sponge/sponge-service-api7/src/main/java/me/lucko/luckperms/sponge/service/proxy/api7/SubjectCollectionProxy.java

@@ -31,6 +31,7 @@ import me.lucko.luckperms.common.utils.ImmutableCollectors;
 import me.lucko.luckperms.sponge.service.CompatibilityUtil;
 import me.lucko.luckperms.sponge.service.model.LPSubject;
 import me.lucko.luckperms.sponge.service.model.LPSubjectCollection;
+import me.lucko.luckperms.sponge.service.model.SubjectReferenceFactory;
 
 import org.spongepowered.api.service.context.Context;
 import org.spongepowered.api.service.permission.Subject;
@@ -91,7 +92,7 @@ public final class SubjectCollectionProxy implements SubjectCollection {
 
     @Override
     public SubjectReference newSubjectReference(String s) {
-        return handle.newSubjectReference(s);
+        return SubjectReferenceFactory.obtain(handle.getService(), getIdentifier(), s);
     }
 
     @Override

sponge/sponge-service-api7/src/main/java/me/lucko/luckperms/sponge/service/proxy/api7/SubjectProxy.java

@@ -31,6 +31,7 @@ import me.lucko.luckperms.api.context.ImmutableContextSet;
 import me.lucko.luckperms.sponge.service.CompatibilityUtil;
 import me.lucko.luckperms.sponge.service.model.LPPermissionService;
 import me.lucko.luckperms.sponge.service.model.LPSubject;
+import me.lucko.luckperms.sponge.service.model.ProxiedSubject;
 import me.lucko.luckperms.sponge.service.model.SubjectReference;
 import me.lucko.luckperms.sponge.service.model.SubjectReferenceFactory;
 
@@ -48,7 +49,7 @@ import java.util.concurrent.CompletableFuture;
 
 @SuppressWarnings("unchecked")
 @RequiredArgsConstructor
-public final class SubjectProxy implements Subject {
+public final class SubjectProxy implements Subject, ProxiedSubject {
     private final LPPermissionService service;
     private final SubjectReference ref;
 
@@ -56,6 +57,11 @@ public final class SubjectProxy implements Subject {
         return ref.resolveLp();
     }
 
+    @Override
+    public SubjectReference getReference() {
+        return ref;
+    }
+
     @Override
     public Optional<CommandSource> getCommandSource() {
         return getHandle().thenApply(LPSubject::getCommandSource).join();

sponge/sponge-service/src/main/java/me/lucko/luckperms/sponge/service/model/LPPermissionService.java

@@ -64,8 +64,6 @@ public interface LPPermissionService {
 
     ImmutableMap<String, LPSubjectCollection> getLoadedCollections();
 
-    SubjectReference newSubjectReference(String collectionIdentifier, String subjectIdentifier);
-
     LPPermissionDescription registerPermissionDescription(String id, Text description, PluginContainer owner);
 
     Optional<LPPermissionDescription> getDescription(String permission);

sponge/sponge-service/src/main/java/me/lucko/luckperms/sponge/service/model/LPSubject.java

@@ -47,7 +47,7 @@ public interface LPSubject {
     String getIdentifier();
 
     default SubjectReference toReference() {
-        return getService().newSubjectReference(getParentCollection().getIdentifier(), getIdentifier());
+        return SubjectReferenceFactory.obtain(getService(), this);
     }
 
     default LPSubject getDefaults() {

sponge/sponge-service/src/main/java/me/lucko/luckperms/sponge/service/model/LPSubjectCollection.java

@@ -49,10 +49,6 @@ public interface LPSubjectCollection {
 
     String getIdentifier();
 
-    default SubjectReference newSubjectReference(String identifier) {
-        return getService().newSubjectReference(getIdentifier(), identifier);
-    }
-
     Predicate<String> getIdentifierValidityPredicate();
 
     CompletableFuture<LPSubject> loadSubject(String identifier);

sponge/sponge-service/src/main/java/me/lucko/luckperms/sponge/service/model/ProxiedSubject.java

@@ -0,0 +1,35 @@
+/*
+ * This file is part of LuckPerms, licensed under the MIT License.
+ *
+ *  Copyright (c) lucko (Luck) <luck@lucko.me>
+ *  Copyright (c) contributors
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package me.lucko.luckperms.sponge.service.model;
+
+/**
+ * Marks that an object is a proxied representation of a {@link org.spongepowered.api.service.permission.Subject}.
+ */
+public interface ProxiedSubject {
+
+    SubjectReference getReference();
+
+}

sponge/sponge-service/src/main/java/me/lucko/luckperms/sponge/service/model/SubjectReference.java

@@ -48,7 +48,7 @@ public final class SubjectReference implements org.spongepowered.api.service.per
     /**
      * The time a subject instance should be cached in this reference
      */
-    private static final long CACHE_TIME = TimeUnit.SECONDS.toMillis(60);
+    private static final long CACHE_TIME = TimeUnit.MINUTES.toMillis(5);
 
     /**
      * Reference to the permission service
@@ -79,6 +79,19 @@ public final class SubjectReference implements org.spongepowered.api.service.per
         this.subjectIdentifier = Preconditions.checkNotNull(subjectIdentifier);
     }
 
+    void fillCache(LPSubject subject) {
+        LPSubject sub = tryCache();
+
+        if (sub == null) {
+            // if no value is currently cached, populate with the passed value
+            lastLookup = System.currentTimeMillis();
+            cache = new WeakReference<>(subject);
+        } else if (sub == subject) {
+            // if equal, reset the cache timeout
+            lastLookup = System.currentTimeMillis();
+        }
+    }
+
     private LPSubject tryCache() {
         if ((System.currentTimeMillis() - lastLookup) < CACHE_TIME) {
             if (cache != null) {
@@ -152,7 +165,7 @@ public final class SubjectReference implements org.spongepowered.api.service.per
 
     @Override
     public String toString() {
-        return "SubjectReference(" +
+        return "luckperms.SubjectReference(" +
                 "collection=" + this.collectionIdentifier + ", " +
                 "subject=" + this.subjectIdentifier + ")";
     }

sponge/sponge-service/src/main/java/me/lucko/luckperms/sponge/service/model/SubjectReferenceFactory.java

@@ -63,7 +63,17 @@ public final class SubjectReferenceFactory {
         return obtain(service, parts.get(0), parts.get(1));
     }
 
+    public static SubjectReference obtain(@NonNull LPPermissionService service, @NonNull LPSubject subject) {
+        SubjectReference ret = obtain(service, subject.getParentCollection().getIdentifier(), subject.getIdentifier());
+        ret.fillCache(subject);
+        return ret;
+    }
+
     public static SubjectReference obtain(@NonNull LPPermissionService service, @NonNull Subject subject) {
+        if (subject instanceof ProxiedSubject) {
+            return ((ProxiedSubject) subject).getReference();
+        }
+
         return obtain(service, subject.getContainingCollection().getIdentifier(), subject.getIdentifier());
     }
 

sponge/src/main/java/me/lucko/luckperms/sponge/managers/SpongeGroupManager.java

@@ -50,6 +50,7 @@ import me.lucko.luckperms.sponge.service.ProxyFactory;
 import me.lucko.luckperms.sponge.service.model.LPSubject;
 import me.lucko.luckperms.sponge.service.model.LPSubjectCollection;
 import me.lucko.luckperms.sponge.service.model.SubjectReference;
+import me.lucko.luckperms.sponge.service.model.SubjectReferenceFactory;
 
 import org.spongepowered.api.service.permission.PermissionService;
 import org.spongepowered.api.service.permission.SubjectCollection;
@@ -237,7 +238,7 @@ public class SpongeGroupManager implements GroupManager, LPSubjectCollection {
             List<HeldPermission<String>> lookup = plugin.getStorage().getGroupsWithPermission(permission).join();
             for (HeldPermission<String> holder : lookup) {
                 if (holder.asNode().getFullContexts().equals(ImmutableContextSet.empty())) {
-                    ret.put(getService().newSubjectReference(getIdentifier(), holder.getHolder()), holder.getValue());
+                    ret.put(SubjectReferenceFactory.obtain(getService(), getIdentifier(), holder.getHolder()), holder.getValue());
                 }
             }
 
@@ -253,7 +254,7 @@ public class SpongeGroupManager implements GroupManager, LPSubjectCollection {
             List<HeldPermission<String>> lookup = plugin.getStorage().getGroupsWithPermission(permission).join();
             for (HeldPermission<String> holder : lookup) {
                 if (holder.asNode().getFullContexts().equals(contexts)) {
-                    ret.put(getService().newSubjectReference(getIdentifier(), holder.getHolder()), holder.getValue());
+                    ret.put(SubjectReferenceFactory.obtain(getService(), getIdentifier(), holder.getHolder()), holder.getValue());
                 }
             }
 

sponge/src/main/java/me/lucko/luckperms/sponge/managers/SpongeUserManager.java

@@ -50,6 +50,7 @@ import me.lucko.luckperms.sponge.service.ProxyFactory;
 import me.lucko.luckperms.sponge.service.model.LPSubject;
 import me.lucko.luckperms.sponge.service.model.LPSubjectCollection;
 import me.lucko.luckperms.sponge.service.model.SubjectReference;
+import me.lucko.luckperms.sponge.service.model.SubjectReferenceFactory;
 
 import org.spongepowered.api.service.permission.PermissionService;
 import org.spongepowered.api.service.permission.SubjectCollection;
@@ -334,7 +335,7 @@ public class SpongeUserManager implements UserManager, LPSubjectCollection {
             List<HeldPermission<UUID>> lookup = plugin.getStorage().getUsersWithPermission(permission).join();
             for (HeldPermission<UUID> holder : lookup) {
                 if (holder.asNode().getFullContexts().equals(ImmutableContextSet.empty())) {
-                    ret.put(getService().newSubjectReference(getIdentifier(), holder.getHolder().toString()), holder.getValue());
+                    ret.put(SubjectReferenceFactory.obtain(getService(), getIdentifier(), holder.getHolder().toString()), holder.getValue());
                 }
             }
 
@@ -350,7 +351,7 @@ public class SpongeUserManager implements UserManager, LPSubjectCollection {
             List<HeldPermission<UUID>> lookup = plugin.getStorage().getUsersWithPermission(permission).join();
             for (HeldPermission<UUID> holder : lookup) {
                 if (holder.asNode().getFullContexts().equals(contexts)) {
-                    ret.put(getService().newSubjectReference(getIdentifier(), holder.getHolder().toString()), holder.getValue());
+                    ret.put(SubjectReferenceFactory.obtain(getService(), getIdentifier(), holder.getHolder().toString()), holder.getValue());
                 }
             }
 

sponge/src/main/java/me/lucko/luckperms/sponge/service/LuckPermsService.java

@@ -47,7 +47,6 @@ import me.lucko.luckperms.sponge.service.model.LPPermissionService;
 import me.lucko.luckperms.sponge.service.model.LPSubject;
 import me.lucko.luckperms.sponge.service.model.LPSubjectCollection;
 import me.lucko.luckperms.sponge.service.model.SubjectReference;
-import me.lucko.luckperms.sponge.service.model.SubjectReferenceFactory;
 import me.lucko.luckperms.sponge.service.persisted.PersistedCollection;
 import me.lucko.luckperms.sponge.service.storage.SubjectStorage;
 
@@ -142,11 +141,6 @@ public class LuckPermsService implements LPPermissionService {
         return ImmutableMap.copyOf(collections.asMap());
     }
 
-    @Override
-    public SubjectReference newSubjectReference(String collectionIdentifier, String subjectIdentifier) {
-        return SubjectReferenceFactory.obtain(this, collectionIdentifier, subjectIdentifier);
-    }
-
     @Override
     public LPPermissionDescription registerPermissionDescription(String id, Text description, PluginContainer owner) {
         LuckPermsPermissionDescription desc = new LuckPermsPermissionDescription(this, id, description, owner);