/**
* Check the manifest cookie.
*
* <p>This routine checks the cookie and parameter on the request and sets the response code
* appropriately if we should not send back a manifest.
*
* @param request the request (for the incoming cookie).
* @param response the response (for the outgoing cookie and status)
* @return false if the caller should bolt because we already set the status.
*/
public static boolean checkManifestCookie(
HttpServletRequest request, HttpServletResponse response) {
Cookie cookie = getManifestCookie(request);
String cookieString = null;
if (cookie != null) {
cookieString = cookie.getValue();
}
cookieString = updateManifestCookieValue(cookieString);
if (cookieString == null) {
deleteManifestCookie(response);
response.setStatus(HttpServletResponse.SC_NOT_FOUND);
return false;
}
//
// Now we look for the client telling us we need to break a cycle, in which case we set a cookie
// and give the client no content.
//
if (errorParam.get(request) != null) {
addManifestErrorCookie(response);
response.setStatus(HttpServletResponse.SC_NO_CONTENT);
return false;
}
addManifestCookie(response, cookieString, SHORT_EXPIRE_SECONDS);
return true;
}
@SuppressWarnings("unchecked")
private Map<String, Object> getConfigMap(HttpServletRequest request) {
Map<String, Object> configMap = null;
String config = contextConfig.get(request);
if (!AuraTextUtil.isNullEmptyOrWhitespace(config)) {
if (config.startsWith(AuraTextUtil.urlencode("{"))) {
// Decode encoded context json. Serialized AuraContext json always starts with "{"
config = AuraTextUtil.urldecode(config);
}
configMap = (Map<String, Object>) new JsonReader().read(config);
}
return configMap;
}
@Override
public void write(HttpServletRequest request, HttpServletResponse response, AuraContext context)
throws IOException {
try {
if (!configAdapter.isTestAllowed()) {
servletUtilAdapter.send404(request.getServletContext(), request, response);
}
String descriptor = DESC_PARAM.get(request);
String testName = TEST_PARAM.get(request);
DefDescriptor<?> targetDesc =
definitionService.getDefDescriptor(descriptor, ComponentDef.class);
DefDescriptor<TestSuiteDef> suiteDesc =
definitionService.getDefDescriptor(
targetDesc, DefDescriptor.JAVASCRIPT_PREFIX, TestSuiteDef.class);
TestSuiteDef testSuite = suiteDesc.getDef();
write(response, testSuite, testName);
} catch (Throwable t) {
servletUtilAdapter.handleServletException(t, false, context, request, response, false);
}
}
private TestContext getTestContext(HttpServletRequest request) {
Map<String, Object> configMap = getConfigMap(request);
String key = null;
// Config takes precedence over param because the value is not expected to change during a test
// and it
// is less likely to have been modified unintentionally when from the config.
if (configMap != null) {
key = (String) configMap.get("test");
}
if (key == null) {
key = testContextKey.get(request);
}
if (key == null) {
return null;
} else {
return Aura.get(TestContextAdapter.class).getTestContext(key);
}
}
@Override
public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)
throws ServletException, IOException {
if (!Aura.getConfigAdapter().isTestAllowed()) {
chain.doFilter(req, res);
return;
}
TestContextAdapter testContextAdapter = Aura.get(TestContextAdapter.class);
if (testContextAdapter == null) {
chain.doFilter(req, res);
return;
}
// Check for requests to execute a JSTest, i.e. initial component GETs with particular
// parameters.
HttpServletRequest request = (HttpServletRequest) req;
if ("GET".equals(request.getMethod())) {
String contextPath = request.getContextPath();
String uri = request.getRequestURI();
String browserType = request.getParameter("aura.browserType");
if (browserType == null) {
// read it from request header
String ua = request.getHeader(HttpHeaders.USER_AGENT);
if (ua != null) {
ua = ua.toLowerCase();
if (ua.contains("chrome")) {
browserType = "GOOGLECHROME";
} else if (ua.contains("safari")) {
browserType = "SAFARI";
} else if (ua.contains("firefox")) {
browserType = "FIREFOX";
} else if (ua.contains("ipad")) {
browserType = "IPAD";
} else if (ua.contains("iphone")) {
browserType = "IPHONE";
} else if (ua.contains("msie 10")) {
browserType = "IE10";
} else if (ua.contains("msie 9")) {
browserType = "IE9";
} else if (ua.contains("msie 8")) {
browserType = "IE8";
} else if (ua.contains("msie 7")) {
browserType = "IE7";
} else if (ua.contains("msie 6")) {
browserType = "IE6";
} else if (ua.contains("trident/7.0")) {
browserType = "IE11";
} else if (ua.contains("edge/12")) {
browserType = "IE12";
} else {
browserType = "OTHER";
}
}
}
String path;
if (uri.startsWith(contextPath)) {
path = uri.substring(contextPath.length());
} else {
path = uri;
}
Matcher matcher = AuraRewriteFilter.DESCRIPTOR_PATTERN.matcher(path);
if (matcher.matches()) {
// Extract the target component since AuraContext usually does not have the app descriptor
// set yet.
DefType type = "app".equals(matcher.group(3)) ? DefType.APPLICATION : DefType.COMPONENT;
String namespace = matcher.group(1);
String name = matcher.group(2);
DefDescriptor<?> targetDescriptor =
Aura.getDefinitionService()
.getDefDescriptor(
String.format("%s:%s", namespace, name), type.getPrimaryInterface());
// Check if a single jstest is being requested.
String testToRun = jstestToRun.get(request);
if (testToRun != null && !testToRun.isEmpty()) {
AuraContext context = Aura.getContextService().getCurrentContext();
Format format = context.getFormat();
switch (format) {
case HTML:
TestCaseDef testDef;
TestContext testContext;
String targetUri;
try {
TestSuiteDef suiteDef = getTestSuite(targetDescriptor);
testDef = getTestCase(suiteDef, testToRun);
testDef.validateDefinition();
testDef.setCurrentBrowser(browserType);
testContextAdapter.getTestContext(testDef.getQualifiedName());
testContextAdapter.release();
testContext = testContextAdapter.getTestContext(testDef.getQualifiedName());
targetUri = buildJsTestTargetUri(targetDescriptor, testDef);
} catch (QuickFixException e) {
((HttpServletResponse) res).setStatus(HttpStatus.SC_INTERNAL_SERVER_ERROR);
res.setCharacterEncoding(AuraBaseServlet.UTF_ENCODING);
res.getWriter().append(e.getMessage());
Aura.getExceptionAdapter().handleException(e);
return;
}
// Load any test mocks.
Collection<Definition> mocks = testDef.getLocalDefs();
testContext.getLocalDefs().addAll(mocks);
loadTestMocks(context, true, testContext.getLocalDefs());
// Capture the response and inject tags to load jstest.
String capturedResponse = captureResponse(req, res, targetUri);
if (capturedResponse != null) {
res.setCharacterEncoding(AuraBaseServlet.UTF_ENCODING);
if (!Aura.getContextService().isEstablished()) {
// There was an error in the original response, so just write the response out.
res.getWriter().write(capturedResponse);
} else {
String testTag =
buildJsTestScriptTag(targetDescriptor, testToRun, capturedResponse);
injectScriptTags(res.getWriter(), capturedResponse, testTag);
}
return;
}
case JS:
res.setCharacterEncoding(AuraBaseServlet.UTF_ENCODING);
writeJsTestScript(res.getWriter(), targetDescriptor, testToRun);
return;
default:
// Pass it on.
}
}
// aurajstest:jstest app is invokable in the following ways:
// ?aura.mode=JSTEST - run all tests
// ?aura.mode JSTEST&test=XXX - run single test
// ?aura.jstest - run all tests
// ?aura.jstest=XXX - run single test
// ?aura.jstestrun - run all tests
// TODO: delete JSTEST mode
String jstestAppRequest = jstestAppFlag.get(request);
Mode mode = AuraContextFilter.mode.get(request, Mode.PROD);
if (mode == Mode.JSTEST
|| mode == Mode.JSTESTDEBUG
|| jstestAppRequest != null
|| testToRun != null) {
mode = mode.toString().endsWith("DEBUG") ? Mode.AUTOJSTESTDEBUG : Mode.AUTOJSTEST;
String qs = String.format("descriptor=%s:%s&defType=%s", namespace, name, type.name());
String testName = null;
if (jstestAppRequest != null && !jstestAppRequest.isEmpty()) {
testName = jstestAppRequest;
} else if (testToRun != null && !testToRun.isEmpty()) {
testName = testToRun;
}
if (testName != null) {
qs = qs + "&test=" + testName;
}
String newUri =
createURI(
"aurajstest",
"jstest",
DefType.APPLICATION,
mode,
Authentication.AUTHENTICATED.name(),
qs);
RequestDispatcher dispatcher =
servletContext.getContext(newUri).getRequestDispatcher(newUri);
if (dispatcher != null) {
dispatcher.forward(req, res);
return;
}
}
}
}
// Handle mock definitions specified in the tests.
TestContext testContext = getTestContext(request);
if (testContext == null) {
// During manual testing, the test context adapter may not always get cleared.
testContextAdapter.clear();
} else {
ContextService contextService = Aura.getContextService();
if (!contextService.isEstablished()) {
LOG.error("Aura context is not established! New context will NOT be created.");
chain.doFilter(req, res);
return;
}
AuraContext context = contextService.getCurrentContext();
// Reset mocks if requested, or for the initial GET.
boolean doResetMocks = testReset.get(request, Format.HTML.equals(context.getFormat()));
loadTestMocks(context, doResetMocks, testContext.getLocalDefs());
}
chain.doFilter(req, res);
}