PhantomThief / simple-failover-java / 410

pending completion

Build # 410

Build Type

Pull #44

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/PhantomThief/simple-failover-java/commit/<a class=hub.com/PhantomThief/simple-failover-java/commit/<a class="double-link" href="https://git"><a class=hub.com/PhantomThief/simple-failover-java/commit/<a class="double-link" href="https://git"><a class=hub.com/PhantomThief/simple-failover-java/commit/<a class="double-link" href="https://git"><a class=hub.com/PhantomThief/simple-failover-java/commit/<a class="double-link" href="https://git"><a class=hub.com/PhantomThief/simple-failover-java/commit/806c448732c66fec0eeaf5ea73eb6a9b858271d1">806c44873">&lt;a href=&quot;https://github.com/PhantomThief/simple-failover-java/commit/</a><a class="double-link" href="https://github.com/PhantomThief/simple-failover-java/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/PhantomThief/simple-failover-java/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/PhantomThief/simple-failover-java/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/PhantomThief/simple-failover-java/commit/806c448732c66fec0eeaf5ea73eb6a9b858271d1">806c44873</a><a href="https://github.com/PhantomThief/simple-failover-java/commit/806c448732c66fec0eeaf5ea73eb6a9b858271d1">&lt;a href=&quot;https://github.com/PhantomThief/simple-failover-java/commit/806c448732c66fec0eeaf5ea73eb6a9b858271d1&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/PhantomThief/simple-failover-java/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/PhantomThief/simple-failover-java/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://git&amp;quot;&amp;gt;&amp;amp;lt;a class=&amp;lt;/a&amp;gt;hub.com/PhantomThief/simple-failover-java/commit/806c448732c66fec0eeaf5ea73eb6a9b858271d1&amp;quot;&amp;gt;806c44873&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/PhantomThief/simple-failover-java/commit/806c448732c66fec0eeaf5ea73eb6a9b858271d1&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/PhantomThief/simple-failover-java/commit/806c448732c66fec0eeaf5ea73eb6a9b&amp;lt;/a&amp;gt;858271d1&amp;quot;&amp;gt;&amp;am</a>p;quot;&amp;gt;Merge &amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/PhantomThief/simple-failover-java/commit/&amp;lt;a class=&am... (continued)

Pull Request Pull Request #44: fix(PriorityFailoverCheckTask): 修复主动关闭 failover 后，failover 实例仍有可能无法被 gc 的问题

Run Details

55 of 55 new or added lines in 5 files covered. (100.0%)

1599 of 1894 relevant lines covered (84.42%)

0.84 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

84.48

/src/main/java/com/github/phantomthief/failover/impl/PriorityFailoverCheckTask.java

package com.github.phantomthief.failover.impl;

import java.util.HashMap;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicReference;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.github.phantomthief.failover.impl.PriorityFailover.GroupInfo;
import com.github.phantomthief.failover.impl.PriorityFailover.ResInfo;
import com.github.phantomthief.failover.impl.PriorityFailoverBuilder.PriorityFailoverConfig;

/**
 * @author huangli
 * Created on 2020-01-20
 */
class PriorityFailoverCheckTask<T> implements Runnable {

    private static final Logger logger = LoggerFactory.getLogger(PriorityFailoverCheckTask.class);

    private final PriorityFailoverConfig<T> config;

    private final AtomicReference<ScheduledFuture<?>> futureRef = new AtomicReference<>();

    private final HashMap<T, ResInfo<T>> resourcesMap;
    private final GroupInfo<T>[] groups;

    private final AtomicBoolean closed = new AtomicBoolean(false);

    /**
     * 有时在 ResInfo 持有的资源对象中，会持有 failover 实例，以便调用 failover 的 success/fail 等方法
     * 一旦在注册到 GcUtil 的 CloseRunnable 中持有了 PriorityFailoverCheckTask 的引用，将导致 failover
     * 始终存在引用，无法被关闭和清理。所以这里单独构造一个 static class，避免隐式持有 this.resourcesMap。
     * 导致即使主动关闭了 failover，failover 也无法被 gc 掉
     */
    private static class CloseRunnable implements Runnable {
        private final AtomicBoolean closed;
        private final AtomicReference<ScheduledFuture<?>> futureRef;

        CloseRunnable(AtomicBoolean closed,
                AtomicReference<ScheduledFuture<?>> futureRef) {
            this.closed = closed;
            this.futureRef = futureRef;
        }

        @Override
        public void run() {
            // 这里代码和 close 一样，由于此时 failover 已经被 gc 掉了，所以不需要再加锁了
            closed.set(true);
            ScheduledFuture<?> scheduledFuture = futureRef.get();
            if (scheduledFuture != null && !scheduledFuture.isCancelled()) {
                scheduledFuture.cancel(true);
                futureRef.set(null);
            }
        }
    }

    PriorityFailoverCheckTask(PriorityFailoverConfig<T> config, PriorityFailover<T> failover) {
        this.config = config;
        this.resourcesMap = failover.getResourcesMap();
        this.groups = failover.getGroups();
        if (config.getChecker() != null) {
            if (config.isStartCheckTaskImmediately()) {
                ensureStart();
            }
            GcUtil.register(failover, new CloseRunnable(closed, futureRef));
            GcUtil.doClean();
        }
    }

    public void ensureStart() {
        if (futureRef.get() == null) {
            synchronized (this) {
                if (futureRef.get() == null && config.getChecker() != null) {
                    futureRef.set(config.getCheckExecutor().scheduleWithFixedDelay(
                            this, config.getCheckDuration().toMillis(),
                            config.getCheckDuration().toMillis(), TimeUnit.MILLISECONDS));
                }
            }
        }
    }

    @Override
    public void run() {
        // TODO run in multi threads mode?

        Thread currentThread = Thread.currentThread();
        String origName = currentThread.getName();
        if (config.getName() != null) {
            currentThread.setName(origName + "-[" + config.getName() + "]");
        }
        try {
            for (ResInfo<T> r : resourcesMap.values()) {
                try {
                    if (closed.get()) {
                        return;
                    }
                    if (config.getWeightFunction().needCheck(r.maxWeight,
                            r.minWeight, r.priority, r.currentWeight, r.resource)) {
                        boolean ok = config.getChecker().test(r.resource);
                        if (closed.get()) {
                            return;
                        }
                        PriorityFailover.updateWeight(ok, r, config, groups);
                    }
                } catch (Throwable e) {
                    // the test may fail, the user's onSuccess/onFail callback may fail
                    if (config.getName() == null) {
                        logger.error("failover check/updateWeight fail: {}", e.toString());
                    } else {
                        logger.error("failover({}) check/updateWeight fail: {}", config.getName(), e.toString());
                    }
                }
            }
        } finally {
            currentThread.setName(origName);
        }
    }

    public synchronized void close() {
        closed.set(true);
        ScheduledFuture<?> scheduledFuture = futureRef.get();
        if (scheduledFuture != null && !scheduledFuture.isCancelled()) {
            scheduledFuture.cancel(true);
            futureRef.set(null);
        }
    }

    boolean isClosed() {
        return closed.get();
    }
}

1	package com.github.phantomthief.failover.impl;
2
3	import java.util.HashMap;
4	import java.util.concurrent.ScheduledFuture;
5	import java.util.concurrent.TimeUnit;
6	import java.util.concurrent.atomic.AtomicBoolean;
7	import java.util.concurrent.atomic.AtomicReference;
8
9	import org.slf4j.Logger;
10	import org.slf4j.LoggerFactory;
11
12	import com.github.phantomthief.failover.impl.PriorityFailover.GroupInfo;
13	import com.github.phantomthief.failover.impl.PriorityFailover.ResInfo;
14	import com.github.phantomthief.failover.impl.PriorityFailoverBuilder.PriorityFailoverConfig;
15
16	/**
17	* @author huangli
18	* Created on 2020-01-20
19	*/
20	class PriorityFailoverCheckTask<T> implements Runnable {
21
22	private static final Logger logger = LoggerFactory.getLogger(PriorityFailoverCheckTask.class);	1✔
23
24	private final PriorityFailoverConfig<T> config;
25
26	private final AtomicReference<ScheduledFuture<?>> futureRef = new AtomicReference<>();	1✔
27
28	private final HashMap<T, ResInfo<T>> resourcesMap;
29	private final GroupInfo<T>[] groups;
30
31	private final AtomicBoolean closed = new AtomicBoolean(false);	1✔
32
33	/**
34	* 有时在 ResInfo 持有的资源对象中，会持有 failover 实例，以便调用 failover 的 success/fail 等方法
35	* 一旦在注册到 GcUtil 的 CloseRunnable 中持有了 PriorityFailoverCheckTask 的引用，将导致 failover
36	* 始终存在引用，无法被关闭和清理。所以这里单独构造一个 static class，避免隐式持有 this.resourcesMap。
37	* 导致即使主动关闭了 failover，failover 也无法被 gc 掉
38	*/
39	private static class CloseRunnable implements Runnable {
40	private final AtomicBoolean closed;
41	private final AtomicReference<ScheduledFuture<?>> futureRef;
42
43	CloseRunnable(AtomicBoolean closed,
44	AtomicReference<ScheduledFuture<?>> futureRef) {	1✔
45	this.closed = closed;	1✔
46	this.futureRef = futureRef;	1✔
47	}	1✔
48
49	@Override
50	public void run() {
51	// 这里代码和 close 一样，由于此时 failover 已经被 gc 掉了，所以不需要再加锁了
52	closed.set(true);	1✔
53	ScheduledFuture<?> scheduledFuture = futureRef.get();	1✔
54	if (scheduledFuture != null && !scheduledFuture.isCancelled()) {	1✔
55	scheduledFuture.cancel(true);	×
56	futureRef.set(null);	×
57	}
58	}	1✔
59	}
60
61	PriorityFailoverCheckTask(PriorityFailoverConfig<T> config, PriorityFailover<T> failover) {	1✔
62	this.config = config;	1✔
63	this.resourcesMap = failover.getResourcesMap();	1✔
64	this.groups = failover.getGroups();	1✔
65	if (config.getChecker() != null) {	1✔
66	if (config.isStartCheckTaskImmediately()) {	1✔
67	ensureStart();	1✔
68	}
69	GcUtil.register(failover, new CloseRunnable(closed, futureRef));	1✔
70	GcUtil.doClean();	1✔
71	}
72	}	1✔
73
74	public void ensureStart() {
75	if (futureRef.get() == null) {	1✔
76	synchronized (this) {	1✔
77	if (futureRef.get() == null && config.getChecker() != null) {	1✔
78	futureRef.set(config.getCheckExecutor().scheduleWithFixedDelay(	1✔
79	this, config.getCheckDuration().toMillis(),	1✔
80	config.getCheckDuration().toMillis(), TimeUnit.MILLISECONDS));	1✔
81	}
82	}	1✔
83	}
84	}	1✔
85
86	@Override
87	public void run() {
88	// TODO run in multi threads mode?
89
90	Thread currentThread = Thread.currentThread();	1✔
91	String origName = currentThread.getName();	1✔
92	if (config.getName() != null) {	1✔
93	currentThread.setName(origName + "-[" + config.getName() + "]");	×
94	}
95	try {
96	for (ResInfo<T> r : resourcesMap.values()) {	1✔
97	try {
98	if (closed.get()) {	1✔
99	return;	×
100	}
101	if (config.getWeightFunction().needCheck(r.maxWeight,	1✔
102	r.minWeight, r.priority, r.currentWeight, r.resource)) {
103	boolean ok = config.getChecker().test(r.resource);	1✔
104	if (closed.get()) {	1✔
105	return;	×
106	}
107	PriorityFailover.updateWeight(ok, r, config, groups);	1✔
108	}
109	} catch (Throwable e) {	×
110	// the test may fail, the user's onSuccess/onFail callback may fail
111	if (config.getName() == null) {	×
112	logger.error("failover check/updateWeight fail: {}", e.toString());	×
113	} else {
114	logger.error("failover({}) check/updateWeight fail: {}", config.getName(), e.toString());	×
115	}
116	}	1✔
117	}	1✔
118	} finally {
119	currentThread.setName(origName);	1✔
120	}
121	}	1✔
122
123	public synchronized void close() {
124	closed.set(true);	1✔
125	ScheduledFuture<?> scheduledFuture = futureRef.get();	1✔
126	if (scheduledFuture != null && !scheduledFuture.isCancelled()) {	1✔
127	scheduledFuture.cancel(true);	1✔
128	futureRef.set(null);	1✔
129	}
130	}	1✔
131
132	boolean isClosed() {
133	return closed.get();	1✔
134	}
135	}

PhantomThief / simple-failover-java / 410

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous